1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "qtuiapplication.h"
25 #include <QStringList>
28 # include <KStandardDirs>
32 #include "cliparser.h"
35 #include "qtuisettings.h"
37 QtUiApplication::QtUiApplication(int &argc, char **argv)
39 : KApplication() // KApplication is deprecated in KF5
41 : QApplication(argc, argv)
45 Q_UNUSED(argc); Q_UNUSED(argv);
47 // Setup KDE's data dirs
48 // Because we can't use KDE stuff in (the class) Quassel directly, we need to do this here...
49 QStringList dataDirs = KGlobal::dirs()->findDirs("data", "");
51 // Just in case, also check our install prefix
52 dataDirs << QCoreApplication::applicationDirPath() + "/../share/apps/";
54 // Normalize and append our application name
55 for (int i = 0; i < dataDirs.count(); i++)
56 dataDirs[i] = QDir::cleanPath(dataDirs.at(i)) + "/quassel/";
58 // Add resource path and just in case.
59 // Workdir should have precedence
60 dataDirs.prepend(QCoreApplication::applicationDirPath() + "/data/");
61 dataDirs.append(":/data/");
63 // Append trailing '/' and check for existence
64 auto iter = dataDirs.begin();
65 while (iter != dataDirs.end()) {
66 if (!iter->endsWith(QDir::separator()) && !iter->endsWith('/'))
67 iter->append(QDir::separator());
68 if (!QFile::exists(*iter))
69 iter = dataDirs.erase(iter);
74 dataDirs.removeDuplicates();
75 Quassel::setDataDirPaths(dataDirs);
79 Quassel::setDataDirPaths(Quassel::findDataDirPaths());
81 #endif /* HAVE_KDE4 */
83 #if defined(HAVE_KDE4) || defined(Q_OS_MAC)
84 Quassel::disableCrashHandler();
85 #endif /* HAVE_KDE4 || Q_OS_MAC */
87 Quassel::setRunMode(Quassel::ClientOnly);
89 #if QT_VERSION < 0x050000
90 qInstallMsgHandler(Client::logMessage);
92 qInstallMessageHandler(Client::logMessage);
93 connect(this, &QGuiApplication::commitDataRequest, this, &QtUiApplication::commitData, Qt::DirectConnection);
94 connect(this, &QGuiApplication::saveStateRequest, this, &QtUiApplication::saveState, Qt::DirectConnection);
97 #if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
98 QGuiApplication::setFallbackSessionManagementEnabled(false);
103 bool QtUiApplication::init()
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
109 QSettings newSettings("quassel-irc.org", "quasselclient");
113 QSettings::Format format = QSettings::IniFormat;
115 QSettings::Format format = QSettings::NativeFormat;
118 QString newFilePath = Quassel::configDirPath() + "quasselclient"
119 + ((format == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
120 QSettings newSettings(newFilePath, format);
121 #endif /* Q_OS_MAC */
123 if (newSettings.value("Config/Version").toUInt() == 0) {
125 QString org = "quassel-irc.org";
127 QString org = "Quassel Project";
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";
142 // Settings upgrade/downgrade handling
143 if (!migrateSettings()) {
144 qCritical() << "Could not load or upgrade client settings, terminating!";
148 // Checking if settings Icon Theme is valid
149 QString savedIcontheme = QtUiSettings().value("IconTheme", QVariant("")).toString();
151 if (savedIcontheme == "oxygen")
152 QtUiSettings().remove("IconTheme");
155 if (savedIcontheme == "breeze")
156 QtUiSettings().remove("IconTheme");
158 #ifndef WITH_BREEZE_DARK
159 if (savedIcontheme == "breezedark")
160 QtUiSettings().remove("IconTheme");
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");
172 Client::init(new QtUi());
174 // Init UI only after the event loop has started
175 // TODO Qt5: Make this a lambda
176 QTimer::singleShot(0, this, SLOT(initUi()));
178 Quassel::registerQuitHandler([]() {
179 QtUi::mainWindow()->quit();
189 QtUiApplication::~QtUiApplication()
195 void QtUiApplication::initUi()
197 QtUi::instance()->init();
198 resumeSessionIfPossible();
202 bool QtUiApplication::migrateSettings()
205 // Check major settings version. This represents incompatible changes between settings
206 // versions. So far, we only have 1.
208 uint versionMajor = s.version();
209 if (versionMajor != 1) {
210 qCritical() << qPrintable(QString("Invalid client settings version '%1'")
216 // Check minor settings version, handling upgrades/downgrades as needed
217 // Current minor version
219 // NOTE: If you increase the minor version, you MUST ALSO add new version upgrade logic in
220 // applySettingsMigration()! Otherwise, settings upgrades will fail.
221 const uint VERSION_MINOR_CURRENT = 7;
222 // Stored minor version
223 uint versionMinor = s.versionMinor();
225 if (versionMinor == VERSION_MINOR_CURRENT) {
226 // At latest version, no need to migrate defaults or other settings
228 } else if (versionMinor == 0) {
229 // New configuration, store as current version
230 qDebug() << qPrintable(QString("Set up new client settings v%1.%2")
231 .arg(versionMajor).arg(VERSION_MINOR_CURRENT));
232 s.setVersionMinor(VERSION_MINOR_CURRENT);
234 // Update the settings stylesheet for first setup. We don't know if older content exists,
235 // if the configuration got erased separately, etc.
237 qtUiStyle.generateSettingsQss();
239 } else if (versionMinor < VERSION_MINOR_CURRENT) {
240 // We're upgrading - apply the neccessary upgrades from each interim version
241 // curVersion will never equal VERSION_MINOR_CURRENT, as it represents the version before
242 // the most recent applySettingsMigration() call.
243 for (uint curVersion = versionMinor; curVersion < VERSION_MINOR_CURRENT; curVersion++) {
244 if (!applySettingsMigration(s, curVersion + 1)) {
245 // Something went wrong, time to bail out
246 qCritical() << qPrintable(QString("Could not migrate client settings from v%1.%2 "
248 .arg(versionMajor).arg(curVersion).arg(curVersion + 1));
249 // Keep track of the last successful upgrade to avoid repeating it on next start
250 s.setVersionMinor(curVersion);
254 // Migration successful!
255 qDebug() << qPrintable(QString("Successfully migrated client settings from v%1.%2 to "
257 .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
258 // Store the new minor version
259 s.setVersionMinor(VERSION_MINOR_CURRENT);
262 // versionMinor > VERSION_MINOR_CURRENT
263 // The user downgraded to an older version of Quassel. Let's hope for the best.
264 // Don't change the minorVersion as the newer version's upgrade logic has already run.
265 qWarning() << qPrintable(QString("Client settings v%1.%2 is newer than latest known v%1.%3,"
266 " things might not work!")
267 .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
273 bool QtUiApplication::applySettingsMigration(QtUiSettings settings, const uint newVersion)
275 switch (newVersion) {
276 // Version 0 and 1 aren't valid upgrade paths - one represents no version, the other is the
277 // oldest version. Ignore those, start from 2 and higher.
278 // Each missed version will be called in sequence. E.g. to upgrade from '1' to '3', this
279 // function will be called with '2', then '3'.
280 // Use explicit scope via { ... } to avoid cross-initialization
282 // In most cases, the goal is to preserve the older default values for keys that haven't been
283 // saved. Exceptions will be noted below.
284 // NOTE: If you add new upgrade logic here, you MUST ALSO increase VERSION_MINOR_CURRENT in
285 // migrateSettings()! Otherwise, your upgrade logic won't ever be called.
288 // New default changes: UseProxy is no longer used in CoreAccountSettings
289 CoreAccountSettings s;
290 for (auto &&accountId : s.knownAccounts()) {
291 auto map = s.retrieveAccountData(accountId);
292 if (!map.value("UseProxy", false).toBool()) {
293 map["ProxyType"] = static_cast<int>(QNetworkProxy::ProxyType::NoProxy);
295 map.remove("UseProxy");
296 s.storeAccountData(accountId, map);
299 // Migration complete!
304 // New default changes: sender colors switched around to Tango-ish theme
307 // QtUiStyle settings
308 QtUiStyleSettings settingsUiStyleColors("Colors");
309 // Preserve the old default values for all variants
310 const QColor oldDefaultSenderColorSelf = QColor(0, 0, 0);
311 const QList<QColor> oldDefaultSenderColors = QList<QColor> {
312 QColor(204, 13, 127), /// Sender00
313 QColor(142, 85, 233), /// Sender01
314 QColor(179, 14, 14), /// Sender02
315 QColor( 23, 179, 57), /// Sender03
316 QColor( 88, 175, 179), /// Sender04
317 QColor(157, 84, 179), /// Sender05
318 QColor(179, 151, 117), /// Sender06
319 QColor( 49, 118, 179), /// Sender07
320 QColor(233, 13, 127), /// Sender08
321 QColor(142, 85, 233), /// Sender09
322 QColor(179, 14, 14), /// Sender10
323 QColor( 23, 179, 57), /// Sender11
324 QColor( 88, 175, 179), /// Sender12
325 QColor(157, 84, 179), /// Sender13
326 QColor(179, 151, 117), /// Sender14
327 QColor( 49, 118, 179), /// Sender15
329 if (!settingsUiStyleColors.valueExists("SenderSelf")) {
330 // Preserve the old default sender color if none set
331 settingsUiStyleColors.setValue("SenderSelf", oldDefaultSenderColorSelf);
333 QString senderColorId;
334 for (int i = 0; i < oldDefaultSenderColors.count(); i++) {
335 // Get the sender color ID for each available color
336 QString dez = QString::number(i);
337 if (dez.length() == 1) dez.prepend('0');
338 senderColorId = QString("Sender" + dez);
339 if (!settingsUiStyleColors.valueExists(senderColorId)) {
340 // Preserve the old default sender color if none set
341 settingsUiStyleColors.setValue(senderColorId, oldDefaultSenderColors[i]);
345 // Update the settings stylesheet with old defaults
347 qtUiStyle.generateSettingsQss();
350 // Migration complete!
355 // New default changes: sender colors apply to nearly all messages with nicks
358 // QtUiStyle settings
359 QtUiStyleSettings settingsUiStyleColors("Colors");
360 const QString useNickGeneralColorsId = "UseNickGeneralColors";
361 if (!settingsUiStyleColors.valueExists(useNickGeneralColorsId)) {
362 // New default is true, preserve previous behavior by setting to false
363 settingsUiStyleColors.setValue(useNickGeneralColorsId, false);
366 // Update the settings stylesheet with old defaults
368 qtUiStyle.generateSettingsQss();
371 // Migration complete!
376 // New default changes: system locale used to generate a timestamp format string, deciding
377 // 24-hour or 12-hour timestamp.
381 const QString useCustomTimestampFormatId = "ChatView/__default__/UseCustomTimestampFormat";
382 if (!settings.valueExists(useCustomTimestampFormatId)) {
383 // New default value is false, preserve previous behavior by setting to true
384 settings.setValue(useCustomTimestampFormatId, true);
388 // Migration complete!
393 // New default changes: per-chat history and line wrapping enabled by default.
396 // InputWidget settings
397 UiSettings settingsInputWidget("InputWidget");
398 const QString enableInputPerChatId = "EnablePerChatHistory";
399 if (!settingsInputWidget.valueExists(enableInputPerChatId)) {
400 // New default value is true, preserve previous behavior by setting to false
401 settingsInputWidget.setValue(enableInputPerChatId, false);
404 const QString enableInputLinewrap = "EnableLineWrap";
405 if (!settingsInputWidget.valueExists(enableInputLinewrap)) {
406 // New default value is true, preserve previous behavior by setting to false
407 settingsInputWidget.setValue(enableInputLinewrap, false);
411 // Migration complete!
416 // New default changes: sender <nick> brackets disabled, sender colors and sender CTCP
421 const QString timestampFormatId = "ChatView/__default__/TimestampFormat";
422 if (!settings.valueExists(timestampFormatId)) {
423 // New default value is " hh:mm:ss", preserve old default of "[hh:mm:ss]"
424 settings.setValue(timestampFormatId, "[hh:mm:ss]");
427 const QString showSenderBracketsId = "ChatView/__default__/ShowSenderBrackets";
428 if (!settings.valueExists(showSenderBracketsId)) {
429 // New default is false, preserve previous behavior by setting to true
430 settings.setValue(showSenderBracketsId, true);
435 // QtUiStyle settings
436 QtUiStyleSettings settingsUiStyleColors("Colors");
437 const QString useSenderColorsId = "UseSenderColors";
438 if (!settingsUiStyleColors.valueExists(useSenderColorsId)) {
439 // New default is true, preserve previous behavior by setting to false
440 settingsUiStyleColors.setValue(useSenderColorsId, false);
443 const QString useSenderActionColorsId = "UseSenderActionColors";
444 if (!settingsUiStyleColors.valueExists(useSenderActionColorsId)) {
445 // New default is true, preserve previous behavior by setting to false
446 settingsUiStyleColors.setValue(useSenderActionColorsId, false);
449 // Update the settings stylesheet with old defaults
451 qtUiStyle.generateSettingsQss();
454 // Migration complete!
458 // Something unexpected happened
464 void QtUiApplication::commitData(QSessionManager &manager)
471 void QtUiApplication::saveState(QSessionManager &manager)
473 //qDebug() << QString("saving session state to id %1").arg(manager.sessionId());
474 // AccountId activeCore = Client::currentCoreAccount().accountId(); // FIXME store this!
475 SessionSettings s(manager.sessionId());
477 QtUi::mainWindow()->saveStateToSettings(s);
481 void QtUiApplication::resumeSessionIfPossible()
484 if (isSessionRestored()) {
485 qDebug() << QString("restoring from session %1").arg(sessionId());
486 SessionSettings s(sessionId());
489 QtUi::mainWindow()->restoreStateFromSettings(s);
493 SessionSettings s(QString("1"));