1 /***************************************************************************
2 * Copyright (C) 2005-08 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 void delUser(UserId user);
53 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
54 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
57 /* Network handling */
58 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
59 virtual bool updateNetwork(UserId user, const NetworkInfo &info);
60 virtual bool removeNetwork(UserId user, const NetworkId &networkId);
61 virtual QList<NetworkInfo> networks(UserId user);
62 virtual QList<NetworkId> connectedNetworks(UserId user);
63 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
65 /* persistent channels */
66 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
67 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
68 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
71 virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "");
72 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
73 virtual QList<BufferInfo> requestBuffers(UserId user);
74 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
75 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
76 virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName);
77 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
78 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
80 /* Message handling */
82 virtual MsgId logMessage(Message msg);
83 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, int lastmsgs = -1, int offset = -1);
84 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, QDateTime since, int offset = -1);
85 virtual QList<Message> requestMsgRange(UserId user, BufferId bufferId, int first, int last);
88 inline virtual QString driverName() { return "QSQLITE"; }
89 inline virtual QString databaseName() { return backlogFile(); }
90 virtual int installedSchemaVersion();
92 virtual bool init(const QVariantMap &settings = QVariantMap()); // only needed for migration
95 static QString backlogFile();
96 bool isValidNetwork(UserId user, const NetworkId &networkId);
97 bool isValidBuffer(const UserId &user, const BufferId &bufferId);
98 NetworkId getNetworkId(UserId user, const QString &network);
99 void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer);