/***************************************************************************
- * 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 *
#include <QtCore>
#include "types.h"
+#include "coreidentity.h"
#include "message.h"
#include "network.h"
class Storage : public QObject {
Q_OBJECT
- public:
+public:
Storage(QObject *parent = 0);
virtual ~Storage() {};
+ enum State {
+ IsReady, // ready to go
+ NeedsSetup, // need basic setup (ask the user for input)
+ NotAvailable // remove the storage backend from the list of avaliable backends
+ };
+
public slots:
/* General */
//! Initialize the storage provider
/** \param settings Hostname, port, username, password, ...
- * \return True if and only if the storage provider was initialized successfully.
+ * \return the State the storage backend is now in (see Storage::State)
*/
- virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
+ virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
//! Makes temp data persistent
/** This Method is periodically called by the Quassel Core to make temporary
* \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 */
* \param key The key of the channel (possibly empty)
*/
virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
-
+
+ //! retrieve last known away message for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ */
+ virtual QString awayMessage(UserId user, NetworkId networkId) = 0;
+
+ //! Make away message persistent for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param awayMsg The current away message of own user
+ */
+ virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) = 0;
+
+
+ //! retrieve last known user mode for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ */
+ virtual QString userModes(UserId user, NetworkId networkId) = 0;
+
+ //! Make our user modes persistent for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param userModes The current user modes of own user
+ */
+ virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes) = 0;
+
+
/* Buffer handling */
//! Get the unique BufferInfo for the given combination of network and buffername for a user.
* \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
*/
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
*/
virtual MsgId logMessage(Message msg) = 0;
- //! Request a certain number (or all) messages stored in a given buffer.
+ //! Request a certain number messages stored in a given buffer.
/** \param buffer The buffer we request messages from
- * \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(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
- * \param since Only return messages newer than this point in time
- * \param offset Do not return messages with MsgId >= offset, if offset >= 0
- * \return The requested list of messages
- */
- 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
- * \param first Return messages with first <= MsgId <= last
- * \param last Return messages with first <= MsgId <= last
- * \return The requested list of messages
- */
- virtual QList<Message> requestMsgRange(UserId user, BufferId buffer, int first, int last) = 0;
-
- //! Request all unread messages
- /** \param buffer The buffer we request messages from
- * \param first Return messages with first <= MsgId
- * \param limit Max amount of messages
+ * \param first if != -1 return only messages with a MsgId >= first
+ * \param last if != -1 return only messages with a MsgId < last
+ * \param limit if != -1 limit the returned list to a max of \limit entries
* \return The requested list of messages
*/
- virtual QList<Message> requestNewMsgs(UserId user, BufferId bufferId, int first, int limit = -1) = 0;
+ 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 first <= MsgId
+ //! 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.
projects / quassel.git / blobdiff