Deuglify channel state icons

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

diff --git a/src/core/storage.h b/src/core/storage.h
index 9612a59..1cb2ee8 100644 (file)
--- a/src/core/storage.h
+++ b/src/core/storage.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -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 */
 
@@ -62,9 +68,9 @@ public slots:
 
   //! Initialize the storage provider
   /** \param settings   Hostname, port, username, password, ...  
-   *  \return True if and only if the storage provider was initialized successfully.
+   *  \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
@@ -222,7 +228,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.
@@ -230,9 +272,10 @@ public slots:
    *  \param networkId The network id
    *  \param type      The type of the buffer (StatusBuffer, Channel, etc.)
    *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
+   *  \param create    Whether or not the buffer should be created if it doesnt exist
    *  \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
    */
-  virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") = 0;
+  virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) = 0;
 
   //! Get the unique BufferInfo for a bufferId
   /** \param user      The core user who owns this buffername