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 ***************************************************************************/
30 # include <QSslSocket>
31 # include "sslserver.h"
33 # include <QTcpSocket>
34 # include <QTcpServer>
38 #include "bufferinfo.h"
40 #include "sessionthread.h"
48 class Core : public QObject {
52 static Core * instance();
53 static void destroy();
55 static void saveState();
56 static void restoreState();
58 /*** Storage access ***/
59 // These methods are threadsafe.
61 //! Store a user setting persistently
63 * \param userId The users Id
64 * \param settingName The Name of the Setting
65 * \param data The Value
67 static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) {
68 instance()->storage->setUserSetting(userId, settingName, data);
71 //! Retrieve a persistent user setting
73 * \param userId The users Id
74 * \param settingName The Name of the Setting
75 * \param default Value to return in case it's unset.
76 * \return the Value of the Setting or the default value if it is unset.
78 static inline QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) {
79 return instance()->storage->getUserSetting(userId, settingName, data);
82 /* Identity handling */
83 static inline IdentityId createIdentity(UserId user, CoreIdentity &identity) {
84 return instance()->storage->createIdentity(user, identity);
86 static bool updateIdentity(UserId user, const CoreIdentity &identity) {
87 return instance()->storage->updateIdentity(user, identity);
89 static void removeIdentity(UserId user, IdentityId identityId) {
90 instance()->storage->removeIdentity(user, identityId);
92 static QList<CoreIdentity> identities(UserId user) {
93 return instance()->storage->identities(user);
96 //! Create a Network in the Storage and store it's Id in the given NetworkInfo
97 /** \note This method is thredsafe.
99 * \param user The core user
100 * \param networkInfo a NetworkInfo definition to store the newly created ID in
101 * \return true if successfull.
103 static bool createNetwork(UserId user, NetworkInfo &info);
105 //! Apply the changes to NetworkInfo info to the storage engine
106 /** \note This method is thredsafe.
108 * \param user The core user
109 * \param networkInfo The Updated NetworkInfo
110 * \return true if successfull.
112 static inline bool updateNetwork(UserId user, const NetworkInfo &info) {
113 return instance()->storage->updateNetwork(user, info);
116 //! Permanently remove a Network and all the data associated with it.
117 /** \note This method is thredsafe.
119 * \param user The core user
120 * \param networkId The network to delete
121 * \return true if successfull.
123 static inline bool removeNetwork(UserId user, const NetworkId &networkId) {
124 return instance()->storage->removeNetwork(user, networkId);
127 //! Returns a list of all NetworkInfos for the given UserId user
128 /** \note This method is thredsafe.
130 * \param user The core user
131 * \return QList<NetworkInfo>.
133 static inline QList<NetworkInfo> networks(UserId user) {
134 return instance()->storage->networks(user);
137 //! Get the NetworkId for a network name.
138 /** \note This method is threadsafe.
140 * \param user The core user
141 * \param network The name of the network
142 * \return The NetworkId corresponding to the given network.
144 static inline NetworkId networkId(UserId user, const QString &network) {
145 return instance()->storage->getNetworkId(user, network);
148 //! Get a list of Networks to restore
149 /** Return a list of networks the user was connected at the time of core shutdown
150 * \note This method is threadsafe.
152 * \param user The User Id in question
154 static inline QList<NetworkId> connectedNetworks(UserId user) {
155 return instance()->storage->connectedNetworks(user);
158 //! Update the connected state of a network
159 /** \note This method is threadsafe
161 * \param user The Id of the networks owner
162 * \param networkId The Id of the network
163 * \param isConnected whether the network is connected or not
165 static inline void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) {
166 return instance()->storage->setNetworkConnected(user, networkId, isConnected);
169 //! Get a hash of channels with their channel keys for a given network
170 /** The keys are channel names and values are passwords (possibly empty)
171 * \note This method is threadsafe
173 * \param user The id of the networks owner
174 * \param networkId The Id of the network
176 static inline QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) {
177 return instance()->storage->persistentChannels(user, networkId);
180 //! Update the connected state of a channel
181 /** \note This method is threadsafe
183 * \param user The Id of the networks owner
184 * \param networkId The Id of the network
185 * \param channel The name of the channel
186 * \param isJoined whether the channel is connected or not
188 static inline void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) {
189 return instance()->storage->setChannelPersistent(user, networkId, channel, isJoined);
192 //! Update the key of a channel
193 /** \note This method is threadsafe
195 * \param user The Id of the networks owner
196 * \param networkId The Id of the network
197 * \param channel The name of the channel
198 * \param key The key of the channel (possibly empty)
200 static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) {
201 return instance()->storage->setPersistentChannelKey(user, networkId, channel, key);
204 //! retrieve last known away message for session restore
205 /** \note This method is threadsafe
207 * \param user The Id of the networks owner
208 * \param networkId The Id of the network
210 static inline QString awayMessage(UserId user, NetworkId networkId) {
211 return instance()->storage->awayMessage(user, networkId);
214 //! Make away message persistent for session restore
215 /** \note This method is threadsafe
217 * \param user The Id of the networks owner
218 * \param networkId The Id of the network
219 * \param awayMsg The current away message of own user
221 static inline void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) {
222 return instance()->storage->setAwayMessage(user, networkId, awayMsg);
225 //! retrieve last known user mode for session restore
226 /** \note This method is threadsafe
228 * \param user The Id of the networks owner
229 * \param networkId The Id of the network
231 static inline QString userModes(UserId user, NetworkId networkId) {
232 return instance()->storage->userModes(user, networkId);
235 //! Make our user modes persistent for session restore
236 /** \note This method is threadsafe
238 * \param user The Id of the networks owner
239 * \param networkId The Id of the network
240 * \param userModes The current user modes of own user
242 static inline void setUserModes(UserId user, NetworkId networkId, const QString &userModes) {
243 return instance()->storage->setUserModes(user, networkId, userModes);
246 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
247 /** \note This method is threadsafe.
249 * \param user The core user who owns this buffername
250 * \param networkId The network id
251 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
252 * \param buffer The buffer name (if empty, the net's status buffer is returned)
253 * \param create Whether or not the buffer should be created if it doesnt exist
254 * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
256 static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) {
257 return instance()->storage->bufferInfo(user, networkId, type, buffer, create);
260 //! Get the unique BufferInfo for a bufferId
261 /** \note This method is threadsafe
262 * \param user The core user who owns this buffername
263 * \param bufferId The id of the buffer
264 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
266 static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) {
267 return instance()->storage->getBufferInfo(user, bufferId);
270 //! Store a Message in the backlog.
271 /** \note This method is threadsafe.
273 * \param msg The message object to be stored
274 * \return The globally unique id for the stored message
276 static inline MsgId storeMessage(const Message &message) {
277 return instance()->storage->logMessage(message);
280 //! Request a certain number messages stored in a given buffer.
281 /** \param buffer The buffer we request messages from
282 * \param first if != -1 return only messages with a MsgId >= first
283 * \param last if != -1 return only messages with a MsgId < last
284 * \param limit if != -1 limit the returned list to a max of \limit entries
285 * \return The requested list of messages
287 static inline QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) {
288 return instance()->storage->requestMsgs(user, bufferId, first, last, limit);
291 //! Request a certain number of messages across all buffers
292 /** \param first if != -1 return only messages with a MsgId >= first
293 * \param last if != -1 return only messages with a MsgId < last
294 * \param limit Max amount of messages
295 * \return The requested list of messages
297 static inline QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) {
298 return instance()->storage->requestAllMsgs(user, first, last, limit);
301 //! Request a list of all buffers known to a user.
302 /** This method is used to get a list of all buffers we have stored a backlog from.
303 * \note This method is threadsafe.
305 * \param user The user whose buffers we request
306 * \return A list of the BufferInfos for all buffers as requested
308 static inline QList<BufferInfo> requestBuffers(UserId user) {
309 return instance()->storage->requestBuffers(user);
312 //! Request a list of BufferIds for a given NetworkId
313 /** \note This method is threadsafe.
315 * \param user The user whose buffers we request
316 * \param networkId The NetworkId of the network in question
317 * \return List of BufferIds belonging to the Network
319 static inline QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) {
320 return instance()->storage->requestBufferIdsForNetwork(user, networkId);
323 //! Remove permanently a buffer and it's content from the storage backend
324 /** This call cannot be reverted!
325 * \note This method is threadsafe.
327 * \param user The user who is the owner of the buffer
328 * \param bufferId The bufferId
329 * \return true if successfull
331 static inline bool removeBuffer(const UserId &user, const BufferId &bufferId) {
332 return instance()->storage->removeBuffer(user, bufferId);
336 /** \note This method is threadsafe.
337 * \param user The id of the buffer owner
338 * \param bufferId The bufferId
339 * \param newName The new name of the buffer
340 * \return true if successfull
342 static inline bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) {
343 return instance()->storage->renameBuffer(user, bufferId, newName);
346 //! Merge the content of two Buffers permanently. This cannot be reversed!
347 /** \note This method is threadsafe.
348 * \param user The id of the buffer owner
349 * \param bufferId1 The bufferId of the remaining buffer
350 * \param bufferId2 The buffer that is about to be removed
351 * \return true if successfulln
353 static inline bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) {
354 return instance()->storage->mergeBuffersPermanently(user, bufferId1, bufferId2);
357 //! Update the LastSeenDate for a Buffer
358 /** This Method is used to make the LastSeenDate of a Buffer persistent
359 * \note This method is threadsafe.
361 * \param user The Owner of that Buffer
362 * \param bufferId The buffer id
363 * \param MsgId The Message id of the message that has been just seen
365 static inline void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) {
366 return instance()->storage->setBufferLastSeenMsg(user, bufferId, msgId);
369 //! Get a Hash of all last seen message ids
370 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
371 * \note This method is threadsafe.
373 * \param user The Owner of the buffers
375 static inline QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) {
376 return instance()->storage->bufferLastSeenMsgIds(user);
379 const QDateTime &startTime() const { return _startTime; }
381 static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; }
384 //! Make storage data persistent
385 /** \note This method is threadsafe.
388 void setupInternalClientSession(SignalProxy *proxy);
390 //! Sent when a BufferInfo is updated in storage.
391 void bufferInfoUpdated(UserId user, const BufferInfo &info);
393 //! Relay From CoreSession::sessionState(const QVariant &). Used for internal connection only
394 void sessionState(const QVariant &);
397 bool startListening();
398 void stopListening(const QString &msg = QString());
399 void incomingConnection();
400 void clientHasData();
401 void clientDisconnected();
403 bool initStorage(QVariantMap dbSettings, bool setup = false);
406 void sslErrors(const QList<QSslError> &errors);
408 void socketError(QAbstractSocket::SocketError);
414 static Core *instanceptr;
416 SessionThread *createSession(UserId userId, bool restoreState = false);
417 void setupClientSession(QTcpSocket *socket, UserId uid);
418 void processClientMessage(QTcpSocket *socket, const QVariantMap &msg);
419 //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
420 QString setupCoreForInternalUsage();
421 QString setupCore(QVariantMap setupData);
423 bool registerStorageBackend(Storage *);
424 void unregisterStorageBackend(Storage *);
426 QHash<UserId, SessionThread *> sessions;
428 QTimer _storageSyncTimer;
431 SslServer _server, _v6server;
433 QTcpServer _server, _v6server;
436 QHash<QTcpSocket *, quint32> blocksizes;
437 QHash<QTcpSocket *, QVariantMap> clientInfo;
439 QHash<QString, Storage *> _storageBackends;
441 QDateTime _startTime;