[KDESKTOP-1262] Do not force file status after an upload session abortion

.githooks/pre-commit

@@ -15,7 +15,7 @@ for file in ${staged_files}
 do
 	# Source file filtering is based on file extensions.
 	if [ -f "${file}" ] && [[ "${file}" =~ ^.*\.(ino|cpp|cc|c|h|hpp|hh|mm)$ ]]; then
-		clang-format -i ${file} --style="file:${GIT_DIR}/../.clang-format"
+		clang-format -i ${file} --style="file"
 		git add ${file}
 		formatting_exit_code=$?
 		if [ ${formatting_exit_code} -ne 0 ]; then

extensions/MacOSX/kDriveLiteSync/Extension/main.m

@@ -16,8 +16,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#import "../../../../src/libcommonserver/io/fileAttributes.h"
 #include "xpcService.h"
-#include "fileAttributes.h"
 
 #import <Foundation/Foundation.h>
 #import <EndpointSecurity/EndpointSecurity.h>
@@ -109,10 +109,11 @@ static BOOL processAuthOpen(const es_message_t *msg, BOOL *thumbnail)
           msg->process->signing_id.data);*/
 
     // Check file status
-    long bufferLength = getxattr([filePath UTF8String], [EXT_ATTR_STATUS UTF8String], NULL, 0, 0, 0);
+    long bufferLength = getxattr([filePath UTF8String], [@EXT_ATTR_STATUS UTF8String], NULL, 0, 0, 0);
     if (bufferLength >= 0) {
         char status[bufferLength];
-        if (getxattr([filePath UTF8String], [EXT_ATTR_STATUS UTF8String], status, bufferLength, 0, 0) != bufferLength) {
+        if (getxattr([filePath UTF8String], [@EXT_ATTR_STATUS UTF8String], status, bufferLength, 0, 0)
+            != bufferLength) {
             NSLog(@"[KD] ERROR: fgetxattr() failed for file %@: %d", filePath, errno);
             return FALSE;
         }
@@ -194,14 +195,15 @@ static BOOL processAuthRename(const es_message_t *msg)
     }
 
     // Check file status
-    long bufferLength = getxattr([filePath UTF8String], [EXT_ATTR_STATUS UTF8String], NULL, 0, 0, 0);
+    long bufferLength = getxattr([filePath UTF8String], [@EXT_ATTR_STATUS UTF8String], NULL, 0, 0, 0);
     char status[bufferLength];
     if (bufferLength >= 0) {
-        if (getxattr([filePath UTF8String], [EXT_ATTR_STATUS UTF8String], status, bufferLength, 0, 0) != bufferLength) {
+        if (getxattr([filePath UTF8String], [@EXT_ATTR_STATUS UTF8String], status, bufferLength, 0, 0)
+            != bufferLength) {
             NSLog(@"[KD] ERROR: fgetxattr() failed for file %@: %d", filePath, errno);
             return FALSE;
         }
-        
+
         if (status[0] != EXT_ATTR_STATUS_ONLINE[0]) {
             return FALSE;
         }

extensions/MacOSX/kDriveLiteSync/Extension/xpcService.h

@@ -32,21 +32,21 @@
 }
 
 @property(retain) XPCServiceProxy *_Nullable xpcServiceProxy;
-@property(retain) NSMutableDictionary<NSString *, NSMutableSet<NSString *> *> *registeredFoldersMap;
+@property(retain) NSMutableDictionary<NSString *, NSMutableSet<NSString *> *> *_Nullable registeredFoldersMap;
 
-- (BOOL)isFileMonitored:(NSString *)filePath;
+- (BOOL)isFileMonitored:(NSString *_Nonnull)filePath;
 - (void)initOpenWhiteListThumbnailSet;
 - (void)initOpenWhiteListSet;
 - (void)initOpenBlackListSet;
-- (BOOL)isAppInOpenWhiteListThumbnail:(NSString *)appSigningId;
-- (BOOL)isAppInOpenWhiteList:(NSString *)appSigningId;
-- (BOOL)matchGlob:(NSString *)string globToMatch:(NSString *)glob;
-- (BOOL)isAppInOpenBlackList:(NSString *)appSigningId filePath:(NSString *)filePath;
-- (BOOL)isAppInDefaultBlackList:(NSString *)appSigningId;
-- (void)addAppToFetchList:(NSString *)appSigningId;
-- (void)sendMessage:(NSString *)filePath query:(NSString *)verb oneApp:(BOOL)one;
-- (BOOL)fetchFile:(NSString *)filePath pid:(pid_t)pid;
-- (BOOL)fetchThumbnail:(NSString *)filePath pid:(pid_t)pid;
-- (BOOL)isDirectory:(NSString *)path error:(NSError *_Nullable *_Nullable)error;
+- (BOOL)isAppInOpenWhiteListThumbnail:(NSString *_Nonnull)appSigningId;
+- (BOOL)isAppInOpenWhiteList:(NSString *_Nonnull)appSigningId;
+- (BOOL)matchGlob:(NSString *_Nonnull)string globToMatch:(NSString *_Nonnull)glob;
+- (BOOL)isAppInOpenBlackList:(NSString *_Nonnull)appSigningId filePath:(NSString *_Nonnull)filePath;
+- (BOOL)isAppInDefaultBlackList:(NSString *_Nonnull)appSigningId;
+- (void)addAppToFetchList:(NSString *_Nonnull)appSigningId;
+- (void)sendMessage:(NSString *_Nullable)filePath query:(NSString *_Nonnull)verb oneApp:(BOOL)one;
+- (BOOL)fetchFile:(NSString *_Nonnull)filePath pid:(pid_t)pid;
+- (BOOL)fetchThumbnail:(NSString *_Nonnull)filePath pid:(pid_t)pid;
+- (BOOL)isDirectory:(NSString *_Nonnull)path error:(NSError *_Nullable *_Nullable)error;
 
 @end

src/libcommon/log/customlogwstream.h

@@ -16,8 +16,10 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 #pragma once
+
 #include <sstream>
-#include "libcommon/utility/types.h"
+
+#include <QIODevice>
 
 class CustomLogWStream : private std::wstringstream {
     public:

src/libcommonserver/CMakeLists.txt

@@ -38,7 +38,7 @@ set(libcommonserver_SRCS
 )
 
 if(APPLE)
-    list(APPEND libcommonserver_SRCS io/iohelper_mac.mm io/iohelper_mac.cpp)
+    list(APPEND libcommonserver_SRCS io/iohelper_mac.mm io/iohelper_mac.cpp io/fileAttributes.h)
     list(APPEND libcommonserver_SRCS utility/utility_mac.mm)
 elseif(WIN32)
     list(APPEND libcommonserver_SRCS io/iohelper_win.h io/iohelper_win.cpp)

extensions/MacOSX/kDriveLiteSync/Extension/fileAttributes.h → src/libcommonserver/io/fileAttributes.h

@@ -18,8 +18,8 @@
 
 #pragma once
 
-#define EXT_ATTR_STATUS @"com.infomaniak.drive.desktopclient.litesync.status"
-#define EXT_ATTR_PIN_STATE @"com.infomaniak.drive.desktopclient.litesync.pinstate"
+#define EXT_ATTR_STATUS "com.infomaniak.drive.desktopclient.litesync.status"
+#define EXT_ATTR_PIN_STATE "com.infomaniak.drive.desktopclient.litesync.pinstate"
 
 #define EXT_ATTR_STATUS_ONLINE "O"
 #define EXT_ATTR_STATUS_OFFLINE "F"

src/libcommonserver/io/iohelper.h

@@ -333,6 +333,15 @@ struct IoHelper {
          */
         static bool setXAttrValue(const SyncPath &path, const std::string &attrName, const std::string &value,
                                   IoError &ioError) noexcept;
+
+        //! Removes the value of the extended attribute with specified name for the item indicated by path.
+        /*!
+         \param path is the file system path of the item.
+         \param attrName is the name of the extended attribute to be removed.
+         \param ioError holds the error returned when an underlying OS API call fails.
+         \return true if no unexpected error occurred, false otherwise.
+         */
+        static bool removeXAttr(const SyncPath &path, const std::string &attrName, IoError &ioError) noexcept;
 #endif
 
 #ifdef _WIN32

src/libcommonserver/io/iohelper_mac.cpp

@@ -18,8 +18,8 @@
 
 #include "libcommon/utility/types.h"
 
-#include "libcommonserver/io/filestat.h"
 #include "libcommonserver/io/iohelper.h"
+#include "libcommonserver/io/fileAttributes.h"
 #include "libcommonserver/log/log.h"
 #include "libcommonserver/utility/utility.h"
 
@@ -66,20 +66,21 @@ bool IoHelper::getXAttrValue(const SyncPath &path, const std::string &attrName,
                      isSymlink ? XATTR_NOFOLLOW : 0) != bufferLength) {
             ioError = posixError2ioError(errno);
             if (ioError == IoError::ResultOutOfRange) {
-                // XAttr length has changed, retry
-                continue;
+                continue; // The extended attribute length has changed, let us retry.
             }
             return _isXAttrValueExpectedError(ioError);
         }
 
-        // XAttr has been read
         ioError = IoError::Success;
-        return true;
+
+        return true; // The extended attribute `attrName` has been read.
     }
 }
 
 bool IoHelper::setXAttrValue(const SyncPath &path, const std::string &attrName, const std::string &value,
                              IoError &ioError) noexcept {
+    ioError = IoError::Success;
+
     ItemType itemType;
     if (!getItemType(path, itemType)) {
         LOGW_WARN(logger(), L"Error in IoHelper::getItemType for " << Utility::formatIoError(path, itemType.ioError).c_str());
@@ -100,17 +101,24 @@ bool IoHelper::setXAttrValue(const SyncPath &path, const std::string &attrName,
         return _isXAttrValueExpectedError(ioError);
     }
 
-    // XAttr has been set
+    return true; // The extended attribute `attrName` has been set.
+}
+
+bool IoHelper::removeXAttr(const SyncPath &path, const std::string &attrName, IoError &ioError) noexcept {
     ioError = IoError::Success;
-    return true;
+
+    if (removexattr(path.native().c_str(), attrName.c_str(), XATTR_NOFOLLOW) == -1) {
+        ioError = posixError2ioError(errno);
+        return _isXAttrValueExpectedError(ioError);
+    }
+
+    return true; // The extended attribute `attrName` has been removed.
 }
 
 bool IoHelper::checkIfFileIsDehydrated(const SyncPath &itemPath, bool &isDehydrated, IoError &ioError) noexcept {
     isDehydrated = false;
     ioError = IoError::Success;
 
-    static const std::string EXT_ATTR_STATUS = "com.infomaniak.drive.desktopclient.litesync.status";
-
     std::string value;
     const bool result = IoHelper::getXAttrValue(itemPath.native(), EXT_ATTR_STATUS, value, ioError);
     if (!result) {

src/libcommonserver/io/iohelper_mac.mm

@@ -245,5 +245,4 @@ bool isLocked(const SyncPath &path) {
     return isLocked;
 }
 
-
 }  // namespace KDC

src/libcommonserver/utility/utility_mac.cpp

@@ -33,11 +33,6 @@ namespace KDC {
 bool setFileDates(const SyncPath &filePath, std::optional<KDC::SyncTime> creationDate,
                   std::optional<KDC::SyncTime> modificationDate, bool symlink, bool &exists);
 
-static bool init_private() {
-    return true;
-}
-
-static void makeMessage() {}
 
 bool moveItemToTrash(const SyncPath &itemPath, std::string &errorStr);
 bool preventSleeping(bool enable);

src/libsyncengine/jobs/abstractjob.h

@@ -95,6 +95,7 @@ class AbstractJob : public Poco::Runnable {
         }
 
         virtual void abort();
+        bool hasVfsForceStatusCallback() const noexcept { return _vfsForceStatus != nullptr; };
         bool isAborted() const;
 
         [[nodiscard]] inline bool bypassCheck() const { return _bypassCheck; }

src/libsyncengine/jobs/network/API_v2/upload_session/abstractuploadsession.h

@@ -20,7 +20,6 @@
 
 #include "jobs/abstractjob.h"
 #include "utility/types.h"
-#include "db/syncdb.h"
 #include "uploadsessionchunkjob.h"
 #include "uploadsessionfinishjob.h"
 #include "uploadsessionstartjob.h"

src/libsyncengine/jobs/network/API_v2/upload_session/driveuploadsession.cpp

@@ -17,6 +17,8 @@
  */
 
 #include "driveuploadsession.h"
+#include "libcommonserver/io/fileAttributes.h"
+#include "libcommonserver/io/iohelper.h"
 #include "utility/utility.h"
 
 namespace KDC {
@@ -30,15 +32,15 @@ DriveUploadSession::DriveUploadSession(int driveDbId, std::shared_ptr<SyncDb> sy
 DriveUploadSession::DriveUploadSession(int driveDbId, std::shared_ptr<SyncDb> syncDb, const SyncPath &filepath,
                                        const SyncName &filename, const NodeId &remoteParentDirId, SyncTime modtime,
                                        bool liteSyncActivated, uint64_t nbParalleleThread /*= 1*/) :
-    AbstractUploadSession(filepath, filename, nbParalleleThread), _driveDbId(driveDbId), _syncDb(syncDb), _modtimeIn(modtime),
-    _remoteParentDirId(remoteParentDirId) {
+    AbstractUploadSession(filepath, filename, nbParalleleThread),
+    _driveDbId(driveDbId), _syncDb(syncDb), _modtimeIn(modtime), _remoteParentDirId(remoteParentDirId) {
     (void) liteSyncActivated;
     _uploadSessionType = UploadSessionType::Drive;
 }
 
 DriveUploadSession::~DriveUploadSession() {
     if (_vfsForceStatus && !_vfsForceStatus(getFilePath(), false, 100, true)) {
-        LOGW_WARN(getLogger(), L"Error in vfsForceStatus: " << Utility::formatSyncPath(getFilePath()).c_str());
+        LOGW_WARN(getLogger(), L"Error in vfsForceStatus: " << Utility::formatSyncPath(getFilePath()));
     }
 }
 
@@ -109,4 +111,27 @@ bool DriveUploadSession::handleCancelJobResult(const std::shared_ptr<UploadSessi
 
     return true;
 }
+
+void DriveUploadSession::abort() {
+    AbstractUploadSession::abort();
+    setVfsForceStatusCallback(nullptr);
+
+#ifdef __APPLE__
+    // Removing all extended attributes so that the file that failed to be uploaded is not identified as a dehydrated placeholder
+    // by the application when restarting the synchronization.
+
+    const SyncPath &localPath = getFilePath();
+    static const std::vector<const char *> extendedAttributes = {EXT_ATTR_STATUS, EXT_ATTR_PIN_STATE};
+
+    for (const auto attribute: extendedAttributes) {
+        if (auto ioError = IoError::Success;
+            !IoHelper::removeXAttr(localPath, attribute, ioError) || ioError != IoError::NoSuchFileOrDirectory) {
+            LOGW_WARN(getLogger(), L"Error in IoHelper::removeXAttr with extended attribute "
+                                           << L"'" << Utility::s2ws(attribute) << L"': "
+                                           << Utility::formatIoError(localPath, ioError));
+        }
+    }
+#endif
+}
+
 } // namespace KDC

src/libsyncengine/jobs/network/API_v2/upload_session/driveuploadsession.h

@@ -41,6 +41,8 @@ class DriveUploadSession : public AbstractUploadSession {
         inline const NodeId &nodeId() const { return _nodeId; }
         inline SyncTime modtime() const { return _modtimeOut; }
 
+        void abort() override;
+
     protected:
         bool handleStartJobResult(const std::shared_ptr<UploadSessionStartJob> &StartJob, std::string uploadToken) override;
         bool handleFinishJobResult(const std::shared_ptr<UploadSessionFinishJob> &finishJob) override;

src/libsyncengine/jobs/network/API_v2/upload_session/uploadsessionfinishjob.cpp

@@ -17,16 +17,16 @@
  */
 
 #include "uploadsessionfinishjob.h"
-#include "libcommonserver/utility/utility.h"
 #include "utility/jsonparserutility.h"
+#include "libcommonserver/utility/utility.h"
 
 namespace KDC {
 
 UploadSessionFinishJob::UploadSessionFinishJob(UploadSessionType uploadType, int driveDbId, const SyncPath &filepath,
                                                const std::string &sessionToken, const std::string &totalChunkHash,
                                                uint64_t totalChunks, SyncTime modtime) :
-    AbstractUploadSessionJob(uploadType, driveDbId, filepath, sessionToken), _totalChunkHash(totalChunkHash),
-    _totalChunks(totalChunks), _modtimeIn(modtime) {
+    AbstractUploadSessionJob(uploadType, driveDbId, filepath, sessionToken),
+    _totalChunkHash(totalChunkHash), _totalChunks(totalChunks), _modtimeIn(modtime) {
     _httpMethod = Poco::Net::HTTPRequest::HTTP_POST;
 }
 
@@ -38,7 +38,7 @@ UploadSessionFinishJob::UploadSessionFinishJob(UploadSessionType uploadType, con
 UploadSessionFinishJob::~UploadSessionFinishJob() {
     if (_vfsForceStatus) {
         if (!_vfsForceStatus(_filePath, false, 0, true)) {
-            LOGW_WARN(_logger, L"Error in vfsForceStatus for path=" << Path2WStr(_filePath).c_str());
+            LOGW_WARN(_logger, L"Error in vfsForceStatus for " << Utility::formatSyncPath(_filePath));
         }
     }
 }