src/Plugins/PasswordPlugin.h

   1 /* Copyright (C) 2013 Pali Rohár <pali.rohar@gmail.com>
   2
   3    This file is part of the Trojita Qt IMAP e-mail client,
   4    http://trojita.flaska.net/
   5
   6    This program is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public License as
   8    published by the Free Software Foundation; either version 2 of
   9    the License or (at your option) version 3 or any later version
  10    accepted by the membership of KDE e.V. (or its successor approved
  11    by the membership of KDE e.V.), which shall act as a proxy
  12    defined in Section 14 of version 3 of the license.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef PASSWORD_INTERFACE
  24 #define PASSWORD_INTERFACE
  25
  26 #include <QObject>
  27 #include <QString>
  28
  29 #include "PluginJob.h"
  30
  31 namespace Plugins
  32 {
  33
  34 class PLUGINMANAGER_EXPORT PasswordJob : public PluginJob
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     /** @short Error emitted by error signal */
  40     enum Error {
  41         UnknownError, /**< Unknown error */
  42         Stopped, /**< Emitted when job stopped */
  43         NoSuchPassword /**< Emitted when password is not available */
  44     };
  45
  46 signals:
  47     /** @short Emitted when password is available */
  48     void passwordAvailable(const QString &password);
  49
  50     /** @short Emitted when job finish storing password */
  51     void passwordStored();
  52
  53     /** @short Emitted when job finish deleting password */
  54     void passwordDeleted();
  55
  56     /** @short Emitted when job finish unsuccessful with error */
  57     void error(const Plugins::PasswordJob::Error error, const QString &errorMessage);
  58
  59 protected:
  60     PasswordJob(QObject *parent);
  61 };
  62
  63 class PLUGINMANAGER_EXPORT PasswordPlugin : public QObject
  64 {
  65     Q_OBJECT
  66
  67 public:
  68     /** @short Features returned by method features */
  69     enum Feature {
  70         FeatureEncryptedStorage = 1 << 0 /**< Plugin using encrypted storage */
  71     };
  72
  73     Q_DECLARE_FLAGS(Features, Feature)
  74
  75     /** @short Return implementation features */
  76     virtual Features features() const = 0;
  77
  78 public slots:
  79     /** @short Request password associated with accountId and accountType and return PasswordJob */
  80     virtual PasswordJob *requestPassword(const QString &accountId, const QString &accountType) = 0;
  81
  82     /** @short Save password for accountId and accountType and return PasswordJob */
  83     virtual PasswordJob *storePassword(const QString &accountId, const QString &accountType, const QString &password) = 0;
  84
  85     /** @short Delete password for accountId and accountType and return PasswordJob */
  86     virtual PasswordJob *deletePassword(const QString &accountId, const QString &accountType) = 0;
  87
  88 protected:
  89     PasswordPlugin(QObject *parent);
  90 };
  91
  92 Q_DECLARE_OPERATORS_FOR_FLAGS(PasswordPlugin::Features)
  93
  94 }
  95
  96 #endif //PASSWORD_INTERFACE
  97
  98 // vim: set et ts=4 sts=4 sw=4