projects
/
quassel.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Fixed some indentation issues (and a typo).
[quassel.git]
/
src
/
core
/
storage.h
diff --git
a/src/core/storage.h
b/src/core/storage.h
index
17fdd70
..
b8f5c23
100644
(file)
--- a/
src/core/storage.h
+++ b/
src/core/storage.h
@@
-59,9
+59,13
@@
public slots:
/** \return A string that can be displayed by the client to describe the storage backend */
virtual QString description() const = 0;
/** \return A string that can be displayed by the client to describe the storage backend */
virtual QString description() const = 0;
- //! Returns a map where the keys are required properties to use the storage backend
+ //! 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 */
/* the values are QVariants with default values */
- virtual QVariantMap setupKeys() const = 0;
+ virtual QVariantMap setupDefaults() const = 0;
+
//! Setup the storage provider.
/** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
//! Setup the storage provider.
/** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
@@
-71,7
+75,7
@@
public slots:
virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
//! Initialize the storage provider
virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
//! Initialize the storage provider
- /** \param settings Hostname, port, username, password, ...
+ /** \param settings Hostname, port, username, password, ...
* \return the State the storage backend is now in (see Storage::State)
*/
virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
* \return the State the storage backend is now in (see Storage::State)
*/
virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
@@
-97,8
+101,9
@@
public slots:
//! Update a core user's password.
/** \param user The user's id
* \param password The user's new password
//! Update a core user's password.
/** \param user The user's id
* \param password The user's new password
+ * \return true on success.
*/
*/
- virtual
void
updateUser(UserId user, const QString &password) = 0;
+ virtual
bool
updateUser(UserId user, const QString &password) = 0;
//! Rename a user
/** \param user The user's id
//! Rename a user
/** \param user The user's id
@@
-113,6
+118,12
@@
public slots:
*/
virtual UserId validateUser(const QString &user, const QString &password) = 0;
*/
virtual UserId validateUser(const QString &user, const QString &password) = 0;
+ //! Check if a user with given username exists. Do not use for login purposes!
+ /** \param username The username to validate
+ * \return A valid UserId if the user exists; 0 else
+ */
+ virtual UserId getUserId(const QString &username) = 0;
+
//! Determine the UserId of the internal user
/** \return A valid UserId if the password matches the username; 0 else
*/
//! Determine the UserId of the internal user
/** \return A valid UserId if the password matches the username; 0 else
*/
@@
-130,7
+141,7
@@
public slots:
* \param data The Value
*/
virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
* \param data The Value
*/
virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) = 0;
-
+
//! Retrieve a persistent user setting
/**
* \param userId The users Id
//! Retrieve a persistent user setting
/**
* \param userId The users Id
@@
-145,7
+156,7
@@
public slots:
virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
virtual QList<CoreIdentity> identities(UserId user) = 0;
virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
virtual void removeIdentity(UserId user, IdentityId identityId) = 0;
virtual QList<CoreIdentity> identities(UserId user) = 0;
-
+
/* Network handling */
//! Create a new Network in the storage backend and return it unique Id
/* Network handling */
//! Create a new Network in the storage backend and return it unique Id
@@
-179,7
+190,7
@@
public slots:
* \return QList<NetworkInfo>.
*/
virtual QList<NetworkInfo> networks(UserId user) = 0;
* \return QList<NetworkInfo>.
*/
virtual QList<NetworkInfo> networks(UserId user) = 0;
-
+
//! 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.
//! 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.
@@
-338,14
+349,20
@@
public slots:
*/
virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
*/
virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) = 0;
-
+
/* Message handling */
/* Message handling */
- //! Store a Message in the
backlog
.
+ //! Store a Message in the
storage backend and set its unique Id
.
/** \param msg The message object to be stored
/** \param msg The message object to be stored
- * \return The globally unique id for the stored message
+ * \return true on success
+ */
+ virtual bool logMessage(Message &msg) = 0;
+
+ //! Store a list of Messages in the storage backend and set their unique Id.
+ /** \param msgs The list message objects to be stored
+ * \return true on success
*/
*/
- virtual
MsgId logMessage(Message msg
) = 0;
+ virtual
bool logMessages(MessageList &msgs
) = 0;
//! Request a certain number messages stored in a given buffer.
/** \param buffer The buffer we request messages from
//! Request a certain number messages stored in a given buffer.
/** \param buffer The buffer we request messages from