--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="et" xmlns="http://www.w3.org/1999/xhtml" xml:lang="et">
+
+ <head>
+ <meta http-equiv="CONTENT-TYPE" content="text/html; charset=utf-8" />
+ <title>eVaf Tutorial - 06 - Storage Module</title>
+ <meta name="Author" content="Enar Väikene" />
+ <meta name="description" content="eVaf Tutorial" />
+ <meta name="keywords" content="evaf c++ application development framework tutorial password generator" />
+ <link rel="StyleSheet" href="evaf.css" type="text/css" media="all" />
+ <link rel="StyleSheet" href="highlight.css" type="text/css" media="all" />
+ </head>
+
+ <body>
+
+ <h1>eVaf Tutorial</h1>
+
+ <h2>06 - Storage Module</h2>
+
+ <p>In this section we start implementing the Storage module. The storage module stores non-sensitive data required to re-generate
+ passwords. We use a simple SQLITE database in this module, but nothing prevents us replacing it with a more complex storage
+ module in the future.</p>
+
+ <h3>iStorage interface</h3>
+
+ <p>Once again, we start by defining the interface for the module and create the file <tt>istorage.h</tt> in the
+ <tt>src/apps/PswGen/Storage</tt> directory:</p>
+
+ <pre class="hl"><span class="hl com">/**</span>
+<span class="hl com"> * @file PswGen/Storage/istorage.h</span>
+<span class="hl com"> */</span>
+
+<span class="hl ppc">#ifndef __PSWGEN_STORAGE_ISTORAGE_H</span>
+<span class="hl ppc"># define __PSWGEN_STORAGE_ISTORAGE_H</span>
+<span class="hl ppc">#endif</span> <span class="hl slc">// istorage.h</span></pre>
+
+ <p>Include Qt header files for <tt>QObject</tt> and <tt>QString</tt> as they are almost always needed. In additon, we are going to
+ include headers for <tt>QSharedData</tt> and <tt>QExplicitlySharedDataPointer</tt>. We need a container for the data that
+ we store and making it shared data object with the benefit of automatic reference counting and memory management makes sense.</p>
+
+ <pre class="hl"><span class="hl ppc">#include <QObject></span>
+<span class="hl ppc">#include <QString></span>
+<span class="hl ppc">#include <QSharedData></span>
+<span class="hl ppc">#include <QExplicitlySharedDataPointer></span></pre>
+
+ <p>Use the <tt>eVaf::PswGen</tt> namespace:</p>
+
+ <pre class="hl"><span class="hl kwa">namespace</span> eVaf <span class="hl opt">{</span>
+<span class="hl kwa">namespace</span> PswGen <span class="hl opt">{</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf</span></pre>
+
+ <p>The container class for stored data has the following attributes:</p>
+ <ul>
+ <li>Name -- Name of the generated password</li>
+ <li>Length -- Length of the password</li>
+ <li>Options -- Additional parameters for the password generator</li>
+ </ul>
+
+ <p>The container class belongs to the Storage module and we use the <tt>eVaf::PswGen::Storage</tt> namespace for it:</p>
+
+ <pre class="hl"><span class="hl kwa">namespace</span> Storage <span class="hl opt">{</span>
+
+<span class="hl kwc">class</span> Data <span class="hl opt">:</span> <span class="hl kwc">public</span> QSharedData
+<span class="hl opt">{</span>
+<span class="hl kwc">private</span><span class="hl opt">:</span>
+
+ <span class="hl kwb">bool</span> mModified<span class="hl opt">;</span>
+ QString mName<span class="hl opt">;</span>
+ <span class="hl kwb">int</span> mLength<span class="hl opt">;</span>
+ uint mFlags<span class="hl opt">;</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// eVaf::PswGen::Storage</span></pre>
+
+ <p>The extra attribute - <tt>mModified</tt> - is used to detect unsaved modifications in the data object.</p>
+
+ <p>Add constructors for the shared data class. Creating a data object without name makes no sense and we include the
+ name attribute in all our constructors:</p>
+
+ <pre class="hl"><span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">Data</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span>
+ <span class="hl opt">:</span> <span class="hl kwd">QSharedData</span><span class="hl opt">()</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mModified</span><span class="hl opt">(</span><span class="hl kwa">false</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mName</span><span class="hl opt">(</span>name<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mLength</span><span class="hl opt">(</span><span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mFlags</span><span class="hl opt">(</span><span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">{}</span>
+
+ <span class="hl kwd">Data</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> <span class="hl kwb">int</span> l<span class="hl opt">,</span> uint f <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">:</span> <span class="hl kwd">QSharedData</span><span class="hl opt">()</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mModified</span><span class="hl opt">(</span><span class="hl kwa">false</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mName</span><span class="hl opt">(</span>name<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mLength</span><span class="hl opt">(</span>l<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mFlags</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
+ <span class="hl opt">{}</span></pre>
+
+ <p>Fianlly, we add getter and setter methods:</p>
+
+ <pre class="hl">
+ QString <span class="hl kwb">const</span> <span class="hl opt">&</span> <span class="hl kwd">name</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mName<span class="hl opt">; }</span>
+
+ <span class="hl kwb">int</span> <span class="hl kwd">length</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mLength<span class="hl opt">; }</span>
+ <span class="hl kwb">void</span> <span class="hl kwd">setLength</span><span class="hl opt">(</span><span class="hl kwb">int</span> value<span class="hl opt">)</span>
+ <span class="hl opt">{</span>
+ <span class="hl kwa">if</span> <span class="hl opt">(</span>mLength <span class="hl opt">!=</span> value<span class="hl opt">) {</span>
+ mLength <span class="hl opt">=</span> value<span class="hl opt">;</span>
+ mModified <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
+ <span class="hl opt">}</span>
+ <span class="hl opt">}</span>
+
+ uint <span class="hl kwd">flags</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mFlags<span class="hl opt">; }</span>
+ <span class="hl kwb">void</span> <span class="hl kwd">setFlags</span><span class="hl opt">(</span>uint value<span class="hl opt">)</span>
+ <span class="hl opt">{</span>
+ <span class="hl kwa">if</span> <span class="hl opt">(</span>mFlags <span class="hl opt">!=</span> value<span class="hl opt">) {</span>
+ mFlags <span class="hl opt">=</span> value<span class="hl opt">;</span>
+ mModified <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
+ <span class="hl opt">}</span>
+ <span class="hl opt">}</span>
+
+ <span class="hl kwb">bool</span> <span class="hl kwd">modified</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mModified<span class="hl opt">; }</span>
+
+ <span class="hl kwb">void</span> <span class="hl kwd">reset</span><span class="hl opt">() {</span> mModified <span class="hl opt">=</span> <span class="hl kwa">false</span><span class="hl opt">; }</span></pre>
+
+ <p>The <tt>reset()</tt> method resets the <tt>modified</tt> attribute.</p>
+
+ <p>Continue with the <tt>iStorage</tt> interface:</tt>
+
+ <pre class="hl"><span class="hl kwb">struct</span> iStorage
+<span class="hl opt">{</span>
+
+<span class="hl opt">};</span></pre>
+
+ <p>According to the specification, we need functions to store and query data:</p>
+
+ <pre class="hl">
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">save</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> data<span class="hl opt">) =</span> <span class="hl num">0</span><span class="hl opt">;</span>
+
+ <span class="hl kwc">virtual</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> <span class="hl kwd">query</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span> <span class="hl kwb">const</span> <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span></pre>
+
+ <p>The specification also mentions partial matches where entering "fa" would offer "facebook.com" if it exists. This could be done by
+ using the <tt>QCompleter</tt> class that provides auto completion in Qt widgets like <tt>QLineEdit</tt> and <tt>QComboBox</tt>. The
+ <tt>QCompleter<tt> class needs a <tt>QAbstractItemModel</tt> for the auto completion word list and we can provide it
+ from our <tt>Storage</tt> module:</tt>
+
+ <pre class="hl">
+ <span class="hl kwc">virtual</span> QAbstractItemModel <span class="hl opt">*</span> <span class="hl kwd">autoCompletionModel</span><span class="hl opt">() =</span> <span class="hl num">0</span><span class="hl opt">;</span></pre>
+
+ <p><tt>QAbstractItemModel</tt> is not known at this moment and we need to add a forward class declaration to the beginning of the
+ <tt>istorage.h</tt> file:</p>
+
+ <pre class="hl">
+ <span class="hl kwc">class</span> QAbstractItemModel<span class="hl opt">;</span></pre>
+
+ <p>At the the end of the <tt>istorage.h</tt> file, we declare the <tt>iStorage</tt> interface:</p>
+
+ <pre class="hl"><span class="hl kwd">Q_DECLARE_INTERFACE</span><span class="hl opt">(</span>eVaf<span class="hl opt">::</span>PswGen<span class="hl opt">::</span>iStorage<span class="hl opt">,</span> <span class="hl str">"eVaf.PswGen.iStorage/1.0"</span><span class="hl opt">)</span></pre>
+
+ <p>This is the complete <tt>istorage.h</tt> file:</p>
+
+ <pre class="hl"><span class="hl com">/**</span>
+<span class="hl com"> * @file PswGen/Storage/istorage.h</span>
+<span class="hl com"> */</span>
+
+<span class="hl ppc">#ifndef __PSWGEN_STORAGE_ISTORAGE_H</span>
+<span class="hl ppc"># define __PSWGEN_STORAGE_ISTORAGE_H</span>
+
+<span class="hl ppc">#include <QObject></span>
+<span class="hl ppc">#include <QString></span>
+<span class="hl ppc">#include <QSharedData></span>
+<span class="hl ppc">#include <QExplicitlySharedDataPointer></span>
+
+<span class="hl kwc">class</span> QAbstractItemModel<span class="hl opt">;</span>
+
+<span class="hl kwa">namespace</span> eVaf <span class="hl opt">{</span>
+<span class="hl kwa">namespace</span> PswGen <span class="hl opt">{</span>
+
+<span class="hl kwa">namespace</span> Storage <span class="hl opt">{</span>
+
+<span class="hl com">/// Data stored for every password.</span>
+<span class="hl kwc">class</span> Data <span class="hl opt">:</span> <span class="hl kwc">public</span> QSharedData
+<span class="hl opt">{</span>
+<span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">Data</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span>
+ <span class="hl opt">:</span> <span class="hl kwd">QSharedData</span><span class="hl opt">()</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mModified</span><span class="hl opt">(</span><span class="hl kwa">false</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mName</span><span class="hl opt">(</span>name<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mLength</span><span class="hl opt">(</span><span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mFlags</span><span class="hl opt">(</span><span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">{}</span>
+
+ <span class="hl kwd">Data</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> <span class="hl kwb">int</span> l<span class="hl opt">,</span> uint f <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">)</span>
+ <span class="hl opt">:</span> <span class="hl kwd">QSharedData</span><span class="hl opt">()</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mModified</span><span class="hl opt">(</span><span class="hl kwa">false</span><span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mName</span><span class="hl opt">(</span>name<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mLength</span><span class="hl opt">(</span>l<span class="hl opt">)</span>
+ <span class="hl opt">,</span> <span class="hl kwd">mFlags</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
+ <span class="hl opt">{}</span>
+
+ <span class="hl slc">/// Name of the password</span>
+ QString <span class="hl kwb">const</span> <span class="hl opt">&</span> <span class="hl kwd">name</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mName<span class="hl opt">; }</span>
+
+ <span class="hl slc">/// Length of the generated password</span>
+ <span class="hl kwb">int</span> <span class="hl kwd">length</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mLength<span class="hl opt">; }</span>
+ <span class="hl kwb">void</span> <span class="hl kwd">setLength</span><span class="hl opt">(</span><span class="hl kwb">int</span> value<span class="hl opt">)</span>
+ <span class="hl opt">{</span>
+ <span class="hl kwa">if</span> <span class="hl opt">(</span>mLength <span class="hl opt">!=</span> value<span class="hl opt">) {</span>
+ mLength <span class="hl opt">=</span> value<span class="hl opt">;</span>
+ mModified <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
+ <span class="hl opt">}</span>
+ <span class="hl opt">}</span>
+
+ <span class="hl slc">/// Optional flags for the password generator</span>
+ uint <span class="hl kwd">flags</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mFlags<span class="hl opt">; }</span>
+ <span class="hl kwb">void</span> <span class="hl kwd">setFlags</span><span class="hl opt">(</span>uint value<span class="hl opt">)</span>
+ <span class="hl opt">{</span>
+ <span class="hl kwa">if</span> <span class="hl opt">(</span>mFlags <span class="hl opt">!=</span> value<span class="hl opt">) {</span>
+ mFlags <span class="hl opt">=</span> value<span class="hl opt">;</span>
+ mModified <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
+ <span class="hl opt">}</span>
+ <span class="hl opt">}</span>
+
+ <span class="hl slc">/// Flag indicating that some fields are modified</span>
+ <span class="hl kwb">bool</span> <span class="hl kwd">modified</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mModified<span class="hl opt">; }</span>
+
+ <span class="hl slc">/// Resets the modified flag</span>
+ <span class="hl kwb">void</span> <span class="hl kwd">reset</span><span class="hl opt">() {</span> mModified <span class="hl opt">=</span> <span class="hl kwa">false</span><span class="hl opt">; }</span>
+
+<span class="hl kwc">private</span><span class="hl opt">:</span>
+
+ <span class="hl kwb">bool</span> mModified<span class="hl opt">;</span>
+ QString mName<span class="hl opt">;</span>
+ <span class="hl kwb">int</span> mLength<span class="hl opt">;</span>
+ uint mFlags<span class="hl opt">;</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// eVaf::PswGen::Storage</span>
+
+<span class="hl com">/// Password storage interface.</span>
+<span class="hl kwb">struct</span> iStorage
+<span class="hl opt">{</span>
+
+ <span class="hl com">/// Saves the data record</span>
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">save</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> data<span class="hl opt">) =</span> <span class="hl num">0</span><span class="hl opt">;</span>
+
+ <span class="hl com">/// Returns a data record by the name</span>
+ <span class="hl kwc">virtual</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> <span class="hl kwd">query</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span> <span class="hl kwb">const</span> <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span>
+
+ <span class="hl com">/// Returns an item model with the names of all the stored passwords</span>
+ <span class="hl kwc">virtual</span> QAbstractItemModel <span class="hl opt">*</span> <span class="hl kwd">autoCompletionModel</span><span class="hl opt">() =</span> <span class="hl num">0</span><span class="hl opt">;</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf</span>
+
+<span class="hl kwd">Q_DECLARE_INTERFACE</span><span class="hl opt">(</span>eVaf<span class="hl opt">::</span>PswGen<span class="hl opt">::</span>iStorage<span class="hl opt">,</span> <span class="hl str">"eVaf.PswGen.iStorage/1.0"</span><span class="hl opt">)</span>
+
+<span class="hl ppc">#endif</span> <span class="hl slc">// istorage.h</span><span class="hl ppc"></span></pre>
+
+ <p>We also create the <tt>iStorage</tt> file so that we can use <tt>#include <Storage/iStorage></tt> in our other modules:</tt>
+
+ <pre class="hl"><span class="hl ppc">#include </span><span class="hl pps">"istorage.h"</span></pre>
+
+ <h3>Storage module</h3>
+
+ <p>The <tt>Storage<tt> module is simple enough to be derived directly from the <tt>Plugins::iPlugin</tt> interface and needs only one
+ header/source file. In general, I personally prefer short source files and follow the <i>one-class-per-file</i> rule. Only when classes
+ are very simple and closely related I put the into the same source file.</p>
+
+ <p>Create the <tt>module.h</tt> header file in the <tt>src/apps/PswGen/Storage</tt> directory. Include <tt>istorage.h</tt> and
+ <tt>Plugins/iPlugin</tt> header files. We use the <tt>eVaf::PswGen::Storage</tt> namespace for public classes and
+ <tt>eVaf::PswGen::Storage::Internal<tt> namespace for private classes.</p>
+
+ <pre class="hl"><span class="hl ppc">#ifndef __PSWGEN_STORAGE_MODULE_H</span>
+<span class="hl ppc"># define __PSWGEN_STORAGE_MODULE_H</span>
+
+<span class="hl ppc">#include</span> <span class="hl pps">"istorage.h"</span><span class="hl ppc"></span>
+<span class="hl ppc">#include <Plugins/iPlugin></span>
+
+<span class="hl kwa">namespace</span> eVaf <span class="hl opt">{</span>
+<span class="hl kwa">namespace</span> PswGen <span class="hl opt">{</span>
+
+<span class="hl slc">/// Module that stores options for strong passwords</span>
+<span class="hl kwa">namespace</span> Storage <span class="hl opt">{</span>
+
+<span class="hl slc">/// Internal implementation of the Storage module</span>
+<span class="hl kwa">namespace</span> Internal <span class="hl opt">{</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage::Internal</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf</span>
+<span class="hl ppc">#endif</span> <span class="hl slc">// module.h</span><span class="hl ppc"></span></pre>
+
+ <p>We use the same name <tt>Module</tt> for the class that implements the module. This class is public and goes to the
+ <tt>eVaf::PswGen::Storage</tt> namespace:</p>
+
+ <pre class="hl"><span class="hl kwc">class</span> Module <span class="hl opt">:</span> <span class="hl kwc">public</span> Plugins<span class="hl opt">::</span>iPlugin
+<span class="hl opt">{</span>
+ Q_OBJECT
+
+<span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">Module</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl opt">~</span><span class="hl kwd">Module</span><span class="hl opt">();</span>
+
+<span class="hl opt">};</span></pre>
+
+ <p>Implement pure virtual methods in the <tt>iPlugin</tt> interface:</p>
+
+ <pre class="hl">
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">init</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> args<span class="hl opt">);</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">void</span> <span class="hl kwd">done</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">isReady</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mReady<span class="hl opt">; }</span></pre>
+
+ <p>This module needs more complex initialization that the <tt>Generator</tt> module and we use the <tt>mReady</tt> flag to
+ indicate that the module is fully initialized:</p>
+
+ <pre class="hl">
+<span class="hl kwc">private</span><span class="hl opt">:</span>
+
+ <span class="hl kwb">bool</span> mReady<span class="hl opt">;</span></pre>
+
+ <p>The <tt>StorageImpl</tt> class is the internal implementation of the <tt>iStorage</tt> interface:</p>
+
+ <pre class="hl">
+ Internal<span class="hl opt">::</span>StorageImpl <span class="hl opt">*</span> mStorage<span class="hl opt">;</span></pre>
+
+ <p>We could declare the <tt>Internal::StorageImpl</tt> class before the <tt>Module</tt> class, but as I like starting with more
+ generic (public) classes and then go into the details, we add a forward declaration to the beginning of the file:</p>
+
+ <pre class="hl">
+<span class="hl kwa">namespace</span> Internal <span class="hl opt">{</span>
+ <span class="hl kwc">class</span> StorageImpl<span class="hl opt">;</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage::Internal</span></pre>
+
+ <p>The declaration of the <tt>StorageImpl</tt> class goes into the <tt>eVaf::PswGen::Storage::Internal</tt> namespace and the class
+ shall be derived both from <tt>QObject</tt> and <tt>iStorage</tt>. However, since we also need to implement the
+ <tt>QAbstractItemModel</tt> data model for the <tt>iStorage::autoCompletionModel()</tt> method, we derive it from the
+ <tt>QAbstractListModel</tt> class instead. We use the <tt>QAbstractListModel</tt> class because it meets our requirements
+ to return a list of auto completion words.</p>
+
+ <pre class="hl">
+<span class="hl kwa">namespace</span> Internal <span class="hl opt">{</span>
+
+<span class="hl kwc">class</span> StorageImpl <span class="hl opt">:</span> <span class="hl kwc">public</span> QAbstractListModel<span class="hl opt">,</span> <span class="hl kwc">public</span> iStorage
+<span class="hl opt">{</span>
+ Q_OBJECT
+ <span class="hl kwd">Q_INTERFACES</span><span class="hl opt">(</span>eVaf<span class="hl opt">::</span>PswGen<span class="hl opt">::</span>iStorage<span class="hl opt">)</span>
+
+<span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">StorageImpl</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl opt">~</span><span class="hl kwd">StorageImpl</span><span class="hl opt">();</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage::Internal</span></pre>
+
+ <p>First, we implement pure virtual methods found in the <tt>iStorage</tt> interface:</p>
+
+ <pre class="hl">
+ <span class="hl com">/*</span>
+ <span class="hl com">iStorage interface</span>
+ <span class="hl com">*/</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">save</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> data<span class="hl opt">);</span>
+
+ <span class="hl kwc">virtual</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> <span class="hl kwd">query</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span> <span class="hl kwb">const</span><span class="hl opt">;</span>
+
+ <span class="hl kwc">virtual</span> QAbstractItemModel <span class="hl opt">*</span> <span class="hl kwd">autoCompletionModel</span><span class="hl opt">() {</span> <span class="hl kwa">return this</span><span class="hl opt">; }</span></pre>
+
+ <p>Since the <tt>QAbstractItemModel</tt> data model is implemented by the same class, we can simply return <tt>this</tt> in the
+ <tt>autoCompletionModel()</tt> model.</p>
+
+ <p>The <tt>QAbstractListModel</tt> class also has pure virtual methods that need to be implemented:</p>
+
+ <pre class="hl">
+ <span class="hl com">/*</span>
+ <span class="hl com">QAbstractListModel methods</span>
+ <span class="hl com">*/</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">int</span> <span class="hl kwd">rowCount</span><span class="hl opt">(</span>QModelIndex <span class="hl kwb">const</span> <span class="hl opt">&</span> parent<span class="hl opt">)</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mData<span class="hl opt">.</span><span class="hl kwd">count</span><span class="hl opt">(); }</span>
+
+ <span class="hl kwc">virtual</span> QVariant <span class="hl kwd">data</span><span class="hl opt">(</span>QModelIndex <span class="hl kwb">const</span> <span class="hl opt">&</span> index<span class="hl opt">,</span> <span class="hl kwb">int</span> role <span class="hl opt">=</span> Qt<span class="hl opt">::</span>DisplayRole<span class="hl opt">)</span> <span class="hl kwb">const</span><span class="hl opt">;</span></pre>
+
+ <p><tt>mData</tt> here is a container with all the stored data objects, which we add to the <tt>private</tt> section. We use
+ a <tt>QMap<QString, QExplicitlySharedDataPointer<Storage::Data> ></tt> for this purpose as it allows fast lookups
+ by the name string.</p>
+
+ <pre class="hl">
+<span class="hl kwc">private</span><span class="hl opt">:</span>
+
+ QMap<span class="hl opt"><</span>QString<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">> ></span> mData<span class="hl opt">;</span></pre>
+
+ <p>Permanent data storage is done using a SQLITE database. We add the database object and a methods to load data from the database. We
+ also need a method to create database tables if they do not exist yet:</p>
+
+ <pre class="hl">
+ QSqlDatabase mDb<span class="hl opt">;</span>
+
+ <span class="hl kwb">bool</span> <span class="hl kwd">createTables</span><span class="hl opt">();</span>
+
+ <span class="hl kwb">bool</span> <span class="hl kwd">loadData</span><span class="hl opt">();</span></pre>
+
+ <p>The database object needs names for the connection and for the database, which we can add as constants to the class:</p>
+
+ <pre class="hl">
+ <span class="hl kwb">static char const</span> <span class="hl opt">*</span> <span class="hl kwb">const</span> DbConnectionName<span class="hl opt">;</span>
+
+ <span class="hl kwb">static char const</span> <span class="hl opt">*</span> <span class="hl kwb">const</span> DbName<span class="hl opt">;</span></pre>
+
+ <p>The database needs to be opened and closed, and the list of data objects populated with data from the database. For this purpose
+ we add <tt>init()</tt> and <tt>done()</tt> methods to the public section of the class. The <tt>init()</tt> method can return
+ <tt>false</tt> if the initialization fails.</p>
+
+ <pre class="hl">
+ <span class="hl kwb">bool</span> <span class="hl kwd">init</span><span class="hl opt">();</span>
+
+ <span class="hl kwb">void</span> <span class="hl kwd">done</span><span class="hl opt">();</span></pre>
+
+ <p>This is the final <tt>module.h</tt> file:</p>
+
+<pre class="hl"><span class="hl com">/**</span>
+<span class="hl com"> * @file PswGen/Storage/module.h</span>
+<span class="hl com"> */</span>
+
+<span class="hl ppc">#ifndef __PSWGEN_STORAGE_MODULE_H</span>
+<span class="hl ppc"># define __PSWGEN_STORAGE_MODULE_H</span>
+
+<span class="hl ppc">#include</span> <span class="hl pps">"istorage.h"</span><span class="hl ppc"></span>
+
+<span class="hl ppc">#include <Plugins/iPlugin></span>
+
+<span class="hl ppc">#include <QObject></span>
+<span class="hl ppc">#include <QString></span>
+<span class="hl ppc">#include <QAbstractListModel></span>
+<span class="hl ppc">#include <QMap></span>
+<span class="hl ppc">#include <QtSql/QSqlDatabase></span>
+
+
+<span class="hl kwa">namespace</span> eVaf <span class="hl opt">{</span>
+<span class="hl kwa">namespace</span> PswGen <span class="hl opt">{</span>
+
+<span class="hl slc">/// Module that stores options for strong passwords</span>
+<span class="hl kwa">namespace</span> Storage <span class="hl opt">{</span>
+
+<span class="hl slc">/// Internal implementation of the Storage module</span>
+<span class="hl kwa">namespace</span> Internal <span class="hl opt">{</span>
+ <span class="hl kwc">class</span> StorageImpl<span class="hl opt">;</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage::Internal</span>
+
+<span class="hl com">/// Module implementing the iStorage interface.</span>
+<span class="hl kwc">class</span> Module <span class="hl opt">:</span> <span class="hl kwc">public</span> Plugins<span class="hl opt">::</span>iPlugin
+<span class="hl opt">{</span>
+ Q_OBJECT
+
+<span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">Module</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl opt">~</span><span class="hl kwd">Module</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">init</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> args<span class="hl opt">);</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">void</span> <span class="hl kwd">done</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">isReady</span><span class="hl opt">()</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mReady<span class="hl opt">; }</span>
+
+
+<span class="hl kwc">private</span><span class="hl opt">:</span> <span class="hl slc">// Members</span>
+
+ <span class="hl slc">/// Flag indicating that the module is ready</span>
+ <span class="hl kwb">bool</span> mReady<span class="hl opt">;</span>
+
+ <span class="hl slc">/// iStorage interface instance</span>
+ Internal<span class="hl opt">::</span>StorageImpl <span class="hl opt">*</span> mStorage<span class="hl opt">;</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl kwa">namespace</span> Internal <span class="hl opt">{</span>
+
+<span class="hl com">/// iStorage interface implementation.</span>
+<span class="hl kwc">class</span> StorageImpl <span class="hl opt">:</span> <span class="hl kwc">public</span> QAbstractListModel<span class="hl opt">,</span> <span class="hl kwc">public</span> iStorage
+<span class="hl opt">{</span>
+ Q_OBJECT
+ <span class="hl kwd">Q_INTERFACES</span><span class="hl opt">(</span>eVaf<span class="hl opt">::</span>PswGen<span class="hl opt">::</span>iStorage<span class="hl opt">)</span>
+
+<span class="hl kwc">public</span><span class="hl opt">:</span>
+
+ <span class="hl kwd">StorageImpl</span><span class="hl opt">();</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl opt">~</span><span class="hl kwd">StorageImpl</span><span class="hl opt">();</span>
+
+ <span class="hl kwb">bool</span> <span class="hl kwd">init</span><span class="hl opt">();</span>
+
+ <span class="hl kwb">void</span> <span class="hl kwd">done</span><span class="hl opt">();</span>
+
+ <span class="hl com">/*</span>
+ <span class="hl com">iStorage interface</span>
+ <span class="hl com">*/</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">bool</span> <span class="hl kwd">save</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> data<span class="hl opt">);</span>
+
+ <span class="hl kwc">virtual</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">></span> <span class="hl kwd">query</span><span class="hl opt">(</span>QString <span class="hl kwb">const</span> <span class="hl opt">&</span> name<span class="hl opt">)</span> <span class="hl kwb">const</span><span class="hl opt">;</span>
+
+ <span class="hl kwc">virtual</span> QAbstractItemModel <span class="hl opt">*</span> <span class="hl kwd">autoCompletionModel</span><span class="hl opt">() {</span> <span class="hl kwa">return this</span><span class="hl opt">; }</span>
+
+ <span class="hl com">/*</span>
+ <span class="hl com">QAbstractListModel methods</span>
+ <span class="hl com">*/</span>
+
+ <span class="hl kwc">virtual</span> <span class="hl kwb">int</span> <span class="hl kwd">rowCount</span><span class="hl opt">(</span>QModelIndex <span class="hl kwb">const</span> <span class="hl opt">&</span> parent<span class="hl opt">)</span> <span class="hl kwb">const</span> <span class="hl opt">{</span> <span class="hl kwa">return</span> mData<span class="hl opt">.</span><span class="hl kwd">count</span><span class="hl opt">(); }</span>
+
+ <span class="hl kwc">virtual</span> QVariant <span class="hl kwd">data</span><span class="hl opt">(</span>QModelIndex <span class="hl kwb">const</span> <span class="hl opt">&</span> index<span class="hl opt">,</span> <span class="hl kwb">int</span> role <span class="hl opt">=</span> Qt<span class="hl opt">::</span>DisplayRole<span class="hl opt">)</span> <span class="hl kwb">const</span><span class="hl opt">;</span>
+
+<span class="hl kwc">private</span><span class="hl opt">:</span> <span class="hl slc">// Members</span>
+
+ <span class="hl slc">/// Name of the database connection</span>
+ <span class="hl kwb">static char const</span> <span class="hl opt">*</span> <span class="hl kwb">const</span> DbConnectionName<span class="hl opt">;</span>
+
+ <span class="hl slc">/// Name of the database file without path</span>
+ <span class="hl kwb">static char const</span> <span class="hl opt">*</span> <span class="hl kwb">const</span> DbName<span class="hl opt">;</span>
+
+ <span class="hl slc">/// Database connection</span>
+ QSqlDatabase mDb<span class="hl opt">;</span>
+
+ <span class="hl slc">/// List of name/data pairs</span>
+ QMap<span class="hl opt"><</span>QString<span class="hl opt">,</span> QExplicitlySharedDataPointer<span class="hl opt"><</span>Storage<span class="hl opt">::</span>Data<span class="hl opt">> ></span> mData<span class="hl opt">;</span>
+
+
+<span class="hl kwc">private</span><span class="hl opt">:</span> <span class="hl slc">// Methods</span>
+
+ <span class="hl com">/// Creates database tables if necessary</span>
+ <span class="hl kwb">bool</span> <span class="hl kwd">createTables</span><span class="hl opt">();</span>
+
+ <span class="hl com">/// Loads data from the database</span>
+ <span class="hl kwb">bool</span> <span class="hl kwd">loadData</span><span class="hl opt">();</span>
+
+<span class="hl opt">};</span>
+
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage::Internal</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen::Storage</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf::PswGen</span>
+<span class="hl opt">}</span> <span class="hl slc">// namespace eVaf</span>
+
+<span class="hl ppc">#endif</span> <span class="hl slc">// module.h</span><span class="hl ppc"></span></pre>
+
+ <p>Continue implementing the <a href="pswgen07.html">Storage Module</a>.</p>
+
+ </body>
+</html>
projects / evaf / blobdiff