Adding .desktop file to make packagers moar happy...

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

diff --git a/src/core/storage.h b/src/core/storage.h
index c7444b1..ee4cbfe 100644 (file)
--- a/src/core/storage.h
+++ b/src/core/storage.h
@@ -117,8 +117,7 @@ class Storage : public QObject {
     virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
 
     //! Apply the changes to NetworkInfo info to the storage engine
-    /** \note This method is thredsafe.
-     *
+    /**
      *  \param user        The core user
      *  \param networkInfo The Updated NetworkInfo
      *  \return true if successfull.
@@ -149,6 +148,52 @@ class Storage : public QObject {
      */
     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
+     *  \note This method is threadsafe.
+     *
+     *  \param user  The User Id in question
+     */
+    virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
+
+    //! Update the connected state of a network
+    /** \note This method is threadsafe
+     *
+     *  \param user        The Id of the networks owner
+     *  \param networkId   The Id of the network
+     *  \param isConnected whether the network is connected or not
+     */
+    virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
+
+    //! Get a hash of channels with their channel keys for a given network
+    /** The keys are channel names and values are passwords (possibly empty)
+     *  \note This method is threadsafe
+     *
+     *  \param user       The id of the networks owner
+     *  \param networkId  The Id of the network
+     */
+    virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
+
+    //! Update the connected state of a channel
+    /** \note This method is threadsafe
+     *
+     *  \param user       The Id of the networks owner
+     *  \param networkId  The Id of the network
+     *  \param channel    The name of the channel
+     *  \param isJoined   whether the channel is connected or not
+     */
+    virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
+
+    //! Update the key of a channel
+    /** \note This method is threadsafe
+     *
+     *  \param user       The Id of the networks owner
+     *  \param networkId  The Id of the network
+     *  \param channel    The name of the channel
+     *  \param key        The key of the channel (possibly empty)
+     */
+    virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
+  
     /* Buffer handling */
 
     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
@@ -156,10 +201,17 @@ class Storage : public QObject {
      *  \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)
-     *  \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
+     *  \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;
 
+    //! Get the unique BufferInfo for a bufferId
+    /** \param user      The core user who owns this buffername
+     *  \param bufferId  The id of the buffer
+     *  \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
+     */
+    virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 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.
      *  Optionally, a QDateTime can be given, so that only buffers are listed that where active
@@ -170,6 +222,23 @@ class Storage : public QObject {
      */
     virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
 
+    //! Remove permanently a buffer and it's content from the storage backend
+    /** This call cannot be reverted!
+     *  \param user      The user who is the owner of the buffer
+     *  \param bufferId  The bufferId
+     *  \return true if successfull
+     */
+    virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
+
+    //! Rename a Buffer
+    /** \param user      The id of the buffer owner
+     *  \param networkId The id of the network the buffer belongs to
+     *  \param newName   The new name of the buffer
+     *  \param oldName   The previous name of the buffer
+     *  \return the BufferId of the affected buffer or an invalid BufferId if not successfull
+     */
+    virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0;
+  
     //! Update the LastSeenDate for a Buffer
     /** This Method is used to make the LastSeenDate of a Buffer persistent
      * \param user      The Owner of that Buffer
@@ -220,6 +289,8 @@ class Storage : public QObject {
   signals:
     //! Sent when a new BufferInfo is created, or an existing one changed somehow.
     void bufferInfoUpdated(UserId user, const BufferInfo &);
+    //! Sent when a Buffer was renamed
+    void bufferRenamed(const QString &newName, const QString &oldName);
     //! Sent when a new user has been added
     void userAdded(UserId, const QString &username);
     //! Sent when a user has been renamed
@@ -227,8 +298,11 @@ class Storage : public QObject {
     //! Sent when a user has been removed
     void userRemoved(UserId);
 
-  public:
-
+  protected:
+    //! when implementing a storage handler, use this method to crypt user passwords.
+    /**  This guarantees compatibility with other storage handlers and allows easy migration
+     */
+    QString cryptedPassword(const QString &password);
 };