GpgFrontend-Doxygen/docs/html/DataObjectOperator_8h_source.html

162 lines
18 KiB
HTML
Raw Normal View History

2022-05-08 19:59:26 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2022-05-08 22:01:23 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
2022-05-08 19:59:26 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: src/core/function/DataObjectOperator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
2022-05-08 22:01:23 +00:00
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
2022-05-08 19:59:26 +00:00
<div id="projectname">GpgFrontend Project
</div>
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2022-05-08 22:01:23 +00:00
<!-- Generated by Doxygen 1.8.17 -->
2022-05-08 19:59:26 +00:00
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2022-05-08 19:59:26 +00:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-05-08 22:01:23 +00:00
/* @license-end */</script>
2022-05-08 19:59:26 +00:00
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(document).ready(function(){initNavTree('DataObjectOperator_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
2022-05-08 22:01:23 +00:00
<div class="headertitle">
<div class="title">DataObjectOperator.h</div> </div>
2022-05-08 19:59:26 +00:00
</div><!--header-->
<div class="contents">
2022-05-08 22:01:23 +00:00
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#ifndef GPGFRONTEND_DATAOBJECTOPERATOR_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define GPGFRONTEND_DATAOBJECTOPERATOR_H</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;json/single_include/nlohmann/json.hpp&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;core/GpgFrontendCore.h&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;core/GpgFunctionObject.h&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;core/function/GlobalSettingStation.h&quot;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html"> 40</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1DataObjectOperator.html">DataObjectOperator</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; : <span class="keyword">public</span> <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html">SingletonFunctionObject</a>&lt;DataObjectOperator&gt; {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classGpgFrontend_1_1DataObjectOperator.html">DataObjectOperator</a>(</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">int</span> channel = <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">SingletonFunctionObject::GetDefaultChannel</a>());</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::string SaveDataObj(<span class="keyword">const</span> std::string &amp;_key, <span class="keyword">const</span> nlohmann::json &amp;value);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; std::optional&lt;nlohmann::json&gt; GetDataObject(<span class="keyword">const</span> std::string &amp;_key);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; std::optional&lt;nlohmann::json&gt; GetDataObjectByRef(<span class="keyword">const</span> std::string &amp;_ref);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> init_app_secure_key();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#a3c195f8e4c30d95be14a6d43e9282601"> 64</a></span>&#160; <a class="code" href="classGpgFrontend_1_1GlobalSettingStation.html">GlobalSettingStation</a> &amp;global_setting_station_ =</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GlobalSettingStation::GetInstance</a>(); </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#a6d38d25c91c33c48d083ec4de051108a"> 66</a></span>&#160; std::filesystem::path app_secure_path_ =</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; global_setting_station_.GetAppConfigPath() /</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="stringliteral">&quot;secure&quot;</span>; </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#a56c0c031cd327207260c73d1885dbdca"> 69</a></span>&#160; std::filesystem::path app_secure_key_path_ =</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; app_secure_path_ / <span class="stringliteral">&quot;app.key&quot;</span>; </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#ae6762d4f0f5ca2e83f7c1508cd25cc21"> 71</a></span>&#160; std::filesystem::path app_data_objs_path_ =</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; global_setting_station_.GetAppDataPath() / <span class="stringliteral">&quot;data_objs&quot;</span>; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#a24c9cdbe9256e332ac93d6dc28c76b90"> 76</a></span>&#160; std::random_device <a class="code" href="classGpgFrontend_1_1DataObjectOperator.html#a24c9cdbe9256e332ac93d6dc28c76b90">rd_</a>; </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#a9fc92c7d497f2a2057776adfca40e8ca"> 77</a></span>&#160; std::mt19937 mt_ = std::mt19937(rd_()); </div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1DataObjectOperator.html#ae409c3562c3e08931daa17f5790c508b"> 78</a></span>&#160; QByteArray <a class="code" href="classGpgFrontend_1_1DataObjectOperator.html#ae409c3562c3e08931daa17f5790c508b">hash_key_</a>; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;} <span class="comment">// namespace GpgFrontend</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif // GPGFRONTEND_DATAOBJECTOPERATOR_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html">GpgFrontend::SingletonFunctionObject</a></div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:49</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1FileOperator_html_a51121c94dc32a83d7073fbe7138b603b"><div class="ttname"><a href="classGpgFrontend_1_1FileOperator.html#a51121c94dc32a83d7073fbe7138b603b">GpgFrontend::FileOperator::WriteFileStd</a></div><div class="ttdeci">static bool WriteFileStd(const std::filesystem::path &amp;file_name, const std::string &amp;data)</div><div class="ttdoc">write file content using std struct</div><div class="ttdef"><b>Definition:</b> FileOperator.cpp:67</div></div>
2022-05-08 19:59:26 +00:00
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_a24c9cdbe9256e332ac93d6dc28c76b90"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#a24c9cdbe9256e332ac93d6dc28c76b90">GpgFrontend::DataObjectOperator::rd_</a></div><div class="ttdeci">std::random_device rd_</div><div class="ttdoc">Random device.</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:76</div></div>
2022-05-08 22:01:23 +00:00
<div class="ttc" id="anamespaceGpgFrontend_html"><div class="ttname"><a href="namespaceGpgFrontend.html">GpgFrontend</a></div><div class="ttdef"><b>Definition:</b> CoreCommonUtil.cpp:29</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a70484d7cfe9f9dcbcd5f8bb749250f36"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgFrontend::SingletonFunctionObject&lt; PassphraseGenerator &gt;::GetInstance</a></div><div class="ttdeci">static PassphraseGenerator &amp; GetInstance(int channel=GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL)</div><div class="ttdoc">Get the Instance object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:57</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_a6d38d25c91c33c48d083ec4de051108a"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#a6d38d25c91c33c48d083ec4de051108a">GpgFrontend::DataObjectOperator::app_secure_path_</a></div><div class="ttdeci">std::filesystem::path app_secure_path_</div><div class="ttdoc">Where sensitive information is stored.</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:66</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_a56c0c031cd327207260c73d1885dbdca"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#a56c0c031cd327207260c73d1885dbdca">GpgFrontend::DataObjectOperator::app_secure_key_path_</a></div><div class="ttdeci">std::filesystem::path app_secure_key_path_</div><div class="ttdoc">Where the key of data object is stored.</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:69</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_a3a8ae5c36fec01d0d5c3e5f9aed457a6"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#a3a8ae5c36fec01d0d5c3e5f9aed457a6">GpgFrontend::DataObjectOperator::DataObjectOperator</a></div><div class="ttdeci">DataObjectOperator(int channel=SingletonFunctionObject::GetDefaultChannel())</div><div class="ttdoc">DataObjectOperator constructor.</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.cpp:46</div></div>
2022-05-08 19:59:26 +00:00
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_ae409c3562c3e08931daa17f5790c508b"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#ae409c3562c3e08931daa17f5790c508b">GpgFrontend::DataObjectOperator::hash_key_</a></div><div class="ttdeci">QByteArray hash_key_</div><div class="ttdoc">Hash key.</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:78</div></div>
2022-05-08 22:01:23 +00:00
<div class="ttc" id="aclassGpgFrontend_1_1GlobalSettingStation_html"><div class="ttname"><a href="classGpgFrontend_1_1GlobalSettingStation.html">GpgFrontend::GlobalSettingStation</a></div><div class="ttdef"><b>Definition:</b> GlobalSettingStation.h:47</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_ae6762d4f0f5ca2e83f7c1508cd25cc21"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#ae6762d4f0f5ca2e83f7c1508cd25cc21">GpgFrontend::DataObjectOperator::app_data_objs_path_</a></div><div class="ttdeci">std::filesystem::path app_data_objs_path_</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:71</div></div>
2022-05-08 19:59:26 +00:00
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a50e2b3794d6553f4231eaec72d9d0a50"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">GpgFrontend::SingletonFunctionObject::GetDefaultChannel</a></div><div class="ttdeci">static int GetDefaultChannel()</div><div class="ttdoc">Get the Default Channel object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:127</div></div>
2022-05-08 22:01:23 +00:00
<div class="ttc" id="aclassGpgFrontend_1_1FileOperator_html_ad4424bce4f22ae75a16c542dfb4ddf0a"><div class="ttname"><a href="classGpgFrontend_1_1FileOperator.html#ad4424bce4f22ae75a16c542dfb4ddf0a">GpgFrontend::FileOperator::ReadFileStd</a></div><div class="ttdeci">static bool ReadFileStd(const std::filesystem::path &amp;file_name, std::string &amp;data)</div><div class="ttdoc">read file content using std struct</div><div class="ttdef"><b>Definition:</b> FileOperator.cpp:55</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html">GpgFrontend::DataObjectOperator</a></div><div class="ttdef"><b>Definition:</b> DataObjectOperator.h:40</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1DataObjectOperator_html_a6b357780482f0e0c021ad55a81eb37cf"><div class="ttname"><a href="classGpgFrontend_1_1DataObjectOperator.html#a6b357780482f0e0c021ad55a81eb37cf">GpgFrontend::DataObjectOperator::init_app_secure_key</a></div><div class="ttdeci">void init_app_secure_key()</div><div class="ttdoc">init the secure key of application data object</div><div class="ttdef"><b>Definition:</b> DataObjectOperator.cpp:37</div></div>
2022-05-08 19:59:26 +00:00
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_f8a0abd6d3586538a5b71803e0ab7ffa.html">function</a></li><li class="navelem"><b>DataObjectOperator.h</b></li>
2022-05-08 22:01:23 +00:00
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
2022-05-08 19:59:26 +00:00
</ul>
</div>
</body>
</html>