Fix license headers: Quassel IRC Team -> Quassel Project, 2007 -> 2008
[quassel.git] / src / core / sqlitestorage.h
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel Project                          *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #ifndef _SQLITESTORAGE_H_
22 #define _SQLITESTORAGE_H_
23
24 #include <QCryptographicHash>
25
26 #include "storage.h"
27
28 class QSqlQuery;
29
30 class SqliteStorage : public Storage {
31   Q_OBJECT
32
33   public:
34     SqliteStorage();
35     virtual ~SqliteStorage();
36
37   public slots:
38     /* General */
39
40     static bool isAvailable();
41     static QString displayName();
42     virtual bool setup(const QVariantMap &settings = QVariantMap());
43     virtual bool init(const QVariantMap &settings = QVariantMap());
44
45     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
46
47     /* User handling */
48
49     virtual UserId addUser(const QString &user, const QString &password);
50     virtual void updateUser(UserId user, const QString &password);
51     virtual void renameUser(UserId user, const QString &newName);
52     virtual UserId validateUser(const QString &user, const QString &password);
53     virtual void delUser(UserId user);
54
55     /* Network handling */
56     virtual uint getNetworkId(UserId user, const QString &network);
57
58     /* Buffer handling */
59     virtual BufferInfo getBufferInfo(UserId user, const QString &network, const QString &buffer = "");
60     virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime());
61
62     /* Message handling */
63
64     virtual MsgId logMessage(Message msg);
65     virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1);
66     virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1);
67     virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last);
68
69   signals:
70     void bufferInfoUpdated(BufferInfo);
71
72   protected:
73
74   private:
75     static QString backlogFile(bool createPath = false);
76     
77     void createBuffer(UserId user, const QString &network, const QString &buffer);
78     bool watchQuery(QSqlQuery *query);
79
80     QSqlDatabase logDb;
81
82     QSqlQuery *logMessageQuery;
83     QSqlQuery *addSenderQuery;
84     QSqlQuery *getLastMessageIdQuery;
85     QSqlQuery *requestMsgsQuery;
86     QSqlQuery *requestMsgsOffsetQuery;
87     QSqlQuery *requestMsgsSinceQuery;
88     QSqlQuery *requestMsgsSinceOffsetQuery;
89     QSqlQuery *requestMsgRangeQuery;
90     QSqlQuery *createNetworkQuery;
91     QSqlQuery *createBufferQuery;
92     QSqlQuery *getBufferInfoQuery;
93 };
94
95 #endif