1 /***************************************************************************
2 * Copyright (C) 2005-08 by the Quassel Project *
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) version 3. *
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 ***************************************************************************/
30 class Storage : public QObject {
34 Storage(QObject *parent = 0);
35 virtual ~Storage() {};
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.
45 virtual bool isAvailable() const = 0;
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;
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;
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.
60 virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
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.
66 virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
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.
73 virtual void sync() = 0;
75 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
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
84 virtual UserId addUser(const QString &user, const QString &password) = 0;
86 //! Update a core user's password.
87 /** \param user The user's id
88 * \param password The user's new password
90 virtual void updateUser(UserId user, const QString &password) = 0;
93 /** \param user The user's id
94 * \param newName The user's new name
96 virtual void renameUser(UserId user, const QString &newName) = 0;
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
103 virtual UserId validateUser(const QString &user, const QString &password) = 0;
105 //! Remove a core user from storage.
106 /** \param user The userid to delete
108 virtual void delUser(UserId user) = 0;
110 /* Network handling */
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.
117 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
119 //! Apply the changes to NetworkInfo info to the storage engine
120 /** \note This method is thredsafe.
122 * \param user The core user
123 * \param networkInfo The Updated NetworkInfo
124 * \return true if successfull.
126 virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
128 //! Permanently remove a Network and all the data associated with it.
129 /** \note This method is thredsafe.
131 * \param user The core user
132 * \param networkId The network to delete
133 * \return true if successfull.
135 virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
137 //! Returns a list of all NetworkInfos for the given UserId user
138 /** \note This method is thredsafe.
140 * \param user The core user
141 * \return QList<NetworkInfo>.
143 virtual QList<NetworkInfo> networks(UserId user) = 0;
145 //! Get the unique NetworkId of the network for a user.
146 /** \param user The core user who owns this network
147 * \param network The network name
148 * \return The NetworkId corresponding to the given network, or 0 if not found
150 virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
152 /* Buffer handling */
154 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
155 /** \param user The core user who owns this buffername
156 * \param network The network name
157 * \param buffer The buffer name (if empty, the net's status buffer is returned)
158 * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
160 virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, const QString &buffer = "") = 0;
162 //! Request a list of all buffers known to a user since a certain point in time.
163 /** This method is used to get a list of all buffers we have stored a backlog from.
164 * Optionally, a QDateTime can be given, so that only buffers are listed that where active
165 * since that point in time.
166 * \param user The user whose buffers we request
167 * \param since If this is defined, older buffers will be ignored
168 * \return A list of the BufferInfos for all buffers as requested
170 virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
172 /* Message handling */
174 //! Store a Message in the backlog.
175 /** \param msg The message object to be stored
176 * \return The globally unique id for the stored message
178 virtual MsgId logMessage(Message msg) = 0;
180 //! Request a certain number (or all) messages stored in a given buffer.
181 /** \param buffer The buffer we request messages from
182 * \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
183 * \param offset Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
184 * \return The requested list of messages
186 virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1) = 0;
188 //! Request messages stored in a given buffer since a certain point in time.
189 /** \param buffer The buffer we request messages from
190 * \param since Only return messages newer than this point in time
191 * \param offset Do not return messages with MsgId >= offset, if offset >= 0
192 * \return The requested list of messages
194 virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1) = 0;
196 //! Request a range of messages stored in a given buffer.
197 /** \param buffer The buffer we request messages from
198 * \param first Return messages with first <= MsgId <= last
199 * \param last Return messages with first <= MsgId <= last
200 * \return The requested list of messages
202 virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last) = 0;
205 //! Sent when a new BufferInfo is created, or an existing one changed somehow.
206 void bufferInfoUpdated(UserId user, const BufferInfo &);
207 //! Sent when a new user has been added
208 void userAdded(UserId, const QString &username);
209 //! Sent when a user has been renamed
210 void userRenamed(UserId, const QString &newname);
211 //! Sent when a user has been removed
212 void userRemoved(UserId);