X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=1cb2ee827dd9f61a3d5eb8f1bd012d3e868b8e4d;hp=d0c6afbbd011ed216b3e7b5f655eb393115f070d;hb=7c9c1b348382b8b77f96a883945c522d32a478d5;hpb=335e1e55ee8df69b37b1b4d839950ced9ac08cc4 diff --git a/src/core/storage.h b/src/core/storage.h index d0c6afbb..1cb2ee82 100644 --- a/src/core/storage.h +++ b/src/core/storage.h @@ -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,16 +24,23 @@ #include #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 */ @@ -61,9 +68,9 @@ public slots: //! 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 @@ -128,6 +135,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 identities(UserId user) = 0; /* Network handling */ @@ -215,7 +228,43 @@ public slots: * \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. @@ -223,9 +272,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 +308,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