src/common/quassel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   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 <signal.h>
  24
  25 #include <QCoreApplication>
  26 #include <QDateTime>
  27 #include <QObject>
  28 #include <QMetaType>
  29
  30 #include "message.h"
  31 #include "identity.h"
  32 #include "network.h"
  33 #include "bufferinfo.h"
  34 #include "types.h"
  35 #include "syncableobject.h"
  36
  37 #if defined(HAVE_EXECINFO) and not defined(Q_OS_MAC)
  38 #  define BUILD_CRASHHANDLER
  39 #  include <execinfo.h>
  40 #  include <dlfcn.h>
  41 #  include <cxxabi.h>
  42 #endif
  43
  44 Quassel::BuildInfo Quassel::_buildInfo;
  45 CliParser *Quassel::_cliParser = 0;
  46 Quassel::RunMode Quassel::_runMode;
  47 bool Quassel::_initialized = false;
  48 bool Quassel::DEBUG = false;
  49
  50 Quassel::Quassel() {
  51   Q_INIT_RESOURCE(i18n);
  52
  53   // We catch SIGTERM and SIGINT (caused by Ctrl+C) to graceful shutdown Quassel.
  54   signal(SIGTERM, handleSignal);
  55   signal(SIGINT, handleSignal);
  56
  57 #ifdef BUILD_CRASHHANDLER
  58   signal(SIGABRT, handleSignal);
  59   signal(SIGBUS, handleSignal);
  60   signal(SIGSEGV, handleSignal);
  61 #endif // #if defined(HAVE_EXECINFO) and not defined(Q_OS_MAC)
  62
  63   _cliParser = new CliParser();
  64
  65   // put shared client&core arguments here
  66   cliParser()->addSwitch("debug",'d', tr("Enable debug output"));
  67   cliParser()->addSwitch("help",'h', tr("Display this help and exit"));
  68 }
  69
  70 Quassel::~Quassel() {
  71   delete _cliParser;
  72 }
  73
  74 bool Quassel::init() {
  75   if(_initialized) return true;  // allow multiple invocations because of MonolithicApplication
  76
  77   qsrand(QTime(0,0,0).secsTo(QTime::currentTime()));
  78
  79   registerMetaTypes();
  80   setupTranslations();
  81
  82   QCoreApplication::setApplicationName(buildInfo().applicationName);
  83   QCoreApplication::setOrganizationName(buildInfo().organizationName);
  84   QCoreApplication::setOrganizationDomain(buildInfo().organizationDomain);
  85
  86   Network::setDefaultCodecForServer("ISO-8859-1");
  87   Network::setDefaultCodecForEncoding("UTF-8");
  88   Network::setDefaultCodecForDecoding("ISO-8859-15");
  89
  90   if(!cliParser()->parse(QCoreApplication::arguments()) || isOptionSet("help")) {
  91     cliParser()->usage();
  92     return false;
  93   }
  94   DEBUG = isOptionSet("debug");
  95   return true;
  96 }
  97
  98 //! Register our custom types with Qt's Meta Object System.
  99 /**  This makes them available for QVariant and in signals/slots, among other things.
 100 *
 101 */
 102 void Quassel::registerMetaTypes() {
 103   // Complex types
 104   qRegisterMetaType<QVariant>("QVariant");
 105   qRegisterMetaType<Message>("Message");
 106   qRegisterMetaType<BufferInfo>("BufferInfo");
 107   qRegisterMetaType<NetworkInfo>("NetworkInfo");
 108   qRegisterMetaType<Identity>("Identity");
 109   qRegisterMetaType<Network::ConnectionState>("Network::ConnectionState");
 110
 111   qRegisterMetaTypeStreamOperators<QVariant>("QVariant");
 112   qRegisterMetaTypeStreamOperators<Message>("Message");
 113   qRegisterMetaTypeStreamOperators<BufferInfo>("BufferInfo");
 114   qRegisterMetaTypeStreamOperators<NetworkInfo>("NetworkInfo");
 115   qRegisterMetaTypeStreamOperators<Identity>("Identity");
 116   qRegisterMetaTypeStreamOperators<qint8>("Network::ConnectionState");
 117
 118   qRegisterMetaType<IdentityId>("IdentityId");
 119   qRegisterMetaType<BufferId>("BufferId");
 120   qRegisterMetaType<NetworkId>("NetworkId");
 121   qRegisterMetaType<UserId>("UserId");
 122   qRegisterMetaType<AccountId>("AccountId");
 123   qRegisterMetaType<MsgId>("MsgId");
 124
 125   qRegisterMetaTypeStreamOperators<IdentityId>("IdentityId");
 126   qRegisterMetaTypeStreamOperators<BufferId>("BufferId");
 127   qRegisterMetaTypeStreamOperators<NetworkId>("NetworkId");
 128   qRegisterMetaTypeStreamOperators<UserId>("UserId");
 129   qRegisterMetaTypeStreamOperators<AccountId>("AccountId");
 130   qRegisterMetaTypeStreamOperators<MsgId>("MsgId");
 131 }
 132
 133 void Quassel::setupTranslations() {
 134   // Set up i18n support
 135   QLocale locale = QLocale::system();
 136
 137   QTranslator *qtTranslator = new QTranslator(qApp);
 138   qtTranslator->setObjectName("QtTr");
 139   qtTranslator->load(QString(":i18n/qt_%1").arg(locale.name()));
 140   qApp->installTranslator(qtTranslator);
 141
 142   QTranslator *quasselTranslator = new QTranslator(qApp);
 143   quasselTranslator->setObjectName("QuasselTr");
 144   quasselTranslator->load(QString(":i18n/quassel_%1").arg(locale.name()));
 145   qApp->installTranslator(quasselTranslator);
 146 }
 147
 148 void Quassel::setupBuildInfo(const QString &generated) {
 149   _buildInfo.applicationName = "Quassel IRC";
 150   _buildInfo.coreApplicationName = "Quassel Core";
 151   _buildInfo.clientApplicationName = "Quassel Client";
 152   _buildInfo.organizationName = "Quassel Project";
 153   _buildInfo.organizationDomain = "quassel-irc.org";
 154
 155   QStringList gen = generated.split(',');
 156   Q_ASSERT(gen.count() == 10);
 157   _buildInfo.baseVersion = gen[0];
 158   _buildInfo.generatedVersion = gen[1];
 159   _buildInfo.isSourceDirty = !gen[2].isEmpty();
 160   _buildInfo.commitHash = gen[3];
 161   _buildInfo.commitDate = gen[4].toUInt();
 162   _buildInfo.protocolVersion = gen[5].toUInt();
 163   _buildInfo.clientNeedsProtocol = gen[6].toUInt();
 164   _buildInfo.coreNeedsProtocol = gen[7].toUInt();
 165   _buildInfo.buildDate = QString("%1 %2").arg(gen[8], gen[9]);
 166   // create a nice version string
 167   if(_buildInfo.generatedVersion.isEmpty()) {
 168     if(!_buildInfo.commitHash.isEmpty()) {
 169       // dist version
 170       _buildInfo.plainVersionString = QString("v%1 (dist-%2)")
 171                                         .arg(_buildInfo.baseVersion)
 172                                         .arg(_buildInfo.commitHash.left(7));
 173                                         _buildInfo.fancyVersionString
 174                                            = QString("v%1 (dist-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%3\">%2</a>)")
 175                                         .arg(_buildInfo.baseVersion)
 176                                         .arg(_buildInfo.commitHash.left(7))
 177                                         .arg(_buildInfo.commitHash);
 178     } else {
 179     // we only have a base version :(
 180       _buildInfo.plainVersionString = QString("v%1 (unknown rev)").arg(_buildInfo.baseVersion);
 181     }
 182   } else {
 183     // analyze what we got from git-describe
 184     QRegExp rx("(.*)-(\\d+)-g([0-9a-f]+)$");
 185     if(rx.exactMatch(_buildInfo.generatedVersion)) {
 186       QString distance = rx.cap(2) == "0" ? QString() : QString(" [+%1]").arg(rx.cap(2));
 187       _buildInfo.plainVersionString = QString("v%1%2 (git-%3%4)")
 188                                         .arg(rx.cap(1), distance, rx.cap(3))
 189                                         .arg(_buildInfo.isSourceDirty ? "*" : "");
 190       if(!_buildInfo.commitHash.isEmpty()) {
 191         _buildInfo.fancyVersionString = QString("v%1%2 (git-<a href=\"http://git.quassel-irc.org/?p=quassel.git;a=commit;h=%5\">%3</a>%4)")
 192                                           .arg(rx.cap(1), distance, rx.cap(3))
 193                                           .arg(_buildInfo.isSourceDirty ? "*" : "")
 194                                           .arg(_buildInfo.commitHash);
 195       }
 196     } else {
 197       _buildInfo.plainVersionString = QString("v%1 (invalid rev)").arg(_buildInfo.baseVersion);
 198     }
 199   }
 200   if(_buildInfo.fancyVersionString.isEmpty())
 201     _buildInfo.fancyVersionString = _buildInfo.plainVersionString;
 202 }
 203
 204 //! Signal handler for graceful shutdown.
 205 void Quassel::handleSignal(int sig) {
 206   switch(sig) {
 207     case SIGTERM:
 208     case SIGINT:
 209       qWarning("%s", qPrintable(QString("Caught signal %1 - exiting.").arg(sig)));
 210       QCoreApplication::quit();
 211       break;
 212
 213 #ifdef BUILD_CRASHHANDLER
 214     case SIGABRT:
 215     case SIGBUS:
 216     case SIGSEGV:
 217       handleCrash();
 218 #endif
 219       break;
 220     default:
 221       break;
 222   }
 223 }
 224
 225 void Quassel::handleCrash() {
 226 #ifdef BUILD_CRASHHANDLER
 227   void* callstack[128];
 228   int i, frames = backtrace(callstack, 128);
 229
 230   QFile dumpFile(QString("Quassel-Crash-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmm.log")));
 231   dumpFile.open(QIODevice::WriteOnly);
 232   QTextStream dumpStream(&dumpFile);
 233
 234   for (i = 0; i < frames; ++i) {
 235     Dl_info info;
 236     dladdr (callstack[i], &info);
 237     // as a reference:
 238     //     typedef struct
 239     //     {
 240       //       __const char *dli_fname;   /* File name of defining object.  */
 241     //       void *dli_fbase;           /* Load address of that object.  */
 242     //       __const char *dli_sname;   /* Name of nearest symbol.  */
 243     //       void *dli_saddr;           /* Exact value of nearest symbol.  */
 244     //     } Dl_info;
 245
 246     #if __LP64__
 247     int addrSize = 16;
 248     #else
 249     int addrSize = 8;
 250     #endif
 251
 252     QString funcName;
 253     if(info.dli_sname) {
 254       char *func = abi::__cxa_demangle(info.dli_sname, 0, 0, 0);
 255       if(func) {
 256         funcName = QString(func);
 257         free(func);
 258       } else {
 259         funcName = QString(info.dli_sname);
 260       }
 261     } else {
 262       funcName = QString("0x%1").arg((long)info.dli_saddr, addrSize, QLatin1Char('0'));
 263     }
 264
 265     // prettificating the filename
 266     QString fileName("???");
 267     if(info.dli_fname) {
 268       fileName = QString(info.dli_fname);
 269       int slashPos = fileName.lastIndexOf('/');
 270       if(slashPos != -1)
 271         fileName = fileName.mid(slashPos + 1);
 272       if(fileName.count() < 20)
 273         fileName += QString(20 - fileName.count(), ' ');
 274     }
 275
 276     QString debugLine = QString("#%1 %2 0x%3 %4").arg(i, 3, 10)
 277     .arg(fileName)
 278     .arg((long)(callstack[i]), addrSize, 16, QLatin1Char('0'))
 279     .arg(funcName);
 280
 281     dumpStream << debugLine << "\n";
 282     qDebug() << qPrintable(debugLine);
 283   }
 284   dumpFile.close();
 285   exit(27);
 286 #endif /* BUILD_CRASHHANDLER */
 287 }