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 struct NetworkInfo;
  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     static bool isAvailable() { return false; }
  46
  47     //! Returns the display name of the storage backend
  48     /** \return A string that can be used by the GUI to describe the storage backend */
  49     static QString displayName() { return ""; }
  50
  51     //! Setup the storage provider.
  52     /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
  53      *  \param settings   Hostname, port, username, password, ...
  54      *  \return True if and only if the storage provider was initialized successfully.
  55      */
  56     virtual bool setup(const QVariantMap &settings = QVariantMap()) { Q_UNUSED(settings); return false; }
  57
  58     //! Initialize the storage provider
  59     /** \param settings   Hostname, port, username, password, ...
  60      *  \return True if and only if the storage provider was initialized successfully.
  61      */
  62     virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
  63
  64   //! Makes temp data persistent
  65   /** This Method is periodically called by the Quassel Core to make temporary
  66    *  data persistant. This reduces the data loss drastically in the
  67    *  unlikely case of a Core crash.
  68    */
  69     virtual void sync() = 0;
  70
  71     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
  72
  73     /* User handling */
  74
  75     //! Add a new core user to the storage.
  76     /** \param user     The username of the new user
  77      *  \param password The cleartext password for the new user
  78      *  \return The new user's UserId
  79      */
  80     virtual UserId addUser(const QString &user, const QString &password) = 0;
  81
  82     //! Update a core user's password.
  83     /** \param user     The user's id
  84      *  \param password The user's new password
  85      */
  86     virtual void updateUser(UserId user, const QString &password) = 0;
  87
  88     //! Rename a user
  89     /** \param user     The user's id
  90      *  \param newName  The user's new name
  91      */
  92     virtual void renameUser(UserId user, const QString &newName) = 0;
  93
  94     //! Validate a username with a given password.
  95     /** \param user     The username to validate
  96      *  \param password The user's alleged password
  97      *  \return A valid UserId if the password matches the username; 0 else
  98      */
  99     virtual UserId validateUser(const QString &user, const QString &password) = 0;
 100
 101     //! Remove a core user from storage.
 102     /** \param user     The userid to delete
 103      */
 104     virtual void delUser(UserId user) = 0;
 105
 106     /* Network handling */
 107
 108     //! Create a new unique Network in the storage backend
 109     /** \param user        The core user who owns this network
 110      *  \param networkInfo The networkInfo holding the network definition
 111      *  \return the NetworkId of the newly created Network. Possibly invalid.
 112      */
 113     virtual NetworkId createNetworkId(UserId user, const NetworkInfo &info) = 0;
 114
 115     //! Get the unique NetworkId of the network for a user.
 116     /** \param user    The core user who owns this network
 117      *  \param network The network name
 118      *  \return The NetworkId corresponding to the given network, or 0 if not found
 119      */
 120     virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 121
 122     /* Buffer handling */
 123
 124     //! Get the unique BufferInfo for the given combination of network and buffername for a user.
 125     /** \param user    The core user who owns this buffername
 126      *  \param network The network name
 127      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
 128      *  \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
 129      */
 130     virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, const QString &buffer = "") = 0;
 131
 132     //! Request a list of all buffers known to a user since a certain point in time.
 133     /** This method is used to get a list of all buffers we have stored a backlog from.
 134      *  Optionally, a QDateTime can be given, so that only buffers are listed that where active
 135      *  since that point in time.
 136      *  \param user  The user whose buffers we request
 137      *  \param since If this is defined, older buffers will be ignored
 138      *  \return A list of the BufferInfos for all buffers as requested
 139      */
 140     virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
 141
 142     /* Message handling */
 143
 144     //! Store a Message in the backlog.
 145     /** \param msg  The message object to be stored
 146      *  \return The globally unique id for the stored message
 147      */
 148     virtual MsgId logMessage(Message msg) = 0;
 149
 150     //! Request a certain number (or all) messages stored in a given buffer.
 151     /** \param buffer   The buffer we request messages from
 152      *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
 153      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
 154      *  \return The requested list of messages
 155      */
 156     virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1) = 0;
 157
 158     //! Request messages stored in a given buffer since a certain point in time.
 159     /** \param buffer   The buffer we request messages from
 160      *  \param since    Only return messages newer than this point in time
 161      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
 162      *  \return The requested list of messages
 163      */
 164     virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1) = 0;
 165
 166     //! Request a range of messages stored in a given buffer.
 167     /** \param buffer   The buffer we request messages from
 168      *  \param first    Return messages with first <= MsgId <= last
 169      *  \param last     Return messages with first <= MsgId <= last
 170      *  \return The requested list of messages
 171      */
 172     virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last) = 0;
 173
 174   signals:
 175     //! Sent when a new BufferInfo is created, or an existing one changed somehow.
 176     void bufferInfoUpdated(UserId user, const BufferInfo &);
 177     //! Sent when a new user has been added
 178     void userAdded(UserId, const QString &username);
 179     //! Sent when a user has been renamed
 180     void userRenamed(UserId, const QString &newname);
 181     //! Sent when a user has been removed
 182     void userRemoved(UserId);
 183
 184   public:
 185
 186 };
 187
 188
 189 #endif