src/core/storage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _STORAGE_H_
  22 #define _STORAGE_H_
  23
  24 #include <QtCore>
  25
  26 #include "types.h"
  27 #include "message.h"
  28 #include "network.h"
  29
  30 class Storage : public QObject {
  31   Q_OBJECT
  32
  33   public:
  34     Storage(QObject *parent = 0);
  35     virtual ~Storage() {};
  36
  37   public slots:
  38     /* General */
  39
  40     //! Check if the storage type is available.
  41     /** A storage subclass should return true if it can be successfully used, i.e. if all
  42      *  prerequisites are in place (e.g. we have an appropriate DB driver etc.).
  43      * \return True if and only if the storage class can be successfully used.
  44      */
  45     virtual bool isAvailable() const = 0;
  46
  47     //! Returns the display name of the storage backend
  48     /** \return A string that can be used by the client to name the storage backend */
  49     virtual QString displayName() const = 0;
  50
  51     //! Returns a description of this storage backend
  52     /** \return A string that can be displayed by the client to describe the storage backend */
  53     virtual QString description() const = 0;
  54
  55     //! Setup the storage provider.
  56     /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
  57      *  \param settings   Hostname, port, username, password, ...
  58      *  \return True if and only if the storage provider was initialized successfully.
  59      */
  60     virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
  61
  62     //! Initialize the storage provider
  63     /** \param settings   Hostname, port, username, password, ...
  64      *  \return True if and only if the storage provider was initialized successfully.
  65      */
  66     virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
  67
  68     //! Makes temp data persistent
  69     /** This Method is periodically called by the Quassel Core to make temporary
  70     *  data persistant. This reduces the data loss drastically in the
  71     *  unlikely case of a Core crash.
  72     */
  73     virtual void sync() = 0;
  74
  75     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
  76
  77     /* User handling */
  78
  79     //! Add a new core user to the storage.
  80     /** \param user     The username of the new user
  81      *  \param password The cleartext password for the new user
  82      *  \return The new user's UserId
  83      */
  84     virtual UserId addUser(const QString &user, const QString &password) = 0;
  85
  86     //! Update a core user's password.
  87     /** \param user     The user's id
  88      *  \param password The user's new password
  89      */
  90     virtual void updateUser(UserId user, const QString &password) = 0;
  91
  92     //! Rename a user
  93     /** \param user     The user's id
  94      *  \param newName  The user's new name
  95      */
  96     virtual void renameUser(UserId user, const QString &newName) = 0;
  97
  98     //! Validate a username with a given password.
  99     /** \param user     The username to validate
 100      *  \param password The user's alleged password
 101      *  \return A valid UserId if the password matches the username; 0 else
 102      */
 103     virtual UserId validateUser(const QString &user, const QString &password) = 0;
 104
 105     //! Remove a core user from storage.
 106     /** \param user     The userid to delete
 107      */
 108     virtual void delUser(UserId user) = 0;
 109
 110     /* Network handling */
 111
 112     //! Create a new Network in the storage backend and return it unique Id
 113     /** \param user        The core user who owns this network
 114      *  \param networkInfo The networkInfo holding the network definition
 115      *  \return the NetworkId of the newly created Network. Possibly invalid.
 116      */
 117     virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
 118
 119     //! Apply the changes to NetworkInfo info to the storage engine
 120     /**
 121      *  \param user        The core user
 122      *  \param networkInfo The Updated NetworkInfo
 123      *  \return true if successfull.
 124      */
 125     virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
 126
 127     //! Permanently remove a Network and all the data associated with it.
 128     /** \note This method is thredsafe.
 129      *
 130      *  \param user        The core user
 131      *  \param networkId   The network to delete
 132      *  \return true if successfull.
 133      */
 134     virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
 135
 136     //! Returns a list of all NetworkInfos for the given UserId user
 137     /** \note This method is thredsafe.
 138      *
 139      *  \param user        The core user
 140      *  \return QList<NetworkInfo>.
 141      */
 142     virtual QList<NetworkInfo> networks(UserId user) = 0;
 143
 144     //! Get the unique NetworkId of the network for a user.
 145     /** \param user    The core user who owns this network
 146      *  \param network The network name
 147      *  \return The NetworkId corresponding to the given network, or 0 if not found
 148      */
 149     virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 150
 151     //! Get a list of Networks to restore
 152     /** Return a list of networks the user was connected at the time of core shutdown
 153      *  \note This method is threadsafe.
 154      *
 155      *  \param user  The User Id in question
 156      */
 157     virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
 158
 159     //! Update the connected state of a network
 160     /** \note This method is threadsafe
 161      *
 162      *  \param user        The Id of the networks owner
 163      *  \param networkId   The Id of the network
 164      *  \param isConnected whether the network is connected or not
 165      */
 166     virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
 167
 168     //! Get a hash of channels with their channel keys for a given network
 169     /** The keys are channel names and values are passwords (possibly empty)
 170      *  \note This method is threadsafe
 171      *
 172      *  \param user       The id of the networks owner
 173      *  \param networkId  The Id of the network
 174      */
 175     virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
 176
 177     //! Update the connected state of a channel
 178     /** \note This method is threadsafe
 179      *
 180      *  \param user       The Id of the networks owner
 181      *  \param networkId  The Id of the network
 182      *  \param channel    The name of the channel
 183      *  \param isJoined   whether the channel is connected or not
 184      */
 185     virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
 186
 187     //! Update the key of a channel
 188     /** \note This method is threadsafe
 189      *
 190      *  \param user       The Id of the networks owner
 191      *  \param networkId  The Id of the network
 192      *  \param channel    The name of the channel
 193      *  \param key        The key of the channel (possibly empty)
 194      */
 195     virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
 196
 197     /* Buffer handling */
 198
 199     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
 200     /** \param user      The core user who owns this buffername
 201      *  \param networkId The network id
 202      *  \param type      The type of the buffer (StatusBuffer, Channel, etc.)
 203      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
 204      *  \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
 205      */
 206     virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") = 0;
 207
 208     //! Get the unique BufferInfo for a bufferId
 209     /** \param user      The core user who owns this buffername
 210      *  \param bufferId  The id of the buffer
 211      *  \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
 212      */
 213     virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0;
 214
 215     //! Request a list of all buffers known to a user since a certain point in time.
 216     /** This method is used to get a list of all buffers we have stored a backlog from.
 217      *  Optionally, a QDateTime can be given, so that only buffers are listed that where active
 218      *  since that point in time.
 219      *  \param user  The user whose buffers we request
 220      *  \param since If this is defined, older buffers will be ignored
 221      *  \return A list of the BufferInfos for all buffers as requested
 222      */
 223     virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
 224
 225     //! Remove permanently a buffer and it's content from the storage backend
 226     /** This call cannot be reverted!
 227      *  \param user      The user who is the owner of the buffer
 228      *  \param bufferId  The bufferId
 229      *  \return true if successfull
 230      */
 231     virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
 232
 233     //! Rename a Buffer
 234     /** \param user      The id of the buffer owner
 235      *  \param networkId The id of the network the buffer belongs to
 236      *  \param newName   The new name of the buffer
 237      *  \param oldName   The previous name of the buffer
 238      *  \return the BufferId of the affected buffer or an invalid BufferId if not successfull
 239      */
 240     virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0;
 241
 242     //! Update the LastSeenDate for a Buffer
 243     /** This Method is used to make the LastSeenDate of a Buffer persistent
 244      * \param user      The Owner of that Buffer
 245      * \param bufferId  The buffer id
 246      * \param MsgId     The Message id of the message that has been just seen
 247      */
 248     virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
 249
 250     //! Get a Hash of all last seen message ids
 251     /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
 252      * \param user      The Owner of the buffers
 253      */
 254     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
 255
 256
 257     /* Message handling */
 258
 259     //! Store a Message in the backlog.
 260     /** \param msg  The message object to be stored
 261      *  \return The globally unique id for the stored message
 262      */
 263     virtual MsgId logMessage(Message msg) = 0;
 264
 265     //! Request a certain number (or all) messages stored in a given buffer.
 266     /** \param buffer   The buffer we request messages from
 267      *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
 268      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
 269      *  \return The requested list of messages
 270      */
 271     virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1) = 0;
 272
 273     //! Request messages stored in a given buffer since a certain point in time.
 274     /** \param buffer   The buffer we request messages from
 275      *  \param since    Only return messages newer than this point in time
 276      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
 277      *  \return The requested list of messages
 278      */
 279     virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1) = 0;
 280
 281     //! Request a range of messages stored in a given buffer.
 282     /** \param buffer   The buffer we request messages from
 283      *  \param first    Return messages with first <= MsgId <= last
 284      *  \param last     Return messages with first <= MsgId <= last
 285      *  \return The requested list of messages
 286      */
 287     virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last) = 0;
 288
 289   signals:
 290     //! Sent when a new BufferInfo is created, or an existing one changed somehow.
 291     void bufferInfoUpdated(UserId user, const BufferInfo &);
 292     //! Sent when a Buffer was renamed
 293     void bufferRenamed(const QString &newName, const QString &oldName);
 294     //! Sent when a new user has been added
 295     void userAdded(UserId, const QString &username);
 296     //! Sent when a user has been renamed
 297     void userRenamed(UserId, const QString &newname);
 298     //! Sent when a user has been removed
 299     void userRemoved(UserId);
 300
 301   protected:
 302     //! when implementing a storage handler, use this method to crypt user passwords.
 303     /**  This guarantees compatibility with other storage handlers and allows easy migration
 304      */
 305     QString cryptedPassword(const QString &password);
 306 };
 307
 308
 309 #endif