1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef SQLITESTORAGE_H
22 #define SQLITESTORAGE_H
24 #include "abstractsqlstorage.h"
26 #include <QSqlDatabase>
30 class SqliteStorage : public AbstractSqlStorage {
34 SqliteStorage(QObject *parent = 0);
35 virtual ~SqliteStorage();
40 bool isAvailable() const;
41 QString displayName() const;
42 QString description() const;
44 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
48 virtual UserId addUser(const QString &user, const QString &password);
49 virtual void updateUser(UserId user, const QString &password);
50 virtual void renameUser(UserId user, const QString &newName);
51 virtual UserId validateUser(const QString &user, const QString &password);
52 virtual UserId internalUser();
53 virtual void delUser(UserId user);
54 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
55 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
57 /* Identity handling */
58 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity);
59 virtual bool updateIdentity(UserId user, const CoreIdentity &identity);
60 virtual void removeIdentity(UserId user, IdentityId identityId);
61 virtual QList<CoreIdentity> identities(UserId user);
63 /* Network handling */
64 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
65 virtual bool updateNetwork(UserId user, const NetworkInfo &info);
66 virtual bool removeNetwork(UserId user, const NetworkId &networkId);
67 virtual QList<NetworkInfo> networks(UserId user);
68 virtual QList<NetworkId> connectedNetworks(UserId user);
69 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
71 /* persistent channels */
72 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
73 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
74 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
77 virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true);
78 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
79 virtual QList<BufferInfo> requestBuffers(UserId user);
80 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
81 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
82 virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName);
83 virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2);
84 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
85 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
87 /* Message handling */
89 virtual MsgId logMessage(Message msg);
90 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1);
91 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1);
94 inline virtual QString driverName() { return "QSQLITE"; }
95 inline virtual QString databaseName() { return backlogFile(); }
96 virtual int installedSchemaVersion();
97 bool safeExec(QSqlQuery &query, int retryCount = 0);
100 static QString backlogFile();
101 bool isValidNetwork(UserId user, const NetworkId &networkId);
102 bool isValidBuffer(const UserId &user, const BufferId &bufferId);
103 NetworkId getNetworkId(UserId user, const QString &network);
104 void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer);
106 static int _maxRetryCount;