1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 // Settings upgrade/downgrade handling
107 if (!migrateSettings()) {
108 qCritical() << "Could not load or upgrade client settings, terminating!";
112 Client::init(new QtUi());
114 // Init UI only after the event loop has started
115 // TODO Qt5: Make this a lambda
116 QTimer::singleShot(0, this, SLOT(initUi()));
118 Quassel::registerQuitHandler([]() {
119 QtUi::mainWindow()->quit();
128 QtUiApplication::~QtUiApplication()
135 void QtUiApplication::initUi()
137 QtUi::instance()->init();
138 resumeSessionIfPossible();
142 bool QtUiApplication::migrateSettings()
145 // Check major settings version. This represents incompatible changes between settings
146 // versions. So far, we only have 1.
148 uint versionMajor = s.version();
149 if (versionMajor != 1) {
150 qCritical() << qPrintable(QString("Invalid client settings version '%1'")
156 // Check minor settings version, handling upgrades/downgrades as needed
157 // Current minor version
159 // NOTE: If you increase the minor version, you MUST ALSO add new version upgrade logic in
160 // applySettingsMigration()! Otherwise, settings upgrades will fail.
161 const uint VERSION_MINOR_CURRENT = 8;
162 // Stored minor version
163 uint versionMinor = s.versionMinor();
165 if (versionMinor == VERSION_MINOR_CURRENT) {
166 // At latest version, no need to migrate defaults or other settings
168 } else if (versionMinor == 0) {
169 // New configuration, store as current version
170 qDebug() << qPrintable(QString("Set up new client settings v%1.%2")
171 .arg(versionMajor).arg(VERSION_MINOR_CURRENT));
172 s.setVersionMinor(VERSION_MINOR_CURRENT);
174 // Update the settings stylesheet for first setup. We don't know if older content exists,
175 // if the configuration got erased separately, etc.
177 qtUiStyle.generateSettingsQss();
179 } else if (versionMinor < VERSION_MINOR_CURRENT) {
180 // We're upgrading - apply the neccessary upgrades from each interim version
181 // curVersion will never equal VERSION_MINOR_CURRENT, as it represents the version before
182 // the most recent applySettingsMigration() call.
183 for (uint curVersion = versionMinor; curVersion < VERSION_MINOR_CURRENT; curVersion++) {
184 if (!applySettingsMigration(s, curVersion + 1)) {
185 // Something went wrong, time to bail out
186 qCritical() << qPrintable(QString("Could not migrate client settings from v%1.%2 "
188 .arg(versionMajor).arg(curVersion).arg(curVersion + 1));
189 // Keep track of the last successful upgrade to avoid repeating it on next start
190 s.setVersionMinor(curVersion);
194 // Migration successful!
195 qDebug() << qPrintable(QString("Successfully migrated client settings from v%1.%2 to "
197 .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
198 // Store the new minor version
199 s.setVersionMinor(VERSION_MINOR_CURRENT);
202 // versionMinor > VERSION_MINOR_CURRENT
203 // The user downgraded to an older version of Quassel. Let's hope for the best.
204 // Don't change the minorVersion as the newer version's upgrade logic has already run.
205 qWarning() << qPrintable(QString("Client settings v%1.%2 is newer than latest known v%1.%3,"
206 " things might not work!")
207 .arg(versionMajor).arg(versionMinor).arg(VERSION_MINOR_CURRENT));
213 bool QtUiApplication::applySettingsMigration(QtUiSettings settings, const uint newVersion)
215 switch (newVersion) {
216 // Version 0 and 1 aren't valid upgrade paths - one represents no version, the other is the
217 // oldest version. Ignore those, start from 2 and higher.
218 // Each missed version will be called in sequence. E.g. to upgrade from '1' to '3', this
219 // function will be called with '2', then '3'.
220 // Use explicit scope via { ... } to avoid cross-initialization
222 // In most cases, the goal is to preserve the older default values for keys that haven't been
223 // saved. Exceptions will be noted below.
224 // NOTE: If you add new upgrade logic here, you MUST ALSO increase VERSION_MINOR_CURRENT in
225 // migrateSettings()! Otherwise, your upgrade logic won't ever be called.
228 // New default changes: RegEx checkbox now toggles Channel regular expressions, too
230 // This only affects local highlights. Core-side highlights weren't released in stable when
231 // this change was made, so no need to migrate those.
234 // NotificationSettings
235 NotificationSettings notificationSettings;
237 // Check each highlight rule for a "Channel" field. If one exists, convert to RegEx mode.
238 // This might be more efficient with std::transform() or such. It /is/ only run once...
239 auto highlightList = notificationSettings.highlightList();
240 bool changesMade = false;
241 for (int index = 0; index < highlightList.count(); ++index)
243 // Load the highlight rule...
244 auto highlightRule = highlightList[index].toMap();
246 // Check if "Channel" has anything set and RegEx is disabled
247 if (!highlightRule["Channel"].toString().isEmpty()
248 && highlightRule["RegEx"].toBool() == false) {
249 // We have a rule to convert
251 // Mark as a regular expression, allowing the Channel filtering to work the same as
252 // before the upgrade
253 highlightRule["RegEx"] = true;
255 // Convert the main rule to regular expression, mirroring the conversion to wildcard
256 // format from QtUiMessageProcessor::checkForHighlight()
257 highlightRule["Name"] =
258 "(^|\\W)" + QRegExp::escape(highlightRule["Name"].toString()) + "(\\W|$)";
260 // Save the rule back
261 highlightList[index] = highlightRule;
266 // Save the modified rules if any changes were made
268 notificationSettings.setHighlightList(highlightList);
272 // Migration complete!
276 // New default changes: UseProxy is no longer used in CoreAccountSettings
277 CoreAccountSettings s;
278 for (auto &&accountId : s.knownAccounts()) {
279 auto map = s.retrieveAccountData(accountId);
280 if (!map.value("UseProxy", false).toBool()) {
281 map["ProxyType"] = static_cast<int>(QNetworkProxy::ProxyType::NoProxy);
283 map.remove("UseProxy");
284 s.storeAccountData(accountId, map);
287 // Migration complete!
292 // New default changes: sender colors switched around to Tango-ish theme
295 // QtUiStyle settings
296 QtUiStyleSettings settingsUiStyleColors("Colors");
297 // Preserve the old default values for all variants
298 const QColor oldDefaultSenderColorSelf = QColor(0, 0, 0);
299 const QList<QColor> oldDefaultSenderColors = QList<QColor> {
300 QColor(204, 13, 127), /// Sender00
301 QColor(142, 85, 233), /// Sender01
302 QColor(179, 14, 14), /// Sender02
303 QColor( 23, 179, 57), /// Sender03
304 QColor( 88, 175, 179), /// Sender04
305 QColor(157, 84, 179), /// Sender05
306 QColor(179, 151, 117), /// Sender06
307 QColor( 49, 118, 179), /// Sender07
308 QColor(233, 13, 127), /// Sender08
309 QColor(142, 85, 233), /// Sender09
310 QColor(179, 14, 14), /// Sender10
311 QColor( 23, 179, 57), /// Sender11
312 QColor( 88, 175, 179), /// Sender12
313 QColor(157, 84, 179), /// Sender13
314 QColor(179, 151, 117), /// Sender14
315 QColor( 49, 118, 179), /// Sender15
317 if (!settingsUiStyleColors.valueExists("SenderSelf")) {
318 // Preserve the old default sender color if none set
319 settingsUiStyleColors.setValue("SenderSelf", oldDefaultSenderColorSelf);
321 QString senderColorId;
322 for (int i = 0; i < oldDefaultSenderColors.count(); i++) {
323 // Get the sender color ID for each available color
324 QString dez = QString::number(i);
325 if (dez.length() == 1) dez.prepend('0');
326 senderColorId = QString("Sender" + dez);
327 if (!settingsUiStyleColors.valueExists(senderColorId)) {
328 // Preserve the old default sender color if none set
329 settingsUiStyleColors.setValue(senderColorId, oldDefaultSenderColors[i]);
333 // Update the settings stylesheet with old defaults
335 qtUiStyle.generateSettingsQss();
338 // Migration complete!
343 // New default changes: sender colors apply to nearly all messages with nicks
346 // QtUiStyle settings
347 QtUiStyleSettings settingsUiStyleColors("Colors");
348 const QString useNickGeneralColorsId = "UseNickGeneralColors";
349 if (!settingsUiStyleColors.valueExists(useNickGeneralColorsId)) {
350 // New default is true, preserve previous behavior by setting to false
351 settingsUiStyleColors.setValue(useNickGeneralColorsId, false);
354 // Update the settings stylesheet with old defaults
356 qtUiStyle.generateSettingsQss();
359 // Migration complete!
364 // New default changes: system locale used to generate a timestamp format string, deciding
365 // 24-hour or 12-hour timestamp.
369 const QString useCustomTimestampFormatId = "ChatView/__default__/UseCustomTimestampFormat";
370 if (!settings.valueExists(useCustomTimestampFormatId)) {
371 // New default value is false, preserve previous behavior by setting to true
372 settings.setValue(useCustomTimestampFormatId, true);
376 // Migration complete!
381 // New default changes: per-chat history and line wrapping enabled by default.
384 // InputWidget settings
385 UiSettings settingsInputWidget("InputWidget");
386 const QString enableInputPerChatId = "EnablePerChatHistory";
387 if (!settingsInputWidget.valueExists(enableInputPerChatId)) {
388 // New default value is true, preserve previous behavior by setting to false
389 settingsInputWidget.setValue(enableInputPerChatId, false);
392 const QString enableInputLinewrap = "EnableLineWrap";
393 if (!settingsInputWidget.valueExists(enableInputLinewrap)) {
394 // New default value is true, preserve previous behavior by setting to false
395 settingsInputWidget.setValue(enableInputLinewrap, false);
399 // Migration complete!
404 // New default changes: sender <nick> brackets disabled, sender colors and sender CTCP
409 const QString timestampFormatId = "ChatView/__default__/TimestampFormat";
410 if (!settings.valueExists(timestampFormatId)) {
411 // New default value is " hh:mm:ss", preserve old default of "[hh:mm:ss]"
412 settings.setValue(timestampFormatId, "[hh:mm:ss]");
415 const QString showSenderBracketsId = "ChatView/__default__/ShowSenderBrackets";
416 if (!settings.valueExists(showSenderBracketsId)) {
417 // New default is false, preserve previous behavior by setting to true
418 settings.setValue(showSenderBracketsId, true);
423 // QtUiStyle settings
424 QtUiStyleSettings settingsUiStyleColors("Colors");
425 const QString useSenderColorsId = "UseSenderColors";
426 if (!settingsUiStyleColors.valueExists(useSenderColorsId)) {
427 // New default is true, preserve previous behavior by setting to false
428 settingsUiStyleColors.setValue(useSenderColorsId, false);
431 const QString useSenderActionColorsId = "UseSenderActionColors";
432 if (!settingsUiStyleColors.valueExists(useSenderActionColorsId)) {
433 // New default is true, preserve previous behavior by setting to false
434 settingsUiStyleColors.setValue(useSenderActionColorsId, false);
437 // Update the settings stylesheet with old defaults
439 qtUiStyle.generateSettingsQss();
442 // Migration complete!
446 // Something unexpected happened
452 void QtUiApplication::commitData(QSessionManager &manager)
459 void QtUiApplication::saveState(QSessionManager &manager)
461 //qDebug() << QString("saving session state to id %1").arg(manager.sessionId());
462 // AccountId activeCore = Client::currentCoreAccount().accountId(); // FIXME store this!
463 SessionSettings s(manager.sessionId());
465 QtUi::mainWindow()->saveStateToSettings(s);
469 void QtUiApplication::resumeSessionIfPossible()
472 if (isSessionRestored()) {
473 qDebug() << QString("restoring from session %1").arg(sessionId());
474 SessionSettings s(sessionId());
477 QtUi::mainWindow()->restoreStateFromSettings(s);
481 SessionSettings s(QString("1"));