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 # 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);
83 //! Create a Network in the Storage and store it's Id in the given NetworkInfo
84 /** \note This method is thredsafe.
86 * \param user The core user
87 * \param networkInfo a NetworkInfo definition to store the newly created ID in
88 * \return true if successfull.
90 static bool createNetwork(UserId user, NetworkInfo &info);
92 //! Apply the changes to NetworkInfo info to the storage engine
93 /** \note This method is thredsafe.
95 * \param user The core user
96 * \param networkInfo The Updated NetworkInfo
97 * \return true if successfull.
99 static inline bool updateNetwork(UserId user, const NetworkInfo &info) {
100 return instance()->storage->updateNetwork(user, info);
103 //! Permanently remove a Network and all the data associated with it.
104 /** \note This method is thredsafe.
106 * \param user The core user
107 * \param networkId The network to delete
108 * \return true if successfull.
110 static inline bool removeNetwork(UserId user, const NetworkId &networkId) {
111 return instance()->storage->removeNetwork(user, networkId);
114 //! Returns a list of all NetworkInfos for the given UserId user
115 /** \note This method is thredsafe.
117 * \param user The core user
118 * \return QList<NetworkInfo>.
120 static inline QList<NetworkInfo> networks(UserId user) {
121 return instance()->storage->networks(user);
124 //! Get the NetworkId for a network name.
125 /** \note This method is threadsafe.
127 * \param user The core user
128 * \param network The name of the network
129 * \return The NetworkId corresponding to the given network.
131 static inline NetworkId networkId(UserId user, const QString &network) {
132 return instance()->storage->getNetworkId(user, network);
135 //! Get a list of Networks to restore
136 /** Return a list of networks the user was connected at the time of core shutdown
137 * \note This method is threadsafe.
139 * \param user The User Id in question
141 static inline QList<NetworkId> connectedNetworks(UserId user) {
142 return instance()->storage->connectedNetworks(user);
145 //! Update the connected state of a network
146 /** \note This method is threadsafe
148 * \param user The Id of the networks owner
149 * \param networkId The Id of the network
150 * \param isConnected whether the network is connected or not
152 static inline void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) {
153 return instance()->storage->setNetworkConnected(user, networkId, isConnected);
156 //! Get a hash of channels with their channel keys for a given network
157 /** The keys are channel names and values are passwords (possibly empty)
158 * \note This method is threadsafe
160 * \param user The id of the networks owner
161 * \param networkId The Id of the network
163 static inline QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) {
164 return instance()->storage->persistentChannels(user, networkId);
167 //! Update the connected state of a channel
168 /** \note This method is threadsafe
170 * \param user The Id of the networks owner
171 * \param networkId The Id of the network
172 * \param channel The name of the channel
173 * \param isJoined whether the channel is connected or not
175 static inline void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) {
176 return instance()->storage->setChannelPersistent(user, networkId, channel, isJoined);
179 //! Update the key of a channel
180 /** \note This method is threadsafe
182 * \param user The Id of the networks owner
183 * \param networkId The Id of the network
184 * \param channel The name of the channel
185 * \param key The key of the channel (possibly empty)
187 static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) {
188 return instance()->storage->setPersistentChannelKey(user, networkId, channel, key);
191 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
192 /** \note This method is threadsafe.
194 * \param user The core user who owns this buffername
195 * \param networkId The network id
196 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
197 * \param buffer The buffer name (if empty, the net's status buffer is returned)
198 * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
200 static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") {
201 return instance()->storage->getBufferInfo(user, networkId, type, buffer);
204 //! Get the unique BufferInfo for a bufferId
205 /** \note This method is threadsafe
206 * \param user The core user who owns this buffername
207 * \param bufferId The id of the buffer
208 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
210 static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) {
211 return instance()->storage->getBufferInfo(user, bufferId);
214 //! Store a Message in the backlog.
215 /** \note This method is threadsafe.
217 * \param msg The message object to be stored
218 * \return The globally unique id for the stored message
220 static inline MsgId storeMessage(const Message &message) {
221 return instance()->storage->logMessage(message);
224 //! Request a certain number (or all) messages stored in a given buffer.
225 /** \note This method is threadsafe.
227 * \param buffer The buffer we request messages from
228 * \param limit The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
229 * \param offset Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
230 * \return The requested list of messages
232 static inline QList<Message> requestMsgs(UserId user, BufferId buffer, int limit = -1, int offset = -1) {
233 return instance()->storage->requestMsgs(user, buffer, limit, offset);
236 //! Request messages stored in a given buffer since a certain point in time.
237 /** \note This method is threadsafe.
239 * \param buffer The buffer we request messages from
240 * \param since Only return messages newer than this point in time
241 * \param offset Do not return messages with MsgId >= offset, if offset >= 0
242 * \return The requested list of messages
244 static inline QList<Message> requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset = -1) {
245 return instance()->storage->requestMsgs(user, buffer, since, offset);
248 //! Request a range of messages stored in a given buffer.
249 /** \note This method is threadsafe.
251 * \param buffer The buffer we request messages from
252 * \param first Return messages with first <= MsgId <= last
253 * \param last Return messages with first <= MsgId <= last
254 * \return The requested list of messages
256 static inline QList<Message> requestMsgRange(UserId user, BufferId buffer, int first, int last) {
257 return instance()->storage->requestMsgRange(user, buffer, first, last);
260 //! Request a list of all buffers known to a user.
261 /** This method is used to get a list of all buffers we have stored a backlog from.
262 * \note This method is threadsafe.
264 * \param user The user whose buffers we request
265 * \return A list of the BufferInfos for all buffers as requested
267 static inline QList<BufferInfo> requestBuffers(UserId user) {
268 return instance()->storage->requestBuffers(user);
271 //! Request a list of BufferIds for a given NetworkId
272 /** \note This method is threadsafe.
274 * \param user The user whose buffers we request
275 * \param networkId The NetworkId of the network in question
276 * \return List of BufferIds belonging to the Network
278 static inline QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) {
279 return instance()->storage->requestBufferIdsForNetwork(user, networkId);
282 //! Remove permanently a buffer and it's content from the storage backend
283 /** This call cannot be reverted!
284 * \note This method is threadsafe.
286 * \param user The user who is the owner of the buffer
287 * \param bufferId The bufferId
288 * \return true if successfull
290 static inline bool removeBuffer(const UserId &user, const BufferId &bufferId) {
291 return instance()->storage->removeBuffer(user, bufferId);
295 /** \note This method is threadsafe.
296 * \param user The id of the buffer owner
297 * \param networkId The id of the network the buffer belongs to
298 * \param newName The new name of the buffer
299 * \param oldName The previous name of the buffer
300 * \return the BufferId of the affected buffer or an invalid BufferId if not successfull
302 static inline BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
303 return instance()->storage->renameBuffer(user, networkId, newName, oldName);
306 //! Update the LastSeenDate for a Buffer
307 /** This Method is used to make the LastSeenDate of a Buffer persistent
308 * \note This method is threadsafe.
310 * \param user The Owner of that Buffer
311 * \param bufferId The buffer id
312 * \param MsgId The Message id of the message that has been just seen
314 static inline void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) {
315 return instance()->storage->setBufferLastSeenMsg(user, bufferId, msgId);
318 //! Get a Hash of all last seen message ids
319 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
320 * \note This method is threadsafe.
322 * \param user The Owner of the buffers
324 static inline QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) {
325 return instance()->storage->bufferLastSeenMsgIds(user);
328 const QDateTime &startTime() const { return _startTime; }
331 //! Make storage data persistent
332 /** \note This method is threadsafe.
335 void setupInternalClientSession(SignalProxy *proxy);
337 //! Sent when a BufferInfo is updated in storage.
338 void bufferInfoUpdated(UserId user, const BufferInfo &info);
340 //! Relay From CoreSession::sessionState(const QVariant &). Used for internal connection only
341 void sessionState(const QVariant &);
344 bool startListening();
345 void stopListening(const QString &msg = QString());
346 void incomingConnection();
347 void clientHasData();
348 void clientDisconnected();
350 bool initStorage(QVariantMap dbSettings, bool setup = false);
353 void sslErrors(const QList<QSslError> &errors);
355 void socketError(QAbstractSocket::SocketError);
361 static Core *instanceptr;
363 SessionThread *createSession(UserId userId, bool restoreState = false);
364 void setupClientSession(QTcpSocket *socket, UserId uid);
365 void processClientMessage(QTcpSocket *socket, const QVariantMap &msg);
366 //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
367 QString setupCoreForInternalUsage();
368 QString setupCore(QVariantMap setupData);
370 bool registerStorageBackend(Storage *);
371 void unregisterStorageBackend(Storage *);
373 QHash<UserId, SessionThread *> sessions;
375 QTimer _storageSyncTimer;
378 SslServer _server, _v6server;
380 QTcpServer _server, _v6server;
383 QHash<QTcpSocket *, quint32> blocksizes;
384 QHash<QTcpSocket *, QVariantMap> clientInfo;
386 QHash<QString, Storage *> _storageBackends;
388 QDateTime _startTime;