prettyficating the prompting for backend credentials

[quassel.git] / src / core / storage.h

diff --git a/src/core/storage.h b/src/core/storage.h
index fb53611..f7495f4 100644 (file)
--- a/src/core/storage.h
+++ b/src/core/storage.h
@@ -31,10 +31,16 @@
 class Storage : public QObject {
   Q_OBJECT
 
-  public:
+public:
   Storage(QObject *parent = 0);
   virtual ~Storage() {};
 
+  enum State {
+    IsReady,        // ready to go
+    NeedsSetup,     // need basic setup (ask the user for input)
+    NotAvailable    // remove the storage backend from the list of avaliable backends
+  };
+
 public slots:
   /* General */
 
@@ -53,6 +59,14 @@ public slots:
   /** \return A string that can be displayed by the client to describe the storage backend */
   virtual QString description() const = 0;
 
+  //! Returns a list of properties required to use the storage backend
+  virtual QStringList setupKeys() const = 0;
+
+  //! Returns a map where the keys are are properties to use the storage backend
+  /*  the values are QVariants with default values */
+  virtual QVariantMap setupDefaults() const = 0;
+
+
   //! Setup the storage provider.
   /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
    *  \param settings   Hostname, port, username, password, ...
@@ -61,10 +75,10 @@ public slots:
   virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
 
   //! Initialize the storage provider
-  /** \param settings   Hostname, port, username, password, ...  
-   *  \return True if and only if the storage provider was initialized successfully.
+  /** \param settings   Hostname, port, username, password, ...
+   *  \return the State the storage backend is now in (see Storage::State)
    */
-  virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
+  virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
 
   //! Makes temp data persistent
   /** This Method is periodically called by the Quassel Core to make temporary
@@ -120,7 +134,7 @@ public slots:
    * \param data         The Value
    */
   virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
-  
+
   //! Retrieve a persistent user setting
   /**
    * \param userId       The users Id
@@ -135,7 +149,7 @@ public slots:
   virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
   virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
   virtual QList<CoreIdentity> identities(UserId user) = 0;
-  
+
   /* Network handling */
 
   //! Create a new Network in the storage backend and return it unique Id
@@ -169,13 +183,6 @@ public slots:
    *  \return QList<NetworkInfo>.
    */
   virtual QList<NetworkInfo> networks(UserId user) = 0;
-  
-  //! Get the unique NetworkId of the network for a user.
-  /** \param user    The core user who owns this network
-   *  \param network The network name
-   *  \return The NetworkId corresponding to the given network, or 0 if not found
-   */
-  virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 
   //! Get a list of Networks to restore
   /** Return a list of networks the user was connected at the time of core shutdown
@@ -222,7 +229,43 @@ public slots:
    *  \param key        The key of the channel (possibly empty)
    */
   virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
-  
+
+  //! retrieve last known away message for session restore
+  /** \note This method is threadsafe
+   *
+   *  \param user       The Id of the networks owner
+   *  \param networkId  The Id of the network
+   */
+  virtual QString awayMessage(UserId user, NetworkId networkId) = 0;
+
+  //! Make away message persistent for session restore
+  /** \note This method is threadsafe
+   *
+   *  \param user       The Id of the networks owner
+   *  \param networkId  The Id of the network
+   *  \param awayMsg    The current away message of own user
+   */
+  virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) = 0;
+
+
+  //! retrieve last known user mode for session restore
+  /** \note This method is threadsafe
+   *
+   *  \param user       The Id of the networks owner
+   *  \param networkId  The Id of the network
+   */
+  virtual QString userModes(UserId user, NetworkId networkId) = 0;
+
+  //! Make our user modes persistent for session restore
+  /** \note This method is threadsafe
+   *
+   *  \param user       The Id of the networks owner
+   *  \param networkId  The Id of the network
+   *  \param userModes  The current user modes of own user
+   */
+  virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes) = 0;
+
+
   /* Buffer handling */
 
   //! Get the unique BufferInfo for the given combination of network and buffername for a user.
@@ -299,14 +342,20 @@ public slots:
    */
   virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
 
-  
+
   /* Message handling */
 
-  //! Store a Message in the backlog.
+  //! Store a Message in the storage backend and set its unique Id.
   /** \param msg  The message object to be stored
-   *  \return The globally unique id for the stored message
+   *  \return true on success
+   */
+  virtual bool logMessage(Message &msg) = 0;
+
+  //! Store a list of Messages in the storage backend and set their unique Id.
+  /** \param msgs The list message objects to be stored
+   *  \return true on success
    */
-  virtual MsgId logMessage(Message msg) = 0;
+  virtual bool logMessages(MessageList &msgs) = 0;
 
   //! Request a certain number messages stored in a given buffer.
   /** \param buffer   The buffer we request messages from