Yearly copyright bump :)
[quassel.git] / src / core / storage.h
index e52a79f..fb53611 100644 (file)
@@ -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  *
@@ -24,6 +24,7 @@
 #include <QtCore>
 
 #include "types.h"
+#include "coreidentity.h"
 #include "message.h"
 #include "network.h"
 
@@ -128,6 +129,12 @@ public slots:
    * \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;
+
+  /* Identity handling */
+  virtual IdentityId createIdentity(UserId user, CoreIdentity &identity) = 0;
+  virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
+  virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
+  virtual QList<CoreIdentity> identities(UserId user) = 0;
   
   /* Network handling */
 
@@ -223,9 +230,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
@@ -258,15 +266,25 @@ public slots:
    */
   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
+  /** \note This method is threadsafe.
+   *  \param user      The id of the buffer owner
+   *  \param bufferId  The bufferId
    *  \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
+   *  \return true if successfull
    */
-  virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0;
-  
+  virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) = 0;
+
+  //! Merge the content of two Buffers permanently. This cannot be reversed!
+  /** \note This method is threadsafe.
+   *  \param user      The id of the buffer owner
+   *  \param bufferId1 The bufferId of the remaining buffer
+   *  \param bufferId2 The buffer that is about to be removed
+   *  \return true if successfull
+   */
+  virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) = 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
@@ -299,12 +317,13 @@ public slots:
    */
   virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
 
-  //! Request all unread messages for all buffers
-  /** \param first    Return messages with MsgId >= first
+  //! Request a certain number of messages across all buffers
+  /** \param first    if != -1 return only messages with a MsgId >= first
+   *  \param last     if != -1 return only messages with a MsgId < last
    *  \param limit    Max amount of messages
    *  \return The requested list of messages
    */
-  virtual QList<Message> requestAllNewMsgs(UserId user, int first, int limit = -1) = 0;
+  virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
 
 signals:
   //! Sent when a new BufferInfo is created, or an existing one changed somehow.