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 map where the keys are required properties to use the storage backend
63 /* the values are QVariants with default values */
64 virtual QVariantMap setupKeys() const = 0;
66 //! Setup the storage provider.
67 /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
68 * \param settings Hostname, port, username, password, ...
69 * \return True if and only if the storage provider was initialized successfully.
71 virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
73 //! Initialize the storage provider
74 /** \param settings Hostname, port, username, password, ...
75 * \return the State the storage backend is now in (see Storage::State)
77 virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
79 //! Makes temp data persistent
80 /** This Method is periodically called by the Quassel Core to make temporary
81 * data persistant. This reduces the data loss drastically in the
82 * unlikely case of a Core crash.
84 virtual void sync() = 0;
86 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
90 //! Add a new core user to the storage.
91 /** \param user The username of the new user
92 * \param password The cleartext password for the new user
93 * \return The new user's UserId
95 virtual UserId addUser(const QString &user, const QString &password) = 0;
97 //! Update a core user's password.
98 /** \param user The user's id
99 * \param password The user's new password
101 virtual void updateUser(UserId user, const QString &password) = 0;
104 /** \param user The user's id
105 * \param newName The user's new name
107 virtual void renameUser(UserId user, const QString &newName) = 0;
109 //! Validate a username with a given password.
110 /** \param user The username to validate
111 * \param password The user's alleged password
112 * \return A valid UserId if the password matches the username; 0 else
114 virtual UserId validateUser(const QString &user, const QString &password) = 0;
116 //! Determine the UserId of the internal user
117 /** \return A valid UserId if the password matches the username; 0 else
119 virtual UserId internalUser() = 0;
121 //! Remove a core user from storage.
122 /** \param user The userid to delete
124 virtual void delUser(UserId user) = 0;
126 //! Store a user setting persistently
128 * \param userId The users Id
129 * \param settingName The Name of the Setting
130 * \param data The Value
132 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
134 //! Retrieve a persistent user setting
136 * \param userId The users Id
137 * \param settingName The Name of the Setting
138 * \param default Value to return in case it's unset.
139 * \return the Value of the Setting or the default value if it is unset.
141 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
143 /* Identity handling */
144 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity) = 0;
145 virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
146 virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
147 virtual QList<CoreIdentity> identities(UserId user) = 0;
149 /* Network handling */
151 //! Create a new Network in the storage backend and return it unique Id
152 /** \param user The core user who owns this network
153 * \param networkInfo The networkInfo holding the network definition
154 * \return the NetworkId of the newly created Network. Possibly invalid.
156 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
158 //! Apply the changes to NetworkInfo info to the storage engine
160 * \param user The core user
161 * \param networkInfo The Updated NetworkInfo
162 * \return true if successfull.
164 virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
166 //! Permanently remove a Network and all the data associated with it.
167 /** \note This method is thredsafe.
169 * \param user The core user
170 * \param networkId The network to delete
171 * \return true if successfull.
173 virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
175 //! Returns a list of all NetworkInfos for the given UserId user
176 /** \note This method is thredsafe.
178 * \param user The core user
179 * \return QList<NetworkInfo>.
181 virtual QList<NetworkInfo> networks(UserId user) = 0;
183 //! Get a list of Networks to restore
184 /** Return a list of networks the user was connected at the time of core shutdown
185 * \note This method is threadsafe.
187 * \param user The User Id in question
189 virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
191 //! Update the connected state of a network
192 /** \note This method is threadsafe
194 * \param user The Id of the networks owner
195 * \param networkId The Id of the network
196 * \param isConnected whether the network is connected or not
198 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
200 //! Get a hash of channels with their channel keys for a given network
201 /** The keys are channel names and values are passwords (possibly empty)
202 * \note This method is threadsafe
204 * \param user The id of the networks owner
205 * \param networkId The Id of the network
207 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
209 //! Update the connected state of a channel
210 /** \note This method is threadsafe
212 * \param user The Id of the networks owner
213 * \param networkId The Id of the network
214 * \param channel The name of the channel
215 * \param isJoined whether the channel is connected or not
217 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
219 //! Update the key of a channel
220 /** \note This method is threadsafe
222 * \param user The Id of the networks owner
223 * \param networkId The Id of the network
224 * \param channel The name of the channel
225 * \param key The key of the channel (possibly empty)
227 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
229 //! retrieve last known away message for session restore
230 /** \note This method is threadsafe
232 * \param user The Id of the networks owner
233 * \param networkId The Id of the network
235 virtual QString awayMessage(UserId user, NetworkId networkId) = 0;
237 //! Make away message persistent for session restore
238 /** \note This method is threadsafe
240 * \param user The Id of the networks owner
241 * \param networkId The Id of the network
242 * \param awayMsg The current away message of own user
244 virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) = 0;
247 //! retrieve last known user mode for session restore
248 /** \note This method is threadsafe
250 * \param user The Id of the networks owner
251 * \param networkId The Id of the network
253 virtual QString userModes(UserId user, NetworkId networkId) = 0;
255 //! Make our user modes persistent for session restore
256 /** \note This method is threadsafe
258 * \param user The Id of the networks owner
259 * \param networkId The Id of the network
260 * \param userModes The current user modes of own user
262 virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes) = 0;
265 /* Buffer handling */
267 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
268 /** \param user The core user who owns this buffername
269 * \param networkId The network id
270 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
271 * \param buffer The buffer name (if empty, the net's status buffer is returned)
272 * \param create Whether or not the buffer should be created if it doesnt exist
273 * \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
275 virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) = 0;
277 //! Get the unique BufferInfo for a bufferId
278 /** \param user The core user who owns this buffername
279 * \param bufferId The id of the buffer
280 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
282 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0;
284 //! Request a list of all buffers known to a user.
285 /** This method is used to get a list of all buffers we have stored a backlog from.
286 * \param user The user whose buffers we request
287 * \return A list of the BufferInfos for all buffers as requested
289 virtual QList<BufferInfo> requestBuffers(UserId user) = 0;
291 //! Request a list of BufferIds for a given NetworkId
292 /** \note This method is threadsafe.
294 * \param user The user whose buffers we request
295 * \param networkId The NetworkId of the network in question
296 * \return List of BufferIds belonging to the Network
298 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0;
300 //! Remove permanently a buffer and it's content from the storage backend
301 /** This call cannot be reverted!
302 * \param user The user who is the owner of the buffer
303 * \param bufferId The bufferId
304 * \return true if successfull
306 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
310 /** \note This method is threadsafe.
311 * \param user The id of the buffer owner
312 * \param bufferId The bufferId
313 * \param newName The new name of the buffer
314 * \return true if successfull
316 virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) = 0;
318 //! Merge the content of two Buffers permanently. This cannot be reversed!
319 /** \note This method is threadsafe.
320 * \param user The id of the buffer owner
321 * \param bufferId1 The bufferId of the remaining buffer
322 * \param bufferId2 The buffer that is about to be removed
323 * \return true if successfull
325 virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) = 0;
327 //! Update the LastSeenDate for a Buffer
328 /** This Method is used to make the LastSeenDate of a Buffer persistent
329 * \param user The Owner of that Buffer
330 * \param bufferId The buffer id
331 * \param MsgId The Message id of the message that has been just seen
333 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
335 //! Get a Hash of all last seen message ids
336 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
337 * \param user The Owner of the buffers
339 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
342 /* Message handling */
344 //! Store a Message in the storage backend and set its unique Id.
345 /** \param msg The message object to be stored
346 * \return true on success
348 virtual bool logMessage(Message &msg) = 0;
350 //! Store a list of Messages in the storage backend and set their unique Id.
351 /** \param msgs The list message objects to be stored
352 * \return true on success
354 virtual bool logMessages(MessageList &msgs) = 0;
356 //! Request a certain number messages stored in a given buffer.
357 /** \param buffer The buffer we request messages from
358 * \param first if != -1 return only messages with a MsgId >= first
359 * \param last if != -1 return only messages with a MsgId < last
360 * \param limit if != -1 limit the returned list to a max of \limit entries
361 * \return The requested list of messages
363 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
365 //! Request a certain number of messages across all buffers
366 /** \param first if != -1 return only messages with a MsgId >= first
367 * \param last if != -1 return only messages with a MsgId < last
368 * \param limit Max amount of messages
369 * \return The requested list of messages
371 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
374 //! Sent when a new BufferInfo is created, or an existing one changed somehow.
375 void bufferInfoUpdated(UserId user, const BufferInfo &);
376 //! Sent when a Buffer was renamed
377 void bufferRenamed(const QString &newName, const QString &oldName);
378 //! Sent when a new user has been added
379 void userAdded(UserId, const QString &username);
380 //! Sent when a user has been renamed
381 void userRenamed(UserId, const QString &newname);
382 //! Sent when a user has been removed
383 void userRemoved(UserId);
386 //! when implementing a storage handler, use this method to crypt user passwords.
387 /** This guarantees compatibility with other storage handlers and allows easy migration
389 QString cryptedPassword(const QString &password);