X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=6470b40506bb71200233d378c0f95fe4f8f4868e;hp=d143443fab5c77b2c13daab86aa244c11899b512;hb=59579d82e3a16a815a197a4300c8ef279275ccfc;hpb=0ac9ce4d7cf768d13993d6aa1d6b791c4149a843 diff --git a/src/core/storage.h b/src/core/storage.h index d143443f..6470b405 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,28 +22,19 @@ #define _STORAGE_H_ #include -#include -//#include "global.h" +#include "types.h" #include "message.h" +struct NetworkInfo; 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. @@ -57,6 +48,26 @@ class Storage : public QObject { /** \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; + + //! 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 */ @@ -66,35 +77,57 @@ class Storage : public QObject { * \param password The cleartext password for the new user * \return The new user's UserId */ - virtual UserId addUser(QString user, QString password) = 0; + 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, QString password) = 0; + 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(QString user, QString password) = 0; + 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 */ + + //! Create a new unique Network in the storage backend + /** \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 createNetworkId(UserId user, const NetworkInfo &info) = 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; + /* Buffer handling */ - //! Get the unique BufferId for the given combination of network and buffername for a user. + //! 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 BufferId 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 0 if not found */ - virtual BufferId getBufferId(UserId user, QString network, QString buffer = "") = 0; + virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, 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. @@ -102,9 +135,9 @@ class Storage : public QObject { * 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 BufferIds for all buffers as requested + * \return A list of the BufferInfos for all buffers as requested */ - virtual QList requestBuffers(UserId user, QDateTime since = QDateTime()) = 0; + virtual QList requestBuffers(UserId user, QDateTime since = QDateTime()) = 0; /* Message handling */ @@ -120,7 +153,7 @@ class Storage : public QObject { * \param offset Do not return (but DO count) messages with MsgId >= offset, if offset >= 0 * \return The requested list of messages */ - virtual QList requestMsgs(BufferId buffer, int lastmsgs = -1, int offset = -1) = 0; + 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 @@ -128,7 +161,7 @@ class Storage : public QObject { * \param offset Do not return messages with MsgId >= offset, if offset >= 0 * \return The requested list of messages */ - virtual QList requestMsgs(BufferId buffer, QDateTime since, int offset = -1) = 0; + 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 @@ -136,37 +169,19 @@ class Storage : public QObject { * \param last Return messages with first <= MsgId <= last * \return The requested list of messages */ - virtual QList requestMsgRange(BufferId 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; + virtual QList requestMsgRange(BufferInfo buffer, int first, int last) = 0; signals: - //! Sent if a new BufferId is created, or an existing one changed somehow. - void bufferIdUpdated(BufferId); + //! 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: - /* 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; };