1 /***************************************************************************
2 * Copyright (C) 2005-2016 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
32 # include <QSslSocket>
33 # include "sslserver.h"
35 # include <QTcpSocket>
36 # include <QTcpServer>
39 #include "authenticator.h"
40 #include "bufferinfo.h"
41 #include "deferredptr.h"
43 #include "oidentdconfiggenerator.h"
44 #include "sessionthread.h"
48 class CoreAuthHandler;
54 class AbstractSqlMigrationReader;
55 class AbstractSqlMigrationWriter;
57 class Core : public QObject
62 static Core *instance();
63 static void destroy();
65 static void saveState();
66 static void restoreState();
68 /*** Storage access ***/
69 // These methods are threadsafe.
73 * \param userName The user's login name
74 * \param password The user's uncrypted password
75 * \return The user's ID if valid; 0 otherwise
77 static inline UserId validateUser(const QString &userName, const QString &password) {
78 return instance()->_storage->validateUser(userName, password);
81 //! Authenticate user against auth backend
83 * \param userName The user's login name
84 * \param password The user's uncrypted password
85 * \return The user's ID if valid; 0 otherwise
87 static inline UserId authenticateUser(const QString &userName, const QString &password) {
88 return instance()->_authenticator->validateUser(userName, password);
91 //! Add a new user, exposed so auth providers can call this without being the storage.
93 * \param userName The user's login name
94 * \param password The user's uncrypted password
95 * \param authenticator The name of the auth provider service used to log the user in, defaults to "Database".
96 * \return The user's ID if valid; 0 otherwise
98 static inline UserId addUser(const QString &userName, const QString &password, const QString &authenticator = "Database") {
99 return instance()->_storage->addUser(userName, password, authenticator);
102 //! Does a comparison test against the authenticator in the database and the authenticator currently in use for a UserID.
104 * \param userid The user's ID (note: not login name).
105 * \param authenticator The name of the auth provider service used to log the user in, defaults to "Database".
106 * \return True if the userid was configured with the passed authenticator, false otherwise.
108 static inline bool checkAuthProvider(const UserId userid, const QString &authenticator) {
109 return instance()->_storage->getUserAuthenticator(userid) == authenticator;
112 //! Change a user's password
114 * \param userId The user's ID
115 * \param password The user's unencrypted new password
116 * \return true, if the password change was successful
118 static bool changeUserPassword(UserId userId, const QString &password);
120 //! Check if we can change a user password.
122 * \param userID The user's ID
123 * \return true, if we can change their password, false otherwise
125 static bool canChangeUserPassword(UserId userId);
127 //! Store a user setting persistently
129 * \param userId The users Id
130 * \param settingName The Name of the Setting
131 * \param data The Value
133 static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data)
135 instance()->_storage->setUserSetting(userId, settingName, data);
139 //! Retrieve a persistent user setting
141 * \param userId The users Id
142 * \param settingName The Name of the Setting
143 * \param defaultValue Value to return in case it's unset.
144 * \return the Value of the Setting or the default value if it is unset.
146 static inline QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultValue = QVariant())
148 return instance()->_storage->getUserSetting(userId, settingName, defaultValue);
152 /* Identity handling */
153 static inline IdentityId createIdentity(UserId user, CoreIdentity &identity)
155 return instance()->_storage->createIdentity(user, identity);
159 static bool updateIdentity(UserId user, const CoreIdentity &identity)
161 return instance()->_storage->updateIdentity(user, identity);
165 static void removeIdentity(UserId user, IdentityId identityId)
167 instance()->_storage->removeIdentity(user, identityId);
171 static QList<CoreIdentity> identities(UserId user)
173 return instance()->_storage->identities(user);
177 //! Create a Network in the Storage and store it's Id in the given NetworkInfo
178 /** \note This method is thredsafe.
180 * \param user The core user
181 * \param networkInfo a NetworkInfo definition to store the newly created ID in
182 * \return true if successfull.
184 static bool createNetwork(UserId user, NetworkInfo &info);
186 //! Apply the changes to NetworkInfo info to the storage engine
187 /** \note This method is thredsafe.
189 * \param user The core user
190 * \param networkInfo The Updated NetworkInfo
191 * \return true if successfull.
193 static inline bool updateNetwork(UserId user, const NetworkInfo &info)
195 return instance()->_storage->updateNetwork(user, info);
199 //! Permanently remove a Network and all the data associated with it.
200 /** \note This method is thredsafe.
202 * \param user The core user
203 * \param networkId The network to delete
204 * \return true if successfull.
206 static inline bool removeNetwork(UserId user, const NetworkId &networkId)
208 return instance()->_storage->removeNetwork(user, networkId);
212 //! Returns a list of all NetworkInfos for the given UserId user
213 /** \note This method is thredsafe.
215 * \param user The core user
216 * \return QList<NetworkInfo>.
218 static inline QList<NetworkInfo> networks(UserId user)
220 return instance()->_storage->networks(user);
224 //! Get a list of Networks to restore
225 /** Return a list of networks the user was connected at the time of core shutdown
226 * \note This method is threadsafe.
228 * \param user The User Id in question
230 static inline QList<NetworkId> connectedNetworks(UserId user)
232 return instance()->_storage->connectedNetworks(user);
236 //! Update the connected state of a network
237 /** \note This method is threadsafe
239 * \param user The Id of the networks owner
240 * \param networkId The Id of the network
241 * \param isConnected whether the network is connected or not
243 static inline void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected)
245 return instance()->_storage->setNetworkConnected(user, networkId, isConnected);
249 //! Get a hash of channels with their channel keys for a given network
250 /** The keys are channel names and values are passwords (possibly empty)
251 * \note This method is threadsafe
253 * \param user The id of the networks owner
254 * \param networkId The Id of the network
256 static inline QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId)
258 return instance()->_storage->persistentChannels(user, networkId);
262 //! Update the connected state of a channel
263 /** \note This method is threadsafe
265 * \param user The Id of the networks owner
266 * \param networkId The Id of the network
267 * \param channel The name of the channel
268 * \param isJoined whether the channel is connected or not
270 static inline void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined)
272 return instance()->_storage->setChannelPersistent(user, networkId, channel, isJoined);
276 //! Update the key of a channel
277 /** \note This method is threadsafe
279 * \param user The Id of the networks owner
280 * \param networkId The Id of the network
281 * \param channel The name of the channel
282 * \param key The key of the channel (possibly empty)
284 static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key)
286 return instance()->_storage->setPersistentChannelKey(user, networkId, channel, key);
290 //! retrieve last known away message for session restore
291 /** \note This method is threadsafe
293 * \param user The Id of the networks owner
294 * \param networkId The Id of the network
296 static inline QString awayMessage(UserId user, NetworkId networkId)
298 return instance()->_storage->awayMessage(user, networkId);
302 //! Make away message persistent for session restore
303 /** \note This method is threadsafe
305 * \param user The Id of the networks owner
306 * \param networkId The Id of the network
307 * \param awayMsg The current away message of own user
309 static inline void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg)
311 return instance()->_storage->setAwayMessage(user, networkId, awayMsg);
315 //! retrieve last known user mode for session restore
316 /** \note This method is threadsafe
318 * \param user The Id of the networks owner
319 * \param networkId The Id of the network
321 static inline QString userModes(UserId user, NetworkId networkId)
323 return instance()->_storage->userModes(user, networkId);
327 //! Make our user modes persistent for session restore
328 /** \note This method is threadsafe
330 * \param user The Id of the networks owner
331 * \param networkId The Id of the network
332 * \param userModes The current user modes of own user
334 static inline void setUserModes(UserId user, NetworkId networkId, const QString &userModes)
336 return instance()->_storage->setUserModes(user, networkId, userModes);
340 //! Get the unique BufferInfo for the given combination of network and buffername for a user.
341 /** \note This method is threadsafe.
343 * \param user The core user who owns this buffername
344 * \param networkId The network id
345 * \param type The type of the buffer (StatusBuffer, Channel, etc.)
346 * \param buffer The buffer name (if empty, the net's status buffer is returned)
347 * \param create Whether or not the buffer should be created if it doesnt exist
348 * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
350 static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true)
352 return instance()->_storage->bufferInfo(user, networkId, type, buffer, create);
356 //! Get the unique BufferInfo for a bufferId
357 /** \note This method is threadsafe
358 * \param user The core user who owns this buffername
359 * \param bufferId The id of the buffer
360 * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
362 static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId)
364 return instance()->_storage->getBufferInfo(user, bufferId);
368 //! Store a Message in the storage backend and set it's unique Id.
369 /** \note This method is threadsafe.
371 * \param message The message object to be stored
372 * \return true on success
374 static inline bool storeMessage(Message &message)
376 return instance()->_storage->logMessage(message);
380 //! Store a list of Messages in the storage backend and set their unique Id.
381 /** \note This method is threadsafe.
383 * \param messages The list message objects to be stored
384 * \return true on success
386 static inline bool storeMessages(MessageList &messages)
388 return instance()->_storage->logMessages(messages);
392 //! Request a certain number messages stored in a given buffer.
393 /** \param buffer The buffer we request messages from
394 * \param first if != -1 return only messages with a MsgId >= first
395 * \param last if != -1 return only messages with a MsgId < last
396 * \param limit if != -1 limit the returned list to a max of \limit entries
397 * \return The requested list of messages
399 static inline QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1)
401 return instance()->_storage->requestMsgs(user, bufferId, first, last, limit);
405 //! Request a certain number of messages across all buffers
406 /** \param first if != -1 return only messages with a MsgId >= first
407 * \param last if != -1 return only messages with a MsgId < last
408 * \param limit Max amount of messages
409 * \return The requested list of messages
411 static inline QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1)
413 return instance()->_storage->requestAllMsgs(user, first, last, limit);
417 //! Request a list of all buffers known to a user.
418 /** This method is used to get a list of all buffers we have stored a backlog from.
419 * \note This method is threadsafe.
421 * \param user The user whose buffers we request
422 * \return A list of the BufferInfos for all buffers as requested
424 static inline QList<BufferInfo> requestBuffers(UserId user)
426 return instance()->_storage->requestBuffers(user);
430 //! Request a list of BufferIds for a given NetworkId
431 /** \note This method is threadsafe.
433 * \param user The user whose buffers we request
434 * \param networkId The NetworkId of the network in question
435 * \return List of BufferIds belonging to the Network
437 static inline QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId)
439 return instance()->_storage->requestBufferIdsForNetwork(user, networkId);
443 //! Remove permanently a buffer and it's content from the storage backend
444 /** This call cannot be reverted!
445 * \note This method is threadsafe.
447 * \param user The user who is the owner of the buffer
448 * \param bufferId The bufferId
449 * \return true if successfull
451 static inline bool removeBuffer(const UserId &user, const BufferId &bufferId)
453 return instance()->_storage->removeBuffer(user, bufferId);
458 /** \note This method is threadsafe.
459 * \param user The id of the buffer owner
460 * \param bufferId The bufferId
461 * \param newName The new name of the buffer
462 * \return true if successfull
464 static inline bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName)
466 return instance()->_storage->renameBuffer(user, bufferId, newName);
470 //! Merge the content of two Buffers permanently. This cannot be reversed!
471 /** \note This method is threadsafe.
472 * \param user The id of the buffer owner
473 * \param bufferId1 The bufferId of the remaining buffer
474 * \param bufferId2 The buffer that is about to be removed
475 * \return true if successfulln
477 static inline bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2)
479 return instance()->_storage->mergeBuffersPermanently(user, bufferId1, bufferId2);
483 //! Update the LastSeenDate for a Buffer
484 /** This Method is used to make the LastSeenDate of a Buffer persistent
485 * \note This method is threadsafe.
487 * \param user The Owner of that Buffer
488 * \param bufferId The buffer id
489 * \param MsgId The Message id of the message that has been just seen
491 static inline void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId)
493 return instance()->_storage->setBufferLastSeenMsg(user, bufferId, msgId);
497 //! Get a Hash of all last seen message ids
498 /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
499 * \note This method is threadsafe.
501 * \param user The Owner of the buffers
503 static inline QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user)
505 return instance()->_storage->bufferLastSeenMsgIds(user);
509 //! Update the MarkerLineMsgId for a Buffer
510 /** This Method is used to make the marker line position of a Buffer persistent
511 * \note This method is threadsafe.
513 * \param user The Owner of that Buffer
514 * \param bufferId The buffer id
515 * \param MsgId The Message id where the marker line should be placed
517 static inline void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId)
519 return instance()->_storage->setBufferMarkerLineMsg(user, bufferId, msgId);
523 //! Get a Hash of all marker line message ids
524 /** This Method is called when the Quassel Core is started to restore the MarkerLineMsgIds
525 * \note This method is threadsafe.
527 * \param user The Owner of the buffers
529 static inline QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user)
531 return instance()->_storage->bufferMarkerLineMsgIds(user);
534 //! Update the BufferActivity for a Buffer
535 /** This Method is used to make the activity state of a Buffer persistent
536 * \note This method is threadsafe.
538 * \param user The Owner of that Buffer
539 * \param bufferId The buffer id
540 * \param MsgId The Message id where the marker line should be placed
542 static inline void setBufferActivity(UserId user, BufferId bufferId, Message::Types activity) {
543 return instance()->_storage->setBufferActivity(user, bufferId, activity);
547 //! Get a Hash of all buffer activity states
548 /** This Method is called when the Quassel Core is started to restore the BufferActivity
549 * \note This method is threadsafe.
551 * \param user The Owner of the buffers
553 static inline QHash<BufferId, Message::Types> bufferActivities(UserId user) {
554 return instance()->_storage->bufferActivities(user);
557 //! Get the bitset of buffer activity states for a buffer
558 /** This method is used to load the activity state of a buffer when its last seen message changes.
559 * \note This method is threadsafe.
561 * \param bufferId The buffer
562 * \param lastSeenMsgId The last seen message
564 static inline Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) {
565 return instance()->_storage->bufferActivity(bufferId, lastSeenMsgId);
568 static inline QDateTime startTime() { return instance()->_startTime; }
569 static inline bool isConfigured() { return instance()->_configured; }
570 static bool sslSupported();
573 * Reloads SSL certificates used for connection with clients
575 * @return True if certificates reloaded successfully, otherwise false.
577 static bool reloadCerts();
579 static QVariantList backendInfo();
580 static QVariantList authenticatorInfo();
582 static QString setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupMap);
584 static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; }
586 inline OidentdConfigGenerator *oidentdConfigGenerator() const { return _oidentdConfigGenerator; }
588 static const int AddClientEventId;
591 //! Make storage data persistent
592 /** \note This method is threadsafe.
595 void setupInternalClientSession(InternalPeer *clientConnection);
596 QString setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupMap);
599 //! Sent when a BufferInfo is updated in storage.
600 void bufferInfoUpdated(UserId user, const BufferInfo &info);
602 //! Relay from CoreSession::sessionState(). Used for internal connection only
603 void sessionState(const Protocol::SessionState &sessionState);
606 virtual void customEvent(QEvent *event);
609 bool startListening();
610 void stopListening(const QString &msg = QString());
611 void incomingConnection();
612 void clientDisconnected();
614 bool initStorage(const QString &backend, const QVariantMap &settings, bool setup = false);
615 bool initAuthenticator(const QString &backend, const QVariantMap &settings, bool setup = false);
617 void socketError(QAbstractSocket::SocketError err, const QString &errorString);
618 void setupClientSession(RemotePeer *, UserId);
620 bool changeUserPass(const QString &username);
626 static Core *instanceptr;
628 SessionThread *sessionForUser(UserId userId, bool restoreState = false);
629 void addClientHelper(RemotePeer *peer, UserId uid);
630 //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
631 QString setupCoreForInternalUsage();
635 template<typename Storage>
636 void registerStorageBackend();
638 template<typename Authenticator>
639 void registerAuthenticator();
641 void registerStorageBackends();
642 void registerAuthenticators();
644 DeferredSharedPtr<Storage> storageBackend(const QString& backendId) const;
645 DeferredSharedPtr<Authenticator> authenticator(const QString& authenticatorId) const;
647 bool selectBackend(const QString &backend);
648 bool selectAuthenticator(const QString &backend);
650 bool saveBackendSettings(const QString &backend, const QVariantMap &settings);
651 void saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings);
653 template<typename Backend>
654 QVariantMap promptForSettings(const Backend *backend);
657 QSet<CoreAuthHandler *> _connectingClients;
658 QHash<UserId, SessionThread *> _sessions;
659 DeferredSharedPtr<Storage> _storage; ///< Active storage backend
660 DeferredSharedPtr<Authenticator> _authenticator; ///< Active authenticator
661 QTimer _storageSyncTimer;
664 SslServer _server, _v6server;
666 QTcpServer _server, _v6server;
669 OidentdConfigGenerator *_oidentdConfigGenerator {nullptr};
671 std::vector<DeferredSharedPtr<Storage>> _registeredStorageBackends;
672 std::vector<DeferredSharedPtr<Authenticator>> _registeredAuthenticators;
674 QDateTime _startTime;
678 static std::unique_ptr<AbstractSqlMigrationReader> getMigrationReader(Storage *storage);
679 static std::unique_ptr<AbstractSqlMigrationWriter> getMigrationWriter(Storage *storage);
680 static void stdInEcho(bool on);
681 static inline void enableStdInEcho() { stdInEcho(true); }
682 static inline void disableStdInEcho() { stdInEcho(false); }