migrated passwords from blob to strings (still hashed), for easier migration between...

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

diff --git a/src/core/storage.h b/src/core/storage.h
index 95bbb2d..3e8cbb1 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.
@@ -152,12 +151,20 @@ class Storage : public QObject {
     /* Buffer handling */
 
     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
-    /** \param user    The core user who owns this buffername
-     *  \param network The network name
+    /** \param user      The core user who owns this buffername
+     *  \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 NetworkId &networkId, const QString &buffer = "") = 0;
+    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.
@@ -169,6 +176,38 @@ 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
+     * \param bufferId  The buffer id
+     * \param seenDate  Time the Buffer has been visited the last time
+     */
+    virtual void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) = 0;
+
+    //! Get a Hash of all last seen dates. 
+    /** This Method is called when the Quassel Core is started to restore the lastSeenDates
+     * \param user      The Owner of the buffers
+     */
+    virtual QHash<BufferId, QDateTime> bufferLastSeenDates(UserId user) = 0;
+
+  
     /* Message handling */
 
     //! Store a Message in the backlog.
@@ -204,6 +243,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
@@ -211,8 +252,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);
 };