1 /***************************************************************************
2 * Copyright (C) 2005-07 by The Quassel Team *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
28 class Storage : public QObject {
33 virtual ~Storage() {};
35 //! Initialize the static parts of the storage class
36 /** This is called by the core before any other method of the storage backend is used.
37 * This should be used to perform any static initialization that might be necessary.
38 * DO NOT use this for creating database connection or similar stuff, since init() might be
39 * called even if the storage backend is never be actually used (because no user selected it).
40 * For anything like this, the constructor (which is called if and when we actually create an instance
41 * of the storage backend) is the right place.
43 virtual static void init() {};
47 //! Check if the storage type is available.
48 /** A storage subclass should return true if it can be successfully used, i.e. if all
49 * prerequisites are in place (e.g. we have an appropriate DB driver etc.).
50 * \return True if and only if the storage class can be successfully used.
52 virtual static bool isAvailable() = 0;
54 //! Returns the display name of the storage backend
55 /** \return A string that can be used by the GUI to describe the storage backend */
56 virtual static QString displayName() = 0;
58 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
62 //! Add a new core user to the storage.
63 /** \param user The username of the new user
64 * \param password The cleartext password for the new user
65 * \return The new user's UserId
67 virtual UserId addUser(QString user, QString password) = 0;
69 //! Update a core user's password.
70 /** \param user The user's name
71 * \param password The user's new password
73 virtual void updateUser(QString user, QString password) = 0;
75 //! Validate a username with a given password.
76 /** \param user The username to validate
77 * \param password The user's alleged password
78 * \return A valid UserId if the password matches the username; 0 else
80 virtual UserId validateUser(QString user, QString password) = 0;
82 //! Remove a core user from storage.
83 /** \param user The username to delete
85 virtual void delUser(QString user) = 0;
89 //! Get the unique BufferId for the given combination of network and buffername for a user.
90 /** \param user The core user who owns this buffername
91 * \param network The network name
92 * \param buffer The buffer name (if empty, the net's status buffer is returned)
93 * \return The BufferId corresponding to the given network and buffer name, or 0 if not found
95 virtual BufferId getBufferId(UserId user, QString network, QString buffer = "") = 0;
97 //! Request a list of all buffers known to a user since a certain point in time.
98 /** This method is used to get a list of all buffers we have stored a backlog from.
99 * Optionally, a QDateTime can be given, so that only buffers are listed that where active
100 * since that point in time.
101 * \param user The user whose buffers we request
102 * \param since If this is defined, older buffers will be ignored
103 * \return A list of the BufferIds for all buffers as requested
105 virtual QList<BufferId> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
107 /* Message handling */
109 //! Store a Message in the backlog.
110 /** \param msg The message object to be stored
111 * \return The globally uniqe id for the stored message
113 virtual MsgId logMessage(Message msg) = 0;
115 //! Request a certain number (or all) messages stored in a given buffer.
116 /** \param buffer The buffer we request messages from
117 * \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
118 * \param offset Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
119 * \return The requested list of messages
121 virtual QList<Message> requestMsgs(BufferId buffer, int lastmsgs = -1, int offset = -1) = 0;
123 //! Request messages stored in a given buffer since a certain point in time.
124 /** \param buffer The buffer we request messages from
125 * \param since Only return messages newer than this point in time
126 * \param offset Do not return messages with MsgId >= offset, if offset >= 0
127 * \return The requested list of messages
129 virtual QList<Message> requestMsgs(BufferId buffer, QDateTime since, int offset = -1) = 0;
131 //! Request a range of messages stored in a given buffer.
132 /** \param buffer The buffer we request messages from
133 * \param first Return messages with first <= MsgId <= last
134 * \param last Return messages with first <= MsgId <= last
135 * \return The requested list of messages
137 virtual QList<Message> requestMsgRange(BufferId buffer, int first, int last) = 0;
140 //! This is just for importing the old file-based backlog */
141 /** This slot needs to be implemented in the storage backends.
142 * It should first prepare (delete?) the database, then call initBackLogOld().
143 * If the importing was successful, backLogEnabledOld will be true afterwards.
145 void importOldBacklog() = 0;
148 //! Sent if a new BufferId is created, or an existing one changed somehow.
149 void bufferIdUpdated(BufferId);
152 // Old stuff, just for importing old file-based data
153 void initBackLogOld();
154 void logMessageOld(QString net, Message);
156 bool backLogEnabledOld;
158 QHash<QString, QList<Message> > backLog;
159 QHash<QString, QFile *> logFiles;
160 QHash<QString, QDataStream *> logStreams;
161 QHash<QString, QDate> logFileDates;
162 QHash<QString, QDir> logFileDirs;