src/common/quassel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2015 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #include "quassel.h"
  22
  23 #include <iostream>
  24 #include <signal.h>
  25 #if !defined Q_OS_WIN && !defined Q_OS_MAC
  26 #  include <sys/types.h>
  27 #  include <sys/time.h>
  28 #  include <sys/resource.h>
  29 #endif
  30
  31 #include <QCoreApplication>
  32 #include <QDateTime>
  33 #include <QFileInfo>
  34 #include <QHostAddress>
  35 #include <QLibraryInfo>
  36 #include <QSettings>
  37 #include <QTranslator>
  38 #include <QUuid>
  39
  40 #include "bufferinfo.h"
  41 #include "identity.h"
  42 #include "logger.h"
  43 #include "message.h"
  44 #include "network.h"
  45 #include "peer.h"
  46 #include "protocol.h"
  47 #include "syncableobject.h"
  48 #include "types.h"
  49
  50 #include "../../version.h"
  51
  52 Quassel::BuildInfo Quassel::_buildInfo;
  53 AbstractCliParser *Quassel::_cliParser = 0;
  54 Quassel::RunMode Quassel::_runMode;
  55 QString Quassel::_configDirPath;
  56 QString Quassel::_translationDirPath;
  57 QStringList Quassel::_dataDirPaths;
  58 bool Quassel::_initialized = false;
  59 bool Quassel::DEBUG = false;
  60 QString Quassel::_coreDumpFileName;
  61 Quassel *Quassel::_instance = 0;
  62 bool Quassel::_handleCrashes = true;
  63 Quassel::LogLevel Quassel::_logLevel = InfoLevel;
  64 QFile *Quassel::_logFile = 0;
  65 bool Quassel::_logToSyslog = false;
  66
  67 Quassel::Quassel()
  68 {
  69     Q_ASSERT(!_instance);
  70     _instance = this;
  71
  72     // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
  73     signal(SIGTERM, handleSignal);
  74     signal(SIGINT, handleSignal);
  75 }
  76
  77
  78 Quassel::~Quassel()
  79 {
  80     if (logFile()) {
  81         logFile()->close();
  82         logFile()->deleteLater();
  83     }
  84     delete _cliParser;
  85 }
  86
  87
  88 bool Quassel::init()
  89 {
  90     if (_initialized)
  91         return true;  // allow multiple invocations because of MonolithicApplication
  92
  93     if (_handleCrashes) {
  94         // we have crashhandler for win32 and unix (based on execinfo).
  95 #if defined(Q_OS_WIN) || defined(HAVE_EXECINFO)
  96 # ifndef Q_OS_WIN
  97         // we only handle crashes ourselves if coredumps are disabled
  98         struct rlimit *limit = (rlimit *)malloc(sizeof(struct rlimit));
  99         int rc = getrlimit(RLIMIT_CORE, limit);
 100
 101         if (rc == -1 || !((long)limit->rlim_cur > 0 || limit->rlim_cur == RLIM_INFINITY)) {
 102 # endif /* Q_OS_WIN */
 103         signal(SIGABRT, handleSignal);
 104         signal(SIGSEGV, handleSignal);
 105 # ifndef Q_OS_WIN
 106         signal(SIGBUS, handleSignal);
 107     }
 108     free(limit);
 109 # endif /* Q_OS_WIN */
 110 #endif /* Q_OS_WIN || HAVE_EXECINFO */
 111     }
 112
 113     _initialized = true;
 114     qsrand(QTime(0, 0, 0).secsTo(QTime::currentTime()));
 115
 116     setupEnvironment();
 117     registerMetaTypes();
 118
 119     Network::setDefaultCodecForServer("ISO-8859-1");
 120     Network::setDefaultCodecForEncoding("UTF-8");
 121     Network::setDefaultCodecForDecoding("ISO-8859-15");
 122
 123     if (isOptionSet("help")) {
 124         cliParser()->usage();
 125         return false;
 126     }
 127
 128     if (isOptionSet("version")) {
 129         std::cout << qPrintable("Quassel IRC: " + Quassel::buildInfo().plainVersionString) << std::endl;
 130         return false;
 131     }
 132
 133     DEBUG = isOptionSet("debug");
 134
 135     // set up logging
 136     if (Quassel::runMode() != Quassel::ClientOnly) {
 137         if (isOptionSet("loglevel")) {
 138             QString level = optionValue("loglevel");
 139
 140             if (level == "Debug") _logLevel = DebugLevel;
 141             else if (level == "Info") _logLevel = InfoLevel;
 142             else if (level == "Warning") _logLevel = WarningLevel;
 143             else if (level == "Error") _logLevel = ErrorLevel;
 144         }
 145
 146         QString logfilename = optionValue("logfile");
 147         if (!logfilename.isEmpty()) {
 148             _logFile = new QFile(logfilename);
 149             if (!_logFile->open(QIODevice::Append | QIODevice::Text)) {
 150                 qWarning() << "Could not open log file" << logfilename << ":" << _logFile->errorString();
 151                 _logFile->deleteLater();
 152                 _logFile = 0;
 153             }
 154         }
 155 #ifdef HAVE_SYSLOG
 156         _logToSyslog = isOptionSet("syslog");
 157 #endif
 158     }
 159
 160     return true;
 161 }
 162
 163
 164 void Quassel::quit()
 165 {
 166     QCoreApplication::quit();
 167 }
 168
 169
 170 //! Register our custom types with Qt's Meta Object System.
 171 /**  This makes them available for QVariant and in signals/slots, among other things.
 172 *
 173 */
 174 void Quassel::registerMetaTypes()
 175 {
 176     // Complex types
 177     qRegisterMetaType<Message>("Message");
 178     qRegisterMetaType<BufferInfo>("BufferInfo");
 179     qRegisterMetaType<NetworkInfo>("NetworkInfo");
 180     qRegisterMetaType<Network::Server>("Network::Server");
 181     qRegisterMetaType<Identity>("Identity");
 182
 183     qRegisterMetaTypeStreamOperators<Message>("Message");
 184     qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
 185     qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
 186     qRegisterMetaTypeStreamOperators<Network::Server>("Network::Server");
 187     qRegisterMetaTypeStreamOperators<Identity>("Identity");
 188
 189     qRegisterMetaType<IdentityId>("IdentityId");
 190     qRegisterMetaType<BufferId>("BufferId");
 191     qRegisterMetaType<NetworkId>("NetworkId");
 192     qRegisterMetaType<UserId>("UserId");
 193     qRegisterMetaType<AccountId>("AccountId");
 194     qRegisterMetaType<MsgId>("MsgId");
 195
 196     qRegisterMetaType<QHostAddress>("QHostAddress");
 197     qRegisterMetaType<QUuid>("QUuid");
 198
 199     qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
 200     qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
 201     qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
 202     qRegisterMetaTypeStreamOperators<UserId>("UserId");
 203     qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
 204     qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
 205
 206     qRegisterMetaType<Protocol::SessionState>("Protocol::SessionState");
 207     qRegisterMetaType<PeerPtr>("PeerPtr");
 208     qRegisterMetaTypeStreamOperators<PeerPtr>("PeerPtr");
 209
 210     // Versions of Qt prior to 4.7 didn't define QVariant as a meta type
 211     if (!QMetaType::type("QVariant")) {
 212         qRegisterMetaType<QVariant>("QVariant");
 213         qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
 214     }
 215 }
 216
 217
 218 void Quassel::setupEnvironment()
 219 {
 220     // On modern Linux systems, XDG_DATA_DIRS contains a list of directories containing application data. This
 221     // is, for example, used by Qt for finding icons and other things. In case Quassel is installed in a non-standard
 222     // prefix (or run from the build directory), it makes sense to add this to XDG_DATA_DIRS so we don't have to
 223     // hack extra search paths into various places.
 224 #ifdef Q_OS_UNIX
 225     QString xdgDataVar = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
 226     if (xdgDataVar.isEmpty())
 227         xdgDataVar = QLatin1String("/usr/local/share:/usr/share"); // sane defaults
 228
 229     QStringList xdgDirs = xdgDataVar.split(QLatin1Char(':'), QString::SkipEmptyParts);
 230
 231     // Add our install prefix (if we're not in a bindir, this just adds the current workdir)
 232     QString appDir = QCoreApplication::applicationDirPath();
 233     int binpos = appDir.lastIndexOf("/bin");
 234     if (binpos >= 0) {
 235         appDir.replace(binpos, 4, "/share");
 236         xdgDirs.append(appDir);
 237         // Also append apps/quassel, this is only for QIconLoader to find icons there
 238         xdgDirs.append(appDir + "/apps/quassel");
 239     } else
 240         xdgDirs.append(appDir);  // build directory is always the last fallback
 241
 242     xdgDirs.removeDuplicates();
 243
 244     qputenv("XDG_DATA_DIRS", QFile::encodeName(xdgDirs.join(":")));
 245 #endif
 246 }
 247
 248
 249 void Quassel::setupBuildInfo()
 250 {
 251     _buildInfo.applicationName = "quassel";
 252     _buildInfo.coreApplicationName = "quasselcore";
 253     _buildInfo.clientApplicationName = "quasselclient";
 254     _buildInfo.organizationName = "Quassel Project";
 255     _buildInfo.organizationDomain = "quassel-irc.org";
 256
 257     _buildInfo.protocolVersion = 10; // FIXME: deprecated, will be removed
 258
 259     _buildInfo.baseVersion = QUASSEL_VERSION_STRING;
 260     _buildInfo.generatedVersion = GIT_DESCRIBE;
 261
 262     // This will be imprecise for incremental builds not touching this file, but we really don't want to always recompile
 263     _buildInfo.buildDate = QString("%1 %2").arg(__DATE__, __TIME__);
 264
 265     // Check if we got a commit hash
 266     if (!QString(GIT_HEAD).isEmpty())
 267         _buildInfo.commitHash = GIT_HEAD;
 268     else if (!QString(DIST_HASH).contains("Format")) {
 269         _buildInfo.commitHash = DIST_HASH;
 270         _buildInfo.commitDate = QString(DIST_DATE).toUInt();
 271     }
 272
 273     // create a nice version string
 274     if (_buildInfo.generatedVersion.isEmpty()) {
 275         if (!_buildInfo.commitHash.isEmpty()) {
 276             // dist version
 277             _buildInfo.plainVersionString = QString("v%1 (dist-%2)")
 278                                             .arg(_buildInfo.baseVersion)
 279                                             .arg(_buildInfo.commitHash.left(7));
 280             _buildInfo.fancyVersionString = QString("v%1 (dist-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%3\">%2</a>)")
 281                                             .arg(_buildInfo.baseVersion)
 282                                             .arg(_buildInfo.commitHash.left(7))
 283                                             .arg(_buildInfo.commitHash);
 284         }
 285         else {
 286             // we only have a base version :(
 287             _buildInfo.plainVersionString = QString("v%1 (unknown revision)").arg(_buildInfo.baseVersion);
 288         }
 289     }
 290     else {
 291         // analyze what we got from git-describe
 292         QRegExp rx("(.*)-(\\d+)-g([0-9a-f]+)(-dirty)?$");
 293         if (rx.exactMatch(_buildInfo.generatedVersion)) {
 294             QString distance = rx.cap(2) == "0" ? QString() : QString("%1+%2 ").arg(rx.cap(1), rx.cap(2));
 295             _buildInfo.plainVersionString = QString("v%1 (%2git-%3%4)")
 296                                             .arg(_buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4));
 297             if (!_buildInfo.commitHash.isEmpty()) {
 298                 _buildInfo.fancyVersionString = QString("v%1 (%2git-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%5\">%3</a>%4)")
 299                                                 .arg(_buildInfo.baseVersion, distance, rx.cap(3), rx.cap(4), _buildInfo.commitHash);
 300             }
 301         }
 302         else {
 303             _buildInfo.plainVersionString = QString("v%1 (invalid revision)").arg(_buildInfo.baseVersion);
 304         }
 305     }
 306     if (_buildInfo.fancyVersionString.isEmpty())
 307         _buildInfo.fancyVersionString = _buildInfo.plainVersionString;
 308 }
 309
 310
 311 //! Signal handler for graceful shutdown.
 312 void Quassel::handleSignal(int sig)
 313 {
 314     switch (sig) {
 315     case SIGTERM:
 316     case SIGINT:
 317         qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
 318         if (_instance)
 319             _instance->quit();
 320         else
 321             QCoreApplication::quit();
 322         break;
 323     case SIGABRT:
 324     case SIGSEGV:
 325 #ifndef Q_OS_WIN
 326     case SIGBUS:
 327 #endif
 328         logBacktrace(coreDumpFileName());
 329         exit(EXIT_FAILURE);
 330         break;
 331     default:
 332         break;
 333     }
 334 }
 335
 336
 337 void Quassel::logFatalMessage(const char *msg)
 338 {
 339 #ifdef Q_OS_MAC
 340     Q_UNUSED(msg)
 341 #else
 342     QFile dumpFile(coreDumpFileName());
 343     dumpFile.open(QIODevice::Append);
 344     QTextStream dumpStream(&dumpFile);
 345
 346     dumpStream << "Fatal: " << msg << '\n';
 347     dumpStream.flush();
 348     dumpFile.close();
 349 #endif
 350 }
 351
 352
 353 Quassel::Features Quassel::features()
 354 {
 355     Features feats = 0;
 356     for (int i = 1; i <= NumFeatures; i <<= 1)
 357         feats |= (Feature)i;
 358
 359     return feats;
 360 }
 361
 362
 363 const QString &Quassel::coreDumpFileName()
 364 {
 365     if (_coreDumpFileName.isEmpty()) {
 366         QDir configDir(configDirPath());
 367         _coreDumpFileName = configDir.absoluteFilePath(QString("Quassel-Crash-%1.log").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm")));
 368         QFile dumpFile(_coreDumpFileName);
 369         dumpFile.open(QIODevice::Append);
 370         QTextStream dumpStream(&dumpFile);
 371         dumpStream << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash << '\n';
 372         qDebug() << "Quassel IRC: " << _buildInfo.baseVersion << ' ' << _buildInfo.commitHash;
 373         dumpStream.flush();
 374         dumpFile.close();
 375     }
 376     return _coreDumpFileName;
 377 }
 378
 379
 380 QString Quassel::configDirPath()
 381 {
 382     if (!_configDirPath.isEmpty())
 383         return _configDirPath;
 384
 385     if (Quassel::isOptionSet("datadir")) {
 386         qWarning() << "Obsolete option --datadir used!";
 387         _configDirPath = Quassel::optionValue("datadir");
 388     }
 389     else if (Quassel::isOptionSet("configdir")) {
 390         _configDirPath = Quassel::optionValue("configdir");
 391     }
 392     else {
 393 #ifdef Q_OS_MAC
 394         // On Mac, the path is always the same
 395         _configDirPath = QDir::homePath() + "/Library/Application Support/Quassel/";
 396 #else
 397         // We abuse QSettings to find us a sensible path on the other platforms
 398 #  ifdef Q_OS_WIN
 399         // don't use the registry
 400         QSettings::Format format = QSettings::IniFormat;
 401 #  else
 402         QSettings::Format format = QSettings::NativeFormat;
 403 #  endif
 404         QSettings s(format, QSettings::UserScope, QCoreApplication::organizationDomain(), buildInfo().applicationName);
 405         QFileInfo fileInfo(s.fileName());
 406         _configDirPath = fileInfo.dir().absolutePath();
 407 #endif /* Q_OS_MAC */
 408     }
 409
 410     if (!_configDirPath.endsWith(QDir::separator()) && !_configDirPath.endsWith('/'))
 411         _configDirPath += QDir::separator();
 412
 413     QDir qDir(_configDirPath);
 414     if (!qDir.exists(_configDirPath)) {
 415         if (!qDir.mkpath(_configDirPath)) {
 416             qCritical() << "Unable to create Quassel config directory:" << qPrintable(qDir.absolutePath());
 417             return QString();
 418         }
 419     }
 420
 421     return _configDirPath;
 422 }
 423
 424
 425 QStringList Quassel::dataDirPaths()
 426 {
 427     return _dataDirPaths;
 428 }
 429
 430
 431 QStringList Quassel::findDataDirPaths() const
 432 {
 433     // We don't use QStandardPaths for now, as we still need to provide fallbacks for Qt4 and
 434     // want to stay consistent.
 435
 436     QStringList dataDirNames;
 437 #ifdef Q_OS_WIN
 438     dataDirNames << qgetenv("APPDATA") + QCoreApplication::organizationDomain() + "/share/apps/quassel/"
 439                  << qgetenv("APPDATA") + QCoreApplication::organizationDomain()
 440                  << QCoreApplication::applicationDirPath();
 441 #elif defined Q_OS_MAC
 442     dataDirNames << QDir::homePath() + "/Library/Application Support/Quassel/"
 443                  << QCoreApplication::applicationDirPath();
 444 #else
 445     // Linux et al
 446
 447     // XDG_DATA_HOME is the location for users to override system-installed files, usually in .local/share
 448     // This should thus come first.
 449     QString xdgDataHome = QFile::decodeName(qgetenv("XDG_DATA_HOME"));
 450     if (xdgDataHome.isEmpty())
 451         xdgDataHome = QDir::homePath() + QLatin1String("/.local/share");
 452     dataDirNames << xdgDataHome;
 453
 454     // Now whatever is configured through XDG_DATA_DIRS
 455     QString xdgDataDirs = QFile::decodeName(qgetenv("XDG_DATA_DIRS"));
 456     if (xdgDataDirs.isEmpty())
 457         dataDirNames << "/usr/local/share" << "/usr/share";
 458     else
 459         dataDirNames << xdgDataDirs.split(':', QString::SkipEmptyParts);
 460
 461     // Just in case, also check our install prefix
 462     dataDirNames << QCoreApplication::applicationDirPath() + "/../share";
 463
 464     // Normalize and append our application name
 465     for (int i = 0; i < dataDirNames.count(); i++)
 466         dataDirNames[i] = QDir::cleanPath(dataDirNames.at(i)) + "/quassel/";
 467
 468 #endif
 469
 470     // Add resource path and workdir just in case.
 471     // Workdir should have precedence
 472     dataDirNames.prepend(QCoreApplication::applicationDirPath() + "/data/");
 473     dataDirNames.append(":/data/");
 474
 475     // Append trailing '/' and check for existence
 476     auto iter = dataDirNames.begin();
 477     while (iter != dataDirNames.end()) {
 478         if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
 479             iter->append(QDir::separator());
 480         if (!QFile::exists(*iter))
 481             iter = dataDirNames.erase(iter);
 482         else
 483             ++iter;
 484     }
 485
 486     dataDirNames.removeDuplicates();
 487
 488     return dataDirNames;
 489 }
 490
 491
 492 QString Quassel::findDataFilePath(const QString &fileName)
 493 {
 494     QStringList dataDirs = dataDirPaths();
 495     foreach(QString dataDir, dataDirs) {
 496         QString path = dataDir + fileName;
 497         if (QFile::exists(path))
 498             return path;
 499     }
 500     return QString();
 501 }
 502
 503
 504 QStringList Quassel::scriptDirPaths()
 505 {
 506     QStringList res(configDirPath() + "scripts/");
 507     foreach(QString path, dataDirPaths())
 508     res << path + "scripts/";
 509     return res;
 510 }
 511
 512
 513 QString Quassel::translationDirPath()
 514 {
 515     if (_translationDirPath.isEmpty()) {
 516         // We support only one translation dir; fallback mechanisms wouldn't work else.
 517         // This means that if we have a $data/translations dir, the internal :/i18n resource won't be considered.
 518         foreach(const QString &dir, dataDirPaths()) {
 519             if (QFile::exists(dir + "translations/")) {
 520                 _translationDirPath = dir + "translations/";
 521                 break;
 522             }
 523         }
 524         if (_translationDirPath.isEmpty())
 525             _translationDirPath = ":/i18n/";
 526     }
 527     return _translationDirPath;
 528 }
 529
 530
 531 void Quassel::loadTranslation(const QLocale &locale)
 532 {
 533     QTranslator *qtTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QtTr");
 534     QTranslator *quasselTranslator = QCoreApplication::instance()->findChild<QTranslator *>("QuasselTr");
 535
 536     if (qtTranslator)
 537         qApp->removeTranslator(qtTranslator);
 538     if (quasselTranslator)
 539         qApp->removeTranslator(quasselTranslator);
 540
 541     // We use QLocale::C to indicate that we don't want a translation
 542     if (locale.language() == QLocale::C)
 543         return;
 544
 545     qtTranslator = new QTranslator(qApp);
 546     qtTranslator->setObjectName("QtTr");
 547     qApp->installTranslator(qtTranslator);
 548
 549     quasselTranslator = new QTranslator(qApp);
 550     quasselTranslator->setObjectName("QuasselTr");
 551     qApp->installTranslator(quasselTranslator);
 552
 553 #if QT_VERSION >= 0x040800 && !defined Q_OS_MAC
 554     bool success = qtTranslator->load(locale, QString("qt_"), translationDirPath());
 555     if (!success)
 556         qtTranslator->load(locale, QString("qt_"), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
 557     quasselTranslator->load(locale, QString(""), translationDirPath());
 558 #else
 559     bool success = qtTranslator->load(QString("qt_%1").arg(locale.name()), translationDirPath());
 560     if (!success)
 561         qtTranslator->load(QString("qt_%1").arg(locale.name()), QLibraryInfo::location(QLibraryInfo::TranslationsPath));
 562     quasselTranslator->load(QString("%1").arg(locale.name()), translationDirPath());
 563 #endif
 564 }