src/common/quassel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 #include "quassel.h"
  22
  23 #include <iostream>
  24 #include <signal.h>
  25 #if !defined Q_OS_WIN32 && !defined Q_OS_MAC
  26 #  include <sys/resource.h>
  27 #endif
  28
  29 #include <QCoreApplication>
  30 #include <QDateTime>
  31 #include <QFileInfo>
  32 #include <QLibraryInfo>
  33 #include <QSettings>
  34 #include <QTranslator>
  35
  36 #include "message.h"
  37 #include "identity.h"
  38 #include "network.h"
  39 #include "bufferinfo.h"
  40 #include "types.h"
  41 #include "syncableobject.h"
  42
  43 Quassel::BuildInfo Quassel::_buildInfo;
  44 AbstractCliParser *Quassel::_cliParser = 0;
  45 Quassel::RunMode Quassel::_runMode;
  46 QString Quassel::_configDirPath;
  47 QString Quassel::_translationDirPath;
  48 QStringList Quassel::_dataDirPaths;
  49 bool Quassel::_initialized = false;
  50 bool Quassel::DEBUG = false;
  51 QString Quassel::_coreDumpFileName;
  52 Quassel *Quassel::_instance = 0;
  53 bool Quassel::_handleCrashes = true;
  54 Quassel::LogLevel Quassel::_logLevel = InfoLevel;
  55 QFile *Quassel::_logFile = 0;
  56 bool Quassel::_logToSyslog = false;
  57
  58 Quassel::Quassel() {
  59   Q_ASSERT(!_instance);
  60   _instance = this;
  61
  62   // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
  63   signal(SIGTERM, handleSignal);
  64   signal(SIGINT, handleSignal);
  65 }
  66
  67 Quassel::~Quassel() {
  68   if(logFile()) {
  69     logFile()->close();
  70     logFile()->deleteLater();
  71   }
  72   delete _cliParser;
  73 }
  74
  75 bool Quassel::init() {
  76   if(_initialized)
  77     return true;  // allow multiple invocations because of MonolithicApplication
  78
  79   if (_handleCrashes) {
  80     // we have crashhandler for win32 and unix (based on execinfo).
  81 #if defined(Q_OS_WIN32) || defined(HAVE_EXECINFO)
  82 # ifndef Q_OS_WIN32
  83     // we only handle crashes ourselves if coredumps are disabled
  84     struct rlimit *limit = (rlimit *) malloc(sizeof(struct rlimit));
  85     int rc = getrlimit(RLIMIT_CORE, limit);
  86
  87     if(rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
  88 # endif /* Q_OS_WIN32 */
  89       signal(SIGABRT, handleSignal);
  90       signal(SIGSEGV, handleSignal);
  91 # ifndef Q_OS_WIN32
  92       signal(SIGBUS, handleSignal);
  93     }
  94     free(limit);
  95 # endif /* Q_OS_WIN32 */
  96 #endif /* Q_OS_WIN32 || HAVE_EXECINFO */
  97   }
  98
  99   _initialized = true;
 100   qsrand(QTime(0,0,0).secsTo(QTime::currentTime()));
 101
 102   registerMetaTypes();
 103
 104   Network::setDefaultCodecForServer("ISO-8859-1");
 105   Network::setDefaultCodecForEncoding("UTF-8");
 106   Network::setDefaultCodecForDecoding("ISO-8859-15");
 107
 108   if(isOptionSet("help")) {
 109     cliParser()->usage();
 110     return false;
 111   }
 112
 113   if(isOptionSet("version")) {
 114     std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
 115     return false;
 116   }
 117
 118   DEBUG = isOptionSet("debug");
 119
 120   // set up logging
 121   if(Quassel::runMode() != Quassel::ClientOnly) {
 122     if(isOptionSet("loglevel")) {
 123       QString level = optionValue("loglevel");
 124
 125       if(level == "Debug") _logLevel = DebugLevel;
 126       else if(level == "Info") _logLevel = InfoLevel;
 127       else if(level == "Warning") _logLevel= WarningLevel;
 128       else if(level == "Error") _logLevel = ErrorLevel;
 129     }
 130
 131     QString logfilename = optionValue("logfile");
 132     if(!logfilename.isEmpty()) {
 133       _logFile = new QFile(logfilename);
 134       if(!_logFile->open(QIODevice::Append | QIODevice::Text)) {
 135         qWarning() << "Could not open log file" << logfilename << ":" << _logFile->errorString();
 136         _logFile->deleteLater();
 137         _logFile = 0;
 138       }
 139     }
 140 #ifdef HAVE_SYSLOG
 141     _logToSyslog = isOptionSet("syslog");
 142 #endif
 143   }
 144
 145   return true;
 146 }
 147
 148 void Quassel::quit() {
 149   QCoreApplication::quit();
 150 }
 151
 152 //! Register our custom types with Qt's Meta Object System.
 153 /**  This makes them available for QVariant and in signals/slots, among other things.
 154 *
 155 */
 156 void Quassel::registerMetaTypes() {
 157   // Complex types
 158   qRegisterMetaType<Message>("Message");
 159   qRegisterMetaType<BufferInfo>("BufferInfo");
 160   qRegisterMetaType<NetworkInfo>("NetworkInfo");
 161   qRegisterMetaType<Network::Server>("Network::Server");
 162   qRegisterMetaType<Identity>("Identity");
 163   qRegisterMetaType<Network::ConnectionState>("Network::ConnectionState");
 164
 165   qRegisterMetaTypeStreamOperators<Message>("Message");
 166   qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
 167   qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
 168   qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
 169   qRegisterMetaTypeStreamOperators<Identity>("Identity");
 170   qRegisterMetaTypeStreamOperators<qint8>("Network::ConnectionState");
 171
 172   qRegisterMetaType<IdentityId>("IdentityId");
 173   qRegisterMetaType<BufferId>("BufferId");
 174   qRegisterMetaType<NetworkId>("NetworkId");
 175   qRegisterMetaType<UserId>("UserId");
 176   qRegisterMetaType<AccountId>("AccountId");
 177   qRegisterMetaType<MsgId>("MsgId");
 178
 179   qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
 180   qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
 181   qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
 182   qRegisterMetaTypeStreamOperators<UserId>("UserId");
 183   qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
 184   qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
 185
 186   // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
 187   if(!QMetaType::type("QVariant")) {
 188     qRegisterMetaType<QVariant>("QVariant");
 189     qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
 190   }
 191 }
 192
 193 void Quassel::setupBuildInfo(const QString &generated) {
 194   _buildInfo.applicationName = "Quassel IRC";
 195   _buildInfo.coreApplicationName = "quasselcore";
 196   _buildInfo.clientApplicationName = "quasselclient";
 197   _buildInfo.organizationName = "Quassel Project";
 198   _buildInfo.organizationDomain = "quassel-irc.org";
 199
 200   QStringList gen = generated.split(',');
 201   Q_ASSERT(gen.count() == 10);
 202   _buildInfo.baseVersion = gen[0];
 203   _buildInfo.generatedVersion = gen[1];
 204   _buildInfo.isSourceDirty = !gen[2].isEmpty();
 205   _buildInfo.commitHash = gen[3];
 206   _buildInfo.commitDate = gen[4].toUInt();
 207   _buildInfo.protocolVersion = gen[5].toUInt();
 208   _buildInfo.clientNeedsProtocol = gen[6].toUInt();
 209   _buildInfo.coreNeedsProtocol = gen[7].toUInt();
 210   _buildInfo.buildDate = QString("%1 %2").arg(gen[8], gen[9]);
 211   // create a nice version string
 212   if(_buildInfo.generatedVersion.isEmpty()) {
 213     if(!_buildInfo.commitHash.isEmpty()) {
 214       // dist version
 215       _buildInfo.plainVersionString = QString("v%1 (dist-%2)")
 216                                         .arg(_buildInfo.baseVersion)
 217                                         .arg(_buildInfo.commitHash.left(7));
 218       _buildInfo.fancyVersionString = QString("v%1 (dist-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%3\">%2</a>)")
 219                                         .arg(_buildInfo.baseVersion)
 220                                         .arg(_buildInfo.commitHash.left(7))
 221                                         .arg(_buildInfo.commitHash);
 222     } else {
 223     // we only have a base version :(
 224       _buildInfo.plainVersionString = QString("v%1 (unknown rev)").arg(_buildInfo.baseVersion);
 225     }
 226   } else {
 227     // analyze what we got from git-describe
 228     QRegExp rx("(.*)-(\\d+)-g([0-9a-f]+)$");
 229     if(rx.exactMatch(_buildInfo.generatedVersion)) {
 230       QString distance = rx.cap(2) == "0" ? QString() : QString("%1+%2 ").arg(rx.cap(1), rx.cap(2));
 231       _buildInfo.plainVersionString = QString("v%1 (%2git-%3%4)")
 232                                         .arg(_buildInfo.baseVersion, distance, rx.cap(3))
 233                                         .arg(_buildInfo.isSourceDirty ? "*" : "");
 234       if(!_buildInfo.commitHash.isEmpty()) {
 235         _buildInfo.fancyVersionString = QString("v%1 (%2git-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%5\">%3</a>%4)")
 236                                           .arg(_buildInfo.baseVersion, distance, rx.cap(3))
 237                                           .arg(_buildInfo.isSourceDirty ? "*" : "")
 238                                           .arg(_buildInfo.commitHash);
 239       }
 240     } else {
 241       _buildInfo.plainVersionString = QString("v%1 (invalid rev)").arg(_buildInfo.baseVersion);
 242     }
 243   }
 244   if(_buildInfo.fancyVersionString.isEmpty())
 245     _buildInfo.fancyVersionString = _buildInfo.plainVersionString;
 246 }
 247
 248 //! Signal handler for graceful shutdown.
 249 void Quassel::handleSignal(int sig) {
 250   switch(sig) {
 251   case SIGTERM:
 252   case SIGINT:
 253     qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
 254     if(_instance)
 255       _instance->quit();
 256     else
 257       QCoreApplication::quit();
 258     break;
 259   case SIGABRT:
 260   case SIGSEGV:
 261 #ifndef Q_OS_WIN32
 262   case SIGBUS:
 263 #endif
 264     logBacktrace(coreDumpFileName());
 265     exit(EXIT_FAILURE);
 266     break;
 267   default:
 268     break;
 269   }
 270 }
 271
 272 void Quassel::logFatalMessage(const char *msg) {
 273 #ifdef Q_OS_MAC
 274   Q_UNUSED(msg)
 275 #else
 276   QFile dumpFile(coreDumpFileName());
 277   dumpFile.open(QIODevice::Append);
 278   QTextStream dumpStream(&dumpFile);
 279
 280   dumpStream << "Fatal: " << msg << '\n';
 281   dumpStream.flush();
 282   dumpFile.close();
 283 #endif
 284 }
 285
 286 Quassel::Features Quassel::features() {
 287   Features feats = 0;
 288   for(int i = 1; i <= NumFeatures; i<<=1)
 289     feats |= (Feature) i;
 290
 291   return feats;
 292 }
 293
 294 const QString &Quassel::coreDumpFileName() {
 295   if(_coreDumpFileName.isEmpty()) {
 296     QDir configDir(configDirPath());
 297     _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
 298     QFile dumpFile(_coreDumpFileName);
 299     dumpFile.open(QIODevice::Append);
 300     QTextStream dumpStream(&dumpFile);
 301     dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
 302     qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
 303     dumpStream.flush();
 304     dumpFile.close();
 305   }
 306   return _coreDumpFileName;
 307 }
 308
 309 QString Quassel::configDirPath() {
 310   if(!_configDirPath.isEmpty())
 311     return _configDirPath;
 312
 313   if(Quassel::isOptionSet("datadir")) {
 314     qWarning() << "Obsolete option --datadir used!";
 315     _configDirPath = Quassel::optionValue("datadir");
 316   } else if(Quassel::isOptionSet("configdir")) {
 317     _configDirPath = Quassel::optionValue("configdir");
 318   } else {
 319
 320 #ifdef Q_WS_MAC
 321     // On Mac, the path is always the same
 322     _configDirPath = QDir::homePath() + "/Library/Application Support/Quassel/";
 323 #else
 324     // We abuse QSettings to find us a sensible path on the other platforms
 325 #  ifdef Q_WS_WIN
 326     // don't use the registry
 327     QSettings::Format format = QSettings::IniFormat;
 328 #  else
 329     QSettings::Format format = QSettings::NativeFormat;
 330 #  endif
 331     QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
 332     QFileInfo fileInfo(s.fileName());
 333     _configDirPath = fileInfo.dir().absolutePath();
 334 #endif /* Q_WS_MAC */
 335   }
 336
 337   if(!_configDirPath.endsWith(QDir::separator()) && !_configDirPath.endsWith('/'))
 338     _configDirPath += QDir::separator();
 339
 340   QDir qDir(_configDirPath);
 341   if(!qDir.exists(_configDirPath)) {
 342     if(!qDir.mkpath(_configDirPath)) {
 343       qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
 344       return QString();
 345     }
 346   }
 347
 348   return _configDirPath;
 349 }
 350
 351 QStringList Quassel::dataDirPaths() {
 352   return _dataDirPaths;
 353 }
 354
 355 QStringList Quassel::findDataDirPaths() const {
 356   QStringList dataDirNames = QString(qgetenv("XDG_DATA_DIRS")).split(':', QString::SkipEmptyParts);
 357
 358   if(!dataDirNames.isEmpty()) {
 359     for(int i = 0; i < dataDirNames.count(); i++)
 360       dataDirNames[i].append("/apps/quassel/");
 361   } else {
 362   // Provide a fallback
 363 #ifdef Q_OS_WIN32
 364     dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
 365                  << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
 366                  << QCoreApplication::applicationDirPath();
 367   }
 368 #elif defined Q_WS_MAC
 369     dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
 370                  << QCoreApplication::applicationDirPath();
 371   }
 372 #else
 373     dataDirNames.append("/usr/share/apps/quassel/");
 374   }
 375   // on UNIX, we always check our install prefix
 376   QString appDir = QCoreApplication::applicationDirPath();
 377   int binpos = appDir.lastIndexOf("/bin");
 378   if(binpos >= 0) {
 379     appDir.replace(binpos, 4, "/share");
 380     appDir.append("/apps/quassel/");
 381     if(!dataDirNames.contains(appDir))
 382       dataDirNames.append(appDir);
 383   }
 384 #endif
 385
 386   // add resource path and workdir just in case
 387   dataDirNames << QCoreApplication::applicationDirPath() + "/data/"
 388                << ":/data/";
 389
 390   // append trailing '/' and check for existence
 391   QStringList::Iterator iter = dataDirNames.begin();
 392   while(iter != dataDirNames.end()) {
 393     if(!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
 394       iter->append(QDir::separator());
 395     if(!QFile::exists(*iter))
 396       iter = dataDirNames.erase(iter);
 397     else
 398       ++iter;
 399   }
 400
 401   return dataDirNames;
 402 }
 403
 404 QString Quassel::findDataFilePath(const QString &fileName) {
 405   QStringList dataDirs = dataDirPaths();
 406   foreach(QString dataDir, dataDirs) {
 407     QString path = dataDir + fileName;
 408     if(QFile::exists(path))
 409       return path;
 410   }
 411   return QString();
 412 }
 413
 414 QStringList Quassel::scriptDirPaths() {
 415   QStringList res(configDirPath() + "scripts/");
 416   foreach(QString path, dataDirPaths())
 417     res << path + "scripts/";
 418   return res;
 419 }
 420
 421 QString Quassel::translationDirPath() {
 422   if(_translationDirPath.isEmpty()) {
 423     // We support only one translation dir; fallback mechanisms wouldn't work else.
 424     // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
 425     foreach(const QString &dir, dataDirPaths()) {
 426       if(QFile::exists(dir + "translations/")) {
 427         _translationDirPath = dir + "translations/";
 428         break;
 429       }
 430     }
 431     if(_translationDirPath.isEmpty())
 432       _translationDirPath = ":/i18n/";
 433   }
 434   return _translationDirPath;
 435 }
 436
 437 void Quassel::loadTranslation(const QLocale &locale) {
 438   QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
 439   QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
 440
 441   if(qtTranslator)
 442     qApp->removeTranslator(qtTranslator);
 443   if(quasselTranslator)
 444     qApp->removeTranslator(quasselTranslator);
 445
 446   // We use QLocale::C to indicate that we don't want a translation
 447   if(locale.language() == QLocale::C)
 448     return;
 449
 450   qtTranslator = new QTranslator(qApp);
 451   qtTranslator->setObjectName("QtTr");
 452   qApp->installTranslator(qtTranslator);
 453
 454   quasselTranslator = new QTranslator(qApp);
 455   quasselTranslator->setObjectName("QuasselTr");
 456   qApp->installTranslator(quasselTranslator);
 457
 458   QLocale::setDefault(locale);
 459
 460   bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
 461   if(!success)
 462     qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
 463   quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
 464 }