src/core/storage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-07 by The Quassel Team                             *
   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) any later version.                                   *
   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 #include <QSqlDatabase>
  26
  27 #include "message.h"
  28
  29 class Storage : public QObject {
  30   Q_OBJECT
  31
  32   public:
  33     Storage() {};
  34     virtual ~Storage() {};
  35
  36     //! Initialize the static parts of the storage class
  37     /** This is called by the core before any other method of the storage backend is used.
  38      *  This should be used to perform any static initialization that might be necessary.
  39      *  DO NOT use this for creating database connection or similar stuff, since init() might be
  40      *  called even if the storage backend is never be actually used (because no user selected it).
  41      *  For anything like this, the constructor (which is called if and when we actually create an instance
  42      *  of the storage backend) is the right place.
  43      */
  44     static void init() {};
  45
  46     /* General */
  47
  48     //! Check if the storage type is available.
  49     /** A storage subclass should return true if it can be successfully used, i.e. if all
  50      *  prerequisites are in place (e.g. we have an appropriate DB driver etc.).
  51      * \return True if and only if the storage class can be successfully used.
  52      */
  53     static bool isAvailable() { return false; }
  54
  55     //! Returns the display name of the storage backend
  56     /** \return A string that can be used by the GUI to describe the storage backend */
  57     static QString displayName() { return ""; }
  58
  59     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
  60
  61     /* User handling */
  62
  63     //! Add a new core user to the storage.
  64     /** \param user     The username of the new user
  65      *  \param password The cleartext password for the new user
  66      *  \return The new user's UserId
  67      */
  68     virtual UserId addUser(const QString &user, const QString &password) = 0;
  69
  70     //! Update a core user's password.
  71     /** \param user     The user's id
  72      *  \param password The user's new password
  73      */
  74     virtual void updateUser(UserId user, const QString &password) = 0;
  75
  76     //! Rename a user
  77     /** \param user     The user's id
  78      *  \param newName  The user's new name
  79      */
  80     virtual void renameUser(UserId user, const QString &newName) = 0;
  81
  82     //! Validate a username with a given password.
  83     /** \param user     The username to validate
  84      *  \param password The user's alleged password
  85      *  \return A valid UserId if the password matches the username; 0 else
  86      */
  87     virtual UserId validateUser(const QString &user, const QString &password) = 0;
  88
  89     //! Remove a core user from storage.
  90     /** \param user     The userid to delete
  91      */
  92     virtual void delUser(UserId user) = 0;
  93
  94     /* Network handling */
  95
  96     //! Get the unique NetworkId of the network for a user.
  97     /** \param user    The core user who owns this buffername
  98      *  \param network The network name
  99      *  \return The BufferId corresponding to the given network and buffer name, or 0 if not found
 100      */
 101     virtual uint getNetworkId(UserId user, const QString &network) = 0;
 102
 103     /* Buffer handling */
 104
 105     //! Get the unique BufferId for the given combination of network and buffername for a user.
 106     /** \param user    The core user who owns this buffername
 107      *  \param network The network name
 108      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
 109      *  \return The BufferId corresponding to the given network and buffer name, or 0 if not found
 110      */
 111     virtual BufferId getBufferId(UserId user, const QString &network, const QString &buffer = "") = 0;
 112
 113     //! Request a list of all buffers known to a user since a certain point in time.
 114     /** This method is used to get a list of all buffers we have stored a backlog from.
 115      *  Optionally, a QDateTime can be given, so that only buffers are listed that where active
 116      *  since that point in time.
 117      *  \param user  The user whose buffers we request
 118      *  \param since If this is defined, older buffers will be ignored
 119      *  \return A list of the BufferIds for all buffers as requested
 120      */
 121     virtual QList<BufferId> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
 122
 123     /* Message handling */
 124
 125     //! Store a Message in the backlog.
 126     /** \param msg  The message object to be stored
 127      *  \return The globally unique id for the stored message
 128      */
 129     virtual MsgId logMessage(Message msg) = 0;
 130
 131     //! Request a certain number (or all) messages stored in a given buffer.
 132     /** \param buffer   The buffer we request messages from
 133      *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
 134      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
 135      *  \return The requested list of messages
 136      */
 137     virtual QList<Message> requestMsgs(BufferId buffer, int lastmsgs = -1, int offset = -1) = 0;
 138
 139     //! Request messages stored in a given buffer since a certain point in time.
 140     /** \param buffer   The buffer we request messages from
 141      *  \param since    Only return messages newer than this point in time
 142      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
 143      *  \return The requested list of messages
 144      */
 145     virtual QList<Message> requestMsgs(BufferId buffer, QDateTime since, int offset = -1) = 0;
 146
 147     //! Request a range of messages stored in a given buffer.
 148     /** \param buffer   The buffer we request messages from
 149      *  \param first    Return messages with first <= MsgId <= last
 150      *  \param last     Return messages with first <= MsgId <= last
 151      *  \return The requested list of messages
 152      */
 153     virtual QList<Message> requestMsgRange(BufferId buffer, int first, int last) = 0;
 154
 155   public slots:
 156     //! This is just for importing the old file-based backlog */
 157     /** This slot needs to be implemented in the storage backends.
 158      *  It should first prepare (delete?) the database, then call initBackLogOld(UserId id).
 159      *  If the importing was successful, backLogEnabledOld will be true afterwards.
 160      */
 161     virtual void importOldBacklog() = 0;
 162
 163   signals:
 164     //! Sent when a new BufferId is created, or an existing one changed somehow.
 165     void bufferIdUpdated(BufferId);
 166     //! Sent when a new user has been added
 167     void userAdded(UserId, const QString &username);
 168     //! Sent when a user has been renamed
 169     void userRenamed(UserId, const QString &newname);
 170     //! Sent when a user has been removed
 171     void userRemoved(UserId);
 172
 173   public:
 174     /* Exceptions */
 175     struct AuthError : public Exception {};
 176
 177   protected:
 178     // Old stuff, just for importing old file-based data
 179     void initBackLogOld(UserId id);
 180
 181     QSqlDatabase logDb; // FIXME this does not belong in the base class!
 182
 183     bool backLogEnabledOld;
 184     QDir backLogDir;
 185     QHash<QString, QList<Message> > backLog;
 186     QHash<QString, QFile *> logFiles;
 187     QHash<QString, QDataStream *> logStreams;
 188     QHash<QString, QDate> logFileDates;
 189     QHash<QString, QDir> logFileDirs;
 190
 191 };
 192
 193
 194 #endif