X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=6470b40506bb71200233d378c0f95fe4f8f4868e;hp=66d4b20df6782cd05aa4978594430c839b396272;hb=59579d82e3a16a815a197a4300c8ef279275ccfc;hpb=d6b056e936ec441258d291b7a8af7b83f9f53016 diff --git a/src/core/storage.h b/src/core/storage.h index 66d4b20d..6470b405 100644 --- a/src/core/storage.h +++ b/src/core/storage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-07 by the Quassel IRC 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 * @@ -22,17 +22,19 @@ #define _STORAGE_H_ #include -#include +#include "types.h" #include "message.h" +struct NetworkInfo; class Storage : public QObject { Q_OBJECT public: - Storage() {}; + Storage(QObject *parent = 0); virtual ~Storage() {}; + public slots: /* General */ //! Check if the storage type is available. @@ -51,14 +53,21 @@ class Storage : public QObject { * \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()) { return false; } + 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 */ @@ -96,12 +105,19 @@ class Storage : public QObject { /* 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 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; /* Buffer handling */ @@ -111,7 +127,7 @@ class Storage : public QObject { * \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; + 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. @@ -157,7 +173,7 @@ class Storage : public QObject { 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 new user has been added void userAdded(UserId, const QString &username); //! Sent when a user has been renamed @@ -166,8 +182,7 @@ class Storage : public QObject { void userRemoved(UserId); public: - /* Exceptions */ - struct AuthError : public Exception {}; + };