[stable-3.13] Feature/office files lock newly created. Plus refactoring.

src/gui/folder.cpp

@@ -13,7 +13,7 @@
  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  * for more details.
  */
 #include "common/syncjournaldb.h"
 #include "config.h"
 
 #include "account.h"
@@ -1598,6 +1598,7 @@
     connect(_folderWatcher.data(), &FolderWatcher::filesLockImposed, this, &Folder::slotFilesLockImposed, Qt::UniqueConnection);
     _folderWatcher->init(path());
     _folderWatcher->startNotificatonTest(path() + QLatin1String(".nextcloudsync.log"));
+    connect(_engine.data(), &SyncEngine::lockFileDetected, _folderWatcher.data(), &FolderWatcher::slotLockFileDetectedExternally);
 }
 
 void Folder::disconnectFolderWatcher()

src/gui/folderwatcher.cpp

@@ -41,34 +41,7 @@
 
 namespace
 {
-const std::array<const char *, 2> lockFilePatterns = {{".~lock.", "~$"}};
-
 constexpr auto lockChangeDebouncingTimerIntervalMs = 500;
-
-QString filePathLockFilePatternMatch(const QString &path)
-{
-    qCDebug(OCC::lcFolderWatcher) << "Checking if it is a lock file:" << path;
-
-    const auto pathSplit = path.split(QLatin1Char('/'), Qt::SkipEmptyParts);
-    if (pathSplit.isEmpty()) {
-        return {};
-    }
-    QString lockFilePatternFound;
-    for (const auto &lockFilePattern : lockFilePatterns) {
-        if (pathSplit.last().startsWith(lockFilePattern)) {
-            lockFilePatternFound = lockFilePattern;
-            break;
-        }
-    }
-
-    if (lockFilePatternFound.isEmpty()) {
-        return {};
-    }
-
-    qCDebug(OCC::lcFolderWatcher) << "Found a lock file with prefix:" << lockFilePatternFound << "in path:" << path;
-    return lockFilePatternFound;
-}
-
 }
 
 namespace OCC {
@@ -185,7 +158,23 @@
 #endif
 }
 
+void FolderWatcher::slotLockFileDetectedExternally(const QString &lockFile)
+{
+    qCInfo(lcFolderWatcher) << "Lock file detected externally, probably a newly-uploaded office file: " << lockFile;
+    changeDetected(lockFile);
+}
+
+void FolderWatcher::setShouldWatchForFileUnlocking(bool shouldWatchForFileUnlocking)
+{
+    _shouldWatchForFileUnlocking = shouldWatchForFileUnlocking;
+}
+
+int FolderWatcher::lockChangeDebouncingTimout() const
+{
+    return _lockChangeDebouncingTimer.interval();
+}
+
 void FolderWatcher::changeDetected(const QString &path)
 {
     QFileInfo fileInfo(path);
     QStringList paths(path);
@@ -220,17 +209,17 @@
             _testNotificationPath.clear();
         }
 
-        const auto lockFileNamePattern = filePathLockFilePatternMatch(path);
-        const auto checkResult = lockFileTargetFilePath(path,lockFileNamePattern);
+        const auto lockFileNamePattern = FileSystem::filePathLockFilePatternMatch(path);
+        const auto checkResult = FileSystem::lockFileTargetFilePath(path, lockFileNamePattern);
         if (_shouldWatchForFileUnlocking) {
             // Lock file has been deleted, file now unlocked
-            if (checkResult.type == FileLockingInfo::Type::Unlocked && !checkResult.path.isEmpty()) {
+            if (checkResult.type == FileSystem::FileLockingInfo::Type::Unlocked && !checkResult.path.isEmpty()) {
                 _lockedFiles.remove(checkResult.path);
                 _unlockedFiles.insert(checkResult.path);
             }
         }
 
-        if (checkResult.type == FileLockingInfo::Type::Locked && !checkResult.path.isEmpty()) {
+        if (checkResult.type == FileSystem::FileLockingInfo::Type::Locked && !checkResult.path.isEmpty()) {
             _unlockedFiles.remove(checkResult.path);
             _lockedFiles.insert(checkResult.path);
         }
@@ -272,62 +261,4 @@
     _shouldWatchForFileUnlocking = _folder->accountState()->account()->capabilities().filesLockAvailable();
 }
 
-FolderWatcher::FileLockingInfo FolderWatcher::lockFileTargetFilePath(const QString &path, const QString &lockFileNamePattern) const
-{
-    FileLockingInfo result;
-
-    if (lockFileNamePattern.isEmpty()) {
-        return result;
-    }
-
-    const auto lockFilePathWithoutPrefix = QString(path).replace(lockFileNamePattern, QStringLiteral(""));
-    auto lockFilePathWithoutPrefixSplit = lockFilePathWithoutPrefix.split(QLatin1Char('.'));
-
-    if (lockFilePathWithoutPrefixSplit.size() < 2) {
-        return result;
-    }
-
-    auto extensionSanitized = lockFilePathWithoutPrefixSplit.takeLast().toStdString();
-    // remove possible non-alphabetical characters at the end of the extension
-    extensionSanitized.erase(
-        std::remove_if(extensionSanitized.begin(), extensionSanitized.end(), [](const auto &ch) {
-            return !std::isalnum(ch);
-        }),
-        extensionSanitized.end()
-    );
-
-    lockFilePathWithoutPrefixSplit.push_back(QString::fromStdString(extensionSanitized));
-    const auto lockFilePathWithoutPrefixNew = lockFilePathWithoutPrefixSplit.join(QLatin1Char('.'));
-
-    qCDebug(lcFolderWatcher) << "Assumed locked/unlocked file path" << lockFilePathWithoutPrefixNew << "Going to try to find matching file";
-    auto splitFilePath = lockFilePathWithoutPrefixNew.split(QLatin1Char('/'));
-    if (splitFilePath.size() > 1) {
-        const auto lockFileNameWithoutPrefix = splitFilePath.takeLast();
-        // some software will modify lock file name such that it does not correspond to original file (removing some symbols from the name, so we will search
-        // for a matching file
-        result.path = findMatchingUnlockedFileInDir(splitFilePath.join(QLatin1Char('/')), lockFileNameWithoutPrefix);
-    }
-
-    if (result.path.isEmpty() || !QFile::exists(result.path)) {
-        result.path.clear();
-        return result;
-    }
-    result.type = QFile::exists(path) ? FileLockingInfo::Type::Locked : FileLockingInfo::Type::Unlocked;
-    return result;
-}
-
-QString FolderWatcher::findMatchingUnlockedFileInDir(const QString &dirPath, const QString &lockFileName) const
-{
-    QString foundFilePath;
-    const QDir dir(dirPath);
-    const auto entryList = dir.entryInfoList(QDir::Files);
-    for (const auto &candidateUnlockedFileInfo : entryList) {
-        if (candidateUnlockedFileInfo.fileName().contains(lockFileName)) {
-            foundFilePath = candidateUnlockedFileInfo.absoluteFilePath();
-            break;
-        }
-    }
-    return foundFilePath;
-}
-
 } // namespace OCC

src/gui/folderwatcher.h

@@ -15,7 +15,7 @@
 #ifndef MIRALL_FOLDERWATCHER_H
 #define MIRALL_FOLDERWATCHER_H
 
 #include "config.h"
 
 #include <QList>
 #include <QLoggingCategory>
@@ -50,12 +50,6 @@
 {
     Q_OBJECT
 
-    struct FileLockingInfo {
-        enum class Type { Unset = -1, Locked, Unlocked };
-        QString path;
-        Type type = Type::Unset;
-    };
-
 public:
     // Construct, connect signals, call init()
     explicit FolderWatcher(Folder *folder = nullptr);
@@ -86,6 +80,11 @@
     /// For testing linux behavior only
     [[nodiscard]] int testLinuxWatchCount() const;
 
+    void slotLockFileDetectedExternally(const QString &lockFile);
+
+    void setShouldWatchForFileUnlocking(bool shouldWatchForFileUnlocking);
+    [[nodiscard]] int lockChangeDebouncingTimout() const;
+
 signals:
     /** Emitted when one of the watched directories or one
      *  of the contained files is changed. */
@@ -101,8 +100,6 @@
      */
     void filesLockImposed(const QSet<QString> &files);
 
-    void lockFilesFound(const QSet<QString> &files);
-
     void lockedFilesFound(const QSet<QString> &files);
 
     /**
@@ -145,11 +142,6 @@
 
     void appendSubPaths(QDir dir, QStringList& subPaths);
 
-    [[nodiscard]] FileLockingInfo lockFileTargetFilePath(const QString &path, const QString &lockFileNamePattern) const;
-    [[nodiscard]] QString findMatchingUnlockedFileInDir(const QString &dirPath, const QString &lockFileName) const;
-
-    QString findMatchingUnlockedFileInDir(const QString &dirPath, const QString &lockFileName);
-
     /* Check if the path should be ignored by the FolderWatcher. */
     [[nodiscard]] bool pathIsIgnored(const QString &path) const;
 

src/libsync/filesystem.cpp

@@ -1,4 +1,4 @@
 /*
  * Copyright (C) by Daniel Molkentin <[email protected]>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -25,12 +25,132 @@
 #include <QDirIterator>
 #include <QCoreApplication>
 
+#include <array>
+#include <string_view>
+
 #ifdef Q_OS_WIN
 #include <securitybaseapi.h>
 #include <sddl.h>
 #endif
 
+namespace
+{
+constexpr std::array<const char *, 2> lockFilePatterns = {{".~lock.", "~$"}};
+constexpr std::array<std::string_view, 8> officeFileExtensions = {"doc", "docx", "xls", "xlsx", "ppt", "pptx", "odt", "odp"};
+// iterates through the dirPath to find the matching fileName
+QString findMatchingUnlockedFileInDir(const QString &dirPath, const QString &lockFileName)
+{
+    QString foundFilePath;
+    const QDir dir(dirPath);
+    const auto entryList = dir.entryInfoList(QDir::Files);
+    for (const auto &candidateUnlockedFileInfo : entryList) {
+        const auto candidateUnlockFileName = candidateUnlockedFileInfo.fileName();
+        const auto lockFilePatternFoundIt = std::find_if(std::cbegin(lockFilePatterns), std::cend(lockFilePatterns), [&candidateUnlockFileName](std::string_view pattern) {
+            return candidateUnlockFileName.contains(QString::fromStdString(std::string(pattern)));
+        });
+        if (lockFilePatternFoundIt != std::cend(lockFilePatterns)) {
+            continue;
+        }
+        if (candidateUnlockFileName.contains(lockFileName)) {
+            foundFilePath = candidateUnlockedFileInfo.absoluteFilePath();
+            break;
+        }
+    }
+    return foundFilePath;
+}
+}
+
 namespace OCC {
+
+QString FileSystem::filePathLockFilePatternMatch(const QString &path)
+{
+    qCDebug(OCC::lcFileSystem) << "Checking if it is a lock file:" << path;
+
+    const auto pathSplit = path.split(QLatin1Char('/'), Qt::SkipEmptyParts);
+    if (pathSplit.isEmpty()) {
+        return {};
+    }
+    QString lockFilePatternFound;
+    for (const auto &lockFilePattern : lockFilePatterns) {
+        if (pathSplit.last().startsWith(lockFilePattern)) {
+            lockFilePatternFound = lockFilePattern;
+            break;
+        }
+    }
+
+    if (!lockFilePatternFound.isEmpty()) {
+        qCDebug(OCC::lcFileSystem) << "Found a lock file with prefix:" << lockFilePatternFound << "in path:" << path;
+    }
+
+    return lockFilePatternFound;
+}
+
+bool FileSystem::isMatchingOfficeFileExtension(const QString &path)
+{
+    const auto pathSplit = path.split(QLatin1Char('.'));
+    const auto extension = pathSplit.size() > 1 ? pathSplit.last().toStdString() : std::string{};
+    return std::find(std::cbegin(officeFileExtensions), std::cend(officeFileExtensions), extension) != std::cend(officeFileExtensions);
+}
+
+FileSystem::FileLockingInfo FileSystem::lockFileTargetFilePath(const QString &lockFilePath, const QString &lockFileNamePattern)
+{
+    FileLockingInfo result;
+
+    if (lockFileNamePattern.isEmpty()) {
+        return result;
+    }
+
+    const auto lockFilePathWithoutPrefix = QString(lockFilePath).replace(lockFileNamePattern, QStringLiteral(""));
+    auto lockFilePathWithoutPrefixSplit = lockFilePathWithoutPrefix.split(QLatin1Char('.'));
+
+    if (lockFilePathWithoutPrefixSplit.size() < 2) {
+        return result;
+    }
+
+    auto extensionSanitized = lockFilePathWithoutPrefixSplit.takeLast().toStdString();
+    // remove possible non-alphabetical characters at the end of the extension
+    extensionSanitized.erase(std::remove_if(extensionSanitized.begin(),
+                                            extensionSanitized.end(),
+                                            [](const auto &ch) {
+                                                return !std::isalnum(ch);
+                                            }),
+                             extensionSanitized.end());
+
+    lockFilePathWithoutPrefixSplit.push_back(QString::fromStdString(extensionSanitized));
+    const auto lockFilePathWithoutPrefixNew = lockFilePathWithoutPrefixSplit.join(QLatin1Char('.'));
+
+    qCDebug(lcFileSystem) << "Assumed locked/unlocked file path" << lockFilePathWithoutPrefixNew << "Going to try to find matching file";
+    auto splitFilePath = lockFilePathWithoutPrefixNew.split(QLatin1Char('/'));
+    if (splitFilePath.size() > 1) {
+        const auto lockFileNameWithoutPrefix = splitFilePath.takeLast();
+        // some software will modify lock file name such that it does not correspond to original file (removing some symbols from the name, so we will
+        // search for a matching file
+        result.path = findMatchingUnlockedFileInDir(splitFilePath.join(QLatin1Char('/')), lockFileNameWithoutPrefix);
+    }
+
+    if (result.path.isEmpty() || !QFile::exists(result.path)) {
+        result.path.clear();
+        return result;
+    }
+    result.type = QFile::exists(lockFilePath) ? FileLockingInfo::Type::Locked : FileLockingInfo::Type::Unlocked;
+    return result;
+}
+
+QStringList FileSystem::findAllLockFilesInDir(const QString &dirPath)
+{
+    QStringList results;
+    const QDir dir(dirPath);
+    const auto entryList = dir.entryInfoList(QDir::Files | QDir::Hidden | QDir::NoDotAndDotDot);
+    for (const auto &candidateLockFile : entryList) {
+        const auto filePath = candidateLockFile.filePath();
+        const auto isLockFile = !filePathLockFilePatternMatch(filePath).isEmpty();
+        if (isLockFile) {
+            results.push_back(filePath);
+        }
+    }
+
+    return results;
+}
 
 bool FileSystem::fileEquals(const QString &fn1, const QString &fn2)
 {

src/libsync/filesystem.h

@@ -1,4 +1,4 @@
 /*
  * Copyright (C) by Olivier Goffart <[email protected]>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -14,12 +14,13 @@
 
 #pragma once
 
 #include "config.h"
 
 #include "owncloudlib.h"
 #include "common/filesystembase.h"
 
 #include <QString>
+#include <QStringList>
 
 #include <ctime>
 #include <functional>
@@ -42,6 +43,20 @@
  * @brief This file contains file system helper
  */
 namespace FileSystem {
+    struct OWNCLOUDSYNC_EXPORT FileLockingInfo {
+        enum class Type { Unset = -1, Locked, Unlocked };
+        QString path;
+        Type type = Type::Unset;
+    };
+
+    // match file path with lock pattern
+    QString OWNCLOUDSYNC_EXPORT filePathLockFilePatternMatch(const QString &path);
+    // check if it is an office file (by extension), ONLY call it for files
+    bool OWNCLOUDSYNC_EXPORT isMatchingOfficeFileExtension(const QString &path);
+    // finds and fetches FileLockingInfo for the corresponding file that we are locking/unlocking
+    FileLockingInfo OWNCLOUDSYNC_EXPORT lockFileTargetFilePath(const QString &lockFilePath, const QString &lockFileNamePattern);
+    // lists all files matching a lockfile pattern in dirPath
+    QStringList OWNCLOUDSYNC_EXPORT findAllLockFilesInDir(const QString &dirPath);
 
     /**
      * @brief compare two files with given filename and return true if they have the same content