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     //! Store a user setting persistently
 111     /**
 112      * \param userId       The users Id
 113      * \param settingName  The Name of the Setting
 114      * \param data         The Value
 115      */
 116     virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
 117
 118     //! Retrieve a persistent user setting
 119     /**
 120      * \param userId       The users Id
 121      * \param settingName  The Name of the Setting
 122      * \param default      Value to return in case it's unset.
 123      * \return the Value of the Setting or the default value if it is unset.
 124      */
 125     virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
 126
 127     /* Network handling */
 128
 129     //! Create a new Network in the storage backend and return it unique Id
 130     /** \param user        The core user who owns this network
 131      *  \param networkInfo The networkInfo holding the network definition
 132      *  \return the NetworkId of the newly created Network. Possibly invalid.
 133      */
 134     virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
 135
 136     //! Apply the changes to NetworkInfo info to the storage engine
 137     /**
 138      *  \param user        The core user
 139      *  \param networkInfo The Updated NetworkInfo
 140      *  \return true if successfull.
 141      */
 142     virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
 143
 144     //! Permanently remove a Network and all the data associated with it.
 145     /** \note This method is thredsafe.
 146      *
 147      *  \param user        The core user
 148      *  \param networkId   The network to delete
 149      *  \return true if successfull.
 150      */
 151     virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
 152
 153     //! Returns a list of all NetworkInfos for the given UserId user
 154     /** \note This method is thredsafe.
 155      *
 156      *  \param user        The core user
 157      *  \return QList<NetworkInfo>.
 158      */
 159     virtual QList<NetworkInfo> networks(UserId user) = 0;
 160
 161     //! Get the unique NetworkId of the network for a user.
 162     /** \param user    The core user who owns this network
 163      *  \param network The network name
 164      *  \return The NetworkId corresponding to the given network, or 0 if not found
 165      */
 166     virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 167
 168     //! Get a list of Networks to restore
 169     /** Return a list of networks the user was connected at the time of core shutdown
 170      *  \note This method is threadsafe.
 171      *
 172      *  \param user  The User Id in question
 173      */
 174     virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
 175
 176     //! Update the connected state of a network
 177     /** \note This method is threadsafe
 178      *
 179      *  \param user        The Id of the networks owner
 180      *  \param networkId   The Id of the network
 181      *  \param isConnected whether the network is connected or not
 182      */
 183     virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
 184
 185     //! Get a hash of channels with their channel keys for a given network
 186     /** The keys are channel names and values are passwords (possibly empty)
 187      *  \note This method is threadsafe
 188      *
 189      *  \param user       The id of the networks owner
 190      *  \param networkId  The Id of the network
 191      */
 192     virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
 193
 194     //! Update the connected state of a channel
 195     /** \note This method is threadsafe
 196      *
 197      *  \param user       The Id of the networks owner
 198      *  \param networkId  The Id of the network
 199      *  \param channel    The name of the channel
 200      *  \param isJoined   whether the channel is connected or not
 201      */
 202     virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
 203
 204     //! Update the key of a channel
 205     /** \note This method is threadsafe
 206      *
 207      *  \param user       The Id of the networks owner
 208      *  \param networkId  The Id of the network
 209      *  \param channel    The name of the channel
 210      *  \param key        The key of the channel (possibly empty)
 211      */
 212     virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
 213
 214     /* Buffer handling */
 215
 216     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
 217     /** \param user      The core user who owns this buffername
 218      *  \param networkId The network id
 219      *  \param type      The type of the buffer (StatusBuffer, Channel, etc.)
 220      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
 221      *  \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
 222      */
 223     virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") = 0;
 224
 225     //! Get the unique BufferInfo for a bufferId
 226     /** \param user      The core user who owns this buffername
 227      *  \param bufferId  The id of the buffer
 228      *  \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
 229      */
 230     virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0;
 231
 232     //! Request a list of all buffers known to a user.
 233     /** This method is used to get a list of all buffers we have stored a backlog from.
 234      *  \param user  The user whose buffers we request
 235      *  \return A list of the BufferInfos for all buffers as requested
 236      */
 237     virtual QList<BufferInfo> requestBuffers(UserId user) = 0;
 238
 239     //! Request a list of BufferIds for a given NetworkId
 240     /** \note This method is threadsafe.
 241      *
 242      *  \param user  The user whose buffers we request
 243      *  \param networkId  The NetworkId of the network in question
 244      *  \return List of BufferIds belonging to the Network
 245      */
 246     virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0;
 247
 248     //! Remove permanently a buffer and it's content from the storage backend
 249     /** This call cannot be reverted!
 250      *  \param user      The user who is the owner of the buffer
 251      *  \param bufferId  The bufferId
 252      *  \return true if successfull
 253      */
 254     virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
 255
 256     //! Rename a Buffer
 257     /** \param user      The id of the buffer owner
 258      *  \param networkId The id of the network the buffer belongs to
 259      *  \param newName   The new name of the buffer
 260      *  \param oldName   The previous name of the buffer
 261      *  \return the BufferId of the affected buffer or an invalid BufferId if not successfull
 262      */
 263     virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0;
 264
 265     //! Update the LastSeenDate for a Buffer
 266     /** This Method is used to make the LastSeenDate of a Buffer persistent
 267      * \param user      The Owner of that Buffer
 268      * \param bufferId  The buffer id
 269      * \param MsgId     The Message id of the message that has been just seen
 270      */
 271     virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
 272
 273     //! Get a Hash of all last seen message ids
 274     /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
 275      * \param user      The Owner of the buffers
 276      */
 277     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
 278
 279
 280     /* Message handling */
 281
 282     //! Store a Message in the backlog.
 283     /** \param msg  The message object to be stored
 284      *  \return The globally unique id for the stored message
 285      */
 286     virtual MsgId logMessage(Message msg) = 0;
 287
 288     //! Request a certain number (or all) messages stored in a given buffer.
 289     /** \param buffer   The buffer we request messages from
 290      *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
 291      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
 292      *  \return The requested list of messages
 293      */
 294     virtual QList<Message> requestMsgs(UserId user, BufferId buffer, int lastmsgs = -1, int offset = -1) = 0;
 295
 296     //! Request messages stored in a given buffer since a certain point in time.
 297     /** \param buffer   The buffer we request messages from
 298      *  \param since    Only return messages newer than this point in time
 299      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
 300      *  \return The requested list of messages
 301      */
 302     virtual QList<Message> requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset = -1) = 0;
 303
 304     //! Request a range of messages stored in a given buffer.
 305     /** \param buffer   The buffer we request messages from
 306      *  \param first    Return messages with first <= MsgId <= last
 307      *  \param last     Return messages with first <= MsgId <= last
 308      *  \return The requested list of messages
 309      */
 310     virtual QList<Message> requestMsgRange(UserId user, BufferId buffer, int first, int last) = 0;
 311
 312   signals:
 313     //! Sent when a new BufferInfo is created, or an existing one changed somehow.
 314     void bufferInfoUpdated(UserId user, const BufferInfo &);
 315     //! Sent when a Buffer was renamed
 316     void bufferRenamed(const QString &newName, const QString &oldName);
 317     //! Sent when a new user has been added
 318     void userAdded(UserId, const QString &username);
 319     //! Sent when a user has been renamed
 320     void userRenamed(UserId, const QString &newname);
 321     //! Sent when a user has been removed
 322     void userRemoved(UserId);
 323
 324   protected:
 325     //! when implementing a storage handler, use this method to crypt user passwords.
 326     /**  This guarantees compatibility with other storage handlers and allows easy migration
 327      */
 328     QString cryptedPassword(const QString &password);
 329 };
 330
 331
 332 #endif