prettyficating the prompting for backend credentials
[quassel.git] / src / core / core.cpp
index 38272e3..77280c3 100644 (file)
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#include <QMetaObject>
-#include <QMetaMethod>
 #include <QCoreApplication>
 
 #include "core.h"
 #include "coresession.h"
 #include "coresettings.h"
+#include "postgresqlstorage.h"
 #include "quassel.h"
 #include "signalproxy.h"
 #include "sqlitestorage.h"
@@ -50,10 +49,12 @@ void Core::destroy() {
   instanceptr = 0;
 }
 
-Core::Core() : storage(0) {
+Core::Core()
+  : _storage(0)
+{
   _startTime = QDateTime::currentDateTime().toUTC();  // for uptime :)
 
-  loadTranslation(QLocale::system());
+  Quassel::loadTranslation(QLocale::system());
 
   // FIXME: MIGRATION 0.3 -> 0.4: Move database and core config to new location
   // Move settings, note this does not delete the old files
@@ -72,7 +73,6 @@ Core::Core() : storage(0) {
 #endif /* Q_WS_MAC */
 
   if(newSettings.value("Config/Version").toUInt() == 0) {
-    qWarning() << "\n\n*** IMPORTANT: Config and data file locations have changed. Attempting to auto-migrate your core settings...";
 #   ifdef Q_WS_MAC
     QString org = "quassel-irc.org";
 #   else
@@ -80,10 +80,11 @@ Core::Core() : storage(0) {
 #   endif
     QSettings oldSettings(org, "Quassel Core");
     if(oldSettings.allKeys().count()) {
+      qWarning() << "\n\n*** IMPORTANT: Config and data file locations have changed. Attempting to auto-migrate your core settings...";
       foreach(QString key, oldSettings.allKeys())
         newSettings.setValue(key, oldSettings.value(key));
       newSettings.setValue("Config/Version", 1);
-      qWarning() << "*   Your core settings have been migrated to" << newFilePath;
+      qWarning() << "*   Your core settings have been migrated to" << newSettings.fileName();
 
 #ifndef Q_WS_MAC /* we don't need to move the db and cert for mac */
 #ifdef Q_OS_WIN32
@@ -116,10 +117,10 @@ Core::Core() : storage(0) {
         else
           qWarning() << "!!! Moving your certificate has failed. Please move it manually into" << Quassel::configDirPath();
       }
+#endif /* !Q_WS_MAC */
       qWarning() << "*** Migration completed.\n\n";
     }
   }
-#endif /* !Q_WS_MAC */
   // MIGRATION end
 
   // check settings version
@@ -130,28 +131,35 @@ Core::Core() : storage(0) {
     exit(EXIT_FAILURE);
   }
 
-  // Register storage backends here!
-  registerStorageBackend(new SqliteStorage(this));
+  registerStorageBackends();
 
-  if(!_storageBackends.count()) {
-    qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
-    qWarning() << qPrintable(tr("Currently, Quassel only supports SQLite3. You need to build your\n"
-                                "Qt library with the sqlite plugin enabled in order for quasselcore\n"
-                                "to work."));
-    exit(1); // TODO make this less brutal (especially for mono client -> popup)
-  }
   connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
   _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
 }
 
 void Core::init() {
-  configured = false;
+  if(Quassel::isOptionSet("select-backend")) {
+    switchBackend(Quassel::optionValue("select-backend"));
+    exit(0);
+  }
 
   CoreSettings cs;
-
-  if(!(configured = initStorage(cs.storageSettings().toMap()))) {
+  _configured = initStorage(cs.storageSettings().toMap());
+
+  if(!_configured) {
+    if(!_storageBackends.count()) {
+      qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
+      qWarning() << qPrintable(tr("Currently, Quassel supports SQLite3 and PostgreSQL. You need to build your\n"
+                                 "Qt library with the sqlite or postgres plugin enabled in order for quasselcore\n"
+                                 "to work."));
+      exit(1); // TODO make this less brutal (especially for mono client -> popup)
+    }
     qWarning() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
+  }
 
+  if(Quassel::isOptionSet("migrate-backend")) {
+    migrateBackend(Quassel::optionValue("migrate-backend"));
+    exit(0);
   }
 
   connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
@@ -180,7 +188,7 @@ void Core::saveState() {
 }
 
 void Core::restoreState() {
-  if(!instance()->configured) {
+  if(!instance()->_configured) {
     // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
     return;
   }
@@ -228,18 +236,24 @@ QString Core::setupCore(QVariantMap setupData) {
   if(user.isEmpty() || password.isEmpty()) {
     return tr("Admin user or password not set.");
   }
-  if(!initStorage(setupData, true)) {
+  _configured = initStorage(setupData, true);
+  if(!_configured) {
     return tr("Could not setup storage!");
   }
   CoreSettings s;
   s.setStorageSettings(setupData);
   quInfo() << qPrintable(tr("Creating admin user..."));
-  storage->addUser(user, password);
+  _storage->addUser(user, password);
   startListening();  // TODO check when we need this
   return QString();
 }
 
 /*** Storage Handling ***/
+void Core::registerStorageBackends() {
+  // Register storage backends here!
+  registerStorageBackend(new SqliteStorage(this));
+  registerStorageBackend(new PostgreSqlStorage(this));
+}
 
 bool Core::registerStorageBackend(Storage *backend) {
   if(backend->isAvailable()) {
@@ -251,6 +265,13 @@ bool Core::registerStorageBackend(Storage *backend) {
   }
 }
 
+void Core::unregisterStorageBackends() {
+  foreach(Storage *s, _storageBackends.values()) {
+    s->deleteLater();
+  }
+  _storageBackends.clear();
+}
+
 void Core::unregisterStorageBackend(Storage *backend) {
   _storageBackends.remove(backend->displayName());
   backend->deleteLater();
@@ -258,43 +279,58 @@ void Core::unregisterStorageBackend(Storage *backend) {
 
 // old db settings:
 // "Type" => "sqlite"
-bool Core::initStorage(QVariantMap dbSettings, bool setup) {
-  QString backend = dbSettings["Backend"].toString();
+bool Core::initStorage(const QString &backend, QVariantMap settings, bool setup) {
+  _storage = 0;
+
   if(backend.isEmpty()) {
-    //qWarning() << "No storage backend selected!";
-    return configured = false;
+    return false;
   }
 
+  Storage *storage = 0;
   if(_storageBackends.contains(backend)) {
     storage = _storageBackends[backend];
   } else {
     qCritical() << "Selected storage backend is not available:" << backend;
-    return configured = false;
-  }
-  if(!storage->init(dbSettings)) {
-    if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
-      qCritical() << "Could not init storage!";
-      storage = 0;
-      return configured = false;
-    }
+    return false;
   }
-  // delete all other backends
-  foreach(Storage *s, _storageBackends.values()) {
-    if(s != storage) s->deleteLater();
+
+  Storage::State storageState = storage->init(settings);
+  switch(storageState) {
+  case Storage::NeedsSetup:
+    if(!setup)
+      return false; // trigger setup process
+    if(storage->setup(settings))
+      return initStorage(backend, settings, false);
+    // if setup wasn't successfull we mark the backend as unavailable
+  case Storage::NotAvailable:
+    qCritical() << "Selected storage backend is not available:" << backend;
+    storage->deleteLater();
+    _storageBackends.remove(backend);
+    storage = 0;
+    return false;
+  case Storage::IsReady:
+    // delete all other backends
+    _storageBackends.remove(backend);
+    unregisterStorageBackends();
+    connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
   }
-  _storageBackends.clear();
+  _storage = storage;
+  return true;
+}
 
-  connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
-  return configured = true;
+bool Core::initStorage(QVariantMap dbSettings, bool setup) {
+  return initStorage(dbSettings["Backend"].toString(), dbSettings["ConnectionProperties"].toMap(), setup);
 }
 
+
 void Core::syncStorage() {
-  if(storage) storage->sync();
+  if(_storage)
+    _storage->sync();
 }
 
 /*** Storage Access ***/
 bool Core::createNetwork(UserId user, NetworkInfo &info) {
-  NetworkId networkId = instance()->storage->createNetwork(user, info);
+  NetworkId networkId = instance()->_storage->createNetwork(user, info);
   if(!networkId.isValid())
     return false;
 
@@ -407,7 +443,7 @@ void Core::incomingConnection() {
     blocksizes.insert(socket, (quint32)0);
     quInfo() << qPrintable(tr("Client connected from"))  << qPrintable(socket->peerAddress().toString());
 
-    if(!configured) {
+    if(!_configured) {
       stopListening(tr("Closing server for basic setup."));
     }
   }
@@ -482,13 +518,15 @@ void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
     reply["LoginEnabled"] = true;
 
     // check if we are configured, start wizard otherwise
-    if(!configured) {
+    if(!_configured) {
       reply["Configured"] = false;
       QList<QVariant> backends;
       foreach(Storage *backend, _storageBackends.values()) {
         QVariantMap v;
         v["DisplayName"] = backend->displayName();
         v["Description"] = backend->description();
+       v["SetupKeys"] = backend->setupKeys();
+       v["SetupDefaults"] = backend->setupDefaults();
         backends.append(v);
       }
       reply["StorageBackends"] = backends;
@@ -538,7 +576,7 @@ void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
       SignalProxy::writeDataToDevice(socket, reply);
     } else if(msg["MsgType"] == "ClientLogin") {
       QVariantMap reply;
-      UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
+      UserId uid = _storage->validateUser(msg["User"].toString(), msg["Password"].toString());
       if(uid == 0) {
         reply["MsgType"] = "ClientLoginReject";
         reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
@@ -590,7 +628,7 @@ void Core::clientDisconnected() {
 
 
   // make server listen again if still not configured
-  if (!configured) {
+  if (!_configured) {
     startListening();
   }
 
@@ -615,12 +653,12 @@ void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
 }
 
 void Core::setupInternalClientSession(SignalProxy *proxy) {
-  if(!configured) {
+  if(!_configured) {
     stopListening();
     setupCoreForInternalUsage();
   }
 
-  UserId uid = storage->internalUser();
+  UserId uid = _storage->internalUser();
 
   // Find or create session for validated user
   SessionThread *sess;
@@ -656,3 +694,142 @@ void Core::socketError(QAbstractSocket::SocketError err) {
   if(socket && err != QAbstractSocket::RemoteHostClosedError)
     qWarning() << "Core::socketError()" << socket << err << socket->errorString();
 }
+
+bool Core::migrateBackend(const QString &backend) {
+  AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(_storage);
+  if(!sqlStorage) {
+    qWarning() << "Core::migrateDb(): only SQL based backends can be migrated!";
+    return false;
+  }
+
+  AbstractSqlMigrationReader *reader = sqlStorage->createMigrationReader();
+  if(!reader) {
+    qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration reader for %1)").arg(sqlStorage->displayName()));
+    return false;
+  }
+
+
+  // reregister all storage backends
+  registerStorageBackends();
+  if(_storageBackends.contains(sqlStorage->displayName())) {
+    unregisterStorageBackend(_storageBackends[sqlStorage->displayName()]);
+  }
+  if(!_storageBackends.contains(backend)) {
+    qWarning() << qPrintable(QString("Core::migrateBackend(): unsupported migration target: %1").arg(backend));
+    qWarning() << "    supported Targets:" << qPrintable(QStringList(_storageBackends.keys()).join(", "));
+    return false;
+  }
+
+  Storage *storage = _storageBackends[backend];
+  QVariantMap settings = promptForSettings(storage);
+
+  Storage::State storageState = storage->init(settings);
+  switch(storageState) {
+  case Storage::NotAvailable:
+    qCritical() << "Core::migrateBackend(): selected storage backend is not available:" << backend;
+    return false;
+  case Storage::NeedsSetup:
+    if(!storage->setup(settings)) {
+      qWarning() << qPrintable(QString("Core::migrateBackend(): unable to setup target: %1").arg(backend));
+      return false;
+    }
+
+    if(storage->init(settings) != Storage::IsReady) {
+      qWarning() << qPrintable(QString("Core::migrateBackend(): unable to initialize target: %1").arg(backend));
+      return false;
+    }
+  case Storage::IsReady:
+    break;
+  }
+
+  sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
+  if(!sqlStorage) {
+    qWarning() << "Core::migrateDb(): only SQL based backends can be migrated!";
+    return false;
+  }
+  AbstractSqlMigrationWriter *writer = sqlStorage->createMigrationWriter();
+  if(!writer) {
+    qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration writer for %1)").arg(backend));
+    return false;
+  }
+
+  qDebug() << qPrintable(QString("Migrating Storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
+  delete _storage;
+  _storage = 0;
+  delete storage;
+  storage = 0;
+  if(reader->migrateTo(writer)) {
+    qDebug() << "Migration finished!";
+    saveBackendSettings(backend, settings);
+    return true;
+  }
+  return false;
+}
+
+bool Core::switchBackend(const QString &backend) {
+  if(!_storageBackends.contains(backend)) {
+    qWarning() << qPrintable(QString("Core::switchBackend(): unsupported backend: %1").arg(backend));
+    qWarning() << "    supported backends:" << qPrintable(QStringList(_storageBackends.keys()).join(", "));
+    return false;
+  }
+
+  Storage *storage = _storageBackends[backend];
+  QVariantMap settings = promptForSettings(storage);
+
+  bool ok = initStorage(backend, settings, true /* initial setup is allowed */);
+  if(ok) {
+    saveBackendSettings(backend, settings);
+    qWarning() << "Switched backend to:" << qPrintable(backend);
+  } else {
+    qWarning() << "Failed to switch backend to:" << qPrintable(backend);
+  }
+  return ok;
+}
+
+void Core::saveBackendSettings(const QString &backend, const QVariantMap &settings) {
+  QVariantMap dbsettings;
+  dbsettings["Backend"] = backend;
+  dbsettings["ConnectionProperties"] = settings;
+  CoreSettings().setStorageSettings(dbsettings);
+}
+
+QVariantMap Core::promptForSettings(const Storage *storage) {
+  QVariantMap settings;
+
+  QStringList keys = storage->setupKeys();
+  if(keys.isEmpty())
+    return settings;
+
+  QTextStream out(stdout);
+  QTextStream in(stdin);
+  out << "!!!Warning: echo mode is always on even if asked for a password!!!" << endl;
+  out << "Default values are in brackets" << endl;
+
+  QVariantMap defaults = storage->setupDefaults();
+  QString value;
+  foreach(QString key, keys) {
+    QVariant val;
+    if(defaults.contains(key)) {
+      val = defaults[key];
+    }
+    out << key;
+    if(!val.toString().isEmpty()) {
+      out << " (" << val.toString() << ")";
+    }
+    out << ": ";
+    out.flush();
+    value = in.readLine().trimmed();
+
+    if(!value.isEmpty()) {
+      switch(defaults[key].type()) {
+      case QVariant::Int:
+       val = QVariant(value.toInt());
+       break;
+      default:
+       val = QVariant(value);
+      }
+    }
+    settings[key] = val;
+  }
+  return settings;
+}