X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=1561673183b46e984bc7bdaf280a280a8a10fd9b;hp=e52a79f127b57d96d20e2204ff81965813a4129a;hb=5ff4265bbd3a682a6d6542480760eaf4a2b85d77;hpb=de1619ce11bf386490cdb38bc1be134a391eeaae diff --git a/src/core/storage.h b/src/core/storage.h index e52a79f1..15616731 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 */ @@ -52,6 +59,14 @@ public slots: /** \return A string that can be displayed by the client to describe the storage backend */ virtual QString description() const = 0; + //! Returns a list of properties required to use the storage backend + virtual QStringList setupKeys() const = 0; + + //! Returns a map where the keys are are properties to use the storage backend + /* the values are QVariants with default values */ + virtual QVariantMap setupDefaults() const = 0; + + //! Setup the storage provider. /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel. * \param settings Hostname, port, username, password, ... @@ -60,10 +75,10 @@ public slots: virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0; //! Initialize the storage provider - /** \param settings Hostname, port, username, password, ... - * \return True if and only if the storage provider was initialized successfully. + /** \param settings Hostname, port, username, password, ... + * \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 @@ -86,8 +101,9 @@ public slots: //! Update a core user's password. /** \param user The user's id * \param password The user's new password + * \return true on success. */ - virtual void updateUser(UserId user, const QString &password) = 0; + virtual bool updateUser(UserId user, const QString &password) = 0; //! Rename a user /** \param user The user's id @@ -102,6 +118,12 @@ public slots: */ virtual UserId validateUser(const QString &user, const QString &password) = 0; + //! Check if a user with given username exists. Do not use for login purposes! + /** \param username The username to validate + * \return A valid UserId if the user exists; 0 else + */ + virtual UserId getUserId(const QString &username) = 0; + //! Determine the UserId of the internal user /** \return A valid UserId if the password matches the username; 0 else */ @@ -119,7 +141,7 @@ public slots: * \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 @@ -128,7 +150,13 @@ 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 */ //! Create a new Network in the storage backend and return it unique Id @@ -162,13 +190,6 @@ public slots: * \return QList. */ virtual QList networks(UserId user) = 0; - - //! Get the unique NetworkId of the network for a user. - /** \param user The core user who owns this network - * \param network The network name - * \return The NetworkId corresponding to the given network, or 0 if not found - */ - virtual NetworkId getNetworkId(UserId user, const QString &network) = 0; //! Get a list of Networks to restore /** Return a list of networks the user was connected at the time of core shutdown @@ -215,7 +236,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 +280,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 +316,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 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 BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0; - + 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 @@ -281,14 +349,38 @@ public slots: */ virtual QHash bufferLastSeenMsgIds(UserId user) = 0; - + //! Update the MarkerLineMsgId for a Buffer + /** This Method is used to make the marker line position 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 where the marker line should be placed + */ + virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0; + + //! Get a Hash of all marker line message ids + /** This Method is called when the Quassel Core is started to restore the MarkerLineMsgIds + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + virtual QHash bufferMarkerLineMsgIds(UserId user) = 0; + + /* Message handling */ - //! Store a Message in the backlog. + //! Store a Message in the storage backend and set its unique Id. /** \param msg The message object to be stored - * \return The globally unique id for the stored message + * \return true on success */ - virtual MsgId logMessage(Message msg) = 0; + virtual bool logMessage(Message &msg) = 0; + + //! Store a list of Messages in the storage backend and set their unique Id. + /** \param msgs The list message objects to be stored + * \return true on success + */ + virtual bool logMessages(MessageList &msgs) = 0; //! Request a certain number messages stored in a given buffer. /** \param buffer The buffer we request messages from @@ -299,12 +391,13 @@ public slots: */ virtual QList 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 requestAllNewMsgs(UserId user, int first, int limit = -1) = 0; + virtual QList 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.