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 ***************************************************************************/
27 #include "coreidentity.h"
31 class Storage : public QObject {
35 Storage(QObject *parent = 0);
36 virtual ~Storage() {};
41 //! Check if the storage type is available.
42 /** A storage subclass should return true if it can be successfully used, i.e. if all
43 * prerequisites are in place (e.g. we have an appropriate DB driver etc.).
44 * \return True if and only if the storage class can be successfully used.
46 virtual bool isAvailable() const = 0;
48 //! Returns the display name of the storage backend
49 /** \return A string that can be used by the client to name the storage backend */
50 virtual QString displayName() const = 0;
52 //! Returns a description of this storage backend
53 /** \return A string that can be displayed by the client to describe the storage backend */
54 virtual QString description() const = 0;
56 //! Setup the storage provider.
57 /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
58 * \param settings Hostname, port, username, password, ...
59 * \return True if and only if the storage provider was initialized successfully.
61 virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
63 //! Initialize the storage provider
64 /** \param settings Hostname, port, username, password, ...
65 * \return True if and only if the storage provider was initialized successfully.
67 virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
69 //! Makes temp data persistent
70 /** This Method is periodically called by the Quassel Core to make temporary
71 * data persistant. This reduces the data loss drastically in the
72 * unlikely case of a Core crash.
74 virtual void sync() = 0;
76 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
80 //! Add a new core user to the storage.
81 /** \param user The username of the new user
82 * \param password The cleartext password for the new user
83 * \return The new user's UserId
85 virtual UserId addUser(const QString &user, const QString &password) = 0;
87 //! Update a core user's password.
88 /** \param user The user's id
89 * \param password The user's new password
91 virtual void updateUser(UserId user, const QString &password) = 0;
94 /** \param user The user's id
95 * \param newName The user's new name
97 virtual void renameUser(UserId user, const QString &newName) = 0;
99 //! Validate a username with a given password.
100 /** \param user The username to validate
101 * \param password The user's alleged password
102 * \return A valid UserId if the password matches the username; 0 else
104 virtual UserId validateUser(const QString &user, const QString &password) = 0;
106 //! Determine the UserId of the internal user
107 /** \return A valid UserId if the password matches the username; 0 else
109 virtual UserId internalUser() = 0;
111 //! Remove a core user from storage.
112 /** \param user The userid to delete
114 virtual void delUser(UserId user) = 0;
116 //! Store a user setting persistently
118 * \param userId The users Id
119 * \param settingName The Name of the Setting
120 * \param data The Value
122 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
124 //! Retrieve a persistent user setting
126 * \param userId The users Id
127 * \param settingName The Name of the Setting
128 * \param default Value to return in case it's unset.
129 * \return the Value of the Setting or the default value if it is unset.
131 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
133 /* Identity handling */
134 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity) = 0;
135 virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
136 virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
137 virtual QList<CoreIdentity> identities(UserId user) = 0;
139 /* Network handling */
141 //! Create a new Network in the storage backend and return it unique Id
142 /** \param user The core user who owns this network
143 * \param networkInfo The networkInfo holding the network definition
144 * \return the NetworkId of the newly created Network. Possibly invalid.
146 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info) = 0;
148 //! Apply the changes to NetworkInfo info to the storage engine
150 * \param user The core user
151 * \param networkInfo The Updated NetworkInfo
152 * \return true if successfull.
154 virtual bool updateNetwork(UserId user, const NetworkInfo &info) = 0;
156 //! Permanently remove a Network and all the data associated with it.
157 /** \note This method is thredsafe.
159 * \param user The core user
160 * \param networkId The network to delete
161 * \return true if successfull.
163 virtual bool removeNetwork(UserId user, const NetworkId &networkId) = 0;
165 //! Returns a list of all NetworkInfos for the given UserId user
166 /** \note This method is thredsafe.
168 * \param user The core user
169 * \return QList<NetworkInfo>.
171 virtual QList<NetworkInfo> networks(UserId user) = 0;
173 //! Get the unique NetworkId of the network for a user.
174 /** \param user The core user who owns this network
175 * \param network The network name
176 * \return The NetworkId corresponding to the given network, or 0 if not found
178 virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
180 //! Get a list of Networks to restore
181 /** Return a list of networks the user was connected at the time of core shutdown
182 * \note This method is threadsafe.
184 * \param user The User Id in question
186 virtual QList<NetworkId> connectedNetworks(UserId user) = 0;
188 //! Update the connected state of a network
189 /** \note This method is threadsafe
191 * \param user The Id of the networks owner
192 * \param networkId The Id of the network
193 * \param isConnected whether the network is connected or not
195 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) = 0;
197 //! Get a hash of channels with their channel keys for a given network
198 /** The keys are channel names and values are passwords (possibly empty)
199 * \note This method is threadsafe
201 * \param user The id of the networks owner
202 * \param networkId The Id of the network
204 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) = 0;
206 //! Update the connected state of a channel
207 /** \note This method is threadsafe
209 * \param user The Id of the networks owner
210 * \param networkId The Id of the network
211 * \param channel The name of the channel
212 * \param isJoined whether the channel is connected or not
214 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) = 0;
216 //! Update the key of a channel
217 /** \note This method is threadsafe
219 * \param user The Id of the networks owner
220 * \param networkId The Id of the network
221 * \param channel The name of the channel
222 * \param key The key of the channel (possibly empty)
224 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) = 0;
226 /* Buffer handling */
228 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
229 /** \param user The core user who owns this buffername
230 * \param networkId The network id
231 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
232 * \param buffer The buffer name (if empty, the net's status buffer is returned)
233 * \return The BufferInfo corresponding to the given network and buffer name, or an invalid BufferInfo if not found
235 virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") = 0;
237 //! Get the unique BufferInfo for a bufferId
238 /** \param user The core user who owns this buffername
239 * \param bufferId The id of the buffer
240 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
242 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) = 0;
244 //! Request a list of all buffers known to a user.
245 /** This method is used to get a list of all buffers we have stored a backlog from.
246 * \param user The user whose buffers we request
247 * \return A list of the BufferInfos for all buffers as requested
249 virtual QList<BufferInfo> requestBuffers(UserId user) = 0;
251 //! Request a list of BufferIds for a given NetworkId
252 /** \note This method is threadsafe.
254 * \param user The user whose buffers we request
255 * \param networkId The NetworkId of the network in question
256 * \return List of BufferIds belonging to the Network
258 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) = 0;
260 //! Remove permanently a buffer and it's content from the storage backend
261 /** This call cannot be reverted!
262 * \param user The user who is the owner of the buffer
263 * \param bufferId The bufferId
264 * \return true if successfull
266 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId) = 0;
269 /** \param user The id of the buffer owner
270 * \param networkId The id of the network the buffer belongs to
271 * \param newName The new name of the buffer
272 * \param oldName The previous name of the buffer
273 * \return the BufferId of the affected buffer or an invalid BufferId if not successfull
275 virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) = 0;
277 //! Update the LastSeenDate for a Buffer
278 /** This Method is used to make the LastSeenDate of a Buffer persistent
279 * \param user The Owner of that Buffer
280 * \param bufferId The buffer id
281 * \param MsgId The Message id of the message that has been just seen
283 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) = 0;
285 //! Get a Hash of all last seen message ids
286 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
287 * \param user The Owner of the buffers
289 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
292 /* Message handling */
294 //! Store a Message in the backlog.
295 /** \param msg The message object to be stored
296 * \return The globally unique id for the stored message
298 virtual MsgId logMessage(Message msg) = 0;
300 //! Request a certain number messages stored in a given buffer.
301 /** \param buffer The buffer we request messages from
302 * \param first if != -1 return only messages with a MsgId >= first
303 * \param last if != -1 return only messages with a MsgId < last
304 * \param limit if != -1 limit the returned list to a max of \limit entries
305 * \return The requested list of messages
307 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
309 //! Request a certain number of messages across all buffers
310 /** \param first if != -1 return only messages with a MsgId >= first
311 * \param last if != -1 return only messages with a MsgId < last
312 * \param limit Max amount of messages
313 * \return The requested list of messages
315 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
318 //! Sent when a new BufferInfo is created, or an existing one changed somehow.
319 void bufferInfoUpdated(UserId user, const BufferInfo &);
320 //! Sent when a Buffer was renamed
321 void bufferRenamed(const QString &newName, const QString &oldName);
322 //! Sent when a new user has been added
323 void userAdded(UserId, const QString &username);
324 //! Sent when a user has been renamed
325 void userRenamed(UserId, const QString &newname);
326 //! Sent when a user has been removed
327 void userRemoved(UserId);
330 //! when implementing a storage handler, use this method to crypt user passwords.
331 /** This guarantees compatibility with other storage handlers and allows easy migration
333 QString cryptedPassword(const QString &password);