1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
|
#include "./syncthingconnection.h"
#include "./syncthingconfig.h"
#include "./syncthingconnectionsettings.h"
#include "./utils.h"
#if defined(LIB_SYNCTHING_CONNECTOR_CONNECTION_MOCKED) || defined(LIB_SYNCTHING_CONNECTOR_MOCKED)
#include "./syncthingconnectionmockhelpers.h"
#endif
#include "resources/config.h"
#include <c++utilities/conversion/stringconversion.h>
#include <c++utilities/io/ansiescapecodes.h>
#include <QAuthenticator>
#include <QDir>
#include <QFileInfo>
#include <QHostAddress>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonValue>
#include <QNetworkAccessManager>
#include <QNetworkInterface>
#include <QNetworkReply>
#include <QStringBuilder>
#include <QTimer>
#if (QT_VERSION >= QT_VERSION_CHECK(6, 4, 0))
#include <QNetworkInformation>
#define SYNCTHINGCONNECTION_SUPPORT_METERED
#endif
#include <iostream>
#include <utility>
using namespace std;
using namespace CppUtilities;
using namespace CppUtilities::EscapeCodes;
namespace Data {
#ifndef LIB_SYNCTHING_CONNECTOR_MOCKED
/*!
* \brief Returns the QNetworkAccessManager instance used by SyncthingConnection instances.
*/
QNetworkAccessManager &networkAccessManager()
{
static auto networkAccessManager = new QNetworkAccessManager;
return *networkAccessManager;
}
#endif
/*!
* \class SyncthingConnection
* \brief The SyncthingConnection class allows Qt applications to access Syncthing via its REST API.
* \remarks All requests are performed asynchronously.
*
* The first thing to do when working with that class is setting the URL to connect to and the API key
* via the constructor or setSyncthingUrl() and setApiKey(). Credentials for the HTTP authentication
* can be set via setCredentials() if not included in the URL.
*
* Requests can then be done via the request...() methods, eg. requestConfig(). This would emit the
* newConfig() signal on success and the error() signal when an error occurred. The other request...()
* methods work in a similar way.
*
* However, usually it is best to simply call the connect() method. It will do all required requests
* to populate dirInfo(), devInfo(), myId(), totalIncomingTraffic(), totalOutgoingTraffic() and all
* the other variables. It will also use Syncthing's event API to listen for changes. The signals
* newDirs() and newDevs() are can be used to know when dirInfo() and devInfo() become available.
* Note that in this case the previous dirInfo()/devInfo() is invalidated.
*/
/*!
* \brief Constructs a new instance ready to connect. To establish the connection, call connect().
*/
SyncthingConnection::SyncthingConnection(
const QString &syncthingUrl, const QByteArray &apiKey, SyncthingConnectionLoggingFlags loggingFlags, QObject *parent)
: QObject(parent)
, m_syncthingUrl(syncthingUrl)
, m_apiKey(apiKey)
, m_status(SyncthingStatus::Disconnected)
, m_statusComputionFlags(SyncthingStatusComputionFlags::Default)
, m_loggingFlags(SyncthingConnectionLoggingFlags::None)
, m_loggingFlagsHandler(SyncthingConnectionLoggingFlags::None)
, m_keepPolling(false)
, m_abortingAllRequests(false)
, m_connectionAborted(false)
, m_abortingToConnect(false)
, m_abortingToReconnect(false)
, m_requestCompletion(true)
, m_pollingFlags(PollingFlags::All)
, m_statusRecomputationFlags(StatusRecomputation::None)
, m_lastEventId(0)
, m_lastDiskEventId(0)
, m_autoReconnectTries(0)
, m_requestTimeout(SyncthingConnectionSettings::defaultRequestTimeout)
, m_longPollingTimeout(SyncthingConnectionSettings::defaultLongPollingTimeout)
, m_diskEventLimit(SyncthingConnectionSettings::defaultDiskEventLimit)
, m_totalIncomingTraffic(unknownTraffic)
, m_totalOutgoingTraffic(unknownTraffic)
, m_totalIncomingRate(0.0)
, m_totalOutgoingRate(0.0)
, m_configReply(nullptr)
, m_statusReply(nullptr)
, m_connectionsReply(nullptr)
, m_errorsReply(nullptr)
, m_dirStatsReply(nullptr)
, m_devStatsReply(nullptr)
, m_eventsReply(nullptr)
, m_versionReply(nullptr)
, m_diskEventsReply(nullptr)
, m_logReply(nullptr)
, m_hasConfig(false)
, m_hasStatus(false)
, m_hasEvents(false)
, m_hasDiskEvents(false)
, m_statsRequested(false)
, m_lastFileDeleted(false)
, m_recordFileChanges(false)
, m_useDeprecatedRoutes(true)
, m_pausingOnMeteredConnection(false)
#ifdef SYNCTHINGCONNECTION_SUPPORT_METERED
, m_handlingMeteredConnectionInitialized(false)
#endif
, m_insecure(false)
{
m_trafficPollTimer.setInterval(SyncthingConnectionSettings::defaultTrafficPollInterval);
m_trafficPollTimer.setTimerType(Qt::CoarseTimer);
m_trafficPollTimer.setSingleShot(true);
QObject::connect(&m_trafficPollTimer, &QTimer::timeout, this, &SyncthingConnection::requestConnections);
m_devStatsPollTimer.setInterval(SyncthingConnectionSettings::defaultDevStatusPollInterval);
m_devStatsPollTimer.setTimerType(Qt::CoarseTimer);
m_devStatsPollTimer.setSingleShot(true);
QObject::connect(&m_devStatsPollTimer, &QTimer::timeout, this, &SyncthingConnection::requestDeviceStatistics);
m_errorsPollTimer.setInterval(SyncthingConnectionSettings::defaultErrorsPollInterval);
m_errorsPollTimer.setTimerType(Qt::CoarseTimer);
m_errorsPollTimer.setSingleShot(true);
QObject::connect(&m_errorsPollTimer, &QTimer::timeout, this, &SyncthingConnection::requestErrors);
m_autoReconnectTimer.setTimerType(Qt::CoarseTimer);
m_autoReconnectTimer.setInterval(SyncthingConnectionSettings::defaultReconnectInterval);
QObject::connect(&m_autoReconnectTimer, &QTimer::timeout, this, &SyncthingConnection::autoReconnect);
#if defined(LIB_SYNCTHING_CONNECTOR_CONNECTION_MOCKED) || defined(LIB_SYNCTHING_CONNECTOR_MOCKED)
setupTestData();
#endif
setLoggingFlags(loggingFlags);
// allow initializing the default value for m_useDeprecatedRoutes via environment variable
auto useDeprecatedRoutesIsInt = false;
auto useDeprecatedRoutesInt = qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_USE_DEPRECATED_ROUTES", &useDeprecatedRoutesIsInt);
if (useDeprecatedRoutesIsInt) {
m_useDeprecatedRoutes = useDeprecatedRoutesInt;
}
}
/*!
* \brief Destroys the instance. Ongoing requests are aborted.
*/
SyncthingConnection::~SyncthingConnection()
{
m_status = SyncthingStatus::BeingDestroyed;
disconnect();
}
/*!
* \brief Returns whether the currently assigned syncthingUrl() refers to the Syncthing instance on the local machine.
*/
bool SyncthingConnection::isLocal() const
{
return ::Data::isLocal(QUrl(m_syncthingUrl));
}
/*!
* \brief Returns the string representation of the specified \a status.
*/
QString SyncthingConnection::statusText(SyncthingStatus status)
{
switch (status) {
case SyncthingStatus::Disconnected:
return tr("disconnected");
case SyncthingStatus::Reconnecting:
return tr("reconnecting");
case SyncthingStatus::Idle:
return tr("connected");
case SyncthingStatus::Scanning:
return tr("connected, scanning");
case SyncthingStatus::Paused:
return tr("connected, paused");
case SyncthingStatus::Synchronizing:
return tr("connected, synchronizing");
case SyncthingStatus::RemoteNotInSync:
return tr("connected, remote not in sync");
case SyncthingStatus::NoRemoteConnected:
return tr("connected, but all remote devices disconnected");
default:
return tr("unknown");
}
}
/*!
* \brief Sets the specified logging \a flags.
*/
void SyncthingConnection::setLoggingFlags(SyncthingConnectionLoggingFlags flags)
{
m_loggingFlags = flags;
if (flags && SyncthingConnectionLoggingFlags::FromEnvironment) {
if (!(flags && SyncthingConnectionLoggingFlags::All) && qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_LOG_ALL")) {
m_loggingFlags |= SyncthingConnectionLoggingFlags::All;
} else {
if (!(flags && SyncthingConnectionLoggingFlags::ApiCalls) && qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_LOG_API_CALLS")) {
m_loggingFlags |= SyncthingConnectionLoggingFlags::ApiCalls;
}
if (!(flags && SyncthingConnectionLoggingFlags::ApiCalls) && qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_LOG_API_REPLIES")) {
m_loggingFlags |= SyncthingConnectionLoggingFlags::ApiCalls;
}
if (!(flags && SyncthingConnectionLoggingFlags::Events) && qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_LOG_EVENTS")) {
m_loggingFlags |= SyncthingConnectionLoggingFlags::Events;
}
if (!(flags && SyncthingConnectionLoggingFlags::DirsOrDevsResetted)
&& qEnvironmentVariableIntValue(PROJECT_VARNAME_UPPER "_LOG_DIRS_OR_DEVS_RESETTED")) {
m_loggingFlags |= SyncthingConnectionLoggingFlags::Events;
}
}
}
if ((m_loggingFlags && SyncthingConnectionLoggingFlags::DirsOrDevsResetted)
&& !(m_loggingFlagsHandler && SyncthingConnectionLoggingFlags::DirsOrDevsResetted)) {
QObject::connect(this, &SyncthingConnection::newDirs, [this](const auto &dirs) {
if (m_loggingFlags && SyncthingConnectionLoggingFlags::DirsOrDevsResetted) {
std::cerr << Phrases::Info << "Folder list renewed:" << Phrases::End;
std::cerr << displayNames(dirs).join(QStringLiteral(", ")).toStdString() << endl;
}
});
QObject::connect(this, &SyncthingConnection::newDevices, [this](const auto &devs) {
if (m_loggingFlags && SyncthingConnectionLoggingFlags::DirsOrDevsResetted) {
std::cerr << Phrases::Info << "Device list renewed:" << Phrases::End;
std::cerr << displayNames(devs).join(QStringLiteral(", ")).toStdString() << endl;
}
});
m_loggingFlagsHandler |= SyncthingConnectionLoggingFlags::DirsOrDevsResetted;
}
}
/*!
* \brief Cancels \a reply without considering the connection aborted.
* \remarks Setting \a reply back to nullptr before aborting it avoids the usual cancellation handler to be invoked.
*/
static inline void cancelReplyWithoutAbortingConnection(QNetworkReply *&reply)
{
if (reply) {
std::exchange(reply, nullptr)->abort();
}
}
/*!
* \brief Ensure the request with the specified \a timer, \a pendingReply and \a requestFunction is enabled or disabled depending on \a enable.
* \remarks This function is only supposed to be called if \a enabled has actually changed.
*/
static inline void manageTimerBasedRequest(
QTimer &timer, QNetworkReply *pendingReply, SyncthingConnection &connection, void (SyncthingConnection::*requestFunction)(void), bool enable)
{
// stop any possibly active timer if the polling-flag has been disabled (stopping a pending request would be possible but not gain us anything)
if (!enable) {
timer.stop();
return;
}
// make a request immediately (unless there's already a pending reply) if the polling-flag has been enabled and a non-zero polling interval is configured
if (timer.interval() && !pendingReply) {
timer.stop();
std::invoke(requestFunction, connection);
}
}
/*!
* \brief Returns whether flags matching the specified \a mask have been changed between \a flags1 and \a flags2.
*/
static inline bool haveFlagsChanged(
SyncthingConnection::PollingFlags flags1, SyncthingConnection::PollingFlags flags2, SyncthingConnection::PollingFlags mask)
{
return (flags1 & mask) != (flags2 & mask);
}
/*!
* \brief Sets what kind of events are polled for.
* \remarks
* - Call this function to reduce CPU usage in case not all events are needed right now, e.g. remove PollingFlags::DiskEvents
* if the fileChanged() signal is not used anyway.
* - Restarts pending requests as necessary.
*/
void SyncthingConnection::setPollingFlags(PollingFlags flags)
{
if (flags == m_pollingFlags) {
return;
}
// track what flags have changed and set new flags
const auto normalEventsChanged = haveFlagsChanged(flags, m_pollingFlags, PollingFlags::NormalEvents);
const auto diskEventsChanged = haveFlagsChanged(flags, m_pollingFlags, PollingFlags::DiskEvents);
const auto trafficStatsChanged = haveFlagsChanged(flags, m_pollingFlags, PollingFlags::TrafficStatistics);
const auto devStatsChanged = haveFlagsChanged(flags, m_pollingFlags, PollingFlags::DeviceStatistics);
const auto errorsChanged = haveFlagsChanged(flags, m_pollingFlags, PollingFlags::Errors);
m_pollingFlags = flags;
// restart events/disk-events request as necessary
if (normalEventsChanged) {
if (!m_eventMask.isEmpty()) {
m_lastEventIdByMask.insert(m_eventMask, m_lastEventId);
m_eventMask.clear();
}
cancelReplyWithoutAbortingConnection(m_eventsReply);
}
if (diskEventsChanged) {
cancelReplyWithoutAbortingConnection(m_diskEventsReply);
}
if (m_hasConfig && m_hasStatus && m_keepPolling) {
requestEvents();
requestDiskEvents(m_diskEventLimit);
}
// manage timers/requests for timer-based requests
if (trafficStatsChanged) {
manageTimerBasedRequest(m_trafficPollTimer, m_connectionsReply, *this, &SyncthingConnection::requestConnections,
m_keepPolling && (m_pollingFlags && PollingFlags::TrafficStatistics));
}
if (devStatsChanged) {
manageTimerBasedRequest(m_devStatsPollTimer, m_devStatsReply, *this, &SyncthingConnection::requestDeviceStatistics,
m_keepPolling && (m_pollingFlags && PollingFlags::DeviceStatistics));
}
if (errorsChanged) {
manageTimerBasedRequest(
m_errorsPollTimer, m_errorsReply, *this, &SyncthingConnection::requestErrors, m_keepPolling && (m_pollingFlags && PollingFlags::Errors));
}
}
/*!
* \brief Returns whether there is at least one directory out-of-sync.
*/
bool SyncthingConnection::hasOutOfSyncDirs() const
{
if (m_hasOutOfSyncDirs.has_value()) {
return m_hasOutOfSyncDirs.value();
}
for (const SyncthingDir &dir : m_dirs) {
if (!dir.paused && dir.status == SyncthingDirStatus::OutOfSync) {
return m_hasOutOfSyncDirs.emplace(true);
}
}
return m_hasOutOfSyncDirs.emplace(false);
}
/*!
* \brief Sets all polling intervals (traffic, device statistics, errors) to 0 so polling is disabled.
* \remarks Does not affect the auto-reconnect and does not affect the *long* polling for the event API.
*/
void SyncthingConnection::disablePolling()
{
setTrafficPollInterval(0);
setDevStatsPollInterval(0);
setErrorsPollInterval(0);
}
/*!
* \brief Sets whether to pause all devices on metered connections.
*/
void SyncthingConnection::setPausingOnMeteredConnection(bool pausingOnMeteredConnection)
{
if (m_pausingOnMeteredConnection != pausingOnMeteredConnection) {
if ((m_pausingOnMeteredConnection = pausingOnMeteredConnection)) {
// initialize handling of metered connections
#ifdef SYNCTHINGCONNECTION_SUPPORT_METERED
if (!m_handlingMeteredConnectionInitialized) {
if (const auto *const networkInformation = loadNetworkInformationBackendForMetered()) {
QObject::connect(networkInformation, &QNetworkInformation::isMeteredChanged, this, &SyncthingConnection::handleMeteredConnection);
}
}
#endif
}
if (m_hasConfig) {
handleMeteredConnection();
}
}
}
/*!
* \brief Substitutes the tilde as first element in \a path using current values of tilde() and pathSeparator().
*/
QString SyncthingConnection::substituteTilde(const QString &path) const
{
return Data::substituteTilde(path, m_tilde, m_pathSeparator);
}
/*!
* \brief Ensures that devices are paused/resumed depending on whether the network connection is metered.
*/
void SyncthingConnection::handleMeteredConnection()
{
#ifdef SYNCTHINGCONNECTION_SUPPORT_METERED
const auto *const networkInformation = QNetworkInformation::instance();
if (!networkInformation || !networkInformation->supports(QNetworkInformation::Feature::Metered)) {
return;
}
if (networkInformation->isMetered() && m_pausingOnMeteredConnection) {
auto hasDevicesToPause = false;
m_devsPausedDueToMeteredConnection.reserve(static_cast<qsizetype>(m_devs.size()));
for (const auto &device : m_devs) {
if (!device.paused && device.status != SyncthingDevStatus::ThisDevice) {
if (!m_devsPausedDueToMeteredConnection.contains(device.id)) {
m_devsPausedDueToMeteredConnection << device.id;
hasDevicesToPause = true;
}
}
}
if (hasDevicesToPause) {
pauseResumeDevice(m_devsPausedDueToMeteredConnection, true, true);
}
} else {
pauseResumeDevice(m_devsPausedDueToMeteredConnection, false, true);
m_devsPausedDueToMeteredConnection.clear();
}
#endif
}
/*!
* \brief Connects asynchronously to Syncthing. Does nothing if already connected.
*
* Use this to connect the first time or to connect to the same Syncthing instance again or to ensure
* the connection to the currently configured instance is established. Use reconnect() to connect to
* a different instance.
*
* \remarks Does not clear data from a previous connection (except error items). Use reconnect() if that
* is required.
*/
void SyncthingConnection::connect()
{
// reset auto-reconnect
m_autoReconnectTimer.stop();
m_autoReconnectTries = 0;
// skip if already connected (see reconnect() to force reconnecting)
if (isConnected()) {
return;
}
// abort pending requests before connecting
if (hasPendingRequests()) {
m_keepPolling = m_abortingToConnect = true;
abortAllRequests();
return;
}
// reset status
m_connectionAborted = m_abortingToConnect = m_abortingToReconnect = m_hasConfig = m_hasStatus = m_hasEvents = m_hasDiskEvents = m_statsRequested
= false;
if (!checkConnectionConfiguration()) {
return;
}
requestConfig();
requestStatus();
m_keepPolling = true;
}
/*!
* \brief Returns whether the connection configuration is sufficient and sets the connection into the disconnected state if not.
*/
bool SyncthingConnection::checkConnectionConfiguration()
{
if (!m_apiKey.isEmpty() && !m_syncthingUrl.isEmpty()) {
return true;
}
emit error(tr("Connection configuration is insufficient."), SyncthingErrorCategory::OverallConnection, QNetworkReply::NoError);
setStatus(SyncthingStatus::Disconnected);
return false;
}
/*!
* \brief Applies the specified configuration and tries to reconnect via reconnect() if properties requiring reconnect
* to take effect have changed.
* \remarks The expected SSL errors of the specified configuration are updated accordingly.
*/
void SyncthingConnection::connect(SyncthingConnectionSettings &connectionSettings)
{
if (applySettings(connectionSettings) || !isConnected()) {
reconnect();
}
}
/*!
* \brief Connects in \a milliSeconds. Useful to "schedule" another attempt in case of a failure.
* \remarks Does nothing if the connection attempt would happen anyway though auto-reconnect.
*/
void SyncthingConnection::connectLater(int milliSeconds)
{
// skip if connecting via auto-reconnect anyway
if (m_autoReconnectTimer.isActive() && milliSeconds > m_autoReconnectTimer.interval()) {
return;
}
QTimer::singleShot(milliSeconds, this, static_cast<void (SyncthingConnection::*)(void)>(&SyncthingConnection::connect));
}
/*!
* \brief Disconnects. That means all (long) polling is stopped and ongoing requests are aborted via abortAllRequests().
*/
void SyncthingConnection::disconnect()
{
m_abortingToConnect = m_abortingToReconnect = m_keepPolling = false;
m_statusRecomputationFlags = StatusRecomputation::None;
m_trafficPollTimer.stop();
m_devStatsPollTimer.stop();
m_errorsPollTimer.stop();
m_autoReconnectTimer.stop();
m_autoReconnectTries = 0;
abortAllRequests();
}
/*!
* \brief Aborts the specified \a reply if it is not nullptr.
*/
static inline void abortMaybe(QNetworkReply *reply)
{
if (reply) {
reply->abort();
}
}
/*!
* \brief Aborts status-relevant, pending requests.
* \remarks Status-relevant means that requests for triggering actions like rescan() or restart() are excluded. requestQrCode() does not
* contribute to the status as well and is excluded as well.
*/
void SyncthingConnection::abortAllRequests()
{
m_connectionAborted = m_abortingAllRequests = true;
abortMaybe(m_configReply);
abortMaybe(m_statusReply);
abortMaybe(m_connectionsReply);
abortMaybe(m_errorsReply);
abortMaybe(m_dirStatsReply);
abortMaybe(m_devStatsReply);
abortMaybe(m_eventsReply);
abortMaybe(m_versionReply);
abortMaybe(m_diskEventsReply);
abortMaybe(m_logReply);
abortMaybe(m_configReply);
abortMaybe(m_configReply);
for (auto *const reply : std::as_const(m_otherReplies)) {
reply->abort();
}
m_abortingAllRequests = false;
handleAdditionalRequestCanceled();
}
/*!
* \brief Disconnects if connected, then (re-)connects asynchronously.
* \remarks
* - Clears the currently cached configuration.
* - This explicit request to reconnect will reset the autoReconnectTries().
*/
void SyncthingConnection::reconnect()
{
// reset reconnect timer
m_autoReconnectTimer.stop();
m_autoReconnectTries = 0;
// stop other timers
m_trafficPollTimer.stop();
m_devStatsPollTimer.stop();
m_errorsPollTimer.stop();
// reset variables to track connection progress
// note: especially resetting events is important as it influences the subsequent hasPendingRequests() call
m_hasConfig = m_hasStatus = m_hasEvents = m_hasDiskEvents = m_statsRequested = false;
// reconnect right now if no pending requests to be aborted
if (!hasPendingRequests()) {
continueReconnecting();
return;
}
// abort pending requests before connecting again
m_keepPolling = m_abortingToReconnect = true;
abortAllRequests();
}
/*!
* \brief Applies the specified configuration and tries to reconnect via reconnect().
* \remarks The expected SSL errors of the specified configuration are updated accordingly.
*/
void SyncthingConnection::reconnect(SyncthingConnectionSettings &connectionSettings)
{
applySettings(connectionSettings);
reconnect();
}
/*!
* \brief Reconnects after the specified number of \a milliSeconds.
*/
void SyncthingConnection::reconnectLater(int milliSeconds)
{
QTimer::singleShot(milliSeconds, this, static_cast<void (SyncthingConnection::*)(void)>(&SyncthingConnection::reconnect));
}
/*!
* \brief Internally called to reconnect; ensures currently cached config is cleared.
*/
void SyncthingConnection::continueReconnecting()
{
// notify that we're about to invalidate the configuration if not already invalidated anyway
const auto isConfigInvalidated = m_rawConfig.isEmpty();
if (!isConfigInvalidated) {
emit newConfig(m_rawConfig = QJsonObject());
}
// cleanup information from previous connection
m_keepPolling = true;
m_statusRecomputationFlags = StatusRecomputation::None;
m_connectionAborted = false;
m_abortingToConnect = m_abortingToReconnect = false;
m_lastEventId = 0;
m_lastDiskEventId = 0;
m_lastEventIdByMask.clear();
m_configDir.clear();
m_myId.clear();
m_tilde.clear();
m_pathSeparator.clear();
m_totalIncomingTraffic = unknownTraffic;
m_totalOutgoingTraffic = unknownTraffic;
m_totalIncomingRate = 0.0;
m_totalOutgoingRate = 0.0;
emit trafficChanged(unknownTraffic, unknownTraffic);
m_hasOutOfSyncDirs.reset();
m_hasConfig = false;
m_hasStatus = false;
m_hasEvents = false;
m_hasDiskEvents = false;
m_statsRequested = false;
m_dirs.clear();
m_devs.clear();
m_errors.clear();
m_devsPausedDueToMeteredConnection.clear();
m_lastConnectionsUpdateEvent = 0;
m_lastConnectionsUpdateTime = DateTime();
m_lastFileEvent = 0;
m_lastFileTime = DateTime();
m_lastErrorTime = DateTime();
m_startTime = DateTime();
m_lastFileName.clear();
m_lastFileDeleted = false;
m_syncthingVersion.clear();
emit dirStatisticsChanged();
// notify that the configuration has been invalidated
if (!isConfigInvalidated) {
emit newConfigApplied();
}
if (!checkConnectionConfiguration()) {
return;
}
requestConfig();
requestStatus();
setStatus(SyncthingStatus::Reconnecting);
}
/*!
* \brief Reads devs and dirs from the raw config.
*/
void SyncthingConnection::applyRawConfig()
{
readDevs(m_rawConfig.value(QLatin1String("devices")).toArray());
readDirs(m_rawConfig.value(QLatin1String("folders")).toArray());
emit newConfigApplied();
}
/*!
* \brief Reads results of requestConfig() and requestStatus().
* \remarks Called in readConfig() or readStatus() to conclude reading parts requiring config *and* status
* being available. Does nothing if this is not the case (yet).
*/
void SyncthingConnection::concludeReadingConfigAndStatus()
{
if (!m_hasConfig || !m_hasStatus) {
return;
}
applyRawConfig();
continueConnecting();
}
/*!
* \brief Sets the status from (re)connecting to Syncthing's actual state if polling but there are no more pending requests.
* \remarks
* - Called by read...() handlers for requests started in continueConnecting().
* - The flags are used to decide whether the status should be recomputed (as not all read...() handlers require a recomputation).
* \sa hasPendingRequests()
*/
void SyncthingConnection::concludeConnection(StatusRecomputation flags)
{
if (!m_keepPolling) {
return;
}
// take always record of the specified flags but return early if there are still pending requests or the status does not need to be recomputed
m_statusRecomputationFlags += flags;
if (hasPendingRequests() || (m_statusRecomputationFlags == StatusRecomputation::None && isConnected())) {
return;
}
// recompute status and emit events according to flags
if (!setStatus(SyncthingStatus::Idle) && (m_statusRecomputationFlags && StatusRecomputation::OutOfSyncDirs) && !m_hasOutOfSyncDirs.has_value()) {
emit hasOutOfSyncDirsChanged();
}
if (m_statusRecomputationFlags && StatusRecomputation::DirStats) {
emit dirStatisticsChanged();
}
if (m_statusRecomputationFlags && StatusRecomputation::RemoteCompletion) {
emit devCompletionChanged();
}
m_statusRecomputationFlags = StatusRecomputation::None;
}
/*!
* \brief Connects increasing the auto-reconnect tries.
* \remarks Called via m_autoReconnectTimer.
*/
void SyncthingConnection::autoReconnect()
{
const auto tmp = m_autoReconnectTries;
connect();
m_autoReconnectTries = tmp + 1;
}
/*!
* \brief Returns the directory info object for the directory with the specified ID.
* \returns Returns a pointer to the object or nullptr if not found.
* \remarks The returned object becomes invalid when the newDirs() signal is emitted or the connection is destroyed.
*/
SyncthingDir *SyncthingConnection::findDirInfo(const QString &dirId, int &row)
{
row = 0;
for (SyncthingDir &d : m_dirs) {
if (d.id == dirId) {
return &d;
}
++row;
}
return nullptr;
}
/*!
* \brief Returns the directory info object for the directory with the specified ID or label.
* \returns Returns a pointer to the object or nullptr if not found.
* \remarks
* - IDs have precedence, labels are checked as fallback.
* - The returned object becomes invalid when the newDirs() signal is emitted or the connection is destroyed.
*/
SyncthingDir *SyncthingConnection::findDirInfoConsideringLabels(const QString &dirIdOrLabel, int &row)
{
if (auto *const dir = findDirInfo(dirIdOrLabel, row)) {
return dir;
}
row = 0;
for (SyncthingDir &d : m_dirs) {
if (d.label == dirIdOrLabel) {
return &d;
}
++row;
}
return nullptr;
}
/*!
* \brief Returns the directory info object for the directory with the ID stored in the specified \a object with the specified \a key.
*/
SyncthingDir *SyncthingConnection::findDirInfo(QLatin1String key, const QJsonObject &object, int *row)
{
const auto dirId(object.value(key).toString());
if (dirId.isEmpty()) {
return nullptr;
}
int dummyRow;
auto &rowRef(row ? *row : dummyRow);
return findDirInfo(dirId, rowRef);
}
/*!
* \brief Returns the directory info object for the directory with the specified \a path.
*
* If a corresponding Syncthing directory could be found, \a relativePath is set to the path of the item relative
* to the location of the corresponding Syncthing directory.
*
* \returns Returns a pointer to the object or nullptr if not found.
* \remarks The returned object becomes invalid when the newDirs() signal is emitted or the connection is destroyed.
*/
SyncthingDir *SyncthingConnection::findDirInfoByPath(const QString &path, QString &relativePath, int &row)
{
row = 0;
const auto cleanPath = QDir::cleanPath(path);
for (SyncthingDir &dir : m_dirs) {
const auto dirCleanPath = QDir::cleanPath(dir.path);
if (cleanPath == dirCleanPath) {
relativePath.clear();
return &dir;
} else if (cleanPath.startsWith(dirCleanPath)) {
relativePath = cleanPath.mid(dirCleanPath.size());
return &dir;
}
++row;
}
return nullptr;
}
/*!
* \brief Appends a directory info object with the specified \a dirId to \a dirs.
*
* If such an object already exists, it is recycled by moving it to \a dirs.
* Otherwise a new, empty object is created.
*
* \returns Returns the directory info object or nullptr if \a dirId is invalid.
*/
SyncthingDir *SyncthingConnection::addDirInfo(std::vector<SyncthingDir> &dirs, const QString &dirId)
{
if (dirId.isEmpty()) {
return nullptr;
}
auto row = int();
if (auto *const existingDirInfo = findDirInfo(dirId, row)) {
return &dirs.emplace_back(std::move(*existingDirInfo));
} else {
return &dirs.emplace_back(dirId);
}
}
/*!
* \brief Returns the device info object for the device with the specified ID.
* \returns Returns a pointer to the object or nullptr if not found.
* \remarks The returned object becomes invalid when the newConfig() signal is emitted or the connection is destroyed.
*/
SyncthingDev *SyncthingConnection::findDevInfo(const QString &devId, int &row)
{
row = 0;
for (SyncthingDev &d : m_devs) {
if (d.id == devId) {
return &d;
}
++row;
}
return nullptr;
}
/*!
* \brief Returns the device info object for the first device with the specified name.
* \returns Returns a pointer to the object or nullptr if not found.
* \remarks The returned object becomes invalid when the newConfig() signal is emitted or the connection is destroyed.
*/
SyncthingDev *SyncthingConnection::findDevInfoByName(const QString &devName, int &row)
{
row = 0;
for (SyncthingDev &d : m_devs) {
if (d.name == devName) {
return &d;
}
++row;
}
return nullptr;
}
/*!
* \brief Returns all directory IDs for the current configuration.
* \remarks Computed by looping dirInfo().
*/
QStringList SyncthingConnection::directoryIds() const
{
return ids(m_dirs);
}
/*!
* \brief Returns all device IDs for the current configuration.
* \remarks Computed by looping devInfo().
*/
QStringList SyncthingConnection::deviceIds() const
{
return ids(m_devs);
}
/*!
* \brief Returns the device name for the specified \a deviceId if known; otherwise returns just the \a deviceId itself.
*/
QString SyncthingConnection::deviceNameOrId(const QString &deviceId) const
{
for (const auto &dev : devInfo()) {
if (dev.id == deviceId) {
return dev.displayName();
}
}
return deviceId;
}
/*!
* \brief Returns the number of devices Syncthing is currently connected to.
* \remarks Computed by looping devInfo().
*/
std::vector<const SyncthingDev *> SyncthingConnection::connectedDevices() const
{
std::vector<const SyncthingDev *> connectedDevs;
connectedDevs.reserve(devInfo().size());
for (const SyncthingDev &dev : devInfo()) {
if (dev.isConnected()) {
connectedDevs.emplace_back(&dev);
}
}
return connectedDevs;
}
/*!
* \brief Appends a device info object with the specified \a devId to \a devs.
*
* If such an object already exists, it is recycled by moving it to \a devs.
* Otherwise a new, empty object is created.
*
* \returns Returns the device info object or nullptr if \a devId is invalid.
*/
SyncthingDev *SyncthingConnection::addDevInfo(std::vector<SyncthingDev> &devs, const QString &devId)
{
if (devId.isEmpty()) {
return nullptr;
}
auto row = int();
if (SyncthingDev *const existingDevInfo = findDevInfo(devId, row)) {
return &devs.emplace_back(std::move(*existingDevInfo));
} else {
return &devs.emplace_back(devId);
}
}
/*!
* \brief Internally called to parse a time stamp.
*/
DateTime SyncthingConnection::parseTimeStamp(const QJsonValue &jsonValue, const QString &context, DateTime defaultValue, bool greaterThanEpoch)
{
const auto utf16 = jsonValue.toString();
const auto utf8 = utf16.toUtf8();
try {
const auto [localTime, utcOffset] = DateTime::fromIsoString(utf8.data());
return !greaterThanEpoch || (localTime - utcOffset) > DateTime::unixEpochStart() ? localTime : defaultValue;
} catch (const ConversionException &e) {
emit error(tr("Unable to parse timestamp \"%1\" (%2): %3").arg(utf16, context, QString::fromUtf8(e.what())), SyncthingErrorCategory::Parsing,
QNetworkReply::NoError);
}
return defaultValue;
}
/*!
* \brief Continues connecting if both - config and status - have been parsed yet and continuous polling is enabled.
*/
void SyncthingConnection::continueConnecting()
{
// skip if config and status are missing or we're not supposed to actually connect
if (!m_keepPolling || !m_hasConfig || !m_hasStatus) {
return;
}
// read additional information (beside config and status)
requestErrors();
requestVersion();
for (const SyncthingDir &dir : m_dirs) {
if (!m_requestCompletion || dir.paused) {
continue;
}
for (const QString &devId : dir.deviceIds) {
requestCompletion(devId, dir.id);
}
}
// poll for events according to polling flags
requestEvents();
requestDiskEvents(m_diskEventLimit);
}
#ifndef QT_NO_SSL
/*!
* \brief Locates and loads the (self-signed) certificate used by the Syncthing GUI.
* \remarks
* - Ensures any previous certificates are cleared in any case.
* - Emits error() when an error occurs.
* - Loading the certificate is only possible if the connection object is configured
* to connect to the locally running Syncthing instance. Otherwise this method will
* only do the cleanup of previous certificates but not emit any errors.
* - This function uses m_certificatePath which is set by applySettings() if the user
* specified a certificate path manually. Otherwise the path is detected automatically
* and stored in m_dynamicallyDeterminedCertificatePath so the certificate path is
* known in handleSslErrors().
* \returns Returns whether a certificate could be loaded.
*/
bool SyncthingConnection::loadSelfSignedCertificate(const QUrl &url)
{
// ensure current exceptions for self-signed certificates are cleared
m_expectedSslErrors.clear();
// not required when not using secure connection
const auto syncthingUrl = url.isEmpty() ? m_syncthingUrl : url;
if (!syncthingUrl.scheme().endsWith(QChar('s'))) {
return false;
}
// only possible if the Syncthing instance is running on the local machine
if (!::Data::isLocal(syncthingUrl)) {
return false;
}
// find cert
const auto certPath = !m_certificatePath.isEmpty()
? m_certificatePath
: (!m_configDir.isEmpty() ? (m_configDir + QStringLiteral("/https-cert.pem")) : SyncthingConfig::locateHttpsCertificate());
if (certPath.isEmpty()) {
emit error(tr("Unable to locate certificate used by Syncthing."), SyncthingErrorCategory::OverallConnection, QNetworkReply::NoError);
return false;
}
// add exception
const auto certs = QSslCertificate::fromPath(certPath);
if (certs.isEmpty() || certs.at(0).isNull()) {
emit error(tr("Unable to load certificate used by Syncthing."), SyncthingErrorCategory::OverallConnection, QNetworkReply::NoError);
return false;
}
m_expectedSslErrors = SyncthingConnectionSettings::compileSslErrors(certs.at(0));
// keep track of the dynamically determined certificate path for handleSslErrors()
if (m_certificatePath.isEmpty()) {
m_dynamicallyDeterminedCertificatePath = certPath;
m_certificateLastModified = QFileInfo(certPath).lastModified();
}
return true;
}
/*!
* \brief Clears the self-signed certificate that might be loaded via loadSelfSignedCertificate().
* \remarks This function mainly exists to ease testing; one normally doesn't need to invoke it explicitly.
*/
void SyncthingConnection::clearSelfSignedCertificate()
{
m_expectedSslErrors.clear();
m_certificatePath.clear();
m_dynamicallyDeterminedCertificatePath.clear();
m_certificateLastModified = QDateTime();
}
#endif
/*!
* \brief Applies the specified configuration.
* \remarks
* - The expected SSL errors are taken from the specified \a connectionSettings. If empty, this
* function attempts to load expected SSL errors automatically as needed/possible via
* loadSelfSignedCertificate(). It then writes back those SSL errors to \a connectionSettings.
* This way \a connectionSettings can act as a cache for SSL exceptions.
* - The configuration is not used instantly. It will be used on the next reconnect.
* \returns Returns whether at least one property requiring a reconnect to take effect has changed.
* \sa reconnect()
*/
bool SyncthingConnection::applySettings(SyncthingConnectionSettings &connectionSettings)
{
bool reconnectRequired = false;
if (syncthingUrl() != connectionSettings.syncthingUrl) {
setSyncthingUrl(connectionSettings.syncthingUrl);
reconnectRequired = true;
}
if (apiKey() != connectionSettings.apiKey) {
setApiKey(connectionSettings.apiKey);
reconnectRequired = true;
}
if ((connectionSettings.authEnabled && (user() != connectionSettings.userName || password() != connectionSettings.password))
|| (!connectionSettings.authEnabled && (!user().isEmpty() || !password().isEmpty()))) {
if (connectionSettings.authEnabled) {
setCredentials(connectionSettings.userName, connectionSettings.password);
} else {
setCredentials(QString(), QString());
}
reconnectRequired = true;
}
#ifndef QT_NO_SSL
m_certificatePath = connectionSettings.httpsCertPath;
m_certificateLastModified = connectionSettings.httpCertLastModified;
if (connectionSettings.expectedSslErrors.isEmpty()) {
const bool previouslyHadExpectedSslErrors = !expectedSslErrors().isEmpty();
const bool ok = loadSelfSignedCertificate();
connectionSettings.expectedSslErrors = expectedSslErrors();
if (ok || (previouslyHadExpectedSslErrors && !ok)) {
reconnectRequired = true;
}
} else if (expectedSslErrors() != connectionSettings.expectedSslErrors) {
m_expectedSslErrors = connectionSettings.expectedSslErrors;
reconnectRequired = true;
}
#endif
setTrafficPollInterval(connectionSettings.trafficPollInterval);
setDevStatsPollInterval(connectionSettings.devStatsPollInterval);
setErrorsPollInterval(connectionSettings.errorsPollInterval);
setAutoReconnectInterval(connectionSettings.reconnectInterval);
setRequestTimeout(connectionSettings.requestTimeout);
setLongPollingTimeout(connectionSettings.longPollingTimeout);
setDiskEventLimit(connectionSettings.diskEventLimit);
setStatusComputionFlags(connectionSettings.statusComputionFlags);
setPausingOnMeteredConnection(connectionSettings.pauseOnMeteredConnection);
return reconnectRequired;
}
/*!
* \brief Sets the connection status. Ensures statusChanged() is emitted if the status has actually changed.
* \param status Specifies the status; should be either SyncthingStatus::Disconnected, SyncthingStatus::Reconnecting, or
* SyncthingStatus::Idle. There is no use in specifying other values such as SyncthingStatus::Synchronizing as
* these are determined automatically within the method according to SyncthingConnection::statusComputionFlags().
*
* The precedence of the "connected" states from highest to lowest is:
* 1. SyncthingStatus::Synchronizing
* 2. SyncthingStatus::RemoteNotInSync
* 3. SyncthingStatus::Scanning
* 4. SyncthingStatus::Paused
* 5. SyncthingStatus::NoRemoteConnected
* 6. SyncthingStatus::Idle
*
* \remarks
* - The "out-of-sync" status is (currently) *not* handled by this function. One needs to query this via
* the SyncthingConnection::hasOutOfSyncDirs() function.
* - Whether notifications are available is *not* handled by this function. One needs to query this via
* SyncthingConnection::hasUnreadNotifications().
* \returns Returns whether the status has been changed; the the status remained the same as before false
* is returned. Returns always true if the connection is being destroyed.
*/
bool SyncthingConnection::setStatus(SyncthingStatus status)
{
if (m_status == SyncthingStatus::BeingDestroyed) {
return true;
}
switch (status) {
case SyncthingStatus::Disconnected:
// disable (long) polling
m_keepPolling = false;
m_connectionAborted = true;
[[fallthrough]];
case SyncthingStatus::Reconnecting:
m_devStatsPollTimer.stop();
m_trafficPollTimer.stop();
m_errorsPollTimer.stop();
break;
default:
// reset reconnect tries
m_autoReconnectTries = 0;
// skip if no further status information should be gathered
status = SyncthingStatus::Idle;
if (m_statusComputionFlags == SyncthingStatusComputionFlags::None) {
break;
}
// check whether at least one directory is scanning, preparing to synchronize or synchronizing
// note: We don't distinguish between "preparing to sync" and "synchronizing" for computing the overall
// status at the moment.
auto scanning = false, synchronizing = false, remoteSynchronizing = false, noRemoteConnected = true, devPaused = false;
if (m_statusComputionFlags && (SyncthingStatusComputionFlags::Synchronizing | SyncthingStatusComputionFlags::Scanning)) {
for (const SyncthingDir &dir : m_dirs) {
switch (dir.status) {
case SyncthingDirStatus::WaitingToSync:
case SyncthingDirStatus::PreparingToSync:
case SyncthingDirStatus::Synchronizing:
synchronizing = m_statusComputionFlags && SyncthingStatusComputionFlags::Synchronizing;
break;
case SyncthingDirStatus::WaitingToScan:
case SyncthingDirStatus::Scanning:
scanning = m_statusComputionFlags && SyncthingStatusComputionFlags::Scanning;
break;
default:;
}
if (synchronizing) {
break; // skip remaining dirs, "synchronizing" overrides "scanning" anyway
}
}
}
// check whether at least one device is synchronizing
// check whether at least one device is paused
// check whether at least one devices is connected
if (!synchronizing
&& (m_statusComputionFlags
&& (SyncthingStatusComputionFlags::RemoteSynchronizing | SyncthingStatusComputionFlags::NoRemoteConnected
| SyncthingStatusComputionFlags::DevicePaused))) {
for (const SyncthingDev &dev : m_devs) {
if (dev.status == SyncthingDevStatus::Synchronizing) {
remoteSynchronizing = true;
if (m_statusComputionFlags && SyncthingStatusComputionFlags::RemoteSynchronizing) {
break;
}
}
if (dev.isConnected()) {
noRemoteConnected = false;
}
if (dev.paused && dev.status != SyncthingDevStatus::ThisDevice) {
devPaused = true;
}
}
}
if (synchronizing) {
status = SyncthingStatus::Synchronizing;
} else if ((m_statusComputionFlags && SyncthingStatusComputionFlags::RemoteSynchronizing) && remoteSynchronizing) {
status = SyncthingStatus::RemoteNotInSync;
} else if (scanning) {
status = SyncthingStatus::Scanning;
} else if ((m_statusComputionFlags && SyncthingStatusComputionFlags::DevicePaused) && devPaused) {
status = SyncthingStatus::Paused;
} else if ((m_statusComputionFlags && SyncthingStatusComputionFlags::NoRemoteConnected) && noRemoteConnected) {
status = SyncthingStatus::NoRemoteConnected;
}
}
const auto hasStatusChanged = m_status != status || status == SyncthingStatus::Disconnected;
if (hasStatusChanged) {
// emit event if status changed always for disconnects so isConnecting() is re-evaluated
emit statusChanged(m_status = status);
}
return hasStatusChanged;
}
/*!
* \brief Internally called to emit a JSON parsing error.
* \remarks Since in this case the reply has already been read, its response must be passed as extra argument.
*/
void SyncthingConnection::emitError(const QString &message, const QJsonParseError &jsonError, QNetworkReply *reply, const QByteArray &response)
{
if (loggingFlags() && SyncthingConnectionLoggingFlags::ApiReplies) {
std::cerr << Phrases::Error << "JSON parsing error: " << message.toLocal8Bit().data() << jsonError.errorString().toLocal8Bit().data()
<< " (at offset " << jsonError.offset << ')' << Phrases::End;
}
emit error(message % jsonError.errorString() % QChar(' ') % QChar('(') % tr("at offset %1").arg(jsonError.offset) % QChar(')'),
SyncthingErrorCategory::Parsing, QNetworkReply::NoError, reply->request(), response);
}
/*!
* \brief Internally called to emit a network error (server replied error code or server could not be reached at all).
*/
void SyncthingConnection::emitError(const QString &message, SyncthingErrorCategory category, QNetworkReply *reply)
{
if (loggingFlags() && SyncthingConnectionLoggingFlags::ApiReplies) {
cerr << Phrases::Error << "Syncthing connection error: " << message.toLocal8Bit().data() << reply->errorString().toLocal8Bit().data() << endl;
}
emit error(message + reply->errorString(), category, reply->error(), reply->request(), reply->bytesAvailable() ? reply->readAll() : QByteArray());
}
/*!
* \brief Internally called to emit a network error for a specific request (server replied error code or server could not be reached at all).
* \remarks The \a message is supposed to already contain the error string of the reply.
*/
void SyncthingConnection::emitError(const QString &message, QNetworkReply *reply)
{
if (loggingFlags() && SyncthingConnectionLoggingFlags::ApiReplies) {
cerr << Phrases::Error << "Syncthing API error: " << message.toLocal8Bit().data() << reply->errorString().toLocal8Bit().data() << endl;
}
emit error(message, SyncthingErrorCategory::SpecificRequest, reply->error(), reply->request(),
reply->bytesAvailable() ? reply->readAll() : QByteArray());
}
/*!
* \brief Internally called to emit myIdChanged() signal.
*/
void SyncthingConnection::emitMyIdChanged(const QString &newId)
{
if (newId.isEmpty() || m_myId == newId) {
return;
}
// adjust device status
int row = 0;
for (SyncthingDev &dev : m_devs) {
if (dev.id == newId) {
if (dev.status != SyncthingDevStatus::ThisDevice) {
dev.status = SyncthingDevStatus::ThisDevice;
dev.paused = false;
emit devStatusChanged(dev, row);
}
} else if (dev.status == SyncthingDevStatus::ThisDevice) {
dev.status = SyncthingDevStatus::Unknown;
emit devStatusChanged(dev, row);
}
++row;
}
emit myIdChanged(m_myId = newId);
}
/*!
* \brief Internally called to emit tildeChanged() signal.
*/
void SyncthingConnection::emitTildeChanged(const QString &newTilde, const QString &newPathSeparator)
{
if ((newTilde.isEmpty() || m_tilde == newTilde) && (newPathSeparator.isEmpty() && m_pathSeparator == newPathSeparator)) {
return;
}
m_tilde = newTilde;
m_pathSeparator = newPathSeparator;
emit tildeChanged(m_tilde);
}
/*!
* \brief Internally called to handle a fatal error when reading config (dirs/devs), status and events.
*/
void SyncthingConnection::handleFatalConnectionError()
{
// start the timer before emitting the event so its active state can be observed in event handler
if (m_autoReconnectTimer.interval() && !m_autoReconnectTimer.isActive()) {
m_autoReconnectTimer.start();
}
setStatus(SyncthingStatus::Disconnected);
abortAllRequests();
}
/*!
* \brief Handles cancellation of additional requests done via continueConnecting() method.
*/
void SyncthingConnection::handleAdditionalRequestCanceled()
{
// postpone handling if there are still other requests pending
if (hasPendingRequests()) {
return;
}
if (m_abortingToReconnect) {
// if reconnect-flag is set, instantly etstablish a new connection via reconnect()
continueReconnecting();
} else if (m_abortingToConnect) {
// if connect-flag is set, instantly establish a new connection via connect()
connect();
} else {
// ... otherwise declare we're disconnected if that was the last pending request
setStatus(SyncthingStatus::Disconnected);
}
}
/*!
* \brief Internally called to recalculate the overall connection status, e.g. after the status of a directory
* changed.
* \remarks
* - This is achieved by simply setting the status to idle. setStatus() will calculate the specific status.
* - If not connected, this method does nothing. This is important, because when this method is called when
* establishing a connection (and the status is hence still disconnected) timers for polling would be killed.
*/
void SyncthingConnection::recalculateStatus()
{
if (isConnected()) {
setStatus(SyncthingStatus::Idle);
}
}
/*!
* \brief Invalidates whether there are currently out-of-sync dirs and provokes subscribers to the
* hasOutOfSyncDirsChanged() event to re-evaluate it.
*/
void SyncthingConnection::invalidateHasOutOfSyncDirs()
{
if (m_hasOutOfSyncDirs.has_value()) {
m_hasOutOfSyncDirs.reset();
emit hasOutOfSyncDirsChanged();
}
}
/*!
* \brief Returns syncthingUrl() with userName() and password().
*/
QUrl SyncthingConnection::makeUrlWithCredentials() const
{
auto url = QUrl(m_syncthingUrl);
url.setUserName(m_user);
url.setPassword(m_password);
return url;
}
/*!
* \brief Computes the overall completion of all connected devices.
*/
SyncthingCompletion SyncthingConnection::computeOverallRemoteCompletion() const
{
auto completion = SyncthingCompletion();
for (const auto &dev : m_devs) {
if (dev.isConnected()) {
completion += dev.overallCompletion;
}
}
completion.recomputePercentage();
return completion;
}
/*!
* \fn SyncthingConnection::newConfig()
* \brief Indicates new configuration (dirs, devs, ...) is available.
* \remarks
* - Configuration is requested automatically when connecting.
* - Previous directories (and directory info objects!) are invalidated.
* - Previous devices (and device info objects!) are invalidated.
*/
/*!
* \fn SyncthingConnection::newDirs()
* \brief Indicates new directories are available.
* \remarks Always emitted after newConfig() as soon as new directory info objects become available.
*/
/*!
* \fn SyncthingConnection::newDevices()
* \brief Indicates new devices are available.
* \remarks Always emitted after newConfig() as soon as new device info objects become available.
*/
/*!
* \fn SyncthingConnection::newEvents()
* \brief Indicates new events (dir status changed, ...) are available.
* \remarks New events are automatically polled when connected.
*/
/*!
* \fn SyncthingConnection::allEventsProcessed()
* \brief Indicates all new events have been processed.
* \remarks
* This event is emitted after newEvents(), dirStatusChanged(), devStatusChanged() and other specific events.
* If you would go through the list of all directories on every dirStatusChanged() event then using allEventsProcessed()
* instead might be a more efficient alternative. Just set a flag on dirStatusChanged() and go though the list of
* directories only once on the allEventsProcessed() event when the flag has been set.
*/
/*!
* \fn SyncthingConnection::dirStatusChanged()
* \brief Indicates the status of the specified \a dir changed.
*/
/*!
* \fn SyncthingConnection::devStatusChanged()
* \brief Indicates the status of the specified \a dev changed.
*/
/*!
* \fn SyncthingConnection::downloadProgressChanged()
* \brief Indicates the download progress changed.
*/
/*!
* \fn SyncthingConnection::newNotification()
* \brief Indicates a new Syncthing notification is available.
*/
/*!
* \fn SyncthingConnection::newDevAvailable()
* \brief Indicates another device wants to talk to us.
*/
/*!
* \fn SyncthingConnection::newDirAvailable()
* \brief Indicates a device wants to share an so far unknown directory with us.
* \remarks \a dev might be nullptr. In this case the device which wants to share the directory is unknown as well.
*/
/*!
* \fn SyncthingConnection::error()
* \brief Indicates a request (for configuration, events, ...) failed.
*/
/*!
* \fn SyncthingConnection::statusChanged()
* \brief Indicates the status of the connection changed (status(), hasOutOfSyncDirs()).
*/
/*!
* \fn SyncthingConnection::configDirChanged()
* \brief Indicates the Syncthing home/configuration directory changed.
*/
/*!
* \fn SyncthingConnection::myIdChanged()
* \brief Indicates ID of the own Syncthing device changed.
*/
/*!
* \fn SyncthingConnection::tildeChanged()
* \brief Indicates the tilde or path separator of the connected Syncthing instance changed.
*/
/*!
* \fn SyncthingConnection::trafficChanged()
* \brief Indicates totalIncomingTraffic() or totalOutgoingTraffic() has changed.
*/
/*!
* \fn SyncthingConnection::newConfigTriggered()
* \brief Indicates a new configuration has posted successfully via postConfig().
* \remarks In contrast to newConfig(), this signal is only emitted for configuration changes internally posted via postConfig().
*/
/*!
* \fn SyncthingConnection::rescanTriggered()
* \brief Indicates a rescan has been triggered successfully.
* \remarks Only emitted for rescans triggered internally via rescan() or rescanAll().
*/
/*!
* \fn SyncthingConnection::pauseTriggered()
* \brief Indicates a device has been paused successfully.
* \remarks Only emitted for pausing triggered internally via pause() or pauseAll().
*/
/*!
* \fn SyncthingConnection::resumeTriggered()
* \brief Indicates a device has been resumed successfully.
* \remarks Only emitted for resuming triggered internally via resume() or resumeAll().
*/
/*!
* \fn SyncthingConnection::restartTriggered()
* \brief Indicates a restart has been successfully triggered via restart().
*/
/*!
* \fn SyncthingConnection::hasOutOfSyncDirsChanged()
* \brief Indicates that hasOutOfSyncDirs() might has changed.
* \remarks
* - This signal is only emitted if hasOutOfSyncDirs() has been called at least once
* since the connection has been established.
* - This signal is *not* emitted if the status has changed at the same time. Then only
* statusChanged() is emitted. This is so that UI components subscribed to the event
* are only updated once (as they will also be subscribed to statusChanged()).
*/
} // namespace Data
|