fix(file-provider): Do not continue polling ETag from file provider when account is disabled

src/gui/folderman.cpp

@@ -39,13 +39,13 @@
 namespace {
 constexpr auto settingsAccountsC = "Accounts";
 constexpr auto settingsFoldersC = "Folders";
 constexpr auto settingsFoldersWithPlaceholdersC = "FoldersWithPlaceholders";
 constexpr auto settingsVersionC = "version";
 constexpr auto maxFoldersVersion = 1;
 
 int numberOfSyncJournals(const QString &path)
 {
     return QDir(path).entryList({ QStringLiteral(".sync_*.db"), QStringLiteral("._sync_*.db") }, QDir::Hidden | QDir::Files).size();
 }
 
 }
@@ -108,7 +108,7 @@
     return _folderMap;
 }
 
 void FolderMan::unloadFolder(Folder *f)
 {
     if (!f) {
         return;
@@ -227,7 +227,7 @@
         folder->processSwitchedToVirtualFiles();
     }
 
     return _folderMap.size();
 }
 
 void FolderMan::setupFoldersHelper(QSettings &settings, AccountStatePtr account, const QStringList &ignoreKeys, bool backwardsCompatible, bool foldersWithPlaceholders)
@@ -453,14 +453,14 @@
     emit folderListChanged(_folderMap);
 
     // return the number of valid folders.
     return _folderMap.size();
 }
 
 void FolderMan::backwardMigrationSettingsKeys(QStringList *deleteKeys, QStringList *ignoreKeys)
 {
     auto settings = ConfigFile::settingsWithGroup(QLatin1String("Accounts"));
 
     auto processSubgroup = [&](const QString &name) {
         settings->beginGroup(name);
         const auto foldersVersion = settings->value(QLatin1String(settingsVersionC), 1).toInt();
         qCInfo(lcFolderMan) << "FolderDefinition::maxSettingsVersion:" << FolderDefinition::maxSettingsVersion();
@@ -567,7 +567,7 @@
     return a;
 }
 
 void FolderMan::setupLegacyFolder(const QString &fileNamePath, AccountState *accountState)
 {
     qCInfo(lcFolderMan) << "  ` -> setting up:" << fileNamePath;
     QString escapedFileNamePath(fileNamePath);
@@ -602,7 +602,7 @@
         return;
     }
 
     auto migrateFoldersGroup = [&](const QString &folderGroupName) {
         const auto childGroups = settings.childGroups();
         if (childGroups.isEmpty()) {
             qCDebug(lcFolderMan) << "There are no" << folderGroupName << "to migrate from account" <<  accountState->account()->id();
@@ -682,7 +682,7 @@
                 legacyBlacklist << settings.value(QLatin1String("blackList")).toStringList();
                 if (!legacyBlacklist.isEmpty()) {
                     qCInfo(lcFolderMan) << "Legacy selective sync list found:" << legacyBlacklist;
                     for (const auto &legacyFolder : std::as_const(legacyBlacklist)) {
                         folder->migrateBlackListPath(legacyFolder);
                     }
                     settings.remove(QLatin1String("blackList"));
@@ -745,7 +745,7 @@
 
 void FolderMan::slotFolderCanSyncChanged()
 {
     auto folder = qobject_cast<Folder *>(sender());
     ASSERT(folder);
     if (folder->canSync()) {
         _socketApi->slotRegisterPath(folder->alias());
@@ -1046,7 +1046,7 @@
 void FolderMan::slotStartScheduledFolderSync()
 {
     if (isAnySyncRunning()) {
         for (auto f : std::as_const(_folderMap)) {
             if (f->isSyncRunning())
                 qCInfo(lcFolderMan) << "Currently folder " << f->remoteUrl().toString() << " is running, wait for finish!";
         }
@@ -1087,7 +1087,7 @@
     }
 }
 
 bool FolderMan::pushNotificationsFilesReady(const AccountPtr &account)
 {
     const auto pushNotifications = account->pushNotifications();
     const auto pushFilesAvailable = account->capabilities().availablePushNotifications() & PushNotificationType::Files;
@@ -1109,6 +1109,13 @@
     return result;
 }
 
+#ifdef BUILD_FILE_PROVIDER_MODULE
+bool FolderMan::canPollFileProviderEtag(const AccountState &accountState)
+{
+    return accountState.isConnected();
+}
+#endif
+
 void FolderMan::slotEtagPollTimerTimeout()
 {
     qCInfo(lcFolderMan) << "Etag poll timer timeout";
@@ -1120,10 +1127,10 @@
     QList<Folder *> foldersToRun;
 
     // Some folders need not to be checked because they use the push notifications
     std::copy_if(folderMapValues.begin(), folderMapValues.end(), std::back_inserter(foldersToRun), [this](Folder *folder) -> bool {
         const auto account = folder->accountState()->account();
         return !pushNotificationsFilesReady(account);
     });
 
     qCInfo(lcFolderMan) << "Number of folders that don't use push notifications:" << foldersToRun.size();
 
@@ -1139,6 +1146,11 @@
     for (const auto &accountState : accounts) {
         const auto account = accountState->account();
 
+        if (!canPollFileProviderEtag(*accountState)) {
+            qCDebug(lcFolderMan) << "Account" << account->displayName() << "is not connected, skipping File Provider ETag check.";
+            continue;
+        }
+
         // Skip accounts that don't have a File Provider domain
         if (!Mac::FileProvider::instance()->domainManager()->domainForAccount(account.data())) {
             qCDebug(lcFolderMan) << "Account" << account->displayName() << "has no file provider domain, skipping.";
@@ -1425,9 +1437,9 @@
     // Migration: The first account that's configured for a local folder shall
     // be saved in a backwards-compatible way.
     const auto folderList = FolderMan::instance()->map();
     const auto oneAccountOnly = std::none_of(folderList.cbegin(), folderList.cend(), [folder](const auto *other) {
         return other != folder && other->cleanPath() == folder->cleanPath();
     });
 
     folder->setSaveBackwardsCompatible(oneAccountOnly);
 
@@ -1494,10 +1506,10 @@
     QString absolutePath = QDir::cleanPath(path) + QLatin1Char('/');
 
     const auto folders = this->map().values();
     const auto it = std::find_if(folders.cbegin(), folders.cend(), [absolutePath](const auto *folder) {
         const QString folderPath = folder->cleanPath() + QLatin1Char('/');
         return absolutePath.startsWith(folderPath, (Utility::isWindows() || Utility::isMac()) ? Qt::CaseInsensitive : Qt::CaseSensitive);
     });
 
     return it != folders.cend() ? *it : nullptr;
 }
@@ -1560,7 +1572,7 @@
     return re;
 }
 
 void FolderMan::removeFolder(Folder *folderToRemove)
 {
     if (!folderToRemove) {
         qCCritical(lcFolderMan) << "Can not remove null folder";
@@ -1596,7 +1608,7 @@
         // Let the folder delete itself when done.
         connect(folderToRemove, &Folder::syncFinished, folderToRemove, &QObject::deleteLater);
     } else {
         delete folderToRemove;
     }
 
 #ifdef Q_OS_WIN
@@ -1641,7 +1653,7 @@
         f->wipeForRemoval();
 
         // wipe data
         QDir userFolder(f->path());
         if (userFolder.exists()) {
             success = FileSystem::removeRecursively(f->path());
             if (!success) {
@@ -1719,8 +1731,8 @@
         const auto filePathRelative = Utility::noLeadingSlashPath(QString(localFileNoTrailingSlash).remove(folder->path()));
 
         SyncJournalFileRecord rec;
         if (folder->journalDb()->getFileRecord(filePathRelative, &rec)
             && rec.isValid() && rec.isE2eEncrypted()) {
             qCWarning(lcFolderMan) << "You cannot remove yourself from an encrypted share";
             return;
         }
@@ -1741,17 +1753,17 @@
     const auto leaveShareJob = new SimpleApiJob(folder->accountState()->account(), folder->accountState()->account()->davPath() + filePathRelative);
     leaveShareJob->setVerb(SimpleApiJob::Verb::Delete);
     leaveShareJob->addRawHeader("e2e-token", folderToken);
     connect(leaveShareJob, &SimpleApiJob::resultReceived, this, [this, folder, localFile](int statusCode) {
         qCDebug(lcFolderMan) << "slotLeaveShare callback statusCode" << statusCode;
         Q_UNUSED(statusCode);
         scheduleFolder(folder);
     });
     leaveShareJob->start();
 }
 
 void FolderMan::trayOverallStatus(const QList<Folder *> &folders,
                                   SyncResult::Status *status,
                                   bool *unresolvedConflicts,
                                   ProgressInfo **const overallProgressInfo)
 {
     *status = SyncResult::Undefined;
@@ -1854,7 +1866,7 @@
     }
 }
 
 QString FolderMan::trayTooltipStatusString(SyncResult::Status syncStatus, bool hasUnresolvedConflicts, bool paused, ProgressInfo *const progress)
 {
     QString folderMessage;
     switch (syncStatus) {
@@ -1867,13 +1879,13 @@
     case SyncResult::SyncPrepare:
         folderMessage = tr("Preparing for sync.");
         break;
     case SyncResult::SyncRunning:
         if (progress && progress->status() == ProgressInfo::Propagation) {
             const auto estimatedEta = progress->totalProgress().estimatedEta;
             if (progress->totalSize() == 0) {
                 qint64 currentFile = progress->currentFile();
                 qint64 totalFileCount = qMax(progress->totalFiles(), currentFile);
                 if (progress->trustEta()) {
                     if (estimatedEta == 0) {
                         folderMessage = tr("Syncing %1 of %2 (A few seconds left)").arg(currentFile).arg(totalFileCount);
                     } else {
@@ -1885,7 +1897,7 @@
                 }
             } else {
                 QString totalSizeStr = Utility::octetsToString(progress->totalSize());
                 if (progress->trustEta()) {
                     if (estimatedEta == 0) {
                         folderMessage = tr("Syncing %1 (A few seconds left)").arg(totalSizeStr);
                     } else {
@@ -1943,7 +1955,7 @@
 
     if (!FileSystem::fileExists(path)) {
         QString parentPath = selFile.dir().path();
         if (parentPath != path) {
             return checkPathValidityRecursive(parentPath);
         }
 
@@ -2147,7 +2159,7 @@
 {
     qCDebug(lcFolderMan) << "received notify_file push notification account=" << account->displayName();
 
     for (auto folder : std::as_const(_folderMap)) {
         // Just run on the folders that belong to this account
         if (folder->accountState()->account() != account) {
             continue;
@@ -2158,11 +2170,11 @@
     }
 }
 
 void FolderMan::slotProcessFileIdsPushNotification(Account *account, const QList<qint64> &fileIds)
 {
     qCDebug(lcFolderMan).nospace() << "received notify_file_id push notification account=" << account->displayName() << " fileIds=" << fileIds;
 
     for (auto folder : std::as_const(_folderMap)) {
         // Just run on the folders that belong to this account
         if (folder->accountState()->account() != account) {
             continue;
@@ -2189,7 +2201,7 @@
     }
 }
 
 bool FolderMan::checkVfsAvailability(const QString &path, Vfs::Mode mode) const
 {
     return unsupportedConfiguration(path) && Vfs::checkAvailability(path, mode);
 }

src/gui/folderman.h

@@ -7,7 +7,7 @@
 #ifndef FOLDERMAN_H
 #define FOLDERMAN_H
 
 #include <QByteArray>
 #include <QObject>
 #include <QQueue>
 #include <QList>
@@ -36,7 +36,7 @@
 class SyncResult;
 class SocketApi;
 class LockWatcher;
 class UpdateE2eeFolderUsersMetadataJob;
 
 /**
  * @brief The FolderMan class
@@ -228,10 +228,10 @@
     /** removes current user from the share **/
     void leaveShare(const QString &localFile);
 
     /** Whether or not vfs is supported in the location. */
     [[nodiscard]] bool checkVfsAvailability(const QString &path, Vfs::Mode mode = bestAvailableVfsMode()) const;
 
     /** If the folder configuration is no longer supported this will return an error string */
     [[nodiscard]] Result<void, QString> unsupportedConfiguration(const QString &path) const;
 signals:
     /**
@@ -328,7 +328,7 @@
 
     void slotSetupPushNotifications(const OCC::Folder::Map &);
     void slotProcessFilesPushNotification(OCC::Account *account);
     void slotProcessFileIdsPushNotification(OCC::Account *account, const QList<qint64> &fileIds);
     void slotConnectToPushNotifications(const OCC::AccountPtr &account);
 
     void slotLeaveShare(const QString &localFile, const QByteArray &folderToken = {});
@@ -357,6 +357,11 @@
     void runEtagJobsIfPossible(const QList<Folder *> &folderMap);
     void runEtagJobIfPossible(Folder *folder);
 
+#ifdef BUILD_FILE_PROVIDER_MODULE
+    /** @brief Returns whether the account state permits File Provider ETag polling. */
+    [[nodiscard]] static bool canPollFileProviderEtag(const AccountState &accountState);
+#endif
+
     bool pushNotificationsFilesReady(const OCC::AccountPtr &account);
 
     [[nodiscard]] bool isSwitchToVfsNeeded(const FolderDefinition &folderDefinition) const;

test/testfolderman.cpp

@@ -1,3 +1,3 @@
 /*
  * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  * SPDX-FileCopyrightText: 2016 ownCloud GmbH
@@ -8,7 +8,7 @@
  * any purpose.
  */
 
 #include <qglobal.h>
 #include <QTemporaryDir>
 #include <QtTest>
 
@@ -609,6 +609,30 @@
     }
 
 #ifdef BUILD_FILE_PROVIDER_MODULE
+    void testFileProviderEtagPollingRequiresConnectedAccount()
+    {
+        const auto accountState = std::make_unique<FakeAccountState>(Account::create());
+        QVERIFY(FolderMan::canPollFileProviderEtag(*accountState));
+
+        const auto disconnectedStates = {
+            AccountState::SignedOut,
+            AccountState::Disconnected,
+            AccountState::ServiceUnavailable,
+            AccountState::RedirectDetected,
+            AccountState::MaintenanceMode,
+            AccountState::NetworkError,
+            AccountState::ConfigurationError,
+            AccountState::AskingCredentials,
+            AccountState::NeedToSignTermsOfService,
+        };
+
+        for (const auto state : disconnectedStates) {
+            accountState->setStateForTesting(state);
+            QVERIFY2(!FolderMan::canPollFileProviderEtag(*accountState),
+                qPrintable(AccountState::stateString(state)));
+        }
+    }
+
     void testAddFolderRefusedWhenFileProviderModeEnabled()
     {
         _fm.reset({});