X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=f7495f45a392e8bd87af83ba91c15ca2dae85290;hp=db68417c0f239088a7b08a7a9608f7eed7d27c8f;hb=7b4bac1b744a407d51f0ece67e0d531206ddad0b;hpb=d1b6499b0b848d4287efae89107576548533502c diff --git a/src/core/storage.h b/src/core/storage.h index db68417c..f7495f45 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 * @@ -18,155 +18,379 @@ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#ifndef _STORAGE_H_ -#define _STORAGE_H_ +#ifndef STORAGE_H +#define STORAGE_H #include +#include "types.h" +#include "coreidentity.h" #include "message.h" +#include "network.h" class Storage : public QObject { Q_OBJECT - public: - Storage(QObject *parent = 0); - virtual ~Storage() {}; - - public slots: - /* General */ - - //! Check if the storage type is available. - /** A storage subclass should return true if it can be successfully used, i.e. if all - * prerequisites are in place (e.g. we have an appropriate DB driver etc.). - * \return True if and only if the storage class can be successfully used. - */ - static bool isAvailable() { return false; } - - //! Returns the display name of the storage backend - /** \return A string that can be used by the GUI to describe the storage backend */ - static QString displayName() { return ""; } - - //! Setup the storage provider. - /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel. - * \param settings Hostname, port, username, password, ... - * \return True if and only if the storage provider was initialized successfully. - */ - virtual bool setup(const QVariantMap &settings = QVariantMap()) { Q_UNUSED(settings); return false; } - - //! Initialize the storage provider - /** \param settings Hostname, port, username, password, ... - * \return True if and only if the storage provider was initialized successfully. - */ - virtual bool init(const QVariantMap &settings = QVariantMap()) = 0; - - // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc - - /* User handling */ - - //! Add a new core user to the storage. - /** \param user The username of the new user - * \param password The cleartext password for the new user - * \return The new user's UserId - */ - virtual UserId addUser(const QString &user, const QString &password) = 0; - - //! Update a core user's password. - /** \param user The user's id - * \param password The user's new password - */ - virtual void updateUser(UserId user, const QString &password) = 0; - - //! Rename a user - /** \param user The user's id - * \param newName The user's new name - */ - virtual void renameUser(UserId user, const QString &newName) = 0; - - //! Validate a username with a given password. - /** \param user The username to validate - * \param password The user's alleged password - * \return A valid UserId if the password matches the username; 0 else - */ - virtual UserId validateUser(const QString &user, const QString &password) = 0; - - //! Remove a core user from storage. - /** \param user The userid to delete - */ - virtual void delUser(UserId user) = 0; - - /* Network handling */ - - //! Get the unique NetworkId of the network for a user. - /** \param user The core user who owns this buffername - * \param network The network name - * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found - */ - virtual uint getNetworkId(UserId user, const QString &network) = 0; - - /* Buffer handling */ - - //! Get the unique BufferInfo for the given combination of network and buffername for a user. - /** \param user The core user who owns this buffername - * \param network The network name - * \param buffer The buffer name (if empty, the net's status buffer is returned) - * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found - */ - virtual BufferInfo getBufferInfo(UserId user, const QString &network, const QString &buffer = "") = 0; - - //! 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. - * Optionally, a QDateTime can be given, so that only buffers are listed that where active - * since that point in time. - * \param user The user whose buffers we request - * \param since If this is defined, older buffers will be ignored - * \return A list of the BufferInfos for all buffers as requested - */ - virtual QList requestBuffers(UserId user, QDateTime since = QDateTime()) = 0; - - /* Message handling */ - - //! Store a Message in the backlog. - /** \param msg The message object to be stored - * \return The globally unique id for the stored message - */ - virtual MsgId logMessage(Message msg) = 0; - - //! Request a certain number (or all) messages stored in a given buffer. - /** \param buffer The buffer we request messages from - * \param lastmsgs 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 requestMsgs(BufferInfo buffer, int lastmsgs = -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 requestMsgs(BufferInfo 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 requestMsgRange(BufferInfo buffer, int first, int last) = 0; - - signals: - //! Sent when a new BufferInfo is created, or an existing one changed somehow. - void bufferInfoUpdated(UserId user, const BufferInfo &); - //! Sent when a new user has been added - void userAdded(UserId, const QString &username); - //! Sent when a user has been renamed - void userRenamed(UserId, const QString &newname); - //! Sent when a user has been removed - void userRemoved(UserId); - - 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 */ + + //! Check if the storage type is available. + /** A storage subclass should return true if it can be successfully used, i.e. if all + * prerequisites are in place (e.g. we have an appropriate DB driver etc.). + * \return True if and only if the storage class can be successfully used. + */ + virtual bool isAvailable() const = 0; + + //! Returns the display name of the storage backend + /** \return A string that can be used by the client to name the storage backend */ + virtual QString displayName() const = 0; + + //! Returns a description of this storage backend + /** \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, ... + * \return True if and only if the storage provider was initialized successfully. + */ + virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0; + + //! Initialize the storage provider + /** \param settings Hostname, port, username, password, ... + * \return the State the storage backend is now in (see Storage::State) + */ + virtual State init(const QVariantMap &settings = QVariantMap()) = 0; + + //! Makes temp data persistent + /** This Method is periodically called by the Quassel Core to make temporary + * data persistant. This reduces the data loss drastically in the + * unlikely case of a Core crash. + */ + virtual void sync() = 0; + + // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc + + /* User handling */ + + //! Add a new core user to the storage. + /** \param user The username of the new user + * \param password The cleartext password for the new user + * \return The new user's UserId + */ + virtual UserId addUser(const QString &user, const QString &password) = 0; + + //! Update a core user's password. + /** \param user The user's id + * \param password The user's new password + */ + virtual void updateUser(UserId user, const QString &password) = 0; + + //! Rename a user + /** \param user The user's id + * \param newName The user's new name + */ + virtual void renameUser(UserId user, const QString &newName) = 0; + + //! Validate a username with a given password. + /** \param user The username to validate + * \param password The user's alleged password + * \return A valid UserId if the password matches the username; 0 else + */ + virtual UserId validateUser(const QString &user, const QString &password) = 0; + + //! Determine the UserId of the internal user + /** \return A valid UserId if the password matches the username; 0 else + */ + virtual UserId internalUser() = 0; + + //! Remove a core user from storage. + /** \param user The userid to delete + */ + virtual void delUser(UserId user) = 0; + + //! Store a user setting persistently + /** + * \param userId The users Id + * \param settingName The Name of the Setting + * \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 + * \param settingName The Name of the Setting + * \param default Value to return in case it's unset. + * \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 + /** \param user The core user who owns this network + * \param networkInfo The networkInfo holding the network definition + * \return the NetworkId of the newly created Network. Possibly invalid. + */ + virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0; + + //! Apply the changes to NetworkInfo info to the storage engine + /** + * \param user The core user + * \param networkInfo The Updated NetworkInfo + * \return true if successfull. + */ + virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0; + + //! Permanently remove a Network and all the data associated with it. + /** \note This method is thredsafe. + * + * \param user The core user + * \param networkId The network to delete + * \return true if successfull. + */ + virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0; + + //! Returns a list of all NetworkInfos for the given UserId user + /** \note This method is thredsafe. + * + * \param user The core user + * \return QList. + */ + virtual QList networks(UserId user) = 0; + + //! 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 + */ + virtual QList connectedNetworks(UserId user) = 0; + + //! 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 + */ + virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0; + + //! 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 + */ + virtual QHash persistentChannels(UserId user, const NetworkId &networkId) = 0; + + //! 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 + */ + virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0; + + //! 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) + */ + 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 user The core user who owns this buffername + * \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 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 + * \param bufferId The id of the buffer + * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found. + */ + virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0; + + //! Request a list of all buffers known to a user. + /** This method is used to get a list of all buffers we have stored a backlog from. + * \param user The user whose buffers we request + * \return A list of the BufferInfos for all buffers as requested + */ + virtual QList requestBuffers(UserId user) = 0; + + //! Request a list of BufferIds for a given NetworkId + /** \note This method is threadsafe. + * + * \param user The user whose buffers we request + * \param networkId The NetworkId of the network in question + * \return List of BufferIds belonging to the Network + */ + virtual QList requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0; + + //! Remove permanently a buffer and it's content from the storage backend + /** This call cannot be reverted! + * \param user The user who is the owner of the buffer + * \param bufferId The bufferId + * \return true if successfull + */ + virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0; + + + //! Rename a Buffer + /** \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 + * \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 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 + * \param bufferId The buffer id + * \param MsgId The Message id of the message that has been just seen + */ + virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0; + + //! Get a Hash of all last seen message ids + /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds + * \param user The Owner of the buffers + */ + virtual QHash bufferLastSeenMsgIds(UserId user) = 0; + + + /* Message handling */ + + //! Store a Message in the storage backend and set its unique Id. + /** \param msg The message object to be stored + * \return true on success + */ + 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 + * \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 requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0; + + //! 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 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. + void bufferInfoUpdated(UserId user, const BufferInfo &); + //! Sent when a Buffer was renamed + void bufferRenamed(const QString &newName, const QString &oldName); + //! Sent when a new user has been added + void userAdded(UserId, const QString &username); + //! Sent when a user has been renamed + void userRenamed(UserId, const QString &newname); + //! Sent when a user has been removed + void userRemoved(UserId); + +protected: + //! when implementing a storage handler, use this method to crypt user passwords. + /** This guarantees compatibility with other storage handlers and allows easy migration + */ + QString cryptedPassword(const QString &password); };