src/qtui/qtuiapplication.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 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 "qtuiapplication.h"
  22
  23 #include <QIcon>
  24 #include <QStringList>
  25
  26 #ifdef HAVE_KDE4
  27 #  include <KStandardDirs>
  28 #endif
  29
  30 #include "client.h"
  31 #include "cliparser.h"
  32 #include "mainwin.h"
  33 #include "qtui.h"
  34 #include "qtuisettings.h"
  35
  36 QtUiApplication::QtUiApplication(int &argc, char **argv)
  37 #ifdef HAVE_KDE4
  38     : KApplication(),  // KApplication is deprecated in KF5
  39 #else
  40     : QApplication(argc, argv),
  41 #endif
  42     Quassel(),
  43     _aboutToQuit(false)
  44 {
  45 #ifdef HAVE_KDE4
  46     Q_UNUSED(argc); Q_UNUSED(argv);
  47
  48     // Setup KDE's data dirs
  49     // Because we can't use KDE stuff in (the class) Quassel directly, we need to do this here...
  50     QStringList dataDirs = KGlobal::dirs()->findDirs("data", "");
  51
  52     // Just in case, also check our install prefix
  53     dataDirs << QCoreApplication::applicationDirPath() + "/../share/apps/";
  54
  55     // Normalize and append our application name
  56     for (int i = 0; i < dataDirs.count(); i++)
  57         dataDirs[i] = QDir::cleanPath(dataDirs.at(i)) + "/quassel/";
  58
  59     // Add resource path and just in case.
  60     // Workdir should have precedence
  61     dataDirs.prepend(QCoreApplication::applicationDirPath() + "/data/");
  62     dataDirs.append(":/data/");
  63
  64     // Append trailing '/' and check for existence
  65     auto iter = dataDirs.begin();
  66     while (iter != dataDirs.end()) {
  67         if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
  68             iter->append(QDir::separator());
  69         if (!QFile::exists(*iter))
  70             iter = dataDirs.erase(iter);
  71         else
  72             ++iter;
  73     }
  74
  75     dataDirs.removeDuplicates();
  76     setDataDirPaths(dataDirs);
  77
  78 #else /* HAVE_KDE4 */
  79
  80     setDataDirPaths(findDataDirPaths());
  81
  82 #endif /* HAVE_KDE4 */
  83
  84 #if defined(HAVE_KDE4) || defined(Q_OS_MAC)
  85     disableCrashhandler();
  86 #endif /* HAVE_KDE4 || Q_OS_MAC */
  87     setRunMode(Quassel::ClientOnly);
  88
  89 #if QT_VERSION < 0x050000
  90     qInstallMsgHandler(Client::logMessage);
  91 #else
  92     qInstallMessageHandler(Client::logMessage);
  93     connect(this, &QGuiApplication::commitDataRequest, this, &QtUiApplication::commitData, Qt::DirectConnection);
  94     connect(this, &QGuiApplication::saveStateRequest, this, &QtUiApplication::saveState, Qt::DirectConnection);
  95 #endif
  96
  97 #if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
  98     QGuiApplication::setFallbackSessionManagementEnabled(false);
  99 #endif
 100 }
 101
 102
 103 bool QtUiApplication::init()
 104 {
 105     if (Quassel::init()) {
 106         // FIXME: MIGRATION 0.3 -> 0.4: Move database and core config to new location
 107         // Move settings, note this does not delete the old files
 108 #ifdef Q_OS_MAC
 109         QSettings newSettings("quassel-irc.org", "quasselclient");
 110 #else
 111
 112 # ifdef Q_OS_WIN
 113         QSettings::Format format = QSettings::IniFormat;
 114 # else
 115         QSettings::Format format = QSettings::NativeFormat;
 116 # endif
 117
 118         QString newFilePath = Quassel::configDirPath() + "quasselclient"
 119                               + ((format == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
 120         QSettings newSettings(newFilePath, format);
 121 #endif /* Q_OS_MAC */
 122
 123         if (newSettings.value("Config/Version").toUInt() == 0) {
 124 #     ifdef Q_OS_MAC
 125             QString org = "quassel-irc.org";
 126 #     else
 127             QString org = "Quassel Project";
 128 #     endif
 129             QSettings oldSettings(org, "Quassel Client");
 130             if (oldSettings.allKeys().count()) {
 131                 qWarning() << "\n\n*** IMPORTANT: Config and data file locations have changed. Attempting to auto-migrate your client settings...";
 132                 foreach(QString key, oldSettings.allKeys())
 133                 newSettings.setValue(key, oldSettings.value(key));
 134                 newSettings.setValue("Config/Version", 1);
 135                 qWarning() << "*   Your client settings have been migrated to" << newSettings.fileName();
 136                 qWarning() << "*** Migration completed.\n\n";
 137             }
 138         }
 139
 140         // MIGRATION end
 141
 142         // Settings upgrade/downgrade handling
 143         if (!migrateSettings()) {
 144             qCritical() << "Could not load or upgrade client settings, terminating!";
 145             return false;
 146         }
 147
 148         // Checking if settings Icon Theme is valid
 149         QString savedIcontheme = QtUiSettings().value("IconTheme", QVariant("")).toString();
 150 #ifndef WITH_OXYGEN
 151         if (savedIcontheme == "oxygen")
 152             QtUiSettings().remove("IconTheme");
 153 #endif
 154 #ifndef WITH_BREEZE
 155         if (savedIcontheme == "breeze")
 156             QtUiSettings().remove("IconTheme");
 157 #endif
 158 #ifndef WITH_BREEZE_DARK
 159         if (savedIcontheme == "breezedark")
 160             QtUiSettings().remove("IconTheme");
 161 #endif
 162
 163         // Set the icon theme
 164         if (Quassel::isOptionSet("icontheme"))
 165             QIcon::setThemeName(Quassel::optionValue("icontheme"));
 166         else if (QtUiSettings().value("IconTheme", QVariant("")).toString() != "")
 167             QIcon::setThemeName(QtUiSettings().value("IconTheme").toString());
 168         else if (QIcon::themeName().isEmpty())
 169             // Some platforms don't set a default icon theme; chances are we can find our bundled theme though
 170             QIcon::setThemeName("breeze");
 171
 172         // session resume
 173         QtUi *gui = new QtUi();
 174         Client::init(gui);
 175         // init gui only after the event loop has started
 176         // QTimer::singleShot(0, gui, SLOT(init()));
 177         gui->init();
 178         resumeSessionIfPossible();
 179         return true;
 180     }
 181     return false;
 182 }
 183
 184
 185 QtUiApplication::~QtUiApplication()
 186 {
 187     Client::destroy();
 188 }
 189
 190
 191 void QtUiApplication::quit()
 192 {
 193     QtUi::mainWindow()->quit();
 194 }
 195
 196
 197 bool QtUiApplication::migrateSettings()
 198 {
 199     // --------
 200     // Check major settings version.  This represents incompatible changes between settings
 201     // versions.  So far, we only have 1.
 202     QtUiSettings s;
 203     uint versionMajor = s.version();
 204     if (versionMajor != 1) {
 205         qCritical() << qPrintable(QString("Invalid client settings version '%1'")
 206                                   .arg(versionMajor));
 207         return false;
 208     }
 209
 210     // --------
 211     // Check minor settings version, handling upgrades/downgrades as needed
 212     // Current minor version
 213     const uint VERSION_MINOR_CURRENT = 6;
 214     // Stored minor version
 215     uint versionMinor = s.versionMinor();
 216
 217     if (versionMinor == VERSION_MINOR_CURRENT) {
 218         // At latest version, no need to migrate defaults or other settings
 219         return true;
 220     } else if (versionMinor == 0) {
 221         // New configuration, store as current version
 222         qDebug() << qPrintable(QString("Set up new client settings v%1.%2")
 223                                .arg(versionMajor).arg(VERSION_MINOR_CURRENT));
 224         s.setVersionMinor(VERSION_MINOR_CURRENT);
 225
 226         // Update the settings stylesheet for first setup.  We don't know if older content exists,
 227         // if the configuration got erased separately, etc.
 228         QtUiStyle qtUiStyle;
 229         qtUiStyle.generateSettingsQss();
 230         return true;
 231     } else if (versionMinor < VERSION_MINOR_CURRENT) {
 232         // We're upgrading - apply the neccessary upgrades from each interim version
 233         // curVersion will never equal VERSION_MINOR_CURRENT, as it represents the version before
 234         // the most recent applySettingsMigration() call.
 235         for (uint curVersion = versionMinor; curVersion < VERSION_MINOR_CURRENT; curVersion++) {
 236             if (!applySettingsMigration(s, curVersion + 1)) {
 237                 // Something went wrong, time to bail out
 238                 qCritical() << qPrintable(QString("Could not migrate client settings from v%1.%2 "
 239                                                   "to v%1.%3")
 240                                           .arg(versionMajor).arg(curVersion).arg(curVersion + 1));
 241                 // Keep track of the last successful upgrade to avoid repeating it on next start
 242                 s.setVersionMinor(curVersion);
 243                 return false;
 244             }
 245         }
 246         // Migration successful!
 247         qDebug() << qPrintable(QString("Successfully migrated client settings from v%1.%2 to "
 248                                        "v%1.%3")
 249                                .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
 250         // Store the new minor version
 251         s.setVersionMinor(VERSION_MINOR_CURRENT);
 252         return true;
 253     } else {
 254         // versionMinor > VERSION_MINOR_CURRENT
 255         // The user downgraded to an older version of Quassel.  Let's hope for the best.
 256         // Don't change the minorVersion as the newer version's upgrade logic has already run.
 257         qWarning() << qPrintable(QString("Client settings v%1.%2 is newer than latest known v%1.%3,"
 258                                          " things might not work!")
 259                                  .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
 260         return true;
 261     }
 262 }
 263
 264
 265 bool QtUiApplication::applySettingsMigration(QtUiSettings settings, const uint newVersion)
 266 {
 267     switch (newVersion) {
 268     // Version 0 and 1 aren't valid upgrade paths - one represents no version, the other is the
 269     // oldest version.  Ignore those, start from 2 and higher.
 270     // Each missed version will be called in sequence.  E.g. to upgrade from '1' to '3', this
 271     // function will be called with '2', then '3'.
 272     // Use explicit scope via { ... } to avoid cross-initialization
 273     //
 274     // In most cases, the goal is to preserve the older default values for keys that haven't been
 275     // saved.  Exceptions will be noted below.
 276     case 6:
 277     {
 278         // New default changes: sender colors switched around to Tango-ish theme
 279
 280         // --------
 281         // QtUiStyle settings
 282         QtUiStyleSettings settingsUiStyleColors("Colors");
 283         // Preserve the old default values for all variants
 284         const QColor oldDefaultSenderColorSelf = QColor(0, 0, 0);
 285         const QList<QColor> oldDefaultSenderColors = QList<QColor> {
 286             QColor(204,  13, 127),  /// Sender00
 287             QColor(142,  85, 233),  /// Sender01
 288             QColor(179,  14,  14),  /// Sender02
 289             QColor( 23, 179,  57),  /// Sender03
 290             QColor( 88, 175, 179),  /// Sender04
 291             QColor(157,  84, 179),  /// Sender05
 292             QColor(179, 151, 117),  /// Sender06
 293             QColor( 49, 118, 179),  /// Sender07
 294             QColor(233,  13, 127),  /// Sender08
 295             QColor(142,  85, 233),  /// Sender09
 296             QColor(179,  14,  14),  /// Sender10
 297             QColor( 23, 179,  57),  /// Sender11
 298             QColor( 88, 175, 179),  /// Sender12
 299             QColor(157,  84, 179),  /// Sender13
 300             QColor(179, 151, 117),  /// Sender14
 301             QColor( 49, 118, 179),  /// Sender15
 302         };
 303         if (!settingsUiStyleColors.valueExists("SenderSelf")) {
 304             // Preserve the old default sender color if none set
 305             settingsUiStyleColors.setValue("SenderSelf", oldDefaultSenderColorSelf);
 306         }
 307         QString senderColorId;
 308         for (int i = 0; i < oldDefaultSenderColors.count(); i++) {
 309             // Get the sender color ID for each available color
 310             QString dez = QString::number(i);
 311             if (dez.length() == 1) dez.prepend('0');
 312             senderColorId = QString("Sender" + dez);
 313             if (!settingsUiStyleColors.valueExists(senderColorId)) {
 314                 // Preserve the old default sender color if none set
 315                 settingsUiStyleColors.setValue(senderColorId, oldDefaultSenderColors[i]);
 316             }
 317         }
 318
 319         // Update the settings stylesheet with old defaults
 320         QtUiStyle qtUiStyle;
 321         qtUiStyle.generateSettingsQss();
 322         // --------
 323
 324         // Migration complete!
 325         return true;
 326     }
 327     case 5:
 328     {
 329         // New default changes: sender colors apply to nearly all messages with nicks
 330
 331         // --------
 332         // QtUiStyle settings
 333         QtUiStyleSettings settingsUiStyleColors("Colors");
 334         const QString useNickGeneralColorsId = "UseNickGeneralColors";
 335         if (!settingsUiStyleColors.valueExists(useNickGeneralColorsId)) {
 336             // New default is true, preserve previous behavior by setting to false
 337             settingsUiStyleColors.setValue(useNickGeneralColorsId, false);
 338         }
 339
 340         // Update the settings stylesheet with old defaults
 341         QtUiStyle qtUiStyle;
 342         qtUiStyle.generateSettingsQss();
 343         // --------
 344
 345         // Migration complete!
 346         return true;
 347     }
 348     case 4:
 349     {
 350         // New default changes: system locale used to generate a timestamp format string, deciding
 351         // 24-hour or 12-hour timestamp.
 352
 353         // --------
 354         // ChatView settings
 355         const QString useCustomTimestampFormatId = "ChatView/__default__/UseCustomTimestampFormat";
 356         if (!settings.valueExists(useCustomTimestampFormatId)) {
 357             // New default value is false, preserve previous behavior by setting to true
 358             settings.setValue(useCustomTimestampFormatId, true);
 359         }
 360         // --------
 361
 362         // Migration complete!
 363         return true;
 364     }
 365     case 3:
 366     {
 367         // New default changes: per-chat history and line wrapping enabled by default.
 368
 369         // --------
 370         // InputWidget settings
 371         UiSettings settingsInputWidget("InputWidget");
 372         const QString enableInputPerChatId = "EnablePerChatHistory";
 373         if (!settingsInputWidget.valueExists(enableInputPerChatId)) {
 374             // New default value is true, preserve previous behavior by setting to false
 375             settingsInputWidget.setValue(enableInputPerChatId, false);
 376         }
 377
 378         const QString enableInputLinewrap = "EnableLineWrap";
 379         if (!settingsInputWidget.valueExists(enableInputLinewrap)) {
 380             // New default value is true, preserve previous behavior by setting to false
 381             settingsInputWidget.setValue(enableInputLinewrap, false);
 382         }
 383         // --------
 384
 385         // Migration complete!
 386         return true;
 387     }
 388     case 2:
 389     {
 390         // New default changes: sender <nick> brackets disabled, sender colors and sender CTCP
 391         // colors enabled.
 392
 393         // --------
 394         // ChatView settings
 395         const QString timestampFormatId = "ChatView/__default__/TimestampFormat";
 396         if (!settings.valueExists(timestampFormatId)) {
 397             // New default value is " hh:mm:ss", preserve old default of "[hh:mm:ss]"
 398             settings.setValue(timestampFormatId, "[hh:mm:ss]");
 399         }
 400
 401         const QString showSenderBracketsId = "ChatView/__default__/ShowSenderBrackets";
 402         if (!settings.valueExists(showSenderBracketsId)) {
 403             // New default is false, preserve previous behavior by setting to true
 404             settings.setValue(showSenderBracketsId, true);
 405         }
 406         // --------
 407
 408         // --------
 409         // QtUiStyle settings
 410         QtUiStyleSettings settingsUiStyleColors("Colors");
 411         const QString useSenderColorsId = "UseSenderColors";
 412         if (!settingsUiStyleColors.valueExists(useSenderColorsId)) {
 413             // New default is true, preserve previous behavior by setting to false
 414             settingsUiStyleColors.setValue(useSenderColorsId, false);
 415         }
 416
 417         const QString useSenderActionColorsId = "UseSenderActionColors";
 418         if (!settingsUiStyleColors.valueExists(useSenderActionColorsId)) {
 419             // New default is true, preserve previous behavior by setting to false
 420             settingsUiStyleColors.setValue(useSenderActionColorsId, false);
 421         }
 422
 423         // Update the settings stylesheet with old defaults
 424         QtUiStyle qtUiStyle;
 425         qtUiStyle.generateSettingsQss();
 426         // --------
 427
 428         // Migration complete!
 429         return true;
 430     }
 431     default:
 432         // Something unexpected happened
 433         return false;
 434     }
 435 }
 436
 437
 438 void QtUiApplication::commitData(QSessionManager &manager)
 439 {
 440     Q_UNUSED(manager)
 441     _aboutToQuit = true;
 442 }
 443
 444
 445 void QtUiApplication::saveState(QSessionManager &manager)
 446 {
 447     //qDebug() << QString("saving session state to id %1").arg(manager.sessionId());
 448     // AccountId activeCore = Client::currentCoreAccount().accountId(); // FIXME store this!
 449     SessionSettings s(manager.sessionId());
 450     s.setSessionAge(0);
 451     QtUi::mainWindow()->saveStateToSettings(s);
 452 }
 453
 454
 455 void QtUiApplication::resumeSessionIfPossible()
 456 {
 457     // load all sessions
 458     if (isSessionRestored()) {
 459         qDebug() << QString("restoring from session %1").arg(sessionId());
 460         SessionSettings s(sessionId());
 461         s.sessionAging();
 462         s.setSessionAge(0);
 463         QtUi::mainWindow()->restoreStateFromSettings(s);
 464         s.cleanup();
 465     }
 466     else {
 467         SessionSettings s(QString("1"));
 468         s.sessionAging();
 469         s.cleanup();
 470     }
 471 }