/***************************************************************************
- * Copyright (C) 2005-07 by the Quassel IRC Team *
+ * Copyright (C) 2005-2016 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef _CORE_H_
-#define _CORE_H_
+#ifndef CORE_H
+#define CORE_H
+#include <QDateTime>
#include <QString>
#include <QVariant>
-#include <QTcpServer>
-#include <QTcpSocket>
+#include <QTimer>
-#include "global.h"
+#ifdef HAVE_SSL
+# include <QSslSocket>
+# include "sslserver.h"
+#else
+# include <QTcpSocket>
+# include <QTcpServer>
+#endif
+
+#include "bufferinfo.h"
+#include "message.h"
+#include "oidentdconfiggenerator.h"
+#include "sessionthread.h"
+#include "storage.h"
#include "types.h"
+class CoreAuthHandler;
class CoreSession;
-class Storage;
+struct NetworkInfo;
+class SessionThread;
+class SignalProxy;
-class Core : public QObject {
- Q_OBJECT
+class AbstractSqlMigrationReader;
+class AbstractSqlMigrationWriter;
- public:
- static Core * instance();
- static void destroy();
+class Core : public QObject
+{
+ Q_OBJECT
- static CoreSession * session(UserId);
- static CoreSession * localSession();
- static CoreSession * createSession(UserId);
-
- static QVariant connectLocalClient(QString user, QString passwd);
- static void disconnectLocalClient();
+public:
+ static Core *instance();
+ static void destroy();
static void saveState();
static void restoreState();
- private slots:
- bool startListening(uint port = Global::defaultPort);
- void stopListening();
+ /*** Storage access ***/
+ // These methods are threadsafe.
+
+ //! Validate user
+ /**
+ * \param userName The user's login name
+ * \param password The user's uncrypted password
+ * \return The user's ID if valid; 0 otherwise
+ */
+ static inline UserId validateUser(const QString &userName, const QString &password) {
+ return instance()->_storage->validateUser(userName, password);
+ }
+
+
+ //! Change a user's password
+ /**
+ * \param userId The user's ID
+ * \param password The user's unencrypted new password
+ * \return true, if the password change was successful
+ */
+ static bool changeUserPassword(UserId userId, const QString &password);
+
+ //! Store a user setting persistently
+ /**
+ * \param userId The users Id
+ * \param settingName The Name of the Setting
+ * \param data The Value
+ */
+ static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data)
+ {
+ instance()->_storage->setUserSetting(userId, settingName, data);
+ }
+
+
+ //! Retrieve a persistent user setting
+ /**
+ * \param userId The users Id
+ * \param settingName The Name of the Setting
+ * \param defaultValue Value to return in case it's unset.
+ * \return the Value of the Setting or the default value if it is unset.
+ */
+ static inline QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultValue = QVariant())
+ {
+ return instance()->_storage->getUserSetting(userId, settingName, defaultValue);
+ }
+
+
+ /* Identity handling */
+ static inline IdentityId createIdentity(UserId user, CoreIdentity &identity)
+ {
+ return instance()->_storage->createIdentity(user, identity);
+ }
+
+
+ static bool updateIdentity(UserId user, const CoreIdentity &identity)
+ {
+ return instance()->_storage->updateIdentity(user, identity);
+ }
+
+
+ static void removeIdentity(UserId user, IdentityId identityId)
+ {
+ instance()->_storage->removeIdentity(user, identityId);
+ }
+
+
+ static QList<CoreIdentity> identities(UserId user)
+ {
+ return instance()->_storage->identities(user);
+ }
+
+
+ //! Create a Network in the Storage and store it's Id in the given NetworkInfo
+ /** \note This method is thredsafe.
+ *
+ * \param user The core user
+ * \param networkInfo a NetworkInfo definition to store the newly created ID in
+ * \return true if successfull.
+ */
+ static bool createNetwork(UserId user, NetworkInfo &info);
+
+ //! Apply the changes to NetworkInfo info to the storage engine
+ /** \note This method is thredsafe.
+ *
+ * \param user The core user
+ * \param networkInfo The Updated NetworkInfo
+ * \return true if successfull.
+ */
+ static inline bool updateNetwork(UserId user, const NetworkInfo &info)
+ {
+ return instance()->_storage->updateNetwork(user, info);
+ }
+
+
+ //! Permanently remove a Network and all the data associated with it.
+ /** \note This method is thredsafe.
+ *
+ * \param user The core user
+ * \param networkId The network to delete
+ * \return true if successfull.
+ */
+ static inline bool removeNetwork(UserId user, const NetworkId &networkId)
+ {
+ return instance()->_storage->removeNetwork(user, networkId);
+ }
+
+
+ //! Returns a list of all NetworkInfos for the given UserId user
+ /** \note This method is thredsafe.
+ *
+ * \param user The core user
+ * \return QList<NetworkInfo>.
+ */
+ static inline QList<NetworkInfo> networks(UserId user)
+ {
+ return instance()->_storage->networks(user);
+ }
+
+
+ //! Get a list of Networks to restore
+ /** Return a list of networks the user was connected at the time of core shutdown
+ * \note This method is threadsafe.
+ *
+ * \param user The User Id in question
+ */
+ static inline QList<NetworkId> connectedNetworks(UserId user)
+ {
+ return instance()->_storage->connectedNetworks(user);
+ }
+
+
+ //! Update the connected state of a network
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param isConnected whether the network is connected or not
+ */
+ static inline void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected)
+ {
+ return instance()->_storage->setNetworkConnected(user, networkId, isConnected);
+ }
+
+
+ //! Get a hash of channels with their channel keys for a given network
+ /** The keys are channel names and values are passwords (possibly empty)
+ * \note This method is threadsafe
+ *
+ * \param user The id of the networks owner
+ * \param networkId The Id of the network
+ */
+ static inline QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId)
+ {
+ return instance()->_storage->persistentChannels(user, networkId);
+ }
+
+
+ //! Update the connected state of a channel
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param channel The name of the channel
+ * \param isJoined whether the channel is connected or not
+ */
+ static inline void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined)
+ {
+ return instance()->_storage->setChannelPersistent(user, networkId, channel, isJoined);
+ }
+
+
+ //! Update the key of a channel
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param channel The name of the channel
+ * \param key The key of the channel (possibly empty)
+ */
+ static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key)
+ {
+ return instance()->_storage->setPersistentChannelKey(user, networkId, channel, key);
+ }
+
+
+ //! retrieve last known away message for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ */
+ static inline QString awayMessage(UserId user, NetworkId networkId)
+ {
+ return instance()->_storage->awayMessage(user, networkId);
+ }
+
+
+ //! Make away message persistent for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param awayMsg The current away message of own user
+ */
+ static inline void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg)
+ {
+ return instance()->_storage->setAwayMessage(user, networkId, awayMsg);
+ }
+
+
+ //! retrieve last known user mode for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ */
+ static inline QString userModes(UserId user, NetworkId networkId)
+ {
+ return instance()->_storage->userModes(user, networkId);
+ }
+
+
+ //! Make our user modes persistent for session restore
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param userModes The current user modes of own user
+ */
+ static inline void setUserModes(UserId user, NetworkId networkId, const QString &userModes)
+ {
+ return instance()->_storage->setUserModes(user, networkId, userModes);
+ }
+
+
+ //! Get the unique BufferInfo for the given combination of network and buffername for a user.
+ /** \note This method is threadsafe.
+ *
+ * \param user The core user who owns this buffername
+ * \param networkId The network id
+ * \param type The type of the buffer (StatusBuffer, Channel, etc.)
+ * \param buffer The buffer name (if empty, the net's status buffer is returned)
+ * \param create Whether or not the buffer should be created if it doesnt exist
+ * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
+ */
+ static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true)
+ {
+ return instance()->_storage->bufferInfo(user, networkId, type, buffer, create);
+ }
+
+
+ //! Get the unique BufferInfo for a bufferId
+ /** \note This method is threadsafe
+ * \param user The core user who owns this buffername
+ * \param bufferId The id of the buffer
+ * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found.
+ */
+ static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId)
+ {
+ return instance()->_storage->getBufferInfo(user, bufferId);
+ }
+
+
+ //! Store a Message in the storage backend and set it's unique Id.
+ /** \note This method is threadsafe.
+ *
+ * \param message The message object to be stored
+ * \return true on success
+ */
+ static inline bool storeMessage(Message &message)
+ {
+ return instance()->_storage->logMessage(message);
+ }
+
+
+ //! Store a list of Messages in the storage backend and set their unique Id.
+ /** \note This method is threadsafe.
+ *
+ * \param messages The list message objects to be stored
+ * \return true on success
+ */
+ static inline bool storeMessages(MessageList &messages)
+ {
+ return instance()->_storage->logMessages(messages);
+ }
+
+
+ //! Request a certain number messages stored in a given buffer.
+ /** \param buffer The buffer we request messages from
+ * \param first if != -1 return only messages with a MsgId >= first
+ * \param last if != -1 return only messages with a MsgId < last
+ * \param limit if != -1 limit the returned list to a max of \limit entries
+ * \return The requested list of messages
+ */
+ static inline QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1)
+ {
+ return instance()->_storage->requestMsgs(user, bufferId, first, last, limit);
+ }
+
+
+ //! Request a certain number of messages across all buffers
+ /** \param first if != -1 return only messages with a MsgId >= first
+ * \param last if != -1 return only messages with a MsgId < last
+ * \param limit Max amount of messages
+ * \return The requested list of messages
+ */
+ static inline QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1)
+ {
+ return instance()->_storage->requestAllMsgs(user, first, last, limit);
+ }
+
+
+ //! Request a list of all buffers known to a user.
+ /** This method is used to get a list of all buffers we have stored a backlog from.
+ * \note This method is threadsafe.
+ *
+ * \param user The user whose buffers we request
+ * \return A list of the BufferInfos for all buffers as requested
+ */
+ static inline QList<BufferInfo> requestBuffers(UserId user)
+ {
+ return instance()->_storage->requestBuffers(user);
+ }
+
+
+ //! Request a list of BufferIds for a given NetworkId
+ /** \note This method is threadsafe.
+ *
+ * \param user The user whose buffers we request
+ * \param networkId The NetworkId of the network in question
+ * \return List of BufferIds belonging to the Network
+ */
+ static inline QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId)
+ {
+ return instance()->_storage->requestBufferIdsForNetwork(user, networkId);
+ }
+
+
+ //! Remove permanently a buffer and it's content from the storage backend
+ /** This call cannot be reverted!
+ * \note This method is threadsafe.
+ *
+ * \param user The user who is the owner of the buffer
+ * \param bufferId The bufferId
+ * \return true if successfull
+ */
+ static inline bool removeBuffer(const UserId &user, const BufferId &bufferId)
+ {
+ return instance()->_storage->removeBuffer(user, bufferId);
+ }
+
+
+ //! Rename a Buffer
+ /** \note This method is threadsafe.
+ * \param user The id of the buffer owner
+ * \param bufferId The bufferId
+ * \param newName The new name of the buffer
+ * \return true if successfull
+ */
+ static inline bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName)
+ {
+ return instance()->_storage->renameBuffer(user, bufferId, newName);
+ }
+
+
+ //! Merge the content of two Buffers permanently. This cannot be reversed!
+ /** \note This method is threadsafe.
+ * \param user The id of the buffer owner
+ * \param bufferId1 The bufferId of the remaining buffer
+ * \param bufferId2 The buffer that is about to be removed
+ * \return true if successfulln
+ */
+ static inline bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2)
+ {
+ return instance()->_storage->mergeBuffersPermanently(user, bufferId1, bufferId2);
+ }
+
+
+ //! Update the LastSeenDate for a Buffer
+ /** This Method is used to make the LastSeenDate of a Buffer persistent
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of that Buffer
+ * \param bufferId The buffer id
+ * \param MsgId The Message id of the message that has been just seen
+ */
+ static inline void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId)
+ {
+ return instance()->_storage->setBufferLastSeenMsg(user, bufferId, msgId);
+ }
+
+
+ //! Get a Hash of all last seen message ids
+ /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of the buffers
+ */
+ static inline QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user)
+ {
+ return instance()->_storage->bufferLastSeenMsgIds(user);
+ }
+
+
+ //! Update the MarkerLineMsgId for a Buffer
+ /** This Method is used to make the marker line position of a Buffer persistent
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of that Buffer
+ * \param bufferId The buffer id
+ * \param MsgId The Message id where the marker line should be placed
+ */
+ static inline void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId)
+ {
+ return instance()->_storage->setBufferMarkerLineMsg(user, bufferId, msgId);
+ }
+
+
+ //! Get a Hash of all marker line message ids
+ /** This Method is called when the Quassel Core is started to restore the MarkerLineMsgIds
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of the buffers
+ */
+ static inline QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user)
+ {
+ return instance()->_storage->bufferMarkerLineMsgIds(user);
+ }
+
+
+ static inline QDateTime startTime() { return instance()->_startTime; }
+ static inline bool isConfigured() { return instance()->_configured; }
+ static bool sslSupported();
+
+ /**
+ * Reloads SSL certificates used for connection with clients
+ *
+ * @return True if certificates reloaded successfully, otherwise false.
+ */
+ static bool reloadCerts();
+
+ static QVariantList backendInfo();
+
+ /**
+ * Checks if a storage backend is the default storage backend. This
+ * hardcodes this information into the core (not the client).
+ *
+ * \param backend The backend to check.
+ *
+ * @return True if storage backend is default, false otherwise.
+ */
+ static inline bool isStorageBackendDefault(const Storage *backend)
+ {
+ return (backend->displayName() == "SQLite") ? true : false;
+ }
+
+ static QString setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData);
+
+ static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; }
+
+ inline OidentdConfigGenerator *oidentdConfigGenerator() const { return _oidentdConfigGenerator; }
+
+ static const int AddClientEventId;
+
+public slots:
+ //! Make storage data persistent
+ /** \note This method is threadsafe.
+ */
+ void syncStorage();
+ void setupInternalClientSession(InternalPeer *clientConnection);
+ QString setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData);
+
+signals:
+ //! Sent when a BufferInfo is updated in storage.
+ void bufferInfoUpdated(UserId user, const BufferInfo &info);
+
+ //! Relay from CoreSession::sessionState(). Used for internal connection only
+ void sessionState(const Protocol::SessionState &sessionState);
+
+protected:
+ virtual void customEvent(QEvent *event);
+
+private slots:
+ bool startListening();
+ void stopListening(const QString &msg = QString());
void incomingConnection();
- void clientHasData();
void clientDisconnected();
- bool initStorageSqlite(QVariantMap dbSettings, bool setup);
+ bool initStorage(const QString &backend, const QVariantMap &settings, bool setup = false);
+
+ void socketError(QAbstractSocket::SocketError err, const QString &errorString);
+ void setupClientSession(RemotePeer *, UserId);
- private:
+ bool changeUserPass(const QString &username);
+
+private:
Core();
~Core();
void init();
static Core *instanceptr;
-
- //! Initiate a session for the user with the given credentials if one does not already exist.
- /** This function is called during the init process for a new client. If there is no session for the
- * given user, one is created.
- * \param userId The user
- * \return A QVariant containing the session data, e.g. global data and buffers
- */
- QVariant initSession(UserId userId);
- void processClientInit(QTcpSocket *socket, const QVariantMap &msg);
- void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
-
- QStringList availableStorageProviders();
-
- UserId guiUser;
- QHash<UserId, CoreSession *> sessions;
- Storage *storage;
-
- QTcpServer server; // TODO: implement SSL
- QHash<QTcpSocket *, quint32> blockSizes;
-
- bool configured;
+
+ SessionThread *sessionForUser(UserId userId, bool restoreState = false);
+ void addClientHelper(RemotePeer *peer, UserId uid);
+ //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
+ QString setupCoreForInternalUsage();
+
+ void registerStorageBackends();
+ bool registerStorageBackend(Storage *);
+ void unregisterStorageBackends();
+ void unregisterStorageBackend(Storage *);
+ bool selectBackend(const QString &backend);
+ bool createUser();
+ bool saveBackendSettings(const QString &backend, const QVariantMap &settings);
+ QVariantMap promptForSettings(const Storage *storage);
+
+private:
+ QSet<CoreAuthHandler *> _connectingClients;
+ QHash<UserId, SessionThread *> _sessions;
+ Storage *_storage;
+ QTimer _storageSyncTimer;
+
+#ifdef HAVE_SSL
+ SslServer _server, _v6server;
+#else
+ QTcpServer _server, _v6server;
+#endif
+
+ OidentdConfigGenerator *_oidentdConfigGenerator;
+
+ QHash<QString, Storage *> _storageBackends;
+
+ QDateTime _startTime;
+
+ bool _configured;
+
+ static AbstractSqlMigrationReader *getMigrationReader(Storage *storage);
+ static AbstractSqlMigrationWriter *getMigrationWriter(Storage *storage);
+ static void stdInEcho(bool on);
+ static inline void enableStdInEcho() { stdInEcho(true); }
+ static inline void disableStdInEcho() { stdInEcho(false); }
};
+
#endif
projects / quassel.git / blobdiff