Add Quassel::scriptDirPaths() to get a list of locations we look for scripts in
[quassel.git] / src / common / quassel.cpp
index e54d894..08652ab 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include <QCoreApplication>
 #include <QDateTime>
-#include <QObject>
-#include <QMetaType>
+#include <QFileInfo>
+#include <QLibraryInfo>
+#include <QSettings>
+#include <QTranslator>
 
 #include "message.h"
 #include "identity.h"
 #include "types.h"
 #include "syncableobject.h"
 
-#if defined(HAVE_EXECINFO) and not defined(Q_OS_MAC)
-#  define BUILD_CRASHHANDLER
-#  include <execinfo.h>
-#  include <dlfcn.h>
-#  include <cxxabi.h>
-#endif
-
 Quassel::BuildInfo Quassel::_buildInfo;
-CliParser *Quassel::_cliParser = 0;
+AbstractCliParser *Quassel::_cliParser = 0;
 Quassel::RunMode Quassel::_runMode;
+QString Quassel::_configDirPath;
+QString Quassel::_translationDirPath;
+QStringList Quassel::_dataDirPaths;
 bool Quassel::_initialized = false;
 bool Quassel::DEBUG = false;
 QString Quassel::_coreDumpFileName;
 
 Quassel::Quassel() {
-  Q_INIT_RESOURCE(i18n);
-
   // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
   signal(SIGTERM, handleSignal);
   signal(SIGINT, handleSignal);
 
-#ifdef BUILD_CRASHHANDLER
+  // we have crashhandler for win32 and unix (based on execinfo).
+  // on mac os we use it's integrated backtrace generator
+#if defined(Q_OS_WIN32) || (defined(HAVE_EXECINFO) && !defined(Q_OS_MAC))
   signal(SIGABRT, handleSignal);
-  signal(SIGBUS, handleSignal);
   signal(SIGSEGV, handleSignal);
-#endif // #if defined(HAVE_EXECINFO) and not defined(Q_OS_MAC)
-
-  _cliParser = new CliParser();
-
-  // put shared client&core arguments here
-  cliParser()->addSwitch("debug",'d', tr("Enable debug output"));
-  cliParser()->addSwitch("help",'h', tr("Display this help and exit"));
+#  ifndef Q_OS_WIN32
+  signal(SIGBUS, handleSignal);
+#  endif
+#endif
 }
 
 Quassel::~Quassel() {
@@ -80,20 +74,16 @@ bool Quassel::init() {
   qsrand(QTime(0,0,0).secsTo(QTime::currentTime()));
 
   registerMetaTypes();
-  setupTranslations();
-
-  QCoreApplication::setApplicationName(buildInfo().applicationName);
-  QCoreApplication::setOrganizationName(buildInfo().organizationName);
-  QCoreApplication::setOrganizationDomain(buildInfo().organizationDomain);
 
   Network::setDefaultCodecForServer("ISO-8859-1");
   Network::setDefaultCodecForEncoding("UTF-8");
   Network::setDefaultCodecForDecoding("ISO-8859-15");
 
-  if(!cliParser()->parse(QCoreApplication::arguments()) || isOptionSet("help")) {
+  if(isOptionSet("help")) {
     cliParser()->usage();
     return false;
   }
+
   DEBUG = isOptionSet("debug");
   return true;
 }
@@ -108,6 +98,7 @@ void Quassel::registerMetaTypes() {
   qRegisterMetaType<Message>("Message");
   qRegisterMetaType<BufferInfo>("BufferInfo");
   qRegisterMetaType<NetworkInfo>("NetworkInfo");
+  qRegisterMetaType<Network::Server>("Network::Server");
   qRegisterMetaType<Identity>("Identity");
   qRegisterMetaType<Network::ConnectionState>("Network::ConnectionState");
 
@@ -115,6 +106,7 @@ void Quassel::registerMetaTypes() {
   qRegisterMetaTypeStreamOperators<Message>("Message");
   qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
   qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
+  qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
   qRegisterMetaTypeStreamOperators<Identity>("Identity");
   qRegisterMetaTypeStreamOperators<qint8>("Network::ConnectionState");
 
@@ -133,25 +125,10 @@ void Quassel::registerMetaTypes() {
   qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
 }
 
-void Quassel::setupTranslations() {
-  // Set up i18n support
-  QLocale locale = QLocale::system();
-
-  QTranslator *qtTranslator = new QTranslator(qApp);
-  qtTranslator->setObjectName("QtTr");
-  qtTranslator->load(QString(":i18n/qt_%1").arg(locale.name()));
-  qApp->installTranslator(qtTranslator);
-
-  QTranslator *quasselTranslator = new QTranslator(qApp);
-  quasselTranslator->setObjectName("QuasselTr");
-  quasselTranslator->load(QString(":i18n/quassel_%1").arg(locale.name()));
-  qApp->installTranslator(quasselTranslator);
-}
-
 void Quassel::setupBuildInfo(const QString &generated) {
   _buildInfo.applicationName = "Quassel IRC";
-  _buildInfo.coreApplicationName = "Quassel Core";
-  _buildInfo.clientApplicationName = "Quassel Client";
+  _buildInfo.coreApplicationName = "quasselcore";
+  _buildInfo.clientApplicationName = "quasselclient";
   _buildInfo.organizationName = "Quassel Project";
   _buildInfo.organizationDomain = "quassel-irc.org";
 
@@ -207,109 +184,203 @@ void Quassel::setupBuildInfo(const QString &generated) {
 //! Signal handler for graceful shutdown.
 void Quassel::handleSignal(int sig) {
   switch(sig) {
-    case SIGTERM:
-    case SIGINT:
-      qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
-      QCoreApplication::quit();
-      break;
-
-#ifdef BUILD_CRASHHANDLER
-    case SIGABRT:
-    case SIGBUS:
-    case SIGSEGV:
-      handleCrash();
+  case SIGTERM:
+  case SIGINT:
+    qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
+    QCoreApplication::quit();
+    break;
+  case SIGABRT:
+  case SIGSEGV:
+#ifndef Q_OS_WIN32
+  case SIGBUS:
 #endif
-      break;
-    default:
-      break;
+    logBacktrace(coreDumpFileName());
+    exit(EXIT_FAILURE);
+    break;
+  default:
+    break;
   }
 }
 
 void Quassel::logFatalMessage(const char *msg) {
-#ifndef Q_OS_MAC
+#ifdef Q_OS_MAC
+  Q_UNUSED(msg)
+#else
   QFile dumpFile(coreDumpFileName());
-  dumpFile.open(QIODevice::WriteOnly);
+  dumpFile.open(QIODevice::Append);
   QTextStream dumpStream(&dumpFile);
-#else
-  QTextStream dumpStream(stderr);
-#endif
-  
+
   dumpStream << "Fatal: " << msg << '\n';
   dumpStream.flush();
+  dumpFile.close();
+#endif
+}
 
-  qInstallMsgHandler(0);
-  abort();
+const QString &Quassel::coreDumpFileName() {
+  if(_coreDumpFileName.isEmpty()) {
+    QDir configDir(configDirPath());
+    _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
+    QFile dumpFile(_coreDumpFileName);
+    dumpFile.open(QIODevice::Append);
+    QTextStream dumpStream(&dumpFile);
+    dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
+    qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
+    dumpStream.flush();
+    dumpFile.close();
+  }
+  return _coreDumpFileName;
 }
 
-void Quassel::handleCrash() {
-#ifdef BUILD_CRASHHANDLER
-  void* callstack[128];
-  int i, frames = backtrace(callstack, 128);
+QString Quassel::configDirPath() {
+  if(!_configDirPath.isEmpty())
+    return _configDirPath;
 
-  QFile dumpFile(coreDumpFileName());
-  dumpFile.open(QIODevice::Append);
-  QTextStream dumpStream(&dumpFile);
+  if(Quassel::isOptionSet("datadir")) {
+    qWarning() << "Obsolete option --datadir used!";
+    _configDirPath = Quassel::optionValue("datadir");
+  } else if(Quassel::isOptionSet("configdir")) {
+    _configDirPath = Quassel::optionValue("configdir");
+  } else {
 
-  dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
-    
-  for (i = 0; i < frames; ++i) {
-    Dl_info info;
-    dladdr (callstack[i], &info);
-    // as a reference:
-    //     typedef struct
-    //     {
-      //       __const char *dli_fname;   /* File name of defining object.  */
-    //       void *dli_fbase;           /* Load address of that object.  */
-    //       __const char *dli_sname;   /* Name of nearest symbol.  */
-    //       void *dli_saddr;           /* Exact value of nearest symbol.  */
-    //     } Dl_info;
-
-    #if __LP64__
-    int addrSize = 16;
-    #else
-    int addrSize = 8;
-    #endif
-
-    QString funcName;
-    if(info.dli_sname) {
-      char *func = abi::__cxa_demangle(info.dli_sname, 0, 0, 0);
-      if(func) {
-        funcName = QString(func);
-        free(func);
-      } else {
-        funcName = QString(info.dli_sname);
-      }
-    } else {
-      funcName = QString("0x%1").arg((long)info.dli_saddr, addrSize, QLatin1Char('0'));
-    }
+#ifdef Q_WS_MAC
+    // On Mac, the path is always the same
+    _configDirPath = QDir::homePath() + "/Library/Application Support/Quassel/";
+#else
+    // We abuse QSettings to find us a sensible path on the other platforms
+#  ifdef Q_WS_WIN
+    // don't use the registry
+    QSettings::Format format = QSettings::IniFormat;
+#  else
+    QSettings::Format format = QSettings::NativeFormat;
+#  endif
+    QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
+    QFileInfo fileInfo(s.fileName());
+    _configDirPath = fileInfo.dir().absolutePath();
+#endif /* Q_WS_MAC */
+  }
 
-    // prettificating the filename
-    QString fileName("???");
-    if(info.dli_fname) {
-      fileName = QString(info.dli_fname);
-      int slashPos = fileName.lastIndexOf('/');
-      if(slashPos != -1)
-        fileName = fileName.mid(slashPos + 1);
-      if(fileName.count() < 20)
-        fileName += QString(20 - fileName.count(), ' ');
+  if(!_configDirPath.endsWith(QDir::separator()) && !_configDirPath.endsWith('/'))
+    _configDirPath += QDir::separator();
+
+  QDir qDir(_configDirPath);
+  if(!qDir.exists(_configDirPath)) {
+    if(!qDir.mkpath(_configDirPath)) {
+      qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
+      return QString();
     }
+  }
 
-    QString debugLine = QString("#%1 %2 0x%3 %4").arg(i, 3, 10)
-    .arg(fileName)
-    .arg((long)(callstack[i]), addrSize, 16, QLatin1Char('0'))
-    .arg(funcName);
+  return _configDirPath;
+}
+
+QStringList Quassel::dataDirPaths() {
+  return _dataDirPaths;
+}
 
-    dumpStream << debugLine << "\n";
-    qDebug() << qPrintable(debugLine);
+QStringList Quassel::findDataDirPaths() const {
+  QStringList dataDirNames = QString(qgetenv("XDG_DATA_DIRS")).split(':', QString::SkipEmptyParts);
+
+  if(!dataDirNames.isEmpty()) {
+    for(int i = 0; i < dataDirNames.count(); i++)
+      dataDirNames[i].append("/apps/quassel/");
+  } else {
+  // Provide a fallback
+#ifdef Q_OS_WIN32
+    dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
+                 << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
+                 << QCoreApplication::applicationDirPath();
   }
-  dumpFile.close();
-  exit(27);
-#endif /* BUILD_CRASHHANDLER */
+#elif defined Q_WS_MAC
+    dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
+                 << QCoreApplication::applicationDirPath();
+  }
+#else
+    dataDirNames.append("/usr/share/apps/quassel/");
+  }
+  // on UNIX, we always check our install prefix
+  QString appDir = QCoreApplication::applicationDirPath();
+  int binpos = appDir.lastIndexOf("/bin");
+  if(binpos >= 0) {
+    appDir.replace(binpos, 4, "/share");
+    appDir.append("/apps/quassel/");
+    if(!dataDirNames.contains(appDir))
+      dataDirNames.append(appDir);
+  }
+#endif
+
+  // add resource path and workdir just in case
+  dataDirNames << QCoreApplication::applicationDirPath() + "/data/"
+               << ":/data/";
+
+  // append trailing '/' and check for existence
+  QStringList::Iterator iter = dataDirNames.begin();
+  while(iter != dataDirNames.end()) {
+    if(!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
+      iter->append(QDir::separator());
+    if(!QFile::exists(*iter))
+      iter = dataDirNames.erase(iter);
+    else
+      ++iter;
+  }
+
+  return dataDirNames;
 }
 
-const QString &Quassel::coreDumpFileName() {
-  if(_coreDumpFileName.isEmpty())
-    _coreDumpFileName = QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm"));
+QString Quassel::findDataFilePath(const QString &fileName) {
+  QStringList dataDirs = dataDirPaths();
+  foreach(QString dataDir, dataDirs) {
+    QString path = dataDir + fileName;
+    if(QFile::exists(path))
+      return path;
+  }
+  return QString();
+}
 
-  return _coreDumpFileName;
+QStringList Quassel::scriptDirPaths() {
+  QStringList res(configDirPath() + "scripts/");
+  foreach(QString path, dataDirPaths())
+    res << path + "scripts/";
+  return res;
+}
+
+QString Quassel::translationDirPath() {
+  if(_translationDirPath.isEmpty()) {
+    // We support only one translation dir; fallback mechanisms wouldn't work else.
+    // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
+    foreach(const QString &dir, dataDirPaths()) {
+      if(QFile::exists(dir + "translations/")) {
+        _translationDirPath = dir + "translations/";
+        break;
+      }
+    }
+    if(_translationDirPath.isEmpty())
+      _translationDirPath = ":/i18n/";
+  }
+  return _translationDirPath;
+}
+
+void Quassel::loadTranslation(const QLocale &locale) {
+  QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
+  QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
+
+  if(!qtTranslator) {
+    qtTranslator = new QTranslator(qApp);
+    qtTranslator->setObjectName("QtTr");
+    qApp->installTranslator(qtTranslator);
+  }
+  if(!quasselTranslator) {
+    quasselTranslator = new QTranslator(qApp);
+    quasselTranslator->setObjectName("QuasselTr");
+    qApp->installTranslator(quasselTranslator);
+  }
+
+  QLocale::setDefault(locale);
+
+  if(locale.language() == QLocale::C)
+    return;
+
+  bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
+  if(!success)
+    qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
+  quasselTranslator->load(QString("quassel_%1").arg(locale.name()), translationDirPath());
 }