X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=ee4cbfe3089cad143d11d9583fc1014287640c31;hp=f493721cfe1b216e102777cdc5dec57c6fe15f69;hb=cd0868fff76dd067470881134fd736e1a1d97e71;hpb=902c95728306e5ba115de84800fc8d5d239c9d62 diff --git a/src/core/storage.h b/src/core/storage.h index f493721c..ee4cbfe3 100644 --- a/src/core/storage.h +++ b/src/core/storage.h @@ -1,11 +1,11 @@ /*************************************************************************** - * Copyright (C) 2005-07 by The Quassel Team * + * Copyright (C) 2005-08 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * + * (at your option) version 3. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -22,27 +22,19 @@ #define _STORAGE_H_ #include -#include +#include "types.h" #include "message.h" +#include "network.h" class Storage : public QObject { Q_OBJECT public: - Storage() {}; + Storage(QObject *parent = 0); virtual ~Storage() {}; - //! Initialize the static parts of the storage class - /** This is called by the core before any other method of the storage backend is used. - * This should be used to perform any static initialization that might be necessary. - * DO NOT use this for creating database connection or similar stuff, since init() might be - * called even if the storage backend is never be actually used (because no user selected it). - * For anything like this, the constructor (which is called if and when we actually create an instance - * of the storage backend) is the right place. - */ - static void init() {}; - + public slots: /* General */ //! Check if the storage type is available. @@ -50,11 +42,35 @@ class Storage : public QObject { * 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; } + virtual bool isAvailable() const = 0; //! 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 ""; } + /** \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; + + //! 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 True if and only if the storage provider was initialized successfully. + */ + virtual bool 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 @@ -93,22 +109,108 @@ class Storage : public QObject { /* 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 the unique NetworkId of the network for a user. - /** \param user The core user who owns this buffername + /** \param user The core user who owns this network * \param network The network name - * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found + * \return The NetworkId corresponding to the given network, or 0 if not found */ - virtual uint getNetworkId(UserId user, const QString &network) = 0; + 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 + * \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; + /* 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 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) - * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found + * \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; + + //! 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 QString &network, const QString &buffer = "") = 0; + virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 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. @@ -120,6 +222,38 @@ class Storage : public QObject { */ virtual QList requestBuffers(UserId user, QDateTime since = QDateTime()) = 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 + /** \param user The id of the buffer owner + * \param networkId The id of the network the buffer belongs to + * \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 + */ + virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 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 seenDate Time the Buffer has been visited the last time + */ + virtual void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) = 0; + + //! Get a Hash of all last seen dates. + /** This Method is called when the Quassel Core is started to restore the lastSeenDates + * \param user The Owner of the buffers + */ + virtual QHash bufferLastSeenDates(UserId user) = 0; + + /* Message handling */ //! Store a Message in the backlog. @@ -152,17 +286,11 @@ class Storage : public QObject { */ virtual QList requestMsgRange(BufferInfo buffer, int first, int last) = 0; - public slots: - //! This is just for importing the old file-based backlog */ - /** This slot needs to be implemented in the storage backends. - * It should first prepare (delete?) the database, then call initBackLogOld(UserId id). - * If the importing was successful, backLogEnabledOld will be true afterwards. - */ - virtual void importOldBacklog() = 0; - signals: //! Sent when a new BufferInfo is created, or an existing one changed somehow. - void bufferInfoUpdated(BufferInfo); + 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 @@ -170,24 +298,11 @@ class Storage : public QObject { //! Sent when a user has been removed void userRemoved(UserId); - public: - /* Exceptions */ - struct AuthError : public Exception {}; - protected: - // Old stuff, just for importing old file-based data - void initBackLogOld(UserId id); - - QSqlDatabase logDb; // FIXME this does not belong in the base class! - - bool backLogEnabledOld; - QDir backLogDir; - QHash > backLog; - QHash logFiles; - QHash logStreams; - QHash logFileDates; - QHash logFileDirs; - + //! 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); };