mirror of
https://github.com/mCaptcha/mCaptcha.git
synced 2026-02-11 18:15:39 +00:00
Deploying to gh-pages from @ 3710c8f653 🚀
This commit is contained in:
realaravinth
130
src/db_core/errors.rs.html
Normal file
130
src/db_core/errors.rs.html
Normal file
@@ -0,0 +1,130 @@
|
||||
<!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 `db/db-core/src/errors.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>errors.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
|
||||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a><h2 class="location"></h2>
|
||||
</nav>
|
||||
<nav class="sidebar"><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
<span id="15">15</span>
|
||||
<span id="16">16</span>
|
||||
<span id="17">17</span>
|
||||
<span id="18">18</span>
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
<span id="28">28</span>
|
||||
<span id="29">29</span>
|
||||
<span id="30">30</span>
|
||||
<span id="31">31</span>
|
||||
<span id="32">32</span>
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
<span id="51">51</span>
|
||||
<span id="52">52</span>
|
||||
<span id="53">53</span>
|
||||
<span id="54">54</span>
|
||||
<span id="55">55</span>
|
||||
<span id="56">56</span>
|
||||
<span id="57">57</span>
|
||||
<span id="58">58</span>
|
||||
<span id="59">59</span>
|
||||
<span id="60">60</span>
|
||||
<span id="61">61</span>
|
||||
</pre><pre class="rust"><code><span class="comment">/*
|
||||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* 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">//! represents all the ways a trait can fail using this crate</span>
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span> <span class="kw">as</span> <span class="ident">StdError</span>;
|
||||
|
||||
<span class="comment">//use derive_more::{error, Error as DeriveError};</span>
|
||||
<span class="kw">use</span> <span class="ident">thiserror::Error</span>;
|
||||
|
||||
<span class="doccomment">/// Error data structure grouping various error subtypes</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Error</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">DBError</span> {
|
||||
<span class="doccomment">/// errors that are specific to a database implementation</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"{0}"</span>)]</span>
|
||||
<span class="ident">DBError</span>(<span class="attribute">#[<span class="ident">source</span>]</span> <span class="ident">BoxDynError</span>),
|
||||
<span class="doccomment">/// Username is taken</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Username is taken"</span>)]</span>
|
||||
<span class="ident">UsernameTaken</span>,
|
||||
<span class="doccomment">/// Email is taken</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Email is taken"</span>)]</span>
|
||||
<span class="ident">EmailTaken</span>,
|
||||
<span class="doccomment">/// Secret is taken</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Secret is taken"</span>)]</span>
|
||||
<span class="ident">SecretTaken</span>,
|
||||
<span class="doccomment">/// Captcha key is taken</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Captcha key is taken"</span>)]</span>
|
||||
<span class="ident">CaptchaKeyTaken</span>,
|
||||
<span class="doccomment">/// Account not found</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Account not found"</span>)]</span>
|
||||
<span class="ident">AccountNotFound</span>,
|
||||
|
||||
<span class="doccomment">/// Captcha not found</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Captcha not found"</span>)]</span>
|
||||
<span class="ident">CaptchaNotFound</span>,
|
||||
<span class="doccomment">/// Traffic pattern not found</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Traffic pattern not found"</span>)]</span>
|
||||
<span class="ident">TrafficPatternNotFound</span>,
|
||||
|
||||
<span class="doccomment">/// Notification not found</span>
|
||||
<span class="attribute">#[<span class="ident">error</span>(<span class="string">"Notification not found"</span>)]</span>
|
||||
<span class="ident">NotificationNotFound</span>,
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Convenience type alias for grouping driver-specific errors</span>
|
||||
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">BoxDynError</span> <span class="op">=</span> <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">StdError</span> <span class="op">+</span> <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Generic result data structure</span>
|
||||
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">V</span><span class="op">></span> <span class="op">=</span> <span class="ident">std::result::Result</span><span class="op"><</span><span class="ident">V</span>, <span class="ident">DBError</span><span class="op">></span>;
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||||
</body></html>
|
||||
712
src/db_core/lib.rs.html
Normal file
712
src/db_core/lib.rs.html
Normal file
@@ -0,0 +1,712 @@
|
||||
<!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 `db/db-core/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
|
||||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a><h2 class="location"></h2>
|
||||
</nav>
|
||||
<nav class="sidebar"><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
<span id="15">15</span>
|
||||
<span id="16">16</span>
|
||||
<span id="17">17</span>
|
||||
<span id="18">18</span>
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
<span id="28">28</span>
|
||||
<span id="29">29</span>
|
||||
<span id="30">30</span>
|
||||
<span id="31">31</span>
|
||||
<span id="32">32</span>
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
<span id="51">51</span>
|
||||
<span id="52">52</span>
|
||||
<span id="53">53</span>
|
||||
<span id="54">54</span>
|
||||
<span id="55">55</span>
|
||||
<span id="56">56</span>
|
||||
<span id="57">57</span>
|
||||
<span id="58">58</span>
|
||||
<span id="59">59</span>
|
||||
<span id="60">60</span>
|
||||
<span id="61">61</span>
|
||||
<span id="62">62</span>
|
||||
<span id="63">63</span>
|
||||
<span id="64">64</span>
|
||||
<span id="65">65</span>
|
||||
<span id="66">66</span>
|
||||
<span id="67">67</span>
|
||||
<span id="68">68</span>
|
||||
<span id="69">69</span>
|
||||
<span id="70">70</span>
|
||||
<span id="71">71</span>
|
||||
<span id="72">72</span>
|
||||
<span id="73">73</span>
|
||||
<span id="74">74</span>
|
||||
<span id="75">75</span>
|
||||
<span id="76">76</span>
|
||||
<span id="77">77</span>
|
||||
<span id="78">78</span>
|
||||
<span id="79">79</span>
|
||||
<span id="80">80</span>
|
||||
<span id="81">81</span>
|
||||
<span id="82">82</span>
|
||||
<span id="83">83</span>
|
||||
<span id="84">84</span>
|
||||
<span id="85">85</span>
|
||||
<span id="86">86</span>
|
||||
<span id="87">87</span>
|
||||
<span id="88">88</span>
|
||||
<span id="89">89</span>
|
||||
<span id="90">90</span>
|
||||
<span id="91">91</span>
|
||||
<span id="92">92</span>
|
||||
<span id="93">93</span>
|
||||
<span id="94">94</span>
|
||||
<span id="95">95</span>
|
||||
<span id="96">96</span>
|
||||
<span id="97">97</span>
|
||||
<span id="98">98</span>
|
||||
<span id="99">99</span>
|
||||
<span id="100">100</span>
|
||||
<span id="101">101</span>
|
||||
<span id="102">102</span>
|
||||
<span id="103">103</span>
|
||||
<span id="104">104</span>
|
||||
<span id="105">105</span>
|
||||
<span id="106">106</span>
|
||||
<span id="107">107</span>
|
||||
<span id="108">108</span>
|
||||
<span id="109">109</span>
|
||||
<span id="110">110</span>
|
||||
<span id="111">111</span>
|
||||
<span id="112">112</span>
|
||||
<span id="113">113</span>
|
||||
<span id="114">114</span>
|
||||
<span id="115">115</span>
|
||||
<span id="116">116</span>
|
||||
<span id="117">117</span>
|
||||
<span id="118">118</span>
|
||||
<span id="119">119</span>
|
||||
<span id="120">120</span>
|
||||
<span id="121">121</span>
|
||||
<span id="122">122</span>
|
||||
<span id="123">123</span>
|
||||
<span id="124">124</span>
|
||||
<span id="125">125</span>
|
||||
<span id="126">126</span>
|
||||
<span id="127">127</span>
|
||||
<span id="128">128</span>
|
||||
<span id="129">129</span>
|
||||
<span id="130">130</span>
|
||||
<span id="131">131</span>
|
||||
<span id="132">132</span>
|
||||
<span id="133">133</span>
|
||||
<span id="134">134</span>
|
||||
<span id="135">135</span>
|
||||
<span id="136">136</span>
|
||||
<span id="137">137</span>
|
||||
<span id="138">138</span>
|
||||
<span id="139">139</span>
|
||||
<span id="140">140</span>
|
||||
<span id="141">141</span>
|
||||
<span id="142">142</span>
|
||||
<span id="143">143</span>
|
||||
<span id="144">144</span>
|
||||
<span id="145">145</span>
|
||||
<span id="146">146</span>
|
||||
<span id="147">147</span>
|
||||
<span id="148">148</span>
|
||||
<span id="149">149</span>
|
||||
<span id="150">150</span>
|
||||
<span id="151">151</span>
|
||||
<span id="152">152</span>
|
||||
<span id="153">153</span>
|
||||
<span id="154">154</span>
|
||||
<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>
|
||||
<span id="193">193</span>
|
||||
<span id="194">194</span>
|
||||
<span id="195">195</span>
|
||||
<span id="196">196</span>
|
||||
<span id="197">197</span>
|
||||
<span id="198">198</span>
|
||||
<span id="199">199</span>
|
||||
<span id="200">200</span>
|
||||
<span id="201">201</span>
|
||||
<span id="202">202</span>
|
||||
<span id="203">203</span>
|
||||
<span id="204">204</span>
|
||||
<span id="205">205</span>
|
||||
<span id="206">206</span>
|
||||
<span id="207">207</span>
|
||||
<span id="208">208</span>
|
||||
<span id="209">209</span>
|
||||
<span id="210">210</span>
|
||||
<span id="211">211</span>
|
||||
<span id="212">212</span>
|
||||
<span id="213">213</span>
|
||||
<span id="214">214</span>
|
||||
<span id="215">215</span>
|
||||
<span id="216">216</span>
|
||||
<span id="217">217</span>
|
||||
<span id="218">218</span>
|
||||
<span id="219">219</span>
|
||||
<span id="220">220</span>
|
||||
<span id="221">221</span>
|
||||
<span id="222">222</span>
|
||||
<span id="223">223</span>
|
||||
<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>
|
||||
<span id="229">229</span>
|
||||
<span id="230">230</span>
|
||||
<span id="231">231</span>
|
||||
<span id="232">232</span>
|
||||
<span id="233">233</span>
|
||||
<span id="234">234</span>
|
||||
<span id="235">235</span>
|
||||
<span id="236">236</span>
|
||||
<span id="237">237</span>
|
||||
<span id="238">238</span>
|
||||
<span id="239">239</span>
|
||||
<span id="240">240</span>
|
||||
<span id="241">241</span>
|
||||
<span id="242">242</span>
|
||||
<span id="243">243</span>
|
||||
<span id="244">244</span>
|
||||
<span id="245">245</span>
|
||||
<span id="246">246</span>
|
||||
<span id="247">247</span>
|
||||
<span id="248">248</span>
|
||||
<span id="249">249</span>
|
||||
<span id="250">250</span>
|
||||
<span id="251">251</span>
|
||||
<span id="252">252</span>
|
||||
<span id="253">253</span>
|
||||
<span id="254">254</span>
|
||||
<span id="255">255</span>
|
||||
<span id="256">256</span>
|
||||
<span id="257">257</span>
|
||||
<span id="258">258</span>
|
||||
<span id="259">259</span>
|
||||
<span id="260">260</span>
|
||||
<span id="261">261</span>
|
||||
<span id="262">262</span>
|
||||
<span id="263">263</span>
|
||||
<span id="264">264</span>
|
||||
<span id="265">265</span>
|
||||
<span id="266">266</span>
|
||||
<span id="267">267</span>
|
||||
<span id="268">268</span>
|
||||
<span id="269">269</span>
|
||||
<span id="270">270</span>
|
||||
<span id="271">271</span>
|
||||
<span id="272">272</span>
|
||||
<span id="273">273</span>
|
||||
<span id="274">274</span>
|
||||
<span id="275">275</span>
|
||||
<span id="276">276</span>
|
||||
<span id="277">277</span>
|
||||
<span id="278">278</span>
|
||||
<span id="279">279</span>
|
||||
<span id="280">280</span>
|
||||
<span id="281">281</span>
|
||||
<span id="282">282</span>
|
||||
<span id="283">283</span>
|
||||
<span id="284">284</span>
|
||||
<span id="285">285</span>
|
||||
<span id="286">286</span>
|
||||
<span id="287">287</span>
|
||||
<span id="288">288</span>
|
||||
<span id="289">289</span>
|
||||
<span id="290">290</span>
|
||||
<span id="291">291</span>
|
||||
<span id="292">292</span>
|
||||
<span id="293">293</span>
|
||||
<span id="294">294</span>
|
||||
<span id="295">295</span>
|
||||
<span id="296">296</span>
|
||||
<span id="297">297</span>
|
||||
<span id="298">298</span>
|
||||
<span id="299">299</span>
|
||||
<span id="300">300</span>
|
||||
<span id="301">301</span>
|
||||
<span id="302">302</span>
|
||||
<span id="303">303</span>
|
||||
<span id="304">304</span>
|
||||
<span id="305">305</span>
|
||||
<span id="306">306</span>
|
||||
<span id="307">307</span>
|
||||
<span id="308">308</span>
|
||||
<span id="309">309</span>
|
||||
<span id="310">310</span>
|
||||
<span id="311">311</span>
|
||||
<span id="312">312</span>
|
||||
<span id="313">313</span>
|
||||
<span id="314">314</span>
|
||||
<span id="315">315</span>
|
||||
<span id="316">316</span>
|
||||
<span id="317">317</span>
|
||||
<span id="318">318</span>
|
||||
<span id="319">319</span>
|
||||
<span id="320">320</span>
|
||||
<span id="321">321</span>
|
||||
<span id="322">322</span>
|
||||
<span id="323">323</span>
|
||||
<span id="324">324</span>
|
||||
<span id="325">325</span>
|
||||
<span id="326">326</span>
|
||||
<span id="327">327</span>
|
||||
<span id="328">328</span>
|
||||
<span id="329">329</span>
|
||||
<span id="330">330</span>
|
||||
<span id="331">331</span>
|
||||
<span id="332">332</span>
|
||||
<span id="333">333</span>
|
||||
<span id="334">334</span>
|
||||
<span id="335">335</span>
|
||||
<span id="336">336</span>
|
||||
<span id="337">337</span>
|
||||
<span id="338">338</span>
|
||||
<span id="339">339</span>
|
||||
<span id="340">340</span>
|
||||
<span id="341">341</span>
|
||||
<span id="342">342</span>
|
||||
<span id="343">343</span>
|
||||
<span id="344">344</span>
|
||||
<span id="345">345</span>
|
||||
<span id="346">346</span>
|
||||
<span id="347">347</span>
|
||||
<span id="348">348</span>
|
||||
<span id="349">349</span>
|
||||
<span id="350">350</span>
|
||||
<span id="351">351</span>
|
||||
<span id="352">352</span>
|
||||
</pre><pre class="rust"><code><span class="comment">/*
|
||||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* 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="attribute">#![<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span>
|
||||
<span class="doccomment">//! # `mCaptcha` database operations</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Traits and datastructures used in mCaptcha to interact with database.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! To use an unsupported database with mCaptcha, traits present within this crate should be</span>
|
||||
<span class="doccomment">//! implemented.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Organisation</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Database functionallity is divided accross various modules:</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! - [errors](crate::auth): error data structures used in this crate</span>
|
||||
<span class="doccomment">//! - [ops](crate::ops): meta operations like connection pool creation, migrations and getting</span>
|
||||
<span class="doccomment">//! connection from pool</span>
|
||||
<span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">libmcaptcha::defense::Level</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">errors</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">ops</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"test"</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">tests</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">dev</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ops::GetConnection</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">prelude</span> {
|
||||
<span class="doccomment">//! useful imports for users working with a supported database</span>
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">super</span>::errors</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">super</span>::ops</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
}
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">dev</span> {
|
||||
<span class="doccomment">//! useful imports for supporting a new database</span>
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">super</span>::prelude</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">async_trait::async_trait</span>;
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// Data required to register a new user</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Register</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="doccomment">/// username of new user</span>
|
||||
<span class="kw">pub</span> <span class="ident">username</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// secret of new user</span>
|
||||
<span class="kw">pub</span> <span class="ident">secret</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// hashed password of new use</span>
|
||||
<span class="kw">pub</span> <span class="ident">hash</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// Optionally, email of new use</span>
|
||||
<span class="kw">pub</span> <span class="ident">email</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// data required to update them email of a user</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UpdateEmail</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="doccomment">/// username of the user</span>
|
||||
<span class="kw">pub</span> <span class="ident">username</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// new email address of the user</span>
|
||||
<span class="kw">pub</span> <span class="ident">new_email</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// types of credentials used as identifiers during login</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Login</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="doccomment">/// username as login</span>
|
||||
<span class="ident">Username</span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>),
|
||||
<span class="doccomment">/// email as login</span>
|
||||
<span class="ident">Email</span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>),
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// type encapsulating username and hashed password of a user</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">NameHash</span> {
|
||||
<span class="doccomment">/// username</span>
|
||||
<span class="kw">pub</span> <span class="ident">username</span>: <span class="ident">String</span>,
|
||||
<span class="doccomment">/// hashed password</span>
|
||||
<span class="kw">pub</span> <span class="ident">hash</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">async_trait</span>]</span>
|
||||
<span class="doccomment">/// mCaptcha's database requirements. To implement support for $Database, kindly implement this</span>
|
||||
<span class="doccomment">/// trait.</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">MCDatabase</span>: <span class="ident">std::marker::Send</span> <span class="op">+</span> <span class="ident">std::marker::Sync</span> <span class="op">+</span> <span class="ident">CloneSPDatabase</span> {
|
||||
<span class="doccomment">/// ping DB</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">ping</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span>;
|
||||
|
||||
<span class="doccomment">/// register a new user</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">register</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">Register</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// delete a user</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete_user</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// check if username exists</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">username_exists</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// get user email</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_email</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// check if email exists</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">email_exists</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">email</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update a user's email</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_email</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">UpdateEmail</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// get a user's password</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_password</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">l</span>: <span class="kw-2">&</span><span class="ident">Login</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">NameHash</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update user's password</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_password</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">NameHash</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update username</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_username</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">current</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">new</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// get a user's secret</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_secret</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Secret</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update a user's secret</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_secret</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">secret</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// create new captcha</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">create_captcha</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">CreateCaptcha</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Get captcha config</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_captcha_config</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Captcha</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Get all captchas belonging to user</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_all_user_captchas</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Captcha</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update captcha metadata; doesn't change captcha key</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_captcha_metadata</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">CreateCaptcha</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// update captcha key; doesn't change metadata</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">update_captcha_key</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">old_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">new_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Add levels to captcha</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">add_captcha_levels</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">levels</span>: <span class="kw-2">&</span>[<span class="ident">Level</span>],
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// check if captcha exists</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">captcha_exists</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Delete all levels of a captcha</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete_captcha_levels</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Delete captcha</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete_captcha</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Get captcha levels</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_captcha_levels</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Level</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Get captcha's cooldown period</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_captcha_cooldown</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Add traffic configuration</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">add_traffic_pattern</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">pattern</span>: <span class="kw-2">&</span><span class="ident">TrafficPattern</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Get traffic configuration</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_traffic_pattern</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">TrafficPattern</span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// Delete traffic configuration</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">delete_traffic_pattern</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
<span class="ident">captcha_key</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// create new notification</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">create_notification</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">AddNotification</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// get all unread notifications</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_all_unread_notifications</span>(
|
||||
<span class="kw-2">&</span><span class="self">self</span>,
|
||||
<span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||||
) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Notification</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// mark a notification read</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">mark_notification_read</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">username</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">id</span>: <span class="ident">i32</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// record PoWConfig fetches</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_fetch</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// record PoWConfig solves</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_solve</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// record PoWConfig confirms</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">record_confirm</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// featch PoWConfig fetches</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">fetch_config_fetched</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">user</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// featch PoWConfig solves</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">fetch_solve</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">user</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span><span class="op">></span>;
|
||||
|
||||
<span class="doccomment">/// featch PoWConfig confirms</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">fetch_confirm</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">user</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Default</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// Captcha statistics with time recorded in UNIX epoch formats</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">StatsUnixTimestamp</span> {
|
||||
<span class="doccomment">/// times at which the configuration were fetched</span>
|
||||
<span class="kw">pub</span> <span class="ident">config_fetches</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span>,
|
||||
<span class="doccomment">/// times at which the PoW was solved</span>
|
||||
<span class="kw">pub</span> <span class="ident">solves</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span>,
|
||||
<span class="doccomment">/// times at which the PoW token was verified</span>
|
||||
<span class="kw">pub</span> <span class="ident">confirms</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Default</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="doccomment">/// Represents notification</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Notification</span> {
|
||||
<span class="doccomment">/// receiver name of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">name</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||||
<span class="doccomment">/// heading of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">heading</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||||
<span class="doccomment">/// message of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">message</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||||
<span class="doccomment">/// when notification was received</span>
|
||||
<span class="kw">pub</span> <span class="ident">received</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span>,
|
||||
<span class="doccomment">/// db assigned ID of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">id</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Default</span>, <span class="ident">PartialEq</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
|
||||
<span class="doccomment">/// Data required to add notification</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AddNotification</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="doccomment">/// who is the notification addressed to?</span>
|
||||
<span class="kw">pub</span> <span class="ident">to</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// notification sender</span>
|
||||
<span class="kw">pub</span> <span class="ident">from</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// heading of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">heading</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// mesage of the notification</span>
|
||||
<span class="kw">pub</span> <span class="ident">message</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">PartialEq</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="doccomment">/// User's traffic pattern; used in generating a captcha configuration</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TrafficPattern</span> {
|
||||
<span class="doccomment">/// average traffic of user's website</span>
|
||||
<span class="kw">pub</span> <span class="ident">avg_traffic</span>: <span class="ident">u32</span>,
|
||||
<span class="doccomment">/// the peak traffic that the user's website can handle</span>
|
||||
<span class="kw">pub</span> <span class="ident">peak_sustainable_traffic</span>: <span class="ident">u32</span>,
|
||||
<span class="doccomment">/// trafic that bought the user's website down; optional</span>
|
||||
<span class="kw">pub</span> <span class="ident">broke_my_site_traffic</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">PartialEq</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>)]</span>
|
||||
<span class="doccomment">/// data requried to create new captcha</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">CreateCaptcha</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="doccomment">/// cool down duration</span>
|
||||
<span class="kw">pub</span> <span class="ident">duration</span>: <span class="ident">i32</span>,
|
||||
<span class="doccomment">/// description of the captcha</span>
|
||||
<span class="kw">pub</span> <span class="ident">description</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
<span class="doccomment">/// secret key of the captcha</span>
|
||||
<span class="kw">pub</span> <span class="ident">key</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">PartialEq</span>, <span class="ident">Deserialize</span>, <span class="ident">Serialize</span>)]</span>
|
||||
<span class="doccomment">/// Data representing a captcha</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Captcha</span> {
|
||||
<span class="doccomment">/// Database assigned ID</span>
|
||||
<span class="kw">pub</span> <span class="ident">config_id</span>: <span class="ident">i32</span>,
|
||||
<span class="doccomment">/// cool down duration</span>
|
||||
<span class="kw">pub</span> <span class="ident">duration</span>: <span class="ident">i32</span>,
|
||||
<span class="doccomment">/// description of the captcha</span>
|
||||
<span class="kw">pub</span> <span class="ident">description</span>: <span class="ident">String</span>,
|
||||
<span class="doccomment">/// secret key of the captcha</span>
|
||||
<span class="kw">pub</span> <span class="ident">key</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">PartialEq</span>, <span class="ident">Default</span>, <span class="ident">Serialize</span>)]</span>
|
||||
<span class="doccomment">/// datastructure representing a user's secret</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Secret</span> {
|
||||
<span class="doccomment">/// user's secret</span>
|
||||
<span class="kw">pub</span> <span class="ident">secret</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Trait to clone MCDatabase</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">CloneSPDatabase</span> {
|
||||
<span class="doccomment">/// clone DB</span>
|
||||
<span class="kw">fn</span> <span class="ident">clone_db</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">MCDatabase</span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">CloneSPDatabase</span> <span class="kw">for</span> <span class="ident">T</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">MCDatabase</span> <span class="op">+</span> <span class="ident">Clone</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">fn</span> <span class="ident">clone_db</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">MCDatabase</span><span class="op">></span> {
|
||||
<span class="ident">Box::new</span>(<span class="self">self</span>.<span class="ident">clone</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">MCDatabase</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self</span> {
|
||||
(<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">clone_db</span>()
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||||
</body></html>
|
||||
106
src/db_core/ops.rs.html
Normal file
106
src/db_core/ops.rs.html
Normal file
@@ -0,0 +1,106 @@
|
||||
<!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 `db/db-core/src/ops.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ops.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
|
||||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a><h2 class="location"></h2>
|
||||
</nav>
|
||||
<nav class="sidebar"><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
<span id="15">15</span>
|
||||
<span id="16">16</span>
|
||||
<span id="17">17</span>
|
||||
<span id="18">18</span>
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
<span id="28">28</span>
|
||||
<span id="29">29</span>
|
||||
<span id="30">30</span>
|
||||
<span id="31">31</span>
|
||||
<span id="32">32</span>
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
</pre><pre class="rust"><code><span class="comment">/*
|
||||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* 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">//! meta operations like migration and connecting to a database</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::dev</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="doccomment">/// Database operations trait(migrations, pool creation and fetching connection from pool)</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">DBOps</span>: <span class="ident">GetConnection</span> <span class="op">+</span> <span class="ident">Migrate</span> {}
|
||||
|
||||
<span class="doccomment">/// Get database connection</span>
|
||||
<span class="attribute">#[<span class="ident">async_trait</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">GetConnection</span> {
|
||||
<span class="doccomment">/// database connection type</span>
|
||||
<span class="kw">type</span> <span class="ident">Conn</span>;
|
||||
<span class="doccomment">/// database specific error-type</span>
|
||||
<span class="doccomment">/// get connection from connection pool</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">get_conn</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Conn</span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Create databse connection</span>
|
||||
<span class="attribute">#[<span class="ident">async_trait</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Connect</span> {
|
||||
<span class="doccomment">/// database specific pool-type</span>
|
||||
<span class="kw">type</span> <span class="ident">Pool</span>: <span class="ident">MCDatabase</span>;
|
||||
<span class="doccomment">/// database specific error-type</span>
|
||||
<span class="doccomment">/// create connection pool</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">connect</span>(<span class="self">self</span>) -> <span class="ident">DBResult</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Pool</span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="doccomment">/// database migrations</span>
|
||||
<span class="attribute">#[<span class="ident">async_trait</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Migrate</span>: <span class="ident">MCDatabase</span> {
|
||||
<span class="doccomment">/// database specific error-type</span>
|
||||
<span class="doccomment">/// run migrations</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">migrate</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">DBResult</span><span class="op"><</span>()<span class="op">></span>;
|
||||
}
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||||
</body></html>
|
||||
576
src/db_core/tests.rs.html
Normal file
576
src/db_core/tests.rs.html
Normal file
@@ -0,0 +1,576 @@
|
||||
<!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 `db/db-core/src/tests.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>tests.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
|
||||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a><h2 class="location"></h2>
|
||||
</nav>
|
||||
<nav class="sidebar"><a class="sidebar-logo" href="../../db_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
|
||||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../db_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
<span id="15">15</span>
|
||||
<span id="16">16</span>
|
||||
<span id="17">17</span>
|
||||
<span id="18">18</span>
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
<span id="28">28</span>
|
||||
<span id="29">29</span>
|
||||
<span id="30">30</span>
|
||||
<span id="31">31</span>
|
||||
<span id="32">32</span>
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
<span id="36">36</span>
|
||||
<span id="37">37</span>
|
||||
<span id="38">38</span>
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
<span id="41">41</span>
|
||||
<span id="42">42</span>
|
||||
<span id="43">43</span>
|
||||
<span id="44">44</span>
|
||||
<span id="45">45</span>
|
||||
<span id="46">46</span>
|
||||
<span id="47">47</span>
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
<span id="51">51</span>
|
||||
<span id="52">52</span>
|
||||
<span id="53">53</span>
|
||||
<span id="54">54</span>
|
||||
<span id="55">55</span>
|
||||
<span id="56">56</span>
|
||||
<span id="57">57</span>
|
||||
<span id="58">58</span>
|
||||
<span id="59">59</span>
|
||||
<span id="60">60</span>
|
||||
<span id="61">61</span>
|
||||
<span id="62">62</span>
|
||||
<span id="63">63</span>
|
||||
<span id="64">64</span>
|
||||
<span id="65">65</span>
|
||||
<span id="66">66</span>
|
||||
<span id="67">67</span>
|
||||
<span id="68">68</span>
|
||||
<span id="69">69</span>
|
||||
<span id="70">70</span>
|
||||
<span id="71">71</span>
|
||||
<span id="72">72</span>
|
||||
<span id="73">73</span>
|
||||
<span id="74">74</span>
|
||||
<span id="75">75</span>
|
||||
<span id="76">76</span>
|
||||
<span id="77">77</span>
|
||||
<span id="78">78</span>
|
||||
<span id="79">79</span>
|
||||
<span id="80">80</span>
|
||||
<span id="81">81</span>
|
||||
<span id="82">82</span>
|
||||
<span id="83">83</span>
|
||||
<span id="84">84</span>
|
||||
<span id="85">85</span>
|
||||
<span id="86">86</span>
|
||||
<span id="87">87</span>
|
||||
<span id="88">88</span>
|
||||
<span id="89">89</span>
|
||||
<span id="90">90</span>
|
||||
<span id="91">91</span>
|
||||
<span id="92">92</span>
|
||||
<span id="93">93</span>
|
||||
<span id="94">94</span>
|
||||
<span id="95">95</span>
|
||||
<span id="96">96</span>
|
||||
<span id="97">97</span>
|
||||
<span id="98">98</span>
|
||||
<span id="99">99</span>
|
||||
<span id="100">100</span>
|
||||
<span id="101">101</span>
|
||||
<span id="102">102</span>
|
||||
<span id="103">103</span>
|
||||
<span id="104">104</span>
|
||||
<span id="105">105</span>
|
||||
<span id="106">106</span>
|
||||
<span id="107">107</span>
|
||||
<span id="108">108</span>
|
||||
<span id="109">109</span>
|
||||
<span id="110">110</span>
|
||||
<span id="111">111</span>
|
||||
<span id="112">112</span>
|
||||
<span id="113">113</span>
|
||||
<span id="114">114</span>
|
||||
<span id="115">115</span>
|
||||
<span id="116">116</span>
|
||||
<span id="117">117</span>
|
||||
<span id="118">118</span>
|
||||
<span id="119">119</span>
|
||||
<span id="120">120</span>
|
||||
<span id="121">121</span>
|
||||
<span id="122">122</span>
|
||||
<span id="123">123</span>
|
||||
<span id="124">124</span>
|
||||
<span id="125">125</span>
|
||||
<span id="126">126</span>
|
||||
<span id="127">127</span>
|
||||
<span id="128">128</span>
|
||||
<span id="129">129</span>
|
||||
<span id="130">130</span>
|
||||
<span id="131">131</span>
|
||||
<span id="132">132</span>
|
||||
<span id="133">133</span>
|
||||
<span id="134">134</span>
|
||||
<span id="135">135</span>
|
||||
<span id="136">136</span>
|
||||
<span id="137">137</span>
|
||||
<span id="138">138</span>
|
||||
<span id="139">139</span>
|
||||
<span id="140">140</span>
|
||||
<span id="141">141</span>
|
||||
<span id="142">142</span>
|
||||
<span id="143">143</span>
|
||||
<span id="144">144</span>
|
||||
<span id="145">145</span>
|
||||
<span id="146">146</span>
|
||||
<span id="147">147</span>
|
||||
<span id="148">148</span>
|
||||
<span id="149">149</span>
|
||||
<span id="150">150</span>
|
||||
<span id="151">151</span>
|
||||
<span id="152">152</span>
|
||||
<span id="153">153</span>
|
||||
<span id="154">154</span>
|
||||
<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>
|
||||
<span id="193">193</span>
|
||||
<span id="194">194</span>
|
||||
<span id="195">195</span>
|
||||
<span id="196">196</span>
|
||||
<span id="197">197</span>
|
||||
<span id="198">198</span>
|
||||
<span id="199">199</span>
|
||||
<span id="200">200</span>
|
||||
<span id="201">201</span>
|
||||
<span id="202">202</span>
|
||||
<span id="203">203</span>
|
||||
<span id="204">204</span>
|
||||
<span id="205">205</span>
|
||||
<span id="206">206</span>
|
||||
<span id="207">207</span>
|
||||
<span id="208">208</span>
|
||||
<span id="209">209</span>
|
||||
<span id="210">210</span>
|
||||
<span id="211">211</span>
|
||||
<span id="212">212</span>
|
||||
<span id="213">213</span>
|
||||
<span id="214">214</span>
|
||||
<span id="215">215</span>
|
||||
<span id="216">216</span>
|
||||
<span id="217">217</span>
|
||||
<span id="218">218</span>
|
||||
<span id="219">219</span>
|
||||
<span id="220">220</span>
|
||||
<span id="221">221</span>
|
||||
<span id="222">222</span>
|
||||
<span id="223">223</span>
|
||||
<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>
|
||||
<span id="229">229</span>
|
||||
<span id="230">230</span>
|
||||
<span id="231">231</span>
|
||||
<span id="232">232</span>
|
||||
<span id="233">233</span>
|
||||
<span id="234">234</span>
|
||||
<span id="235">235</span>
|
||||
<span id="236">236</span>
|
||||
<span id="237">237</span>
|
||||
<span id="238">238</span>
|
||||
<span id="239">239</span>
|
||||
<span id="240">240</span>
|
||||
<span id="241">241</span>
|
||||
<span id="242">242</span>
|
||||
<span id="243">243</span>
|
||||
<span id="244">244</span>
|
||||
<span id="245">245</span>
|
||||
<span id="246">246</span>
|
||||
<span id="247">247</span>
|
||||
<span id="248">248</span>
|
||||
<span id="249">249</span>
|
||||
<span id="250">250</span>
|
||||
<span id="251">251</span>
|
||||
<span id="252">252</span>
|
||||
<span id="253">253</span>
|
||||
<span id="254">254</span>
|
||||
<span id="255">255</span>
|
||||
<span id="256">256</span>
|
||||
<span id="257">257</span>
|
||||
<span id="258">258</span>
|
||||
<span id="259">259</span>
|
||||
<span id="260">260</span>
|
||||
<span id="261">261</span>
|
||||
<span id="262">262</span>
|
||||
<span id="263">263</span>
|
||||
<span id="264">264</span>
|
||||
<span id="265">265</span>
|
||||
<span id="266">266</span>
|
||||
<span id="267">267</span>
|
||||
<span id="268">268</span>
|
||||
<span id="269">269</span>
|
||||
<span id="270">270</span>
|
||||
<span id="271">271</span>
|
||||
<span id="272">272</span>
|
||||
<span id="273">273</span>
|
||||
<span id="274">274</span>
|
||||
<span id="275">275</span>
|
||||
<span id="276">276</span>
|
||||
<span id="277">277</span>
|
||||
<span id="278">278</span>
|
||||
<span id="279">279</span>
|
||||
<span id="280">280</span>
|
||||
<span id="281">281</span>
|
||||
<span id="282">282</span>
|
||||
<span id="283">283</span>
|
||||
<span id="284">284</span>
|
||||
</pre><pre class="rust"><code><span class="comment">/*
|
||||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* 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">//! Test utilities</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::errors</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::prelude</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="doccomment">/// test all database functions</span>
|
||||
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">database_works</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span>: <span class="ident">MCDatabase</span><span class="op">></span>(
|
||||
<span class="ident">db</span>: <span class="kw-2">&</span><span class="ident">T</span>,
|
||||
<span class="ident">p</span>: <span class="kw-2">&</span><span class="ident">Register</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>,
|
||||
<span class="ident">c</span>: <span class="kw-2">&</span><span class="ident">CreateCaptcha</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>,
|
||||
<span class="ident">l</span>: <span class="kw-2">&</span>[<span class="ident">Level</span>],
|
||||
<span class="ident">tp</span>: <span class="kw-2">&</span><span class="ident">TrafficPattern</span>,
|
||||
<span class="ident">an</span>: <span class="kw-2">&</span><span class="ident">AddNotification</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>,
|
||||
) {
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>.<span class="ident">ping</span>().<span class="kw">await</span>, <span class="string">"ping test"</span>);
|
||||
<span class="kw">if</span> <span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>() {
|
||||
<span class="ident">db</span>.<span class="ident">delete_user</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="op">!</span><span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user is deleted so username shouldn't exsit"</span>
|
||||
);
|
||||
}
|
||||
<span class="ident">db</span>.<span class="ident">register</span>(<span class="ident">p</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// testing get secret</span>
|
||||
<span class="kw">let</span> <span class="ident">secret</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_secret</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">secret</span>.<span class="ident">secret</span>, <span class="ident">p</span>.<span class="ident">secret</span>, <span class="string">"user secret matches"</span>);
|
||||
|
||||
<span class="comment">// testing update secret: setting secret = username</span>
|
||||
<span class="ident">db</span>.<span class="ident">update_secret</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">secret</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_secret</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">secret</span>.<span class="ident">secret</span>, <span class="ident">p</span>.<span class="ident">username</span>,
|
||||
<span class="string">"user secret matches username; as set by previous step"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// testing get_password</span>
|
||||
|
||||
<span class="comment">// with username</span>
|
||||
<span class="kw">let</span> <span class="ident">name_hash</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_password</span>(<span class="kw-2">&</span><span class="ident">Login::Username</span>(<span class="ident">p</span>.<span class="ident">username</span>)).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">name_hash</span>.<span class="ident">hash</span>, <span class="ident">p</span>.<span class="ident">hash</span>, <span class="string">"user password matches"</span>);
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">name_hash</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">username</span>, <span class="string">"username matches"</span>);
|
||||
|
||||
<span class="comment">// with email</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">name_hash</span> <span class="op">=</span> <span class="ident">db</span>
|
||||
.<span class="ident">get_password</span>(<span class="kw-2">&</span><span class="ident">Login::Email</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()))
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">name_hash</span>.<span class="ident">hash</span>, <span class="ident">p</span>.<span class="ident">hash</span>, <span class="string">"user password matches"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">name_hash</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">username</span>, <span class="string">"username matches"</span>);
|
||||
|
||||
<span class="comment">// testing get_email</span>
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">get_email</span>(<span class="ident">p</span>.<span class="ident">username</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">as_ref</span>()
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">as_str</span>(),
|
||||
<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">unwrap</span>()
|
||||
);
|
||||
|
||||
<span class="comment">// testing email exists</span>
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">email_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user is registered so email should exsit"</span>
|
||||
);
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user is registered so username should exsit"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// update password test. setting password = username</span>
|
||||
<span class="ident">name_hash</span>.<span class="ident">hash</span> <span class="op">=</span> <span class="ident">name_hash</span>.<span class="ident">username</span>.<span class="ident">clone</span>();
|
||||
<span class="ident">db</span>.<span class="ident">update_password</span>(<span class="kw-2">&</span><span class="ident">name_hash</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">name_hash</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_password</span>(<span class="kw-2">&</span><span class="ident">Login::Username</span>(<span class="ident">p</span>.<span class="ident">username</span>)).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">name_hash</span>.<span class="ident">hash</span>, <span class="ident">p</span>.<span class="ident">username</span>,
|
||||
<span class="string">"user password matches with changed value"</span>
|
||||
);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">name_hash</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">username</span>, <span class="string">"username matches"</span>);
|
||||
|
||||
<span class="comment">// update username to p.email</span>
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="op">!</span><span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user with p.email doesn't exist. pre-check to update username to p.email"</span>
|
||||
);
|
||||
<span class="ident">db</span>.<span class="ident">update_username</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>())
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user with p.email exist post-update"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// deleting user for re-registration with email = None</span>
|
||||
<span class="ident">db</span>.<span class="ident">delete_user</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="op">!</span><span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user is deleted so username shouldn't exsit"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// register with email = None</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">p2</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">clone</span>();
|
||||
<span class="ident">p2</span>.<span class="ident">email</span> <span class="op">=</span> <span class="prelude-val">None</span>;
|
||||
<span class="ident">db</span>.<span class="ident">register</span>(<span class="kw-2">&</span><span class="ident">p2</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">username_exists</span>(<span class="ident">p2</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user is registered so username should exsit"</span>
|
||||
);
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="op">!</span><span class="ident">db</span>.<span class="ident">email_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user registration with email is deleted; so email shouldn't exsit"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// testing get_email = None</span>
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">db</span>.<span class="ident">get_email</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(), <span class="prelude-val">None</span>);
|
||||
|
||||
<span class="comment">// testing update email</span>
|
||||
<span class="kw">let</span> <span class="ident">update_email</span> <span class="op">=</span> <span class="ident">UpdateEmail</span> {
|
||||
<span class="ident">username</span>: <span class="ident">p</span>.<span class="ident">username</span>,
|
||||
<span class="ident">new_email</span>: <span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>(),
|
||||
};
|
||||
<span class="ident">db</span>.<span class="ident">update_email</span>(<span class="kw-2">&</span><span class="ident">update_email</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(
|
||||
<span class="string">"null user email: {}"</span>,
|
||||
<span class="ident">db</span>.<span class="ident">email_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>()
|
||||
);
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">email_exists</span>(<span class="ident">p</span>.<span class="ident">email</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>()).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="string">"user was with empty email but email is set; so email should exsit"</span>
|
||||
);
|
||||
|
||||
<span class="comment">/*
|
||||
* test notification workflows
|
||||
* 1. Add notifications: a minimum of two, to mark as read and test if it has affected it
|
||||
* 2. Get unread notifications
|
||||
* 3. Mark a notification read, check if it has affected Step #2
|
||||
*/</span>
|
||||
|
||||
<span class="comment">// 1. add notification</span>
|
||||
<span class="ident">db</span>.<span class="ident">create_notification</span>(<span class="ident">an</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="ident">db</span>.<span class="ident">create_notification</span>(<span class="ident">an</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// 2. Get notifications</span>
|
||||
<span class="kw">let</span> <span class="ident">notifications</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_all_unread_notifications</span>(<span class="ident">an</span>.<span class="ident">to</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">notifications</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">notifications</span>[<span class="number">0</span>].<span class="ident">heading</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>(), <span class="ident">an</span>.<span class="ident">heading</span>);
|
||||
|
||||
<span class="comment">// 3. mark a notification read</span>
|
||||
<span class="ident">db</span>.<span class="ident">mark_notification_read</span>(<span class="ident">an</span>.<span class="ident">to</span>, <span class="ident">notifications</span>[<span class="number">0</span>].<span class="ident">id</span>.<span class="ident">unwrap</span>())
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">new_notifications</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_all_unread_notifications</span>(<span class="ident">an</span>.<span class="ident">to</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">new_notifications</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||||
|
||||
<span class="comment">// create captcha</span>
|
||||
<span class="ident">db</span>.<span class="ident">create_captcha</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>.<span class="ident">captcha_exists</span>(<span class="prelude-val">None</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>.<span class="ident">captcha_exists</span>(<span class="prelude-val">Some</span>(<span class="ident">p</span>.<span class="ident">username</span>), <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>());
|
||||
|
||||
<span class="comment">// get captcha configuration</span>
|
||||
<span class="kw">let</span> <span class="ident">captcha</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_captcha_config</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">captcha</span>.<span class="ident">key</span>, <span class="ident">c</span>.<span class="ident">key</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">captcha</span>.<span class="ident">duration</span>, <span class="ident">c</span>.<span class="ident">duration</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">captcha</span>.<span class="ident">description</span>, <span class="ident">c</span>.<span class="ident">description</span>);
|
||||
|
||||
<span class="comment">// get all captchas that belong to user</span>
|
||||
<span class="kw">let</span> <span class="ident">all_user_captchas</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_all_user_captchas</span>(<span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">all_user_captchas</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">all_user_captchas</span>[<span class="number">0</span>], <span class="ident">captcha</span>);
|
||||
|
||||
<span class="comment">// get captcha cooldown duration</span>
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">db</span>.<span class="ident">get_captcha_cooldown</span>(<span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(), <span class="ident">c</span>.<span class="ident">duration</span>);
|
||||
|
||||
<span class="comment">// add traffic pattern</span>
|
||||
<span class="ident">db</span>.<span class="ident">add_traffic_pattern</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>, <span class="ident">tp</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="kw-2">&</span><span class="ident">db</span>.<span class="ident">get_traffic_pattern</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="ident">tp</span>
|
||||
);
|
||||
|
||||
<span class="comment">// delete traffic pattern</span>
|
||||
<span class="ident">db</span>.<span class="ident">delete_traffic_pattern</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(
|
||||
<span class="macro">matches!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">get_traffic_pattern</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>,
|
||||
<span class="prelude-val">Err</span>(<span class="ident">DBError::TrafficPatternNotFound</span>)
|
||||
),
|
||||
<span class="string">"deletion successful; traffic pattern no longer exists"</span>
|
||||
);
|
||||
|
||||
<span class="comment">// add captcha levels</span>
|
||||
<span class="ident">db</span>.<span class="ident">add_captcha_levels</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>, <span class="ident">l</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// get captcha levels with username</span>
|
||||
<span class="kw">let</span> <span class="ident">levels</span> <span class="op">=</span> <span class="ident">db</span>
|
||||
.<span class="ident">get_captcha_levels</span>(<span class="prelude-val">Some</span>(<span class="ident">p</span>.<span class="ident">username</span>), <span class="ident">c</span>.<span class="ident">key</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">levels</span>, <span class="ident">l</span>);
|
||||
<span class="comment">// get captcha levels without username</span>
|
||||
<span class="kw">let</span> <span class="ident">levels</span> <span class="op">=</span> <span class="ident">db</span>.<span class="ident">get_captcha_levels</span>(<span class="prelude-val">None</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">levels</span>, <span class="ident">l</span>);
|
||||
|
||||
<span class="comment">/*
|
||||
* Test stats
|
||||
* 1. record fetch config
|
||||
* 2. record solve
|
||||
* 3. record token verify
|
||||
* 4. fetch config fetches
|
||||
* 5. fetch solves
|
||||
* 6. fetch token verify
|
||||
*/</span>
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>
|
||||
.<span class="ident">fetch_config_fetched</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">is_empty</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>.<span class="ident">fetch_solve</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>().<span class="ident">is_empty</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>
|
||||
.<span class="ident">fetch_confirm</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">is_empty</span>());
|
||||
|
||||
<span class="ident">db</span>.<span class="ident">record_fetch</span>(<span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="ident">db</span>.<span class="ident">record_solve</span>(<span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="ident">db</span>.<span class="ident">record_confirm</span>(<span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">db</span>.<span class="ident">fetch_solve</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>().<span class="ident">len</span>(), <span class="number">1</span>);
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">db</span>.<span class="ident">fetch_config_fetched</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>()
|
||||
.<span class="ident">len</span>(),
|
||||
<span class="number">1</span>
|
||||
);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">db</span>.<span class="ident">fetch_solve</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>().<span class="ident">len</span>(), <span class="number">1</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">db</span>.<span class="ident">fetch_confirm</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>().<span class="ident">len</span>(), <span class="number">1</span>);
|
||||
|
||||
<span class="comment">// update captcha key; set key = username;</span>
|
||||
<span class="ident">db</span>.<span class="ident">update_captcha_key</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>, <span class="ident">p</span>.<span class="ident">username</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>();
|
||||
<span class="comment">// checking for captcha with old key; shouldn't exist</span>
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">db</span>.<span class="ident">captcha_exists</span>(<span class="prelude-val">Some</span>(<span class="ident">p</span>.<span class="ident">username</span>), <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>());
|
||||
<span class="comment">// checking for captcha with new key; shouldn exist</span>
|
||||
<span class="macro">assert!</span>(<span class="ident">db</span>
|
||||
.<span class="ident">captcha_exists</span>(<span class="prelude-val">Some</span>(<span class="ident">p</span>.<span class="ident">username</span>), <span class="ident">p</span>.<span class="ident">username</span>)
|
||||
.<span class="kw">await</span>
|
||||
.<span class="ident">unwrap</span>());
|
||||
|
||||
<span class="comment">// delete captcha levels</span>
|
||||
<span class="ident">db</span>.<span class="ident">delete_captcha_levels</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// update captcha; set description = username and duration *= duration;</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">c2</span> <span class="op">=</span> <span class="ident">c</span>.<span class="ident">clone</span>();
|
||||
<span class="ident">c2</span>.<span class="ident">duration</span> <span class="kw-2">*</span><span class="op">=</span> <span class="ident">c2</span>.<span class="ident">duration</span>;
|
||||
<span class="ident">c2</span>.<span class="ident">description</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">username</span>;
|
||||
<span class="ident">db</span>.<span class="ident">update_captcha_metadata</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="kw-2">&</span><span class="ident">c2</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// delete captcha; updated key = p.username so invoke delete with it</span>
|
||||
<span class="ident">db</span>.<span class="ident">delete_captcha</span>(<span class="ident">p</span>.<span class="ident">username</span>, <span class="ident">p</span>.<span class="ident">username</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">db</span>.<span class="ident">captcha_exists</span>(<span class="prelude-val">Some</span>(<span class="ident">p</span>.<span class="ident">username</span>), <span class="ident">c</span>.<span class="ident">key</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>());
|
||||
}
|
||||
</code></pre></div>
|
||||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="db_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user