1 /***************************************************************************
2 * Copyright (C) 2005-09 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 ***************************************************************************/
27 #include "coreidentity.h"
31 class Storage : public QObject {
35 Storage(QObject *parent = 0);
36 virtual ~Storage() {};
39 IsReady, // ready to go
40 NeedsSetup, // need basic setup (ask the user for input)
41 NotAvailable // remove the storage backend from the list of avaliable backends
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 bool isAvailable() const = 0;
54 //! Returns the display name of the storage backend
55 /** \return A string that can be used by the client to name the storage backend */
56 virtual QString displayName() const = 0;
58 //! Returns a description of this storage backend
59 /** \return A string that can be displayed by the client to describe the storage backend */
60 virtual QString description() const = 0;
62 //! Returns a list of properties required to use the storage backend
63 virtual QStringList setupKeys() const = 0;
65 //! Returns a map where the keys are are properties to use the storage backend
66 /* the values are QVariants with default values */
67 virtual QVariantMap setupDefaults() const = 0;
70 //! Setup the storage provider.
71 /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
72 * \param settings Hostname, port, username, password, ...
73 * \return True if and only if the storage provider was initialized successfully.
75 virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
77 //! Initialize the storage provider
78 /** \param settings Hostname, port, username, password, ...
79 * \return the State the storage backend is now in (see Storage::State)
81 virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
83 //! Makes temp data persistent
84 /** This Method is periodically called by the Quassel Core to make temporary
85 * data persistant. This reduces the data loss drastically in the
86 * unlikely case of a Core crash.
88 virtual void sync() = 0;
90 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
94 //! Add a new core user to the storage.
95 /** \param user The username of the new user
96 * \param password The cleartext password for the new user
97 * \return The new user's UserId
99 virtual UserId addUser(const QString &user, const QString &password) = 0;
101 //! Update a core user's password.
102 /** \param user The user's id
103 * \param password The user's new password
104 * \return true on success.
106 virtual bool updateUser(UserId user, const QString &password) = 0;
109 /** \param user The user's id
110 * \param newName The user's new name
112 virtual void renameUser(UserId user, const QString &newName) = 0;
114 //! Validate a username with a given password.
115 /** \param user The username to validate
116 * \param password The user's alleged password
117 * \return A valid UserId if the password matches the username; 0 else
119 virtual UserId validateUser(const QString &user, const QString &password) = 0;
121 //! Check if a user with given username exists. Do not use for login purposes!
122 /** \param username The username to validate
123 * \return A valid UserId if the user exists; 0 else
125 virtual UserId getUserId(const QString &username) = 0;
127 //! Determine the UserId of the internal user
128 /** \return A valid UserId if the password matches the username; 0 else
130 virtual UserId internalUser() = 0;
132 //! Remove a core user from storage.
133 /** \param user The userid to delete
135 virtual void delUser(UserId user) = 0;
137 //! Store a user setting persistently
139 * \param userId The users Id
140 * \param settingName The Name of the Setting
141 * \param data The Value
143 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
145 //! Retrieve a persistent user setting
147 * \param userId The users Id
148 * \param settingName The Name of the Setting
149 * \param default Value to return in case it's unset.
150 * \return the Value of the Setting or the default value if it is unset.
152 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
154 /* Identity handling */
155 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity) = 0;
156 virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
157 virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
158 virtual QList<CoreIdentity> identities(UserId user) = 0;
160 /* Network handling */
162 //! Create a new Network in the storage backend and return it unique Id
163 /** \param user The core user who owns this network
164 * \param networkInfo The networkInfo holding the network definition
165 * \return the NetworkId of the newly created Network. Possibly invalid.
167 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
169 //! Apply the changes to NetworkInfo info to the storage engine
171 * \param user The core user
172 * \param networkInfo The Updated NetworkInfo
173 * \return true if successfull.
175 virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
177 //! Permanently remove a Network and all the data associated with it.
178 /** \note This method is thredsafe.
180 * \param user The core user
181 * \param networkId The network to delete
182 * \return true if successfull.
184 virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
186 //! Returns a list of all NetworkInfos for the given UserId user
187 /** \note This method is thredsafe.
189 * \param user The core user
190 * \return QList<NetworkInfo>.
192 virtual QList<NetworkInfo> networks(UserId user) = 0;
194 //! Get a list of Networks to restore
195 /** Return a list of networks the user was connected at the time of core shutdown
196 * \note This method is threadsafe.
198 * \param user The User Id in question
200 virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
202 //! Update the connected state of a network
203 /** \note This method is threadsafe
205 * \param user The Id of the networks owner
206 * \param networkId The Id of the network
207 * \param isConnected whether the network is connected or not
209 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
211 //! Get a hash of channels with their channel keys for a given network
212 /** The keys are channel names and values are passwords (possibly empty)
213 * \note This method is threadsafe
215 * \param user The id of the networks owner
216 * \param networkId The Id of the network
218 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
220 //! Update the connected state of a channel
221 /** \note This method is threadsafe
223 * \param user The Id of the networks owner
224 * \param networkId The Id of the network
225 * \param channel The name of the channel
226 * \param isJoined whether the channel is connected or not
228 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
230 //! Update the key of a channel
231 /** \note This method is threadsafe
233 * \param user The Id of the networks owner
234 * \param networkId The Id of the network
235 * \param channel The name of the channel
236 * \param key The key of the channel (possibly empty)
238 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
240 //! retrieve last known away message for session restore
241 /** \note This method is threadsafe
243 * \param user The Id of the networks owner
244 * \param networkId The Id of the network
246 virtual QString awayMessage(UserId user, NetworkId networkId) = 0;
248 //! Make away message persistent for session restore
249 /** \note This method is threadsafe
251 * \param user The Id of the networks owner
252 * \param networkId The Id of the network
253 * \param awayMsg The current away message of own user
255 virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) = 0;
258 //! retrieve last known user mode for session restore
259 /** \note This method is threadsafe
261 * \param user The Id of the networks owner
262 * \param networkId The Id of the network
264 virtual QString userModes(UserId user, NetworkId networkId) = 0;
266 //! Make our user modes persistent for session restore
267 /** \note This method is threadsafe
269 * \param user The Id of the networks owner
270 * \param networkId The Id of the network
271 * \param userModes The current user modes of own user
273 virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes) = 0;
276 /* Buffer handling */
278 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
279 /** \param user The core user who owns this buffername
280 * \param networkId The network id
281 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
282 * \param buffer The buffer name (if empty, the net's status buffer is returned)
283 * \param create Whether or not the buffer should be created if it doesnt exist
284 * \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
286 virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) = 0;
288 //! Get the unique BufferInfo for a bufferId
289 /** \param user The core user who owns this buffername
290 * \param bufferId The id of the buffer
291 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
293 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0;
295 //! Request a list of all buffers known to a user.
296 /** This method is used to get a list of all buffers we have stored a backlog from.
297 * \param user The user whose buffers we request
298 * \return A list of the BufferInfos for all buffers as requested
300 virtual QList<BufferInfo> requestBuffers(UserId user) = 0;
302 //! Request a list of BufferIds for a given NetworkId
303 /** \note This method is threadsafe.
305 * \param user The user whose buffers we request
306 * \param networkId The NetworkId of the network in question
307 * \return List of BufferIds belonging to the Network
309 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0;
311 //! Remove permanently a buffer and it's content from the storage backend
312 /** This call cannot be reverted!
313 * \param user The user who is the owner of the buffer
314 * \param bufferId The bufferId
315 * \return true if successfull
317 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
321 /** \note This method is threadsafe.
322 * \param user The id of the buffer owner
323 * \param bufferId The bufferId
324 * \param newName The new name of the buffer
325 * \return true if successfull
327 virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) = 0;
329 //! Merge the content of two Buffers permanently. This cannot be reversed!
330 /** \note This method is threadsafe.
331 * \param user The id of the buffer owner
332 * \param bufferId1 The bufferId of the remaining buffer
333 * \param bufferId2 The buffer that is about to be removed
334 * \return true if successfull
336 virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) = 0;
338 //! Update the LastSeenDate for a Buffer
339 /** This Method is used to make the LastSeenDate of a Buffer persistent
340 * \param user The Owner of that Buffer
341 * \param bufferId The buffer id
342 * \param MsgId The Message id of the message that has been just seen
344 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
346 //! Get a Hash of all last seen message ids
347 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
348 * \param user The Owner of the buffers
350 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
353 /* Message handling */
355 //! Store a Message in the storage backend and set its unique Id.
356 /** \param msg The message object to be stored
357 * \return true on success
359 virtual bool logMessage(Message &msg) = 0;
361 //! Store a list of Messages in the storage backend and set their unique Id.
362 /** \param msgs The list message objects to be stored
363 * \return true on success
365 virtual bool logMessages(MessageList &msgs) = 0;
367 //! Request a certain number messages stored in a given buffer.
368 /** \param buffer The buffer we request messages from
369 * \param first if != -1 return only messages with a MsgId >= first
370 * \param last if != -1 return only messages with a MsgId < last
371 * \param limit if != -1 limit the returned list to a max of \limit entries
372 * \return The requested list of messages
374 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
376 //! Request a certain number of messages across all buffers
377 /** \param first if != -1 return only messages with a MsgId >= first
378 * \param last if != -1 return only messages with a MsgId < last
379 * \param limit Max amount of messages
380 * \return The requested list of messages
382 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
385 //! Sent when a new BufferInfo is created, or an existing one changed somehow.
386 void bufferInfoUpdated(UserId user, const BufferInfo &);
387 //! Sent when a Buffer was renamed
388 void bufferRenamed(const QString &newName, const QString &oldName);
389 //! Sent when a new user has been added
390 void userAdded(UserId, const QString &username);
391 //! Sent when a user has been renamed
392 void userRenamed(UserId, const QString &newname);
393 //! Sent when a user has been removed
394 void userRemoved(UserId);
397 //! when implementing a storage handler, use this method to crypt user passwords.
398 /** This guarantees compatibility with other storage handlers and allows easy migration
400 QString cryptedPassword(const QString &password);