X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fstorage.h;h=d22372e3361b9d90ae1706bfcdbf54ab5fdc8f2b;hp=29a8df877c79e512da897e9d502067e0da3df418;hb=092e6b212637ffbf68800584b7c1f32d1931b602;hpb=7fb88a023ef8e4658b39d22c2d88c0d8bd6709f8 diff --git a/src/core/storage.h b/src/core/storage.h index 29a8df87..d22372e3 100644 --- a/src/core/storage.h +++ b/src/core/storage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -46,7 +46,7 @@ public: Sha1, Sha2_512, Latest=Sha2_512 - + }; public slots: @@ -59,6 +59,10 @@ public slots: */ virtual bool isAvailable() const = 0; + //! Returns the identifier of the authenticator backend + /** \return A string that can be used by the client to identify the authenticator backend */ + virtual QString backendId() const = 0; + //! Returns the display name of the storage backend /** \return A string that can be used by the client to name the storage backend */ virtual QString displayName() const = 0; @@ -67,12 +71,14 @@ public slots: /** \return A string that can be displayed by the client to describe the storage backend */ virtual QString description() const = 0; - //! Returns a list of properties required to use the storage backend - virtual QStringList setupKeys() const = 0; - - //! Returns a map where the keys are are properties to use the storage backend - /* the values are QVariants with default values */ - virtual QVariantMap setupDefaults() const = 0; + //! Returns data required to configure the authenticator backend + /** + * A list of flattened triples for each field: {key, translated field name, default value} + * The default value's type determines the kind of input widget to be shown + * (int -> QSpinBox; QString -> QLineEdit) + * \return A list of triples defining the data to be shown in the configuration dialog + */ + virtual QVariantList setupData() const = 0; //! Setup the storage provider. /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel. @@ -378,6 +384,79 @@ public slots: */ virtual QHash bufferMarkerLineMsgIds(UserId user) = 0; + //! Update the BufferActivity for a Buffer + /** This Method is used to make the activity state 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 + */ + virtual void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) = 0; + + //! Get a Hash of all buffer activity states + /** This Method is called when the Quassel Core is started to restore the BufferActivities + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + virtual QHash bufferActivities(UserId id) = 0; + + //! Get the bitset of buffer activity states for a buffer + /** This method is used to load the activity state of a buffer when its last seen message changes. + * \note This method is threadsafe. + * + * \param bufferId The buffer + * \param lastSeenMsgId The last seen message + */ + virtual Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) = 0; + + //! Get a hash of buffers with their ciphers for a given network + /** The keys are channel names and values are ciphers (possibly empty) + * \note This method is threadsafe + * + * \param user The id of the networks owner + * \param networkId The Id of the network + */ + virtual QHash bufferCiphers(UserId user, const NetworkId &networkId) = 0; + + //! Update the cipher of a buffer + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param bufferName The Cname of the buffer + * \param cipher The cipher for the buffer + */ + virtual void setBufferCipher(UserId user, const NetworkId &networkId, const QString &bufferName, const QByteArray &cipher) = 0; + + //! Update the highlight count for a Buffer + /** This Method is used to make the activity state 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 + */ + virtual void setHighlightCount(UserId id, BufferId bufferId, int count) = 0; + + //! Get a Hash of all highlight count states + /** This Method is called when the Quassel Core is started to restore the HighlightCounts + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + virtual QHash highlightCounts(UserId id) = 0; + + //! Get the highlight count states for a buffer + /** This method is used to load the activity state of a buffer when its last seen message changes. + * \note This method is threadsafe. + * + * \param bufferId The buffer + * \param lastSeenMsgId The last seen message + */ + virtual int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) = 0; + /* Message handling */ //! Store a Message in the storage backend and set its unique Id. @@ -409,6 +488,17 @@ public slots: */ virtual QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0; + //! Fetch all authusernames + /** \return Map of all current UserIds to permitted idents + */ + virtual QMap getAllAuthUserNames() = 0; + + //! Get the auth username associated with a userId + /** \param user The user to retrieve the username for + * \return The username for the user + */ + virtual QString getAuthUserName(UserId user) = 0; + signals: //! Sent when a new BufferInfo is created, or an existing one changed somehow. void bufferInfoUpdated(UserId user, const BufferInfo &);