feat: search db for matching original filename based on the lock filename.

Signed-off-by: Camila Ayres <hello@camilasan.com>

Author: camilasan

Sources/NextcloudFileProviderKit/Database/FilesDatabaseManager.swift

@@ -661,4 +661,20 @@ public final class FilesDatabaseManager: Sendable {
 
         return (updated, deleted)
     }
+    
+    public func itemsMetadataFromPattern(
+        pattern: String
+    ) -> [SendableItemMetadata]? {
+        logger.debug("Trying to find files matching pattern \(pattern)")
+        let results = itemMetadatas.where { $0.fileName.ends(with: pattern) && !$0.directory }
+        guard !results.isEmpty else {
+            logger.debug("Could not find files matching pattern \(pattern)")
+            return nil
+        }
+        
+        let filesMetadata = results.toUnmanagedResults()
+        logger.debug("Found \(filesMetadata.count) file(s) that match \(pattern) metadata: \(filesMetadata)")
+        return filesMetadata
+    }
+    
 }

Sources/NextcloudFileProviderKit/Item/Item+LockFile.swift

@@ -78,7 +78,7 @@ extension Item {
 
         logger.info("Item to create is a lock file. Will attempt to lock the associated file on the server.", [.name: itemTemplate.filename])
 
-        guard let targetFileName = originalFileName(fromLockFileName: itemTemplate.filename) else {
+        guard let targetFileName = originalFileName(fromLockFileName: itemTemplate.filename, dbManager: dbManager) else {
             logger.error("Will not lock the target file because it could not be determined based on the lock file name.", [.name: itemTemplate.filename])
             return (nil, nil)
         }
@@ -235,8 +235,9 @@ extension Item {
 
         dbManager.deleteItemMetadata(ocId: metadata.ocId)
 
-        guard let originalFileName = originalFileName(fromLockFileName: metadata.fileName) else {
+        guard let originalFileName = originalFileName(fromLockFileName: metadata.fileName, dbManager: dbManager) else {
             logger.error("Could not get original filename from lock file filename so will not unlock target file.", [.name: self.metadata.fileName])
+
             return nil
         }
 

Sources/NextcloudFileProviderKit/Utilities/LocalFiles.swift

@@ -51,23 +51,49 @@ public func isLockFileName(_ filename: String) -> Bool {
 ///
 /// Example for Microsoft Office: `MyDoc.docx` is extracted from `~$MyDoc.docx`.
 /// Example for LibreOffice: `MyDoc.odt` is extracted from `.~lock.MyDoc.odt#`.
-/// 
+/// Filename with <8 characters: Test.docx → lock file: ~$Test.docx
+/// Filename with >8 characters: Document.docx → lock file: ~$cument.docx
+/// Filename sandbox-style temporary naming like: Welcome123456.doc.sb-d215eb53-IBAwfU
 /// - Returns: Either the original file name parsed from the given lock file name or `nil`, if it is not a recognized lock file format.
 ///
-public func originalFileName(fromLockFileName lockFilename: String) -> String? {
+public func originalFileName(fromLockFileName lockFilename: String, dbManager: FilesDatabaseManager) -> String? {
+    let logger = FileProviderLogger(category: "localfileutils", log: dbManager.logger.log)
+    logger.debug("Called originalFileName with lock filename: \(lockFilename)")
+
+    var targetFilePattern = lockFilename
     if lockFilename.hasPrefix("~$") {
-        // Remove the "~$" prefix
         let index = lockFilename.index(lockFilename.startIndex, offsetBy: 2)
-        return String(lockFilename[index...])
+        targetFilePattern = String(lockFilename[index...])
     }
 
     if lockFilename.hasPrefix(".~lock.") && lockFilename.hasSuffix("#") {
-        // Strip the prefix and suffix
         let start = lockFilename.index(lockFilename.startIndex, offsetBy: 7)
         let end = lockFilename.index(before: lockFilename.endIndex)
-        return String(lockFilename[start..<end])
+        targetFilePattern = String(lockFilename[start..<end])
     }
+    
+    if let sbRange = lockFilename.range(of: ".sb-") {
+        targetFilePattern = String(lockFilename[..<sbRange.lowerBound])
+    }
+
+    logger.debug("Target filename is: \(targetFilePattern)")
 
-    // Not a recognized lock file
+    guard let itemsMatchingMetadata = dbManager.itemsMetadataFromPattern(pattern: targetFilePattern) else {
+        logger.debug("Could not find files in db matching pattern: \(targetFilePattern)")
+        return targetFilePattern
+    }
+    
+    for file in itemsMatchingMetadata {
+        let potentialOriginalFile = file.fileName
+        
+        if lockFilename == potentialOriginalFile {
+            logger.debug("Lock filename \(lockFilename) is the same as filename found in db \(potentialOriginalFile)")
+            continue;
+        }
+
+        logger.debug("Matched lock filename \(lockFilename) to original filename \(potentialOriginalFile)")
+        return potentialOriginalFile
+    }
+    
     return nil
 }