Trying to fix random segfault upon connect...
[quassel.git] / src / core / storage.h
1 /***************************************************************************
2  *   Copyright (C) 2005-07 by The Quassel Team                             *
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) any later version.                                   *
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 _STORAGE_H_
22 #define _STORAGE_H_
23
24 #include <QtCore>
25 #include <QSqlDatabase>
26
27 //#include "global.h"
28 #include "message.h"
29
30 class Storage : public QObject {
31   Q_OBJECT
32
33   public:
34     Storage() {};
35     virtual ~Storage() {};
36
37     //! Initialize the static parts of the storage class
38     /** This is called by the core before any other method of the storage backend is used.
39      *  This should be used to perform any static initialization that might be necessary.
40      *  DO NOT use this for creating database connection or similar stuff, since init() might be
41      *  called even if the storage backend is never be actually used (because no user selected it).
42      *  For anything like this, the constructor (which is called if and when we actually create an instance
43      *  of the storage backend) is the right place.
44      */
45     static void init() {};
46
47     /* General */
48
49     //! Check if the storage type is available.
50     /** A storage subclass should return true if it can be successfully used, i.e. if all
51      *  prerequisites are in place (e.g. we have an appropriate DB driver etc.).
52      * \return True if and only if the storage class can be successfully used.
53      */
54     static bool isAvailable() { return false; }
55
56     //! Returns the display name of the storage backend
57     /** \return A string that can be used by the GUI to describe the storage backend */
58     static QString displayName() { return ""; }
59
60     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
61
62     /* User handling */
63
64     //! Add a new core user to the storage.
65     /** \param user     The username of the new user
66      *  \param password The cleartext password for the new user
67      *  \return The new user's UserId
68      */
69     virtual UserId addUser(QString user, QString password) = 0;
70
71     //! Update a core user's password.
72     /** \param user     The user's id
73      *  \param password The user's new password
74      */
75     virtual void updateUser(UserId user, QString password) = 0;
76
77     //! Validate a username with a given password.
78     /** \param user     The username to validate
79      *  \param password The user's alleged password
80      *  \return A valid UserId if the password matches the username; 0 else
81      */
82     virtual UserId validateUser(QString user, QString password) = 0;
83
84     //! Remove a core user from storage.
85     /** \param user     The userid to delete
86      */
87     virtual void delUser(UserId user) = 0;
88
89     /* Buffer handling */
90
91     //! Get the unique BufferId for the given combination of network and buffername for a user.
92     /** \param user    The core user who owns this buffername
93      *  \param network The network name
94      *  \param buffer  The buffer name (if empty, the net's status buffer is returned)
95      *  \return The BufferId corresponding to the given network and buffer name, or 0 if not found
96      */
97     virtual BufferId getBufferId(UserId user, QString network, QString buffer = "") = 0;
98
99     //! Request a list of all buffers known to a user since a certain point in time.
100     /** This method is used to get a list of all buffers we have stored a backlog from.
101      *  Optionally, a QDateTime can be given, so that only buffers are listed that where active
102      *  since that point in time.
103      *  \param user  The user whose buffers we request
104      *  \param since If this is defined, older buffers will be ignored
105      *  \return A list of the BufferIds for all buffers as requested
106      */
107     virtual QList<BufferId> requestBuffers(UserId user, QDateTime since = QDateTime()) = 0;
108
109     /* Message handling */
110
111     //! Store a Message in the backlog.
112     /** \param msg  The message object to be stored
113      *  \return The globally unique id for the stored message
114      */
115     virtual MsgId logMessage(Message msg) = 0;
116
117     //! Request a certain number (or all) messages stored in a given buffer.
118     /** \param buffer   The buffer we request messages from
119      *  \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername
120      *  \param offset   Do not return (but DO count) messages with MsgId >= offset, if offset >= 0
121      *  \return The requested list of messages
122      */
123     virtual QList<Message> requestMsgs(BufferId buffer, int lastmsgs = -1, int offset = -1) = 0;
124
125     //! Request messages stored in a given buffer since a certain point in time.
126     /** \param buffer   The buffer we request messages from
127      *  \param since    Only return messages newer than this point in time
128      *  \param offset   Do not return messages with MsgId >= offset, if offset >= 0
129      *  \return The requested list of messages
130      */
131     virtual QList<Message> requestMsgs(BufferId buffer, QDateTime since, int offset = -1) = 0;
132
133     //! Request a range of messages stored in a given buffer.
134     /** \param buffer   The buffer we request messages from
135      *  \param first    Return messages with first <= MsgId <= last
136      *  \param last     Return messages with first <= MsgId <= last
137      *  \return The requested list of messages
138      */
139     virtual QList<Message> requestMsgRange(BufferId buffer, int first, int last) = 0;
140
141   public slots:
142     //! This is just for importing the old file-based backlog */
143     /** This slot needs to be implemented in the storage backends.
144      *  It should first prepare (delete?) the database, then call initBackLogOld(UserId id).
145      *  If the importing was successful, backLogEnabledOld will be true afterwards.
146      */
147     virtual void importOldBacklog() = 0;
148
149   signals:
150     //! Sent if a new BufferId is created, or an existing one changed somehow.
151     void bufferIdUpdated(BufferId);
152
153   public:
154     /* Exceptions */
155     struct AuthError : public Exception {};
156
157   protected:
158     // Old stuff, just for importing old file-based data
159     void initBackLogOld(UserId id);
160
161     QSqlDatabase logDb; // FIXME this does not belong in the base class!
162       
163     bool backLogEnabledOld;
164     QDir backLogDir;
165     QHash<QString, QList<Message> > backLog;
166     QHash<QString, QFile *> logFiles;
167     QHash<QString, QDataStream *> logStreams;
168     QHash<QString, QDate> logFileDates;
169     QHash<QString, QDir> logFileDirs;
170
171 };
172
173
174 #endif