Prevent the core from restoring its state if it is unconfigured.

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

diff --git a/src/core/storage.h b/src/core/storage.h
index 1af8d86..649bdc4 100644 (file)
--- a/src/core/storage.h
+++ b/src/core/storage.h
@@ -23,7 +23,9 @@
 
 #include <QtCore>
 
+#include "types.h"
 #include "message.h"
+struct NetworkInfo;
 
 class Storage : public QObject {
   Q_OBJECT
@@ -40,25 +42,36 @@ class Storage : public QObject {
      *  prerequisites are in place (e.g. we have an appropriate DB driver etc.).
      * \return True if and only if the storage class can be successfully used.
      */
-    static bool isAvailable() { return false; }
+    virtual bool isAvailable() const = 0;
 
     //! Returns the display name of the storage backend
-    /** \return A string that can be used by the GUI to describe the storage backend */
-    static QString displayName() { return ""; }
+    /** \return A string that can be used by the client to name the storage backend */
+    virtual QString displayName() const = 0;
+
+    //! Returns a description of this storage backend
+    /** \return A string that can be displayed by the client to describe the storage backend */
+    virtual QString description() 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, ...
      *  \return True if and only if the storage provider was initialized successfully.
      */
-    virtual bool setup(const QVariantMap &settings = QVariantMap()) { Q_UNUSED(settings); return false; }
-    
+    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.
      */
     virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
-    
+
+    //! Makes temp data persistent
+    /** This Method is periodically called by the Quassel Core to make temporary
+    *  data persistant. This reduces the data loss drastically in the
+    *  unlikely case of a Core crash.
+    */
+    virtual void sync() = 0;
+
     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
 
     /* User handling */
@@ -96,10 +109,17 @@ class Storage : public QObject {
 
     /* Network handling */
 
+    //! Create a new unique Network in the storage backend
+    /** \param user        The core user who owns this network
+     *  \param networkInfo The networkInfo holding the network definition
+     *  \return the NetworkId of the newly created Network. Possibly invalid.
+     */
+    virtual NetworkId createNetworkId(UserId user, const NetworkInfo &info) = 0;
+
     //! Get the unique NetworkId of the network for a user.
-    /** \param user    The core user who owns this buffername
+    /** \param user    The core user who owns this network
      *  \param network The network name
-     *  \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
+     *  \return The NetworkId corresponding to the given network, or 0 if not found
      */
     virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 
@@ -111,7 +131,7 @@ class Storage : public QObject {
      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
      *  \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
      */
-    virtual BufferInfo getBufferInfo(UserId user, const QString &network, const QString &buffer = "") = 0;
+    virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, const QString &buffer = "") = 0;
 
     //! Request a list of all buffers known to a user since a certain point in time.
     /** This method is used to get a list of all buffers we have stored a backlog from.