Merge pull request #10500 from nextcloud/bugfix/10464/isFileLocked

fix(discovery): move file lock state off the GUI thread.

Author: nilsding

src/libsync/discovery.cpp

@@ -353,7 +353,8 @@ bool ProcessDirectoryJob::handleExcluded(const QString &path, const Entries &ent
         }
     }
 
-    if (excluded == CSYNC_NOT_EXCLUDED && OCC::FileSystem::isFileLocked(_discoveryData->_localDir + path, OCC::FileSystem::LockMode::SharedRead) &&
+    // Lock state was accessed off the GUI thread during discovery, so this read cannot block
+    if (excluded == CSYNC_NOT_EXCLUDED && entries.localEntry.isLocked &&
         (!entries.dbEntry.isValid() || !entries.serverEntry.isValid() || entries.serverEntry.etag == entries.dbEntry._etag)) {
         qCInfo(lcDisco) << _discoveryData->_localDir + path << "is locked" << "exluding it from sync";
         excluded = CSYNC_FILE_LOCKED_SILENTLY_EXCLUDED;

src/libsync/discoveryphase.cpp

@@ -17,6 +17,7 @@
 
 #include "common/asserts.h"
 #include "common/checksums.h"
+#include "common/filesystembase.h"
 
 #include <csync_exclude.h>
 #include "vio/csync_vio_local.h"
@@ -403,6 +404,14 @@ void DiscoverySingleLocalDirectoryJob::run() {
         i.isMetadataMissing = dirent->is_metadata_missing;
         i.isPermissionsInvalid = dirent->isPermissionsInvalid;
         i.type = dirent->type;
+
+        // Access lock state on the worker thread so a blocking open cannot freeze the GUI #10464
+        if (!i.isSymLink && !i.isVirtualFile && !i.isDirectory) {
+            const auto absoluteLocalPath = localPath + QLatin1Char('/') + i.name;
+            i.isLocked = FileSystem::isFileLocked(absoluteLocalPath, FileSystem::LockMode::SharedRead);
+            qCDebug(lcDiscovery) << "File" << absoluteLocalPath << "isLocked" << i.isLocked;
+        }
+
         results.push_back(i);
     }
     if (errno != 0) {

src/libsync/discoveryphase.h

@@ -64,6 +64,7 @@ struct LocalInfo
     bool isSymLink = false;
     bool isMetadataMissing = false;
     bool isPermissionsInvalid = false;
+    bool isLocked = false;
     [[nodiscard]] bool isValid() const { return !name.isNull(); }
 };
 

test/testlockedfiles.cpp

@@ -14,6 +14,8 @@
 #include "lockwatcher.h"
 #include <syncengine.h>
 #include <localdiscoverytracker.h>
+#include "discoveryphase.h"
+#include <QThreadPool>
 
 using namespace OCC;
 
@@ -130,6 +132,43 @@ private slots:
     }
 
 #ifdef Q_OS_WIN
+    void testLockDetectionUsesRealFileSystemCheck()
+    {
+        // Regression guard for #10464: exercise the real FileSystem::isFileLocked path
+        QTemporaryDir tmp;
+        QVERIFY(tmp.isValid());
+        for (const auto &name : { QStringLiteral("locked.bin"), QStringLiteral("test.txt") }) {
+            QFile tmpFile(tmp.filePath(name));
+            QVERIFY(tmpFile.open(QIODevice::WriteOnly));
+            tmpFile.write("x");
+        }
+        QVERIFY(QDir(tmp.path()).mkdir(QStringLiteral("subdir")));
+
+        auto handle = makeHandle(tmp.filePath(QStringLiteral("locked.bin")), 0);
+        QVERIFY(handle != INVALID_HANDLE_VALUE);
+
+        const auto job = new DiscoverySingleLocalDirectoryJob({}, tmp.path(), nullptr, false);
+        QSignalSpy finishedSpy(job, &DiscoverySingleLocalDirectoryJob::finished);
+        QThreadPool::globalInstance()->start(job);
+        QTRY_COMPARE_WITH_TIMEOUT(finishedSpy.count(), 1, 5000);
+
+        CloseHandle(handle);
+
+        const auto results = finishedSpy.takeFirst().at(0).value<QVector<OCC::LocalInfo>>();
+        QCOMPARE(results.size(), 3);
+        for (const auto &info : results) {
+            if (info.name == QStringLiteral("locked.bin")) {
+                QVERIFY(info.isLocked);
+                continue;
+            }
+
+            QVERIFY(!info.isLocked);
+            if (info.name == QStringLiteral("subdir")) {
+                QVERIFY(info.isDirectory);
+            }
+        }
+    }
+
     void testDirectoryLockChecks()
     {
         QTemporaryDir tmp;