X-Git-Url: https://git.quassel-irc.org/?a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=815030f126c7e08bb7470145cc0edc7e16ce376a;hb=f998a95ef357691a8b4cb229602528edd39503bb;hp=083bf8cf051e296ee5e124bdc7bee2939446a5ab;hpb=335e1e55ee8df69b37b1b4d839950ced9ac08cc4;p=quassel.git diff --git a/src/core/core.h b/src/core/core.h index 083bf8cf..815030f1 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel Project * + * Copyright (C) 2005-09 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -65,7 +65,7 @@ class Core : public QObject { * \param data The Value */ static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) { - instance()->storage->setUserSetting(userId, settingName, data); + instance()->_storage->setUserSetting(userId, settingName, data); } //! Retrieve a persistent user setting @@ -76,9 +76,22 @@ class Core : public QObject { * \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 &data = QVariant()) { - return instance()->storage->getUserSetting(userId, settingName, data); + return instance()->_storage->getUserSetting(userId, settingName, data); } + /* 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 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. @@ -97,7 +110,7 @@ class Core : public QObject { * \return true if successfull. */ static inline bool updateNetwork(UserId user, const NetworkInfo &info) { - return instance()->storage->updateNetwork(user, info); + return instance()->_storage->updateNetwork(user, info); } //! Permanently remove a Network and all the data associated with it. @@ -108,7 +121,7 @@ class Core : public QObject { * \return true if successfull. */ static inline bool removeNetwork(UserId user, const NetworkId &networkId) { - return instance()->storage->removeNetwork(user, networkId); + return instance()->_storage->removeNetwork(user, networkId); } //! Returns a list of all NetworkInfos for the given UserId user @@ -118,18 +131,7 @@ class Core : public QObject { * \return QList. */ static inline QList networks(UserId user) { - return instance()->storage->networks(user); - } - - //! Get the NetworkId for a network name. - /** \note This method is threadsafe. - * - * \param user The core user - * \param network The name of the network - * \return The NetworkId corresponding to the given network. - */ - static inline NetworkId networkId(UserId user, const QString &network) { - return instance()->storage->getNetworkId(user, network); + return instance()->_storage->networks(user); } //! Get a list of Networks to restore @@ -139,7 +141,7 @@ class Core : public QObject { * \param user The User Id in question */ static inline QList connectedNetworks(UserId user) { - return instance()->storage->connectedNetworks(user); + return instance()->_storage->connectedNetworks(user); } //! Update the connected state of a network @@ -150,7 +152,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setNetworkConnected(user, networkId, isConnected); } //! Get a hash of channels with their channel keys for a given network @@ -161,7 +163,7 @@ class Core : public QObject { * \param networkId The Id of the network */ static inline QHash persistentChannels(UserId user, const NetworkId &networkId) { - return instance()->storage->persistentChannels(user, networkId); + return instance()->_storage->persistentChannels(user, networkId); } //! Update the connected state of a channel @@ -173,7 +175,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setChannelPersistent(user, networkId, channel, isJoined); } //! Update the key of a channel @@ -185,7 +187,49 @@ class Core : public QObject { * \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); + 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. @@ -195,10 +239,11 @@ class Core : public QObject { * \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 = "") { - return instance()->storage->getBufferInfo(user, networkId, type, buffer); + 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 @@ -208,17 +253,27 @@ class Core : public QObject { * \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); + return instance()->_storage->getBufferInfo(user, bufferId); } - //! Store a Message in the backlog. + //! Store a Message in the storage backend and set it's unique Id. /** \note This method is threadsafe. * - * \param msg The message object to be stored - * \return The globally unique id for the stored message + * \param message The message object to be stored + * \return true on success */ - static inline MsgId storeMessage(const Message &message) { - return instance()->storage->logMessage(message); + 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. @@ -229,7 +284,7 @@ class Core : public QObject { * \return The requested list of messages */ static inline QList requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) { - return instance()->storage->requestMsgs(user, bufferId, first, last, limit); + return instance()->_storage->requestMsgs(user, bufferId, first, last, limit); } //! Request a certain number of messages across all buffers @@ -239,7 +294,7 @@ class Core : public QObject { * \return The requested list of messages */ static inline QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) { - return instance()->storage->requestAllMsgs(user, first, last, limit); + return instance()->_storage->requestAllMsgs(user, first, last, limit); } //! Request a list of all buffers known to a user. @@ -250,7 +305,7 @@ class Core : public QObject { * \return A list of the BufferInfos for all buffers as requested */ static inline QList requestBuffers(UserId user) { - return instance()->storage->requestBuffers(user); + return instance()->_storage->requestBuffers(user); } //! Request a list of BufferIds for a given NetworkId @@ -261,7 +316,7 @@ class Core : public QObject { * \return List of BufferIds belonging to the Network */ static inline QList requestBufferIdsForNetwork(UserId user, NetworkId networkId) { - return instance()->storage->requestBufferIdsForNetwork(user, networkId); + return instance()->_storage->requestBufferIdsForNetwork(user, networkId); } //! Remove permanently a buffer and it's content from the storage backend @@ -273,19 +328,29 @@ class Core : public QObject { * \return true if successfull */ static inline bool removeBuffer(const UserId &user, const BufferId &bufferId) { - return instance()->storage->removeBuffer(user, bufferId); + return instance()->_storage->removeBuffer(user, bufferId); } //! Rename a Buffer /** \note This method is threadsafe. * \param user The id of the buffer owner - * \param networkId The id of the network the buffer belongs to + * \param bufferId The bufferId * \param newName The new name of the buffer - * \param oldName The previous name of the buffer - * \return the BufferId of the affected buffer or an invalid BufferId if not successfull + * \return true if successfull */ - static inline BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) { - return instance()->storage->renameBuffer(user, networkId, newName, oldName); + 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 @@ -297,7 +362,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setBufferLastSeenMsg(user, bufferId, msgId); } //! Get a Hash of all last seen message ids @@ -307,11 +372,13 @@ class Core : public QObject { * \param user The Owner of the buffers */ static inline QHash bufferLastSeenMsgIds(UserId user) { - return instance()->storage->bufferLastSeenMsgIds(user); + return instance()->_storage->bufferLastSeenMsgIds(user); } const QDateTime &startTime() const { return _startTime; } + static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; } + public slots: //! Make storage data persistent /** \note This method is threadsafe. @@ -332,6 +399,7 @@ private slots: void clientHasData(); void clientDisconnected(); + bool initStorage(const QString &backend, QVariantMap settings, bool setup = false); bool initStorage(QVariantMap dbSettings, bool setup = false); #ifdef HAVE_SSL @@ -352,11 +420,17 @@ private: QString setupCoreForInternalUsage(); QString setupCore(QVariantMap setupData); + void registerStorageBackends(); bool registerStorageBackend(Storage *); + void unregisterStorageBackends(); void unregisterStorageBackend(Storage *); + bool migrateBackend(const QString &backend); + bool switchBackend(const QString &backend); + void saveBackendSettings(const QString &backend, const QVariantMap &settings); + QVariantMap promptForSettings(const Storage *storage); QHash sessions; - Storage *storage; + Storage *_storage; QTimer _storageSyncTimer; #ifdef HAVE_SSL @@ -372,7 +446,7 @@ private: QDateTime _startTime; - bool configured; + bool _configured; }; #endif