mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-11 18:15:39 +00:00
Deploying to gh-pages from @ 46098ec85b 🚀
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>settings.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>settings.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../mcaptcha/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../mcaptcha/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
|
||||
<span id="2"> 2</span>
|
||||
<span id="3"> 3</span>
|
||||
<span id="4"> 4</span>
|
||||
@@ -227,6 +227,8 @@
|
||||
<span id="224">224</span>
|
||||
<span id="225">225</span>
|
||||
<span id="226">226</span>
|
||||
<span id="227">227</span>
|
||||
<span id="228">228</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="comment">/*
|
||||
* Copyright (C) 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
@@ -244,13 +246,13 @@
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/</span>
|
||||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">env</span>;
|
||||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::env</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::path::Path</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">config</span>::{<span class="ident">Config</span>, <span class="ident">ConfigError</span>, <span class="ident">Environment</span>, <span class="ident">File</span>};
|
||||
<span class="kw">use</span> <span class="ident">log</span>::<span class="ident">debug</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde</span>::<span class="ident">Deserialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">url</span>::<span class="ident">Url</span>;
|
||||
<span class="kw">use</span> <span class="ident">log::debug</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">url::Url</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Server</span> {
|
||||
@@ -271,15 +273,17 @@
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Smtp</span> {
|
||||
<span class="kw">pub</span> <span class="ident">from</span>: <span class="ident">String</span>,
|
||||
<span class="kw">pub</span> <span class="ident">reply_to</span>: <span class="ident">String</span>,
|
||||
<span class="kw">pub</span> <span class="ident">url</span>: <span class="ident">String</span>,
|
||||
<span class="kw">pub</span> <span class="ident">username</span>: <span class="ident">String</span>,
|
||||
<span class="kw">pub</span> <span class="ident">password</span>: <span class="ident">String</span>,
|
||||
<span class="kw">pub</span> <span class="ident">port</span>: <span class="ident">u16</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Server</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ip</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}:{}"</span>, <span class="self">self</span>.<span class="ident">ip</span>, <span class="self">self</span>.<span class="ident">port</span>)
|
||||
<span class="macro">format!</span>(<span class="string">"{}:{}"</span>, <span class="self">self</span>.<span class="ident">ip</span>, <span class="self">self</span>.<span class="ident">port</span>)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -296,7 +300,7 @@
|
||||
<span class="kw">impl</span> <span class="ident">DatabaseBuilder</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
|
||||
<span class="kw">fn</span> <span class="ident">extract_database_url</span>(<span class="ident">url</span>: <span class="kw-2">&</span><span class="ident">Url</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
|
||||
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">"Databse name: {}"</span>, <span class="ident">url</span>.<span class="ident">path</span>());
|
||||
<span class="macro">debug!</span>(<span class="string">"Databse name: {}"</span>, <span class="ident">url</span>.<span class="ident">path</span>());
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">url</span>.<span class="ident">path</span>().<span class="ident">split</span>(<span class="string">'/'</span>);
|
||||
<span class="ident">path</span>.<span class="ident">next</span>();
|
||||
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">path</span>.<span class="ident">next</span>().<span class="ident">expect</span>(<span class="string">"no database name"</span>).<span class="ident">to_string</span>();
|
||||
@@ -337,7 +341,7 @@
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
|
||||
<span class="kw">impl</span> <span class="ident">Settings</span> {
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ConfigError</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Config</span>::<span class="ident">new</span>();
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Config::new</span>();
|
||||
|
||||
<span class="comment">// setting default values</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
@@ -347,42 +351,42 @@
|
||||
<span class="kw">const</span> <span class="ident">CURRENT_DIR</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"./config/default.toml"</span>;
|
||||
<span class="kw">const</span> <span class="ident">ETC</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"/etc/mcaptcha/config.toml"</span>;
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">path</span>) <span class="op">=</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">"MCAPTCHA_CONFIG"</span>) {
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File</span>::<span class="ident">with_name</span>(<span class="kw-2">&</span><span class="ident">path</span>))<span class="question-mark">?</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="ident">CURRENT_DIR</span>).<span class="ident">exists</span>() {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">path</span>) <span class="op">=</span> <span class="ident">env::var</span>(<span class="string">"MCAPTCHA_CONFIG"</span>) {
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File::with_name</span>(<span class="kw-2">&</span><span class="ident">path</span>))<span class="question-mark">?</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">Path::new</span>(<span class="ident">CURRENT_DIR</span>).<span class="ident">exists</span>() {
|
||||
<span class="comment">// merging default config from file</span>
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File</span>::<span class="ident">with_name</span>(<span class="ident">CURRENT_DIR</span>))<span class="question-mark">?</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="ident">ETC</span>).<span class="ident">exists</span>() {
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File</span>::<span class="ident">with_name</span>(<span class="ident">ETC</span>))<span class="question-mark">?</span>;
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File::with_name</span>(<span class="ident">CURRENT_DIR</span>))<span class="question-mark">?</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">Path::new</span>(<span class="ident">ETC</span>).<span class="ident">exists</span>() {
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">File::with_name</span>(<span class="ident">ETC</span>))<span class="question-mark">?</span>;
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">log</span>::<span class="macro">warn</span><span class="macro">!</span>(<span class="string">"configuration file not found"</span>);
|
||||
<span class="macro">log::warn!</span>(<span class="string">"configuration file not found"</span>);
|
||||
}
|
||||
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">Environment</span>::<span class="ident">with_prefix</span>(<span class="string">"MCAPTCHA"</span>).<span class="ident">separator</span>(<span class="string">"_"</span>))<span class="question-mark">?</span>;
|
||||
<span class="ident">s</span>.<span class="ident">merge</span>(<span class="ident">Environment::with_prefix</span>(<span class="string">"MCAPTCHA"</span>).<span class="ident">separator</span>(<span class="string">"_"</span>))<span class="question-mark">?</span>;
|
||||
|
||||
<span class="ident">check_url</span>(<span class="kw-2">&</span><span class="ident">s</span>);
|
||||
|
||||
<span class="kw">match</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">"PORT"</span>) {
|
||||
<span class="kw">match</span> <span class="ident">env::var</span>(<span class="string">"PORT"</span>) {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="ident">s</span>.<span class="ident">set</span>(<span class="string">"server.port"</span>, <span class="ident">val</span>).<span class="ident">unwrap</span>();
|
||||
}
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"couldn't interpret PORT: {}"</span>, <span class="ident">e</span>),
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="macro">println!</span>(<span class="string">"couldn't interpret PORT: {}"</span>, <span class="ident">e</span>),
|
||||
}
|
||||
|
||||
<span class="kw">match</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">"DATABASE_URL"</span>) {
|
||||
<span class="kw">match</span> <span class="ident">env::var</span>(<span class="string">"DATABASE_URL"</span>) {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">url</span> <span class="op">=</span> <span class="ident">Url</span>::<span class="ident">parse</span>(<span class="kw-2">&</span><span class="ident">val</span>).<span class="ident">expect</span>(<span class="string">"couldn't parse Database URL"</span>);
|
||||
<span class="kw">let</span> <span class="ident">database_conf</span> <span class="op">=</span> <span class="ident">DatabaseBuilder</span>::<span class="ident">extract_database_url</span>(<span class="kw-2">&</span><span class="ident">url</span>);
|
||||
<span class="kw">let</span> <span class="ident">url</span> <span class="op">=</span> <span class="ident">Url::parse</span>(<span class="kw-2">&</span><span class="ident">val</span>).<span class="ident">expect</span>(<span class="string">"couldn't parse Database URL"</span>);
|
||||
<span class="kw">let</span> <span class="ident">database_conf</span> <span class="op">=</span> <span class="ident">DatabaseBuilder::extract_database_url</span>(<span class="kw-2">&</span><span class="ident">url</span>);
|
||||
<span class="ident">set_from_database_url</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">s</span>, <span class="kw-2">&</span><span class="ident">database_conf</span>);
|
||||
}
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"couldn't interpret DATABASE_URL: {}"</span>, <span class="ident">e</span>),
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="macro">println!</span>(<span class="string">"couldn't interpret DATABASE_URL: {}"</span>, <span class="ident">e</span>),
|
||||
}
|
||||
|
||||
<span class="ident">set_database_url</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">s</span>);
|
||||
|
||||
<span class="kw">match</span> <span class="ident">s</span>.<span class="ident">try_into</span>() {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">val</span>),
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">ConfigError</span>::<span class="ident">Message</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"\n\nError: {}. If it says missing fields, then please refer to https://github.com/mCaptcha/mcaptcha#configuration to learn more about how mcaptcha reads configuration\n\n"</span>, <span class="ident">e</span>))),
|
||||
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">ConfigError::Message</span>(<span class="macro">format!</span>(<span class="string">"\n\nError: {}. If it says missing fields, then please refer to https://github.com/mCaptcha/mcaptcha#configuration to learn more about how mcaptcha reads configuration\n\n"</span>, <span class="ident">e</span>))),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -393,7 +397,7 @@
|
||||
.<span class="ident">get</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"source_code"</span>)
|
||||
.<span class="ident">expect</span>(<span class="string">"Couldn't access source_code"</span>);
|
||||
|
||||
<span class="ident">Url</span>::<span class="ident">parse</span>(<span class="kw-2">&</span><span class="ident">url</span>).<span class="ident">expect</span>(<span class="string">"Please enter a URL for source_code in settings"</span>);
|
||||
<span class="ident">Url::parse</span>(<span class="kw-2">&</span><span class="ident">url</span>).<span class="ident">expect</span>(<span class="string">"Please enter a URL for source_code in settings"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
|
||||
@@ -414,7 +418,7 @@
|
||||
<span class="kw">fn</span> <span class="ident">set_database_url</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Config</span>) {
|
||||
<span class="ident">s</span>.<span class="ident">set</span>(
|
||||
<span class="string">"database.url"</span>,
|
||||
<span class="macro">format</span><span class="macro">!</span>(
|
||||
<span class="macro">format!</span>(
|
||||
<span class="string">r"postgres://{}:{}@{}:{}/{}"</span>,
|
||||
<span class="ident">s</span>.<span class="ident">get</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"database.username"</span>)
|
||||
.<span class="ident">expect</span>(<span class="string">"Couldn't access database username"</span>),
|
||||
@@ -455,5 +459,5 @@
|
||||
<span class="comment">// }</span>
|
||||
<span class="comment">//}</span>
|
||||
</pre></div>
|
||||
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha"></div>
|
||||
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mcaptcha" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
|
||||
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
|
||||
Reference in New Issue
Block a user