minor api cleanup for requesting messages from backlog

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

diff --git a/src/core/storage.h b/src/core/storage.h
index ee4cbfe..5743853 100644 (file)
--- a/src/core/storage.h
+++ b/src/core/storage.h
@@ -102,11 +102,33 @@ class Storage : public QObject {
      */
     virtual UserId validateUser(const QString &user, const QString &password) = 0;
 
+    //! Determine the UserId of the internal user
+    /** \return A valid UserId if the password matches the username; 0 else
+     */
+    virtual UserId internalUser() = 0;
+
     //! Remove a core user from storage.
     /** \param user     The userid to delete
      */
     virtual void delUser(UserId user) = 0;
 
+    //! Store a user setting persistently
+    /**
+     * \param userId       The users Id
+     * \param settingName  The Name of the Setting
+     * \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
+     * \param settingName  The Name of the Setting
+     * \param default      Value to return in case it's unset.
+     * \return the Value of the Setting or the default value if it is unset.
+     */
+    virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
+  
     /* Network handling */
 
     //! Create a new Network in the storage backend and return it unique Id
@@ -212,15 +234,21 @@ class Storage : public QObject {
      */
     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.
+    //! Request a list of all buffers known to a user.
     /** 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
-     *  since that point in time.
      *  \param user  The user whose buffers we request
-     *  \param since If this is defined, older buffers will be ignored
      *  \return A list of the BufferInfos for all buffers as requested
      */
-    virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
+    virtual QList<BufferInfo> requestBuffers(UserId user) = 0;
+
+    //! Request a list of BufferIds for a given NetworkId
+    /** \note This method is threadsafe.
+     *
+     *  \param user  The user whose buffers we request
+     *  \param networkId  The NetworkId of the network in question
+     *  \return List of BufferIds belonging to the Network
+     */
+    virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0;
 
     //! Remove permanently a buffer and it's content from the storage backend
     /** This call cannot be reverted!
@@ -243,15 +271,15 @@ class Storage : public QObject {
     /** 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
+     * \param MsgId     The Message id of the message that has been just seen
      */
-    virtual void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) = 0;
+    virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
 
-    //! Get a Hash of all last seen dates. 
-    /** This Method is called when the Quassel Core is started to restore the lastSeenDates
+    //! Get a Hash of all last seen message ids
+    /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
      * \param user      The Owner of the buffers
      */
-    virtual QHash<BufferId, QDateTime> bufferLastSeenDates(UserId user) = 0;
+    virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
 
   
     /* Message handling */
@@ -264,11 +292,11 @@ class Storage : public QObject {
 
     //! Request a certain number (or all) messages stored in a given buffer.
     /** \param buffer   The buffer we request messages from
-     *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
+     *  \param limit The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
      *  \return The requested list of messages
      */
-    virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1) = 0;
+    virtual QList<Message> requestMsgs(UserId user, BufferId buffer, int limit = -1, int offset = -1) = 0;
 
     //! Request messages stored in a given buffer since a certain point in time.
     /** \param buffer   The buffer we request messages from
@@ -276,7 +304,7 @@ class Storage : public QObject {
      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
      *  \return The requested list of messages
      */
-    virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1) = 0;
+    virtual QList<Message> requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset = -1) = 0;
 
     //! Request a range of messages stored in a given buffer.
     /** \param buffer   The buffer we request messages from
@@ -284,7 +312,7 @@ class Storage : public QObject {
      *  \param last     Return messages with first <= MsgId <= last
      *  \return The requested list of messages
      */
-    virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last) = 0;
+    virtual QList<Message> requestMsgRange(UserId user, BufferId buffer, int first, int last) = 0;
 
   signals:
     //! Sent when a new BufferInfo is created, or an existing one changed somehow.