Deuglify channel state icons
[quassel.git] / src / core / sqlitestorage.h
index b661aed..fbb366f 100644 (file)
@@ -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  *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _SQLITESTORAGE_H_
-#define _SQLITESTORAGE_H_
+#ifndef SQLITESTORAGE_H
+#define SQLITESTORAGE_H
 
-#include <QCryptographicHash>
+#include "abstractsqlstorage.h"
 
-#include "storage.h"
+#include <QSqlDatabase>
 
 class QSqlQuery;
 
-class SqliteStorage : public Storage {
+class SqliteStorage : public AbstractSqlStorage {
   Q_OBJECT
 
-  public:
-    SqliteStorage();
-    virtual ~SqliteStorage();
-
-  public slots:
-    /* General */
-
-    static bool isAvailable();
-    static QString displayName();
-    virtual bool setup(const QVariantMap &settings = QVariantMap());
-    virtual bool init(const QVariantMap &settings = QVariantMap());
-
-    // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
-
-    /* User handling */
-
-    virtual UserId addUser(const QString &user, const QString &password);
-    virtual void updateUser(UserId user, const QString &password);
-    virtual void renameUser(UserId user, const QString &newName);
-    virtual UserId validateUser(const QString &user, const QString &password);
-    virtual void delUser(UserId user);
-
-    /* Network handling */
-    virtual uint getNetworkId(UserId user, const QString &network);
-
-    /* Buffer handling */
-    virtual BufferInfo getBufferInfo(UserId user, const QString &network, const QString &buffer = "");
-    virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime());
-
-    /* Message handling */
-
-    virtual MsgId logMessage(Message msg);
-    virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1);
-    virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1);
-    virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last);
-
-  signals:
-    void bufferInfoUpdated(BufferInfo);
-
-  protected:
-
-  private:
-    static QString backlogFile(bool createPath = false);
-    
-    void createBuffer(UserId user, const QString &network, const QString &buffer);
-    bool watchQuery(QSqlQuery *query);
-
-    QSqlDatabase logDb;
-
-    QSqlQuery *logMessageQuery;
-    QSqlQuery *addSenderQuery;
-    QSqlQuery *getLastMessageIdQuery;
-    QSqlQuery *requestMsgsQuery;
-    QSqlQuery *requestMsgsOffsetQuery;
-    QSqlQuery *requestMsgsSinceQuery;
-    QSqlQuery *requestMsgsSinceOffsetQuery;
-    QSqlQuery *requestMsgRangeQuery;
-    QSqlQuery *createNetworkQuery;
-    QSqlQuery *createBufferQuery;
-    QSqlQuery *getBufferInfoQuery;
+public:
+  SqliteStorage(QObject *parent = 0);
+  virtual ~SqliteStorage();
+
+public slots:
+  /* General */
+
+  bool isAvailable() const;
+  QString displayName() const;
+  QString description() const;
+
+  // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
+
+  /* User handling */
+
+  virtual UserId addUser(const QString &user, const QString &password);
+  virtual void updateUser(UserId user, const QString &password);
+  virtual void renameUser(UserId user, const QString &newName);
+  virtual UserId validateUser(const QString &user, const QString &password);
+  virtual UserId internalUser();
+  virtual void delUser(UserId user);
+  virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
+  virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
+
+  /* Identity handling */
+  virtual IdentityId createIdentity(UserId user, CoreIdentity &identity);
+  virtual bool updateIdentity(UserId user, const CoreIdentity &identity);
+  virtual void removeIdentity(UserId user, IdentityId identityId);
+  virtual QList<CoreIdentity> identities(UserId user);
+
+  /* Network handling */
+  virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
+  virtual bool updateNetwork(UserId user, const NetworkInfo &info);
+  virtual bool removeNetwork(UserId user, const NetworkId &networkId);
+  virtual QList<NetworkInfo> networks(UserId user);
+  virtual QList<NetworkId> connectedNetworks(UserId user);
+  virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
+
+  /* persistent channels */
+  virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
+  virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
+  virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
+
+  /* persistent user states */
+  virtual QString awayMessage(UserId user, NetworkId networkId);
+  virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg);
+  virtual QString userModes(UserId user, NetworkId networkId);
+  virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes);
+  
+  /* Buffer handling */
+  virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true);
+  virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
+  virtual QList<BufferInfo> requestBuffers(UserId user);
+  virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
+  virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
+  virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName);
+  virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2);
+  virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
+  virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
+
+  /* Message handling */
+
+  virtual MsgId logMessage(Message msg);
+  virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1);
+  virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1);
+
+protected:
+  inline virtual QString driverName() { return "QSQLITE"; }
+  inline virtual QString databaseName() { return backlogFile(); }
+  virtual int installedSchemaVersion();
+  virtual bool updateSchemaVersion(int newVersion);
+  virtual bool setupSchemaVersion(int version);
+  bool safeExec(QSqlQuery &query, int retryCount = 0);
+
+private:
+  static QString backlogFile();
+  bool isValidNetwork(UserId user, const NetworkId &networkId);
+  bool isValidBuffer(const UserId &user, const BufferId &bufferId);
+  NetworkId getNetworkId(UserId user, const QString &network);
+  void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer);
+
+  static int _maxRetryCount;
 };
 
 #endif