mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-11 18:15:39 +00:00
Deploying to gh-pages from @ 9ed458ebfa 🚀
This commit is contained in:
realaravinth
@@ -158,6 +158,41 @@
|
||||
<span id="155">155</span>
|
||||
<span id="156">156</span>
|
||||
<span id="157">157</span>
|
||||
<span id="158">158</span>
|
||||
<span id="159">159</span>
|
||||
<span id="160">160</span>
|
||||
<span id="161">161</span>
|
||||
<span id="162">162</span>
|
||||
<span id="163">163</span>
|
||||
<span id="164">164</span>
|
||||
<span id="165">165</span>
|
||||
<span id="166">166</span>
|
||||
<span id="167">167</span>
|
||||
<span id="168">168</span>
|
||||
<span id="169">169</span>
|
||||
<span id="170">170</span>
|
||||
<span id="171">171</span>
|
||||
<span id="172">172</span>
|
||||
<span id="173">173</span>
|
||||
<span id="174">174</span>
|
||||
<span id="175">175</span>
|
||||
<span id="176">176</span>
|
||||
<span id="177">177</span>
|
||||
<span id="178">178</span>
|
||||
<span id="179">179</span>
|
||||
<span id="180">180</span>
|
||||
<span id="181">181</span>
|
||||
<span id="182">182</span>
|
||||
<span id="183">183</span>
|
||||
<span id="184">184</span>
|
||||
<span id="185">185</span>
|
||||
<span id="186">186</span>
|
||||
<span id="187">187</span>
|
||||
<span id="188">188</span>
|
||||
<span id="189">189</span>
|
||||
<span id="190">190</span>
|
||||
<span id="191">191</span>
|
||||
<span id="192">192</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="comment">/*
|
||||
* Copyright (C) 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
@@ -175,10 +210,14 @@
|
||||
* 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="doccomment">//! App data: redis cache, database connections, etc.</span>
|
||||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident">argon2_creds</span>::{<span class="ident">Config</span>, <span class="ident">ConfigBuilder</span>, <span class="ident">PasswordPolicy</span>};
|
||||
<span class="kw">use</span> <span class="ident">lettre</span>::{
|
||||
<span class="ident">transport</span>::<span class="ident">smtp</span>::<span class="ident">authentication</span>::<span class="ident">Credentials</span>, <span class="ident">AsyncSmtpTransport</span>, <span class="ident">Tokio1Executor</span>,
|
||||
};
|
||||
<span class="kw">use</span> <span class="ident">libmcaptcha</span>::<span class="ident">cache</span>::<span class="ident">hashcache</span>::<span class="ident">HashCache</span>;
|
||||
<span class="kw">use</span> <span class="ident">libmcaptcha</span>::<span class="ident">cache</span>::<span class="ident">redis</span>::<span class="ident">RedisCache</span>;
|
||||
<span class="kw">use</span> <span class="ident">libmcaptcha</span>::<span class="ident">master</span>::<span class="ident">redis</span>::<span class="ident">master</span>::<span class="ident">Master</span> <span class="kw">as</span> <span class="ident">RedisMaster</span>;
|
||||
@@ -200,12 +239,9 @@
|
||||
|
||||
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">SETTINGS</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Data</span> {
|
||||
<span class="kw">pub</span> <span class="ident">db</span>: <span class="ident">PgPool</span>,
|
||||
<span class="kw">pub</span> <span class="ident">creds</span>: <span class="ident">Config</span>,
|
||||
<span class="kw">pub</span> <span class="ident">captcha</span>: <span class="ident">SystemGroup</span>,
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Represents mCaptcha cache and master system.</span>
|
||||
<span class="doccomment">/// When Redis is configured, [SystemGroup::Redis] is used and</span>
|
||||
<span class="doccomment">/// in its absense, [SystemGroup::Embedded] is used</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">SystemGroup</span> {
|
||||
<span class="ident">Embedded</span>(<span class="ident">System</span><span class="op"><</span><span class="ident">HashCache</span>, <span class="ident">EmbeddedMaster</span><span class="op">></span>),
|
||||
<span class="ident">Redis</span>(<span class="ident">System</span><span class="op"><</span><span class="ident">RedisCache</span>, <span class="ident">RedisMaster</span><span class="op">></span>),
|
||||
@@ -239,21 +275,70 @@
|
||||
}
|
||||
}
|
||||
|
||||
<span class="comment">// /// utility function to AddSite</span>
|
||||
<span class="comment">// pub async fn add_site(</span>
|
||||
<span class="comment">// &self,</span>
|
||||
<span class="comment">// msg: AddSite,</span>
|
||||
<span class="comment">// ) -> CaptchaResult<()> {</span>
|
||||
<span class="comment">// match self {</span>
|
||||
<span class="comment">// Self::Embedded(val) => val.master.send(msg).await?,</span>
|
||||
<span class="comment">// Self::Redis(val) => val.master.send(msg).await?,</span>
|
||||
<span class="comment">// };</span>
|
||||
<span class="comment">// Ok(())</span>
|
||||
<span class="comment">// }</span>
|
||||
<span class="comment">// /// utility function to AddSite</span>
|
||||
<span class="comment">// pub async fn add_site(</span>
|
||||
<span class="comment">// &self,</span>
|
||||
<span class="comment">// msg: AddSite,</span>
|
||||
<span class="comment">// ) -> CaptchaResult<()> {</span>
|
||||
<span class="comment">// match self {</span>
|
||||
<span class="comment">// Self::Embedded(val) => val.master.send(msg).await?,</span>
|
||||
<span class="comment">// Self::Redis(val) => val.master.send(msg).await?,</span>
|
||||
<span class="comment">// };</span>
|
||||
<span class="comment">// Ok(())</span>
|
||||
<span class="comment">// }</span>
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">new_system</span><span class="op"><</span><span class="ident">A</span>: <span class="ident">Save</span>, <span class="ident">B</span>: <span class="ident">MasterTrait</span><span class="op">></span>(<span class="ident">m</span>: <span class="ident">Addr</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>, <span class="ident">c</span>: <span class="ident">Addr</span><span class="op"><</span><span class="ident">A</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">System</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">B</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">pow</span> <span class="op">=</span> <span class="ident">PoWConfigBuilder</span>::<span class="ident">default</span>()
|
||||
.<span class="ident">salt</span>(<span class="ident">SETTINGS</span>.<span class="ident">pow</span>.<span class="ident">salt</span>.<span class="ident">clone</span>())
|
||||
.<span class="ident">build</span>()
|
||||
.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="ident">SystemBuilder</span>::<span class="ident">default</span>().<span class="ident">pow</span>(<span class="ident">pow</span>).<span class="ident">cache</span>(<span class="ident">c</span>).<span class="ident">master</span>(<span class="ident">m</span>).<span class="ident">build</span>()
|
||||
}
|
||||
|
||||
<span class="comment">// read settings, if Redis is configured then produce a Redis mCaptcha cache</span>
|
||||
<span class="comment">// based SystemGroup</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
|
||||
<span class="kw">match</span> <span class="kw-2">&</span><span class="ident">SETTINGS</span>.<span class="ident">redis</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">master</span> <span class="op">=</span> <span class="ident">RedisMaster</span>::<span class="ident">new</span>(<span class="ident">RedisConfig</span>::<span class="ident">Single</span>(<span class="ident">val</span>.<span class="ident">url</span>.<span class="ident">clone</span>()))
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">cache</span> <span class="op">=</span> <span class="ident">RedisCache</span>::<span class="ident">new</span>(<span class="ident">RedisConfig</span>::<span class="ident">Single</span>(<span class="ident">val</span>.<span class="ident">url</span>.<span class="ident">clone</span>()))
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">captcha</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">new_system</span>(<span class="ident">master</span>, <span class="ident">cache</span>);
|
||||
|
||||
<span class="ident">SystemGroup</span>::<span class="ident">Redis</span>(<span class="ident">captcha</span>)
|
||||
}
|
||||
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">master</span> <span class="op">=</span> <span class="ident">EmbeddedMaster</span>::<span class="ident">new</span>(<span class="ident">SETTINGS</span>.<span class="ident">pow</span>.<span class="ident">gc</span>).<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">cache</span> <span class="op">=</span> <span class="ident">HashCache</span>::<span class="ident">default</span>().<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">captcha</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">new_system</span>(<span class="ident">master</span>, <span class="ident">cache</span>);
|
||||
|
||||
<span class="ident">SystemGroup</span>::<span class="ident">Embedded</span>(<span class="ident">captcha</span>)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// App data</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Data</span> {
|
||||
<span class="doccomment">/// databse pool</span>
|
||||
<span class="kw">pub</span> <span class="ident">db</span>: <span class="ident">PgPool</span>,
|
||||
<span class="doccomment">/// credential management configuration</span>
|
||||
<span class="kw">pub</span> <span class="ident">creds</span>: <span class="ident">Config</span>,
|
||||
<span class="doccomment">/// mCaptcha system: Redis cache, etc.</span>
|
||||
<span class="kw">pub</span> <span class="ident">captcha</span>: <span class="ident">SystemGroup</span>,
|
||||
<span class="doccomment">/// email client</span>
|
||||
<span class="kw">pub</span> <span class="ident">mailer</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Mailer</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Data</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">tarpaulin_include</span>))]</span>
|
||||
<span class="doccomment">/// create new instance of app data</span>
|
||||
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">Arc</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">db</span> <span class="op">=</span> <span class="ident">PgPoolOptions</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">max_connections</span>(<span class="ident">SETTINGS</span>.<span class="ident">database</span>.<span class="ident">pool</span>)
|
||||
@@ -273,49 +358,34 @@
|
||||
<span class="ident">creds</span>.<span class="ident">init</span>();
|
||||
<span class="ident">log</span>::<span class="macro">info</span><span class="macro">!</span>(<span class="string">"Initialized credential manager"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="kw">match</span> <span class="kw-2">&</span><span class="ident">SETTINGS</span>.<span class="ident">redis</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">val</span>) <span class="op">=</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">master</span> <span class="op">=</span> <span class="ident">RedisMaster</span>::<span class="ident">new</span>(<span class="ident">RedisConfig</span>::<span class="ident">Single</span>(<span class="ident">val</span>.<span class="ident">url</span>.<span class="ident">clone</span>()))
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">cache</span> <span class="op">=</span> <span class="ident">RedisCache</span>::<span class="ident">new</span>(<span class="ident">RedisConfig</span>::<span class="ident">Single</span>(<span class="ident">val</span>.<span class="ident">url</span>.<span class="ident">clone</span>()))
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">captcha</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">new_system</span>(<span class="ident">master</span>, <span class="ident">cache</span>);
|
||||
|
||||
<span class="ident">Data</span> {
|
||||
<span class="ident">creds</span>,
|
||||
<span class="ident">db</span>,
|
||||
<span class="ident">captcha</span>: <span class="ident">SystemGroup</span>::<span class="ident">Redis</span>(<span class="ident">captcha</span>),
|
||||
}
|
||||
}
|
||||
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">master</span> <span class="op">=</span> <span class="ident">EmbeddedMaster</span>::<span class="ident">new</span>(<span class="ident">SETTINGS</span>.<span class="ident">pow</span>.<span class="ident">gc</span>).<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">cache</span> <span class="op">=</span> <span class="ident">HashCache</span>::<span class="ident">default</span>().<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">captcha</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">new_system</span>(<span class="ident">master</span>, <span class="ident">cache</span>);
|
||||
|
||||
<span class="ident">Data</span> {
|
||||
<span class="ident">creds</span>,
|
||||
<span class="ident">db</span>,
|
||||
<span class="ident">captcha</span>: <span class="ident">SystemGroup</span>::<span class="ident">Embedded</span>(<span class="ident">captcha</span>),
|
||||
}
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">Data</span> {
|
||||
<span class="ident">creds</span>,
|
||||
<span class="ident">db</span>,
|
||||
<span class="ident">captcha</span>: <span class="ident">SystemGroup</span>::<span class="ident">new</span>().<span class="kw">await</span>,
|
||||
<span class="ident">mailer</span>: <span class="self">Self</span>::<span class="ident">get_mailer</span>(),
|
||||
};
|
||||
|
||||
<span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">data</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">new_system</span><span class="op"><</span><span class="ident">A</span>: <span class="ident">Save</span>, <span class="ident">B</span>: <span class="ident">MasterTrait</span><span class="op">></span>(<span class="ident">m</span>: <span class="ident">Addr</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>, <span class="ident">c</span>: <span class="ident">Addr</span><span class="op"><</span><span class="ident">A</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">System</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">B</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">pow</span> <span class="op">=</span> <span class="ident">PoWConfigBuilder</span>::<span class="ident">default</span>()
|
||||
.<span class="ident">salt</span>(<span class="ident">SETTINGS</span>.<span class="ident">pow</span>.<span class="ident">salt</span>.<span class="ident">clone</span>())
|
||||
.<span class="ident">build</span>()
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="kw">fn</span> <span class="ident">get_mailer</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Mailer</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">smtp</span>) <span class="op">=</span> <span class="ident">SETTINGS</span>.<span class="ident">smtp</span>.<span class="ident">as_ref</span>() {
|
||||
<span class="kw">let</span> <span class="ident">creds</span> <span class="op">=</span>
|
||||
<span class="ident">Credentials</span>::<span class="ident">new</span>(<span class="ident">smtp</span>.<span class="ident">username</span>.<span class="ident">to_string</span>(), <span class="ident">smtp</span>.<span class="ident">password</span>.<span class="ident">to_string</span>()); <span class="comment">// "smtp_username".to_string(), "smtp_password".to_string());</span>
|
||||
|
||||
<span class="ident">SystemBuilder</span>::<span class="ident">default</span>().<span class="ident">pow</span>(<span class="ident">pow</span>).<span class="ident">cache</span>(<span class="ident">c</span>).<span class="ident">master</span>(<span class="ident">m</span>).<span class="ident">build</span>()
|
||||
<span class="kw">let</span> <span class="ident">mailer</span>: <span class="ident">Mailer</span> <span class="op">=</span> <span class="ident">AsyncSmtpTransport</span>::<span class="op"><</span><span class="ident">Tokio1Executor</span><span class="op">></span>::<span class="ident">relay</span>(<span class="kw-2">&</span><span class="ident">smtp</span>.<span class="ident">url</span>) <span class="comment">//"smtp.gmail.com")</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">credentials</span>(<span class="ident">creds</span>)
|
||||
.<span class="ident">build</span>();
|
||||
<span class="prelude-val">Some</span>(<span class="ident">mailer</span>)
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">None</span>
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Mailer data type AsyncSmtpTransport<Tokio1Executor></span>
|
||||
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">Mailer</span> <span class="op">=</span> <span class="ident">AsyncSmtpTransport</span><span class="op"><</span><span class="ident">Tokio1Executor</span><span class="op">></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="tests_migrate"></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>
|
||||
Reference in New Issue
Block a user