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);
54 /* Network handling */
55 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
56 virtual bool updateNetwork(UserId user, const NetworkInfo &info);
57 virtual bool removeNetwork(UserId user, const NetworkId &networkId);
58 virtual QList<NetworkInfo> networks(UserId user);
59 virtual QList<NetworkId> connectedNetworks(UserId user);
60 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
62 /* persistent channels */
63 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
64 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
65 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
68 virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "");
69 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
70 virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime());
71 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
72 virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName);
73 virtual void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate);
74 virtual QHash<BufferId, QDateTime> bufferLastSeenDates(UserId user);
76 /* Message handling */
78 virtual MsgId logMessage(Message msg);
79 virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1);
80 virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1);
81 virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last);
84 inline virtual QString driverName() { return "QSQLITE"; }
85 inline virtual QString databaseName() { return backlogFile(); }
86 virtual int installedSchemaVersion();
88 virtual bool init(const QVariantMap &settings = QVariantMap()); // only needed for migration
91 static QString backlogFile();
92 bool isValidNetwork(UserId user, const NetworkId &networkId);
93 bool isValidBuffer(const UserId &user, const BufferId &bufferId);
94 NetworkId getNetworkId(UserId user, const QString &network);
95 void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer);