X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=2255f56a03d389a2389893beffb4a776153bdf42;hp=6b0126cac7dd39d34ca31cb5c976cf2e9d3afbf2;hb=1f7cffc751c022ddea816db471f7870a60dc0d1c;hpb=0c9cd0eef379e1d3e10a75cc8506a7e65f95fd67 diff --git a/src/core/core.h b/src/core/core.h index 6b0126ca..2255f56a 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -53,15 +53,41 @@ class Core : public QObject { /*** Storage access ***/ // These methods are threadsafe. - //! Create a NetworkId in the Storage and store it in the given NetworkInfo + //! 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 createNetworkId(UserId user, NetworkInfo &info); + 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 bool updateNetwork(UserId user, const NetworkInfo &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 bool removeNetwork(UserId user, const NetworkId &networkId); + + //! Returns a list of all NetworkInfos for the given UserId user + /** \note This method is thredsafe. + * + * \param user The core user + * \return QList. + */ + static QList networks(UserId user); + //! Get the NetworkId for a network name. /** \note This method is threadsafe. * @@ -71,16 +97,72 @@ class Core : public QObject { */ static NetworkId networkId(UserId user, const QString &network); + //! 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 QList connectedNetworks(UserId 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 void setNetworkConnected(UserId user, const NetworkId &networkId, bool 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 QHash persistentChannels(UserId user, const NetworkId &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 void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool 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 void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key); + //! 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) * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found */ - static BufferInfo bufferInfo(UserId user, const NetworkId &networkId, const QString &buffer = ""); + static BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type, const QString &buffer = ""); + //! 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 BufferInfo getBufferInfo(UserId user, const BufferId &bufferId); + + //! Store a Message in the backlog. /** \note This method is threadsafe. * @@ -131,6 +213,44 @@ class Core : public QObject { */ static QList requestBuffers(UserId user, QDateTime since = QDateTime()); + //! 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 bool removeBuffer(const UserId &user, const BufferId &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 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 + */ + static BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName); + + //! 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 seenDate Time the Buffer has been visited the last time + */ + static void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate); + + //! Get a Hash of all last seen dates. + /** This Method is called when the Quassel Core is started to restore the lastSeenDates + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + static QHash bufferLastSeenDates(UserId user); + public slots: //! Make storage data persistent /** \note This method is threadsafe.