configfile.cpp 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  1. /*
  2. * Copyright (C) by Klaas Freitag <freitag@owncloud.com>
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation; either version 2 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful, but
  10. * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11. * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  12. * for more details.
  13. */
  14. #include "config.h"
  15. #include "configfile.h"
  16. #include "theme.h"
  17. #include "version.h"
  18. #include "common/utility.h"
  19. #include "common/asserts.h"
  20. #include "version.h"
  21. #include "creds/abstractcredentials.h"
  22. #include "creds/keychainchunk.h"
  23. #include "csync_exclude.h"
  24. #ifndef TOKEN_AUTH_ONLY
  25. #include <QWidget>
  26. #include <QHeaderView>
  27. #endif
  28. #include <QCoreApplication>
  29. #include <QDir>
  30. #include <QFile>
  31. #include <QFileInfo>
  32. #include <QLoggingCategory>
  33. #include <QSettings>
  34. #include <QNetworkProxy>
  35. #include <QStandardPaths>
  36. #define QTLEGACY (QT_VERSION < QT_VERSION_CHECK(5,9,0))
  37. #if !(QTLEGACY)
  38. #include <QOperatingSystemVersion>
  39. #endif
  40. #define DEFAULT_REMOTE_POLL_INTERVAL 30000 // default remote poll time in milliseconds
  41. #define DEFAULT_MAX_LOG_LINES 20000
  42. namespace {
  43. static constexpr char showMainDialogAsNormalWindowC[] = "showMainDialogAsNormalWindow";
  44. static constexpr char showConfigBackupWarningC[] = "showConfigBackupWarning";
  45. static constexpr char remotePollIntervalC[] = "remotePollInterval";
  46. static constexpr char forceSyncIntervalC[] = "forceSyncInterval";
  47. static constexpr char fullLocalDiscoveryIntervalC[] = "fullLocalDiscoveryInterval";
  48. static constexpr char notificationRefreshIntervalC[] = "notificationRefreshInterval";
  49. static constexpr char monoIconsC[] = "monoIcons";
  50. static constexpr char promptDeleteC[] = "promptDeleteAllFiles";
  51. static constexpr char crashReporterC[] = "crashReporter";
  52. static constexpr char optionalServerNotificationsC[] = "optionalServerNotifications";
  53. static constexpr char showCallNotificationsC[] = "showCallNotifications";
  54. static constexpr char showInExplorerNavigationPaneC[] = "showInExplorerNavigationPane";
  55. static constexpr char skipUpdateCheckC[] = "skipUpdateCheck";
  56. static constexpr char autoUpdateCheckC[] = "autoUpdateCheck";
  57. static constexpr char updateCheckIntervalC[] = "updateCheckInterval";
  58. static constexpr char updateSegmentC[] = "updateSegment";
  59. static constexpr char updateChannelC[] = "updateChannel";
  60. static constexpr char overrideServerUrlC[] = "overrideServerUrl";
  61. static constexpr char overrideLocalDirC[] = "overrideLocalDir";
  62. static constexpr char isVfsEnabledC[] = "isVfsEnabled";
  63. static constexpr char geometryC[] = "geometry";
  64. static constexpr char timeoutC[] = "timeout";
  65. static constexpr char chunkSizeC[] = "chunkSize";
  66. static constexpr char minChunkSizeC[] = "minChunkSize";
  67. static constexpr char maxChunkSizeC[] = "maxChunkSize";
  68. static constexpr char targetChunkUploadDurationC[] = "targetChunkUploadDuration";
  69. static constexpr char automaticLogDirC[] = "logToTemporaryLogDir";
  70. static constexpr char logDirC[] = "logDir";
  71. static constexpr char logDebugC[] = "logDebug";
  72. static constexpr char logExpireC[] = "logExpire";
  73. static constexpr char logFlushC[] = "logFlush";
  74. static constexpr char showExperimentalOptionsC[] = "showExperimentalOptions";
  75. static constexpr char clientVersionC[] = "clientVersion";
  76. static constexpr char proxyHostC[] = "Proxy/host";
  77. static constexpr char proxyTypeC[] = "Proxy/type";
  78. static constexpr char proxyPortC[] = "Proxy/port";
  79. static constexpr char proxyUserC[] = "Proxy/user";
  80. static constexpr char proxyPassC[] = "Proxy/pass";
  81. static constexpr char proxyNeedsAuthC[] = "Proxy/needsAuth";
  82. static constexpr char useUploadLimitC[] = "BWLimit/useUploadLimit";
  83. static constexpr char useDownloadLimitC[] = "BWLimit/useDownloadLimit";
  84. static constexpr char uploadLimitC[] = "BWLimit/uploadLimit";
  85. static constexpr char downloadLimitC[] = "BWLimit/downloadLimit";
  86. static constexpr char newBigFolderSizeLimitC[] = "newBigFolderSizeLimit";
  87. static constexpr char useNewBigFolderSizeLimitC[] = "useNewBigFolderSizeLimit";
  88. static constexpr char confirmExternalStorageC[] = "confirmExternalStorage";
  89. static constexpr char moveToTrashC[] = "moveToTrash";
  90. static constexpr char certPath[] = "http_certificatePath";
  91. static constexpr char certPasswd[] = "http_certificatePasswd";
  92. static const QSet validUpdateChannels { QStringLiteral("stable"), QStringLiteral("beta") };
  93. }
  94. namespace OCC {
  95. namespace chrono = std::chrono;
  96. Q_LOGGING_CATEGORY(lcConfigFile, "nextcloud.sync.configfile", QtInfoMsg)
  97. QString ConfigFile::_confDir = {};
  98. QString ConfigFile::_discoveredLegacyConfigPath = {};
  99. static chrono::milliseconds millisecondsValue(const QSettings &setting, const char *key,
  100. chrono::milliseconds defaultValue)
  101. {
  102. return chrono::milliseconds(setting.value(QLatin1String(key), qlonglong(defaultValue.count())).toLongLong());
  103. }
  104. bool copy_dir_recursive(QString from_dir, QString to_dir)
  105. {
  106. QDir dir;
  107. dir.setPath(from_dir);
  108. from_dir += QDir::separator();
  109. to_dir += QDir::separator();
  110. foreach (QString copy_file, dir.entryList(QDir::Files)) {
  111. QString from = from_dir + copy_file;
  112. QString to = to_dir + copy_file;
  113. if (QFile::copy(from, to) == false) {
  114. return false;
  115. }
  116. }
  117. foreach (QString copy_dir, dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)) {
  118. QString from = from_dir + copy_dir;
  119. QString to = to_dir + copy_dir;
  120. if (dir.mkpath(to) == false) {
  121. return false;
  122. }
  123. if (copy_dir_recursive(from, to) == false) {
  124. return false;
  125. }
  126. }
  127. return true;
  128. }
  129. ConfigFile::ConfigFile()
  130. {
  131. // QDesktopServices uses the application name to create a config path
  132. qApp->setApplicationName(Theme::instance()->appNameGUI());
  133. QSettings::setDefaultFormat(QSettings::IniFormat);
  134. const QString config = configFile();
  135. QSettings settings(config, QSettings::IniFormat);
  136. settings.beginGroup(defaultConnection());
  137. }
  138. bool ConfigFile::setConfDir(const QString &value)
  139. {
  140. QString dirPath = value;
  141. if (dirPath.isEmpty())
  142. return false;
  143. QFileInfo fi(dirPath);
  144. if (!fi.exists()) {
  145. QDir().mkpath(dirPath);
  146. fi.setFile(dirPath);
  147. }
  148. if (fi.exists() && fi.isDir()) {
  149. dirPath = fi.absoluteFilePath();
  150. qCInfo(lcConfigFile) << "Using custom config dir " << dirPath;
  151. _confDir = dirPath;
  152. return true;
  153. }
  154. return false;
  155. }
  156. bool ConfigFile::optionalServerNotifications() const
  157. {
  158. QSettings settings(configFile(), QSettings::IniFormat);
  159. return settings.value(QLatin1String(optionalServerNotificationsC), true).toBool();
  160. }
  161. bool ConfigFile::showCallNotifications() const
  162. {
  163. const QSettings settings(configFile(), QSettings::IniFormat);
  164. return settings.value(QLatin1String(showCallNotificationsC), true).toBool() && optionalServerNotifications();
  165. }
  166. void ConfigFile::setShowCallNotifications(bool show)
  167. {
  168. QSettings settings(configFile(), QSettings::IniFormat);
  169. settings.setValue(QLatin1String(showCallNotificationsC), show);
  170. settings.sync();
  171. }
  172. bool ConfigFile::showInExplorerNavigationPane() const
  173. {
  174. const bool defaultValue =
  175. #ifdef Q_OS_WIN
  176. #if QTLEGACY
  177. (QSysInfo::windowsVersion() < QSysInfo::WV_WINDOWS10);
  178. #else
  179. QOperatingSystemVersion::current() >= QOperatingSystemVersion::Windows10;
  180. #endif
  181. #else
  182. false
  183. #endif
  184. ;
  185. QSettings settings(configFile(), QSettings::IniFormat);
  186. return settings.value(QLatin1String(showInExplorerNavigationPaneC), defaultValue).toBool();
  187. }
  188. void ConfigFile::setShowInExplorerNavigationPane(bool show)
  189. {
  190. QSettings settings(configFile(), QSettings::IniFormat);
  191. settings.setValue(QLatin1String(showInExplorerNavigationPaneC), show);
  192. settings.sync();
  193. }
  194. int ConfigFile::timeout() const
  195. {
  196. QSettings settings(configFile(), QSettings::IniFormat);
  197. return settings.value(QLatin1String(timeoutC), 300).toInt(); // default to 5 min
  198. }
  199. qint64 ConfigFile::chunkSize() const
  200. {
  201. QSettings settings(configFile(), QSettings::IniFormat);
  202. return settings.value(QLatin1String(chunkSizeC), 10 * 1000 * 1000).toLongLong(); // default to 10 MB
  203. }
  204. qint64 ConfigFile::maxChunkSize() const
  205. {
  206. QSettings settings(configFile(), QSettings::IniFormat);
  207. return settings.value(QLatin1String(maxChunkSizeC), 1000 * 1000 * 1000).toLongLong(); // default to 1000 MB
  208. }
  209. qint64 ConfigFile::minChunkSize() const
  210. {
  211. QSettings settings(configFile(), QSettings::IniFormat);
  212. return settings.value(QLatin1String(minChunkSizeC), 1000 * 1000).toLongLong(); // default to 1 MB
  213. }
  214. chrono::milliseconds ConfigFile::targetChunkUploadDuration() const
  215. {
  216. QSettings settings(configFile(), QSettings::IniFormat);
  217. return millisecondsValue(settings, targetChunkUploadDurationC, chrono::minutes(1));
  218. }
  219. void ConfigFile::setOptionalServerNotifications(bool show)
  220. {
  221. QSettings settings(configFile(), QSettings::IniFormat);
  222. settings.setValue(QLatin1String(optionalServerNotificationsC), show);
  223. settings.sync();
  224. }
  225. void ConfigFile::saveGeometry(QWidget *w)
  226. {
  227. #ifndef TOKEN_AUTH_ONLY
  228. ASSERT(!w->objectName().isNull());
  229. QSettings settings(configFile(), QSettings::IniFormat);
  230. settings.beginGroup(w->objectName());
  231. settings.setValue(QLatin1String(geometryC), w->saveGeometry());
  232. settings.sync();
  233. #endif
  234. }
  235. void ConfigFile::restoreGeometry(QWidget *w)
  236. {
  237. #ifndef TOKEN_AUTH_ONLY
  238. w->restoreGeometry(getValue(geometryC, w->objectName()).toByteArray());
  239. #endif
  240. }
  241. void ConfigFile::saveGeometryHeader(QHeaderView *header)
  242. {
  243. #ifndef TOKEN_AUTH_ONLY
  244. if (!header)
  245. return;
  246. ASSERT(!header->objectName().isEmpty());
  247. QSettings settings(configFile(), QSettings::IniFormat);
  248. settings.beginGroup(header->objectName());
  249. settings.setValue(QLatin1String(geometryC), header->saveState());
  250. settings.sync();
  251. #endif
  252. }
  253. void ConfigFile::restoreGeometryHeader(QHeaderView *header)
  254. {
  255. #ifndef TOKEN_AUTH_ONLY
  256. if (!header)
  257. return;
  258. ASSERT(!header->objectName().isNull());
  259. QSettings settings(configFile(), QSettings::IniFormat);
  260. settings.beginGroup(header->objectName());
  261. header->restoreState(settings.value(geometryC).toByteArray());
  262. #endif
  263. }
  264. QVariant ConfigFile::getPolicySetting(const QString &setting, const QVariant &defaultValue) const
  265. {
  266. if (Utility::isWindows()) {
  267. // check for policies first and return immediately if a value is found.
  268. QSettings userPolicy(QString::fromLatin1(R"(HKEY_CURRENT_USER\Software\Policies\%1\%2)")
  269. .arg(APPLICATION_VENDOR, Theme::instance()->appNameGUI()),
  270. QSettings::NativeFormat);
  271. if (userPolicy.contains(setting)) {
  272. return userPolicy.value(setting);
  273. }
  274. QSettings machinePolicy(QString::fromLatin1(R"(HKEY_LOCAL_MACHINE\Software\Policies\%1\%2)")
  275. .arg(APPLICATION_VENDOR, Theme::instance()->appNameGUI()),
  276. QSettings::NativeFormat);
  277. if (machinePolicy.contains(setting)) {
  278. return machinePolicy.value(setting);
  279. }
  280. }
  281. return defaultValue;
  282. }
  283. QString ConfigFile::configPath() const
  284. {
  285. if (_confDir.isEmpty()) {
  286. if (!Utility::isWindows()) {
  287. // On Unix, use the AppConfigLocation for the settings, that's configurable with the XDG_CONFIG_HOME env variable.
  288. _confDir = QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation);
  289. } else {
  290. // On Windows, use AppDataLocation, that's where the roaming data is and where we should store the config file
  291. auto newLocation = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
  292. // Check if this is the first time loading the new location
  293. if (!QFileInfo(newLocation).isDir()) {
  294. // Migrate data to the new locations
  295. auto oldLocation = QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation);
  296. // Only migrate if the old location exists.
  297. if (QFileInfo(oldLocation).isDir()) {
  298. QDir().mkpath(newLocation);
  299. copy_dir_recursive(oldLocation, newLocation);
  300. }
  301. }
  302. _confDir = newLocation;
  303. }
  304. }
  305. QString dir = _confDir;
  306. if (!dir.endsWith(QLatin1Char('/')))
  307. dir.append(QLatin1Char('/'));
  308. return dir;
  309. }
  310. static const QLatin1String exclFile("sync-exclude.lst");
  311. QString ConfigFile::excludeFile(Scope scope) const
  312. {
  313. // prefer sync-exclude.lst, but if it does not exist, check for
  314. // exclude.lst for compatibility reasons in the user writeable
  315. // directories.
  316. QFileInfo fi;
  317. switch (scope) {
  318. case UserScope:
  319. fi.setFile(configPath(), exclFile);
  320. if (!fi.isReadable()) {
  321. fi.setFile(configPath(), QLatin1String("exclude.lst"));
  322. }
  323. if (!fi.isReadable()) {
  324. fi.setFile(configPath(), exclFile);
  325. }
  326. return fi.absoluteFilePath();
  327. case SystemScope:
  328. return ConfigFile::excludeFileFromSystem();
  329. }
  330. ASSERT(false);
  331. return QString();
  332. }
  333. QString ConfigFile::excludeFileFromSystem()
  334. {
  335. QFileInfo fi;
  336. #ifdef Q_OS_WIN
  337. fi.setFile(QCoreApplication::applicationDirPath(), exclFile);
  338. #endif
  339. #ifdef Q_OS_UNIX
  340. fi.setFile(QString(SYSCONFDIR "/" + Theme::instance()->appName()), exclFile);
  341. if (!fi.exists()) {
  342. // Prefer to return the preferred path! Only use the fallback location
  343. // if the other path does not exist and the fallback is valid.
  344. QFileInfo nextToBinary(QCoreApplication::applicationDirPath(), exclFile);
  345. if (nextToBinary.exists()) {
  346. fi = nextToBinary;
  347. } else {
  348. // For AppImage, the file might reside under a temporary mount path
  349. QDir d(QCoreApplication::applicationDirPath()); // supposed to be /tmp/mount.xyz/usr/bin
  350. d.cdUp(); // go out of bin
  351. d.cdUp(); // go out of usr
  352. if (!d.isRoot()) { // it is really a mountpoint
  353. if (d.cd("etc") && d.cd(Theme::instance()->appName())) {
  354. QFileInfo inMountDir(d, exclFile);
  355. if (inMountDir.exists()) {
  356. fi = inMountDir;
  357. }
  358. };
  359. }
  360. }
  361. }
  362. #endif
  363. #ifdef Q_OS_MAC
  364. // exec path is inside the bundle
  365. fi.setFile(QCoreApplication::applicationDirPath(),
  366. QLatin1String("../Resources/") + exclFile);
  367. #endif
  368. return fi.absoluteFilePath();
  369. }
  370. QString ConfigFile::backup(const QString &fileName) const
  371. {
  372. const QString baseFilePath = configPath() + fileName;
  373. auto versionString = clientVersionString();
  374. if (!versionString.isEmpty()) {
  375. versionString.prepend('_');
  376. }
  377. QString backupFile =
  378. QString("%1.backup_%2%3")
  379. .arg(baseFilePath)
  380. .arg(QDateTime::currentDateTime().toString("yyyyMMdd_HHmmss"))
  381. .arg(versionString);
  382. // If this exact file already exists it's most likely that a backup was
  383. // already done. (two backup calls directly after each other, potentially
  384. // even with source alterations in between!)
  385. // QFile does not overwrite backupFile
  386. if(!QFile::copy(baseFilePath, backupFile)) {
  387. qCWarning(lcConfigFile) << "Failed to create a backup of the config file" << baseFilePath;
  388. }
  389. return backupFile;
  390. }
  391. bool ConfigFile::showConfigBackupWarning() const
  392. {
  393. return getValue(showConfigBackupWarningC, QString(), false).toBool();
  394. }
  395. QString ConfigFile::configFile() const
  396. {
  397. return configPath() + Theme::instance()->configFileName();
  398. }
  399. bool ConfigFile::exists()
  400. {
  401. QFile file(configFile());
  402. return file.exists();
  403. }
  404. QString ConfigFile::defaultConnection() const
  405. {
  406. return Theme::instance()->appName();
  407. }
  408. void ConfigFile::storeData(const QString &group, const QString &key, const QVariant &value)
  409. {
  410. const QString con(group.isEmpty() ? defaultConnection() : group);
  411. QSettings settings(configFile(), QSettings::IniFormat);
  412. settings.beginGroup(con);
  413. settings.setValue(key, value);
  414. settings.sync();
  415. }
  416. QVariant ConfigFile::retrieveData(const QString &group, const QString &key) const
  417. {
  418. const QString con(group.isEmpty() ? defaultConnection() : group);
  419. QSettings settings(configFile(), QSettings::IniFormat);
  420. settings.beginGroup(con);
  421. return settings.value(key);
  422. }
  423. void ConfigFile::removeData(const QString &group, const QString &key)
  424. {
  425. const QString con(group.isEmpty() ? defaultConnection() : group);
  426. QSettings settings(configFile(), QSettings::IniFormat);
  427. settings.beginGroup(con);
  428. settings.remove(key);
  429. }
  430. bool ConfigFile::dataExists(const QString &group, const QString &key) const
  431. {
  432. const QString con(group.isEmpty() ? defaultConnection() : group);
  433. QSettings settings(configFile(), QSettings::IniFormat);
  434. settings.beginGroup(con);
  435. return settings.contains(key);
  436. }
  437. chrono::milliseconds ConfigFile::remotePollInterval(const QString &connection) const
  438. {
  439. QString con(connection);
  440. if (connection.isEmpty())
  441. con = defaultConnection();
  442. QSettings settings(configFile(), QSettings::IniFormat);
  443. settings.beginGroup(con);
  444. auto defaultPollInterval = chrono::milliseconds(DEFAULT_REMOTE_POLL_INTERVAL);
  445. auto remoteInterval = millisecondsValue(settings, remotePollIntervalC, defaultPollInterval);
  446. if (remoteInterval < chrono::seconds(5)) {
  447. qCWarning(lcConfigFile) << "Remote Interval is less than 5 seconds, reverting to" << DEFAULT_REMOTE_POLL_INTERVAL;
  448. remoteInterval = defaultPollInterval;
  449. }
  450. return remoteInterval;
  451. }
  452. void ConfigFile::setRemotePollInterval(chrono::milliseconds interval, const QString &connection)
  453. {
  454. QString con(connection);
  455. if (connection.isEmpty())
  456. con = defaultConnection();
  457. if (interval < chrono::seconds(5)) {
  458. qCWarning(lcConfigFile) << "Remote Poll interval of " << interval.count() << " is below five seconds.";
  459. return;
  460. }
  461. QSettings settings(configFile(), QSettings::IniFormat);
  462. settings.beginGroup(con);
  463. settings.setValue(QLatin1String(remotePollIntervalC), qlonglong(interval.count()));
  464. settings.sync();
  465. }
  466. chrono::milliseconds ConfigFile::forceSyncInterval(const QString &connection) const
  467. {
  468. auto pollInterval = remotePollInterval(connection);
  469. QString con(connection);
  470. if (connection.isEmpty())
  471. con = defaultConnection();
  472. QSettings settings(configFile(), QSettings::IniFormat);
  473. settings.beginGroup(con);
  474. auto defaultInterval = chrono::hours(2);
  475. auto interval = millisecondsValue(settings, forceSyncIntervalC, defaultInterval);
  476. if (interval < pollInterval) {
  477. qCWarning(lcConfigFile) << "Force sync interval is less than the remote poll inteval, reverting to" << pollInterval.count();
  478. interval = pollInterval;
  479. }
  480. return interval;
  481. }
  482. chrono::milliseconds OCC::ConfigFile::fullLocalDiscoveryInterval() const
  483. {
  484. QSettings settings(configFile(), QSettings::IniFormat);
  485. settings.beginGroup(defaultConnection());
  486. return millisecondsValue(settings, fullLocalDiscoveryIntervalC, chrono::hours(1));
  487. }
  488. chrono::milliseconds ConfigFile::notificationRefreshInterval(const QString &connection) const
  489. {
  490. QString con(connection);
  491. if (connection.isEmpty())
  492. con = defaultConnection();
  493. QSettings settings(configFile(), QSettings::IniFormat);
  494. settings.beginGroup(con);
  495. const auto defaultInterval = chrono::minutes(1);
  496. auto interval = millisecondsValue(settings, notificationRefreshIntervalC, defaultInterval);
  497. if (interval < chrono::minutes(1)) {
  498. qCWarning(lcConfigFile) << "Notification refresh interval smaller than one minute, setting to one minute";
  499. interval = chrono::minutes(1);
  500. }
  501. return interval;
  502. }
  503. chrono::milliseconds ConfigFile::updateCheckInterval(const QString &connection) const
  504. {
  505. QString con(connection);
  506. if (connection.isEmpty())
  507. con = defaultConnection();
  508. QSettings settings(configFile(), QSettings::IniFormat);
  509. settings.beginGroup(con);
  510. auto defaultInterval = chrono::hours(10);
  511. auto interval = millisecondsValue(settings, updateCheckIntervalC, defaultInterval);
  512. auto minInterval = chrono::minutes(5);
  513. if (interval < minInterval) {
  514. qCWarning(lcConfigFile) << "Update check interval less than five minutes, resetting to 5 minutes";
  515. interval = minInterval;
  516. }
  517. return interval;
  518. }
  519. bool ConfigFile::skipUpdateCheck(const QString &connection) const
  520. {
  521. QString con(connection);
  522. if (connection.isEmpty())
  523. con = defaultConnection();
  524. QVariant fallback = getValue(QLatin1String(skipUpdateCheckC), con, false);
  525. fallback = getValue(QLatin1String(skipUpdateCheckC), QString(), fallback);
  526. QVariant value = getPolicySetting(QLatin1String(skipUpdateCheckC), fallback);
  527. return value.toBool();
  528. }
  529. void ConfigFile::setSkipUpdateCheck(bool skip, const QString &connection)
  530. {
  531. QString con(connection);
  532. if (connection.isEmpty())
  533. con = defaultConnection();
  534. QSettings settings(configFile(), QSettings::IniFormat);
  535. settings.beginGroup(con);
  536. settings.setValue(QLatin1String(skipUpdateCheckC), QVariant(skip));
  537. settings.sync();
  538. }
  539. bool ConfigFile::autoUpdateCheck(const QString &connection) const
  540. {
  541. QString con(connection);
  542. if (connection.isEmpty())
  543. con = defaultConnection();
  544. QVariant fallback = getValue(QLatin1String(autoUpdateCheckC), con, true);
  545. fallback = getValue(QLatin1String(autoUpdateCheckC), QString(), fallback);
  546. QVariant value = getPolicySetting(QLatin1String(autoUpdateCheckC), fallback);
  547. return value.toBool();
  548. }
  549. void ConfigFile::setAutoUpdateCheck(bool autoCheck, const QString &connection)
  550. {
  551. QString con(connection);
  552. if (connection.isEmpty())
  553. con = defaultConnection();
  554. QSettings settings(configFile(), QSettings::IniFormat);
  555. settings.beginGroup(con);
  556. settings.setValue(QLatin1String(autoUpdateCheckC), QVariant(autoCheck));
  557. settings.sync();
  558. }
  559. int ConfigFile::updateSegment() const
  560. {
  561. QSettings settings(configFile(), QSettings::IniFormat);
  562. int segment = settings.value(QLatin1String(updateSegmentC), -1).toInt();
  563. // Invalid? (Unset at the very first launch)
  564. if(segment < 0 || segment > 99) {
  565. // Save valid segment value, normally has to be done only once.
  566. segment = Utility::rand() % 99;
  567. settings.setValue(QLatin1String(updateSegmentC), segment);
  568. }
  569. return segment;
  570. }
  571. QString ConfigFile::updateChannel() const
  572. {
  573. QString defaultUpdateChannel = QStringLiteral("stable");
  574. QString suffix = QString::fromLatin1(MIRALL_STRINGIFY(MIRALL_VERSION_SUFFIX));
  575. if (suffix.startsWith("daily")
  576. || suffix.startsWith("nightly")
  577. || suffix.startsWith("alpha")
  578. || suffix.startsWith("rc")
  579. || suffix.startsWith("beta")) {
  580. defaultUpdateChannel = QStringLiteral("beta");
  581. }
  582. QSettings settings(configFile(), QSettings::IniFormat);
  583. const auto channel = settings.value(QLatin1String(updateChannelC), defaultUpdateChannel).toString();
  584. if (!validUpdateChannels.contains(channel)) {
  585. qCWarning(lcConfigFile()) << "Received invalid update channel from confog:"
  586. << channel
  587. << "defaulting to:"
  588. << defaultUpdateChannel;
  589. return defaultUpdateChannel;
  590. }
  591. return channel;
  592. }
  593. void ConfigFile::setUpdateChannel(const QString &channel)
  594. {
  595. if (!validUpdateChannels.contains(channel)) {
  596. qCWarning(lcConfigFile()) << "Received invalid update channel:"
  597. << channel
  598. << "can only accept 'stable' or 'beta'. Ignoring.";
  599. return;
  600. }
  601. QSettings settings(configFile(), QSettings::IniFormat);
  602. settings.setValue(QLatin1String(updateChannelC), channel);
  603. }
  604. [[nodiscard]] QString ConfigFile::overrideServerUrl() const
  605. {
  606. QSettings settings(configFile(), QSettings::IniFormat);
  607. return settings.value(QLatin1String(overrideServerUrlC), {}).toString();
  608. }
  609. void ConfigFile::setOverrideServerUrl(const QString &url)
  610. {
  611. QSettings settings(configFile(), QSettings::IniFormat);
  612. settings.setValue(QLatin1String(overrideServerUrlC), url);
  613. }
  614. [[nodiscard]] QString ConfigFile::overrideLocalDir() const
  615. {
  616. QSettings settings(configFile(), QSettings::IniFormat);
  617. return settings.value(QLatin1String(overrideLocalDirC), {}).toString();
  618. }
  619. void ConfigFile::setOverrideLocalDir(const QString &localDir)
  620. {
  621. QSettings settings(configFile(), QSettings::IniFormat);
  622. settings.setValue(QLatin1String(overrideLocalDirC), localDir);
  623. }
  624. bool ConfigFile::isVfsEnabled() const
  625. {
  626. QSettings settings(configFile(), QSettings::IniFormat);
  627. return settings.value({isVfsEnabledC}, {}).toBool();
  628. }
  629. void ConfigFile::setVfsEnabled(bool enabled)
  630. {
  631. QSettings settings(configFile(), QSettings::IniFormat);
  632. settings.setValue({isVfsEnabledC}, enabled);
  633. }
  634. void ConfigFile::setProxyType(int proxyType,
  635. const QString &host,
  636. int port, bool needsAuth,
  637. const QString &user,
  638. const QString &pass)
  639. {
  640. QSettings settings(configFile(), QSettings::IniFormat);
  641. settings.setValue(QLatin1String(proxyTypeC), proxyType);
  642. if (proxyType == QNetworkProxy::HttpProxy || proxyType == QNetworkProxy::Socks5Proxy) {
  643. settings.setValue(QLatin1String(proxyHostC), host);
  644. settings.setValue(QLatin1String(proxyPortC), port);
  645. settings.setValue(QLatin1String(proxyNeedsAuthC), needsAuth);
  646. settings.setValue(QLatin1String(proxyUserC), user);
  647. if (pass.isEmpty()) {
  648. // Security: Don't keep password in config file
  649. settings.remove(QLatin1String(proxyPassC));
  650. // Delete password from keychain
  651. auto job = new KeychainChunk::DeleteJob(keychainProxyPasswordKey());
  652. job->exec();
  653. } else {
  654. // Write password to keychain
  655. auto job = new KeychainChunk::WriteJob(keychainProxyPasswordKey(), pass.toUtf8());
  656. if (job->exec()) {
  657. // Security: Don't keep password in config file
  658. settings.remove(QLatin1String(proxyPassC));
  659. }
  660. }
  661. }
  662. settings.sync();
  663. }
  664. QVariant ConfigFile::getValue(const QString &param, const QString &group,
  665. const QVariant &defaultValue) const
  666. {
  667. QVariant systemSetting;
  668. if (Utility::isMac()) {
  669. QSettings systemSettings(QLatin1String("/Library/Preferences/" APPLICATION_REV_DOMAIN ".plist"), QSettings::NativeFormat);
  670. if (!group.isEmpty()) {
  671. systemSettings.beginGroup(group);
  672. }
  673. systemSetting = systemSettings.value(param, defaultValue);
  674. } else if (Utility::isUnix()) {
  675. QSettings systemSettings(QString(SYSCONFDIR "/%1/%1.conf").arg(Theme::instance()->appName()), QSettings::NativeFormat);
  676. if (!group.isEmpty()) {
  677. systemSettings.beginGroup(group);
  678. }
  679. systemSetting = systemSettings.value(param, defaultValue);
  680. } else { // Windows
  681. QSettings systemSettings(QString::fromLatin1(R"(HKEY_LOCAL_MACHINE\Software\%1\%2)")
  682. .arg(APPLICATION_VENDOR, Theme::instance()->appNameGUI()),
  683. QSettings::NativeFormat);
  684. if (!group.isEmpty()) {
  685. systemSettings.beginGroup(group);
  686. }
  687. systemSetting = systemSettings.value(param, defaultValue);
  688. }
  689. QSettings settings(configFile(), QSettings::IniFormat);
  690. if (!group.isEmpty())
  691. settings.beginGroup(group);
  692. return settings.value(param, systemSetting);
  693. }
  694. void ConfigFile::setValue(const QString &key, const QVariant &value)
  695. {
  696. QSettings settings(configFile(), QSettings::IniFormat);
  697. settings.setValue(key, value);
  698. }
  699. int ConfigFile::proxyType() const
  700. {
  701. if (Theme::instance()->forceSystemNetworkProxy()) {
  702. return QNetworkProxy::DefaultProxy;
  703. }
  704. return getValue(QLatin1String(proxyTypeC)).toInt();
  705. }
  706. QString ConfigFile::proxyHostName() const
  707. {
  708. return getValue(QLatin1String(proxyHostC)).toString();
  709. }
  710. int ConfigFile::proxyPort() const
  711. {
  712. return getValue(QLatin1String(proxyPortC)).toInt();
  713. }
  714. bool ConfigFile::proxyNeedsAuth() const
  715. {
  716. return getValue(QLatin1String(proxyNeedsAuthC)).toBool();
  717. }
  718. QString ConfigFile::proxyUser() const
  719. {
  720. return getValue(QLatin1String(proxyUserC)).toString();
  721. }
  722. QString ConfigFile::proxyPassword() const
  723. {
  724. QByteArray passEncoded = getValue(proxyPassC).toByteArray();
  725. auto pass = QString::fromUtf8(QByteArray::fromBase64(passEncoded));
  726. passEncoded.clear();
  727. const auto key = keychainProxyPasswordKey();
  728. if (!pass.isEmpty()) {
  729. // Security: Migrate password from config file to keychain
  730. auto job = new KeychainChunk::WriteJob(key, pass.toUtf8());
  731. if (job->exec()) {
  732. QSettings settings(configFile(), QSettings::IniFormat);
  733. settings.remove(QLatin1String(proxyPassC));
  734. qCInfo(lcConfigFile()) << "Migrated proxy password to keychain";
  735. }
  736. } else {
  737. // Read password from keychain
  738. auto job = new KeychainChunk::ReadJob(key);
  739. if (job->exec()) {
  740. pass = job->textData();
  741. }
  742. }
  743. return pass;
  744. }
  745. QString ConfigFile::keychainProxyPasswordKey() const
  746. {
  747. return QString::fromLatin1("proxy-password");
  748. }
  749. int ConfigFile::useUploadLimit() const
  750. {
  751. return getValue(useUploadLimitC, QString(), 0).toInt();
  752. }
  753. int ConfigFile::useDownloadLimit() const
  754. {
  755. return getValue(useDownloadLimitC, QString(), 0).toInt();
  756. }
  757. void ConfigFile::setUseUploadLimit(int val)
  758. {
  759. setValue(useUploadLimitC, val);
  760. }
  761. void ConfigFile::setUseDownloadLimit(int val)
  762. {
  763. setValue(useDownloadLimitC, val);
  764. }
  765. int ConfigFile::uploadLimit() const
  766. {
  767. return getValue(uploadLimitC, QString(), 10).toInt();
  768. }
  769. int ConfigFile::downloadLimit() const
  770. {
  771. return getValue(downloadLimitC, QString(), 80).toInt();
  772. }
  773. void ConfigFile::setUploadLimit(int kbytes)
  774. {
  775. setValue(uploadLimitC, kbytes);
  776. }
  777. void ConfigFile::setDownloadLimit(int kbytes)
  778. {
  779. setValue(downloadLimitC, kbytes);
  780. }
  781. QPair<bool, qint64> ConfigFile::newBigFolderSizeLimit() const
  782. {
  783. auto defaultValue = Theme::instance()->newBigFolderSizeLimit();
  784. const auto fallback = getValue(newBigFolderSizeLimitC, QString(), defaultValue).toLongLong();
  785. const auto value = getPolicySetting(QLatin1String(newBigFolderSizeLimitC), fallback).toLongLong();
  786. const bool use = value >= 0 && useNewBigFolderSizeLimit();
  787. return qMakePair(use, qMax<qint64>(0, value));
  788. }
  789. void ConfigFile::setNewBigFolderSizeLimit(bool isChecked, qint64 mbytes)
  790. {
  791. setValue(newBigFolderSizeLimitC, mbytes);
  792. setValue(useNewBigFolderSizeLimitC, isChecked);
  793. }
  794. bool ConfigFile::confirmExternalStorage() const
  795. {
  796. const auto fallback = getValue(confirmExternalStorageC, QString(), true);
  797. return getPolicySetting(QLatin1String(confirmExternalStorageC), fallback).toBool();
  798. }
  799. bool ConfigFile::useNewBigFolderSizeLimit() const
  800. {
  801. const auto fallback = getValue(useNewBigFolderSizeLimitC, QString(), true);
  802. return getPolicySetting(QLatin1String(useNewBigFolderSizeLimitC), fallback).toBool();
  803. }
  804. void ConfigFile::setConfirmExternalStorage(bool isChecked)
  805. {
  806. setValue(confirmExternalStorageC, isChecked);
  807. }
  808. bool ConfigFile::moveToTrash() const
  809. {
  810. return getValue(moveToTrashC, QString(), false).toBool();
  811. }
  812. void ConfigFile::setMoveToTrash(bool isChecked)
  813. {
  814. setValue(moveToTrashC, isChecked);
  815. }
  816. bool ConfigFile::showMainDialogAsNormalWindow() const {
  817. return getValue(showMainDialogAsNormalWindowC, {}, false).toBool();
  818. }
  819. bool ConfigFile::promptDeleteFiles() const
  820. {
  821. QSettings settings(configFile(), QSettings::IniFormat);
  822. return settings.value(QLatin1String(promptDeleteC), false).toBool();
  823. }
  824. void ConfigFile::setPromptDeleteFiles(bool promptDeleteFiles)
  825. {
  826. QSettings settings(configFile(), QSettings::IniFormat);
  827. settings.setValue(QLatin1String(promptDeleteC), promptDeleteFiles);
  828. }
  829. bool ConfigFile::monoIcons() const
  830. {
  831. QSettings settings(configFile(), QSettings::IniFormat);
  832. bool monoDefault = false; // On Mac we want bw by default
  833. #ifdef Q_OS_MAC
  834. // OEM themes are not obliged to ship mono icons
  835. monoDefault = QByteArrayLiteral("Nextcloud") == QByteArrayLiteral(APPLICATION_NAME);
  836. #endif
  837. return settings.value(QLatin1String(monoIconsC), monoDefault).toBool();
  838. }
  839. void ConfigFile::setMonoIcons(bool useMonoIcons)
  840. {
  841. QSettings settings(configFile(), QSettings::IniFormat);
  842. settings.setValue(QLatin1String(monoIconsC), useMonoIcons);
  843. }
  844. bool ConfigFile::crashReporter() const
  845. {
  846. QSettings settings(configFile(), QSettings::IniFormat);
  847. const auto fallback = settings.value(QLatin1String(crashReporterC), true);
  848. return getPolicySetting(QLatin1String(crashReporterC), fallback).toBool();
  849. }
  850. void ConfigFile::setCrashReporter(bool enabled)
  851. {
  852. QSettings settings(configFile(), QSettings::IniFormat);
  853. settings.setValue(QLatin1String(crashReporterC), enabled);
  854. }
  855. bool ConfigFile::automaticLogDir() const
  856. {
  857. QSettings settings(configFile(), QSettings::IniFormat);
  858. return settings.value(QLatin1String(automaticLogDirC), false).toBool();
  859. }
  860. void ConfigFile::setAutomaticLogDir(bool enabled)
  861. {
  862. QSettings settings(configFile(), QSettings::IniFormat);
  863. settings.setValue(QLatin1String(automaticLogDirC), enabled);
  864. }
  865. QString ConfigFile::logDir() const
  866. {
  867. const auto defaultLogDir = QString(configPath() + QStringLiteral("/logs"));
  868. QSettings settings(configFile(), QSettings::IniFormat);
  869. return settings.value(QLatin1String(logDirC), defaultLogDir).toString();
  870. }
  871. void ConfigFile::setLogDir(const QString &dir)
  872. {
  873. QSettings settings(configFile(), QSettings::IniFormat);
  874. settings.setValue(QLatin1String(logDirC), dir);
  875. }
  876. bool ConfigFile::logDebug() const
  877. {
  878. QSettings settings(configFile(), QSettings::IniFormat);
  879. return settings.value(QLatin1String(logDebugC), true).toBool();
  880. }
  881. void ConfigFile::setLogDebug(bool enabled)
  882. {
  883. QSettings settings(configFile(), QSettings::IniFormat);
  884. settings.setValue(QLatin1String(logDebugC), enabled);
  885. }
  886. int ConfigFile::logExpire() const
  887. {
  888. QSettings settings(configFile(), QSettings::IniFormat);
  889. return settings.value(QLatin1String(logExpireC), 24).toInt();
  890. }
  891. void ConfigFile::setLogExpire(int hours)
  892. {
  893. QSettings settings(configFile(), QSettings::IniFormat);
  894. settings.setValue(QLatin1String(logExpireC), hours);
  895. }
  896. bool ConfigFile::logFlush() const
  897. {
  898. QSettings settings(configFile(), QSettings::IniFormat);
  899. return settings.value(QLatin1String(logFlushC), false).toBool();
  900. }
  901. void ConfigFile::setLogFlush(bool enabled)
  902. {
  903. QSettings settings(configFile(), QSettings::IniFormat);
  904. settings.setValue(QLatin1String(logFlushC), enabled);
  905. }
  906. bool ConfigFile::showExperimentalOptions() const
  907. {
  908. QSettings settings(configFile(), QSettings::IniFormat);
  909. return settings.value(QLatin1String(showExperimentalOptionsC), false).toBool();
  910. }
  911. QString ConfigFile::certificatePath() const
  912. {
  913. return retrieveData(QString(), QLatin1String(certPath)).toString();
  914. }
  915. void ConfigFile::setCertificatePath(const QString &cPath)
  916. {
  917. QSettings settings(configFile(), QSettings::IniFormat);
  918. settings.setValue(QLatin1String(certPath), cPath);
  919. settings.sync();
  920. }
  921. QString ConfigFile::certificatePasswd() const
  922. {
  923. return retrieveData(QString(), QLatin1String(certPasswd)).toString();
  924. }
  925. void ConfigFile::setCertificatePasswd(const QString &cPasswd)
  926. {
  927. QSettings settings(configFile(), QSettings::IniFormat);
  928. settings.setValue(QLatin1String(certPasswd), cPasswd);
  929. settings.sync();
  930. }
  931. QString ConfigFile::clientVersionString() const
  932. {
  933. QSettings settings(configFile(), QSettings::IniFormat);
  934. return settings.value(QLatin1String(clientVersionC), QString()).toString();
  935. }
  936. void ConfigFile::setClientVersionString(const QString &version)
  937. {
  938. QSettings settings(configFile(), QSettings::IniFormat);
  939. settings.setValue(QLatin1String(clientVersionC), version);
  940. }
  941. Q_GLOBAL_STATIC(QString, g_configFileName)
  942. std::unique_ptr<QSettings> ConfigFile::settingsWithGroup(const QString &group, QObject *parent)
  943. {
  944. if (g_configFileName()->isEmpty()) {
  945. // cache file name
  946. ConfigFile cfg;
  947. *g_configFileName() = cfg.configFile();
  948. }
  949. std::unique_ptr<QSettings> settings(new QSettings(*g_configFileName(), QSettings::IniFormat, parent));
  950. settings->beginGroup(group);
  951. return settings;
  952. }
  953. void ConfigFile::setupDefaultExcludeFilePaths(ExcludedFiles &excludedFiles)
  954. {
  955. ConfigFile cfg;
  956. QString systemList = cfg.excludeFile(ConfigFile::SystemScope);
  957. QString userList = cfg.excludeFile(ConfigFile::UserScope);
  958. if (!QFile::exists(userList)) {
  959. qCInfo(lcConfigFile) << "User defined ignore list does not exist:" << userList;
  960. if (!QFile::copy(systemList, userList)) {
  961. qCInfo(lcConfigFile) << "Could not copy over default list to:" << userList;
  962. }
  963. }
  964. if (!QFile::exists(userList)) {
  965. qCInfo(lcConfigFile) << "Adding system ignore list to csync:" << systemList;
  966. excludedFiles.addExcludeFilePath(systemList);
  967. } else {
  968. qCInfo(lcConfigFile) << "Adding user defined ignore list to csync:" << userList;
  969. excludedFiles.addExcludeFilePath(userList);
  970. }
  971. }
  972. QString ConfigFile::discoveredLegacyConfigPath()
  973. {
  974. return _discoveredLegacyConfigPath;
  975. }
  976. void ConfigFile::setDiscoveredLegacyConfigPath(const QString &discoveredLegacyConfigPath)
  977. {
  978. if (_discoveredLegacyConfigPath == discoveredLegacyConfigPath) {
  979. return;
  980. }
  981. _discoveredLegacyConfigPath = discoveredLegacyConfigPath;
  982. }
  983. }