beautyfied the code in userinputhandler::handlectcp
[quassel.git] / src / core / storage.h
index f493721..1af8d86 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by The Quassel Team                             *
+ *   Copyright (C) 2005-08 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   (at your option) version 3.                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
@@ -22,7 +22,6 @@
 #define _STORAGE_H_
 
 #include <QtCore>
-#include <QSqlDatabase>
 
 #include "message.h"
 
@@ -30,19 +29,10 @@ class Storage : public QObject {
   Q_OBJECT
 
   public:
-    Storage() {};
+    Storage(QObject *parent = 0);
     virtual ~Storage() {};
 
-    //! Initialize the static parts of the storage class
-    /** This is called by the core before any other method of the storage backend is used.
-     *  This should be used to perform any static initialization that might be necessary.
-     *  DO NOT use this for creating database connection or similar stuff, since init() might be
-     *  called even if the storage backend is never be actually used (because no user selected it).
-     *  For anything like this, the constructor (which is called if and when we actually create an instance
-     *  of the storage backend) is the right place.
-     */
-    static void init() {};
-
+  public slots:
     /* General */
 
     //! Check if the storage type is available.
@@ -56,6 +46,19 @@ class Storage : public QObject {
     /** \return A string that can be used by the GUI to describe the storage backend */
     static QString displayName() { return ""; }
 
+    //! Setup the storage provider.
+    /** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
+     *  \param settings   Hostname, port, username, password, ...
+     *  \return True if and only if the storage provider was initialized successfully.
+     */
+    virtual bool setup(const QVariantMap &settings = QVariantMap()) { Q_UNUSED(settings); return false; }
+    
+    //! Initialize the storage provider
+    /** \param settings   Hostname, port, username, password, ...  
+     *  \return True if and only if the storage provider was initialized successfully.
+     */
+    virtual bool init(const QVariantMap &settings = QVariantMap()) = 0;
+    
     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
 
     /* User handling */
@@ -98,7 +101,7 @@ class Storage : public QObject {
      *  \param network The network name
      *  \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found
      */
-    virtual uint getNetworkId(UserId user, const QString &network) = 0;
+    virtual NetworkId getNetworkId(UserId user, const QString &network) = 0;
 
     /* Buffer handling */
 
@@ -152,17 +155,9 @@ class Storage : public QObject {
      */
     virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last) = 0;
 
-  public slots:
-    //! This is just for importing the old file-based backlog */
-    /** This slot needs to be implemented in the storage backends.
-     *  It should first prepare (delete?) the database, then call initBackLogOld(UserId id).
-     *  If the importing was successful, backLogEnabledOld will be true afterwards.
-     */
-    virtual void importOldBacklog() = 0;
-
   signals:
     //! Sent when a new BufferInfo is created, or an existing one changed somehow.
-    void bufferInfoUpdated(BufferInfo);
+    void bufferInfoUpdated(UserId user, const BufferInfo &);
     //! Sent when a new user has been added
     void userAdded(UserId, const QString &username);
     //! Sent when a user has been renamed
@@ -171,22 +166,6 @@ class Storage : public QObject {
     void userRemoved(UserId);
 
   public:
-    /* Exceptions */
-    struct AuthError : public Exception {};
-
-  protected:
-    // Old stuff, just for importing old file-based data
-    void initBackLogOld(UserId id);
-
-    QSqlDatabase logDb; // FIXME this does not belong in the base class!
-      
-    bool backLogEnabledOld;
-    QDir backLogDir;
-    QHash<QString, QList<Message> > backLog;
-    QHash<QString, QFile *> logFiles;
-    QHash<QString, QDataStream *> logStreams;
-    QHash<QString, QDate> logFileDates;
-    QHash<QString, QDir> logFileDirs;
 
 };