Lots of new internal stuff (breaking protocol):
[quassel.git] / src / core / core.h
index 67b3a55..19d6541 100644 (file)
@@ -97,6 +97,52 @@ class Core : public QObject {
      */
     static NetworkId networkId(UserId user, const QString &network);
 
+    //! 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
+     */
+    static QList<NetworkId> connectedNetworks(UserId user);
+
+    //! 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
+     */
+    static void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
+
+    //! 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
+     */
+    static QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
+
+    //! 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
+     */
+    static void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
+
+    //! 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)
+     */
+    static void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
+
     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
     /** \note This method is threadsafe.
      *
@@ -108,6 +154,15 @@ class Core : public QObject {
      */
     static BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type, const QString &buffer = "");
 
+    //! Get the unique BufferInfo for a bufferId
+    /** \note This method is threadsafe
+     *  \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.
+     */
+    static BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
+
+  
     //! Store a Message in the backlog.
     /** \note This method is threadsafe.
      *
@@ -124,7 +179,7 @@ class Core : public QObject {
      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
      *  \return The requested list of messages
      */
-    static QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1);
+    static QList<Message> requestMsgs(UserId user, BufferId buffer, int lastmsgs = -1, int offset = -1);
 
     //! Request messages stored in a given buffer since a certain point in time.
     /** \note This method is threadsafe.
@@ -134,7 +189,7 @@ class Core : public QObject {
      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
      *  \return The requested list of messages
      */
-    static QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1);
+    static QList<Message> requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset = -1);
 
     //! Request a range of messages stored in a given buffer.
     /** \note This method is threadsafe.
@@ -144,7 +199,7 @@ class Core : public QObject {
      *  \param last     Return messages with first <= MsgId <= last
      *  \return The requested list of messages
      */
-    static QList<Message> requestMsgRange(BufferInfo buffer, int first, int last);
+    static QList<Message> requestMsgRange(UserId user, BufferId buffer, int first, int last);
 
     //! 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.
@@ -158,6 +213,44 @@ class Core : public QObject {
      */
     static QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime());
 
+    //! Remove permanently a buffer and it's content from the storage backend
+    /** This call cannot be reverted!
+     *  \note This method is threadsafe.
+     *
+     *  \param user      The user who is the owner of the buffer
+     *  \param bufferId  The bufferId
+     *  \return true if successfull
+     */
+    static bool removeBuffer(const UserId &user, const BufferId &bufferId);
+
+    //! Rename a Buffer
+    /** \note This method is threadsafe.
+     *  \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
+     */
+    static BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName);
+
+    //! Update the LastSeenDate for a Buffer
+    /** This Method is used to make the LastSeenDate of a Buffer persistent
+     *  \note This method is threadsafe.
+     *
+     * \param user      The Owner of that Buffer
+     * \param bufferId  The buffer id
+     * \param MsgId     The Message id of the message that has been just seen
+     */
+    static void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
+
+    //! Get a Hash of all last seen message ids
+    /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
+     *  \note This method is threadsafe.
+     *
+     * \param user      The Owner of the buffers
+     */
+    static QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
+
   public slots:
     //! Make storage data persistent
     /** \note This method is threadsafe.