Merge pull request #222 from archshift/renamexyz

Implemented RenameFile and RenameDirectory in FS:USER

src/core/file_sys/archive.h

@@ -193,6 +193,14 @@ public:
      */
     virtual bool DeleteFile(const FileSys::Path& path) const = 0;
 
+    /**
+     * Rename a File specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    virtual bool RenameFile(const FileSys::Path& src_path, const FileSys::Path& dest_path) const = 0;
+
     /**
      * Delete a directory specified by its path
      * @param path Path relative to the archive
@@ -207,6 +215,14 @@ public:
      */
     virtual bool CreateDirectory(const Path& path) const = 0;
 
+    /**
+     * Rename a Directory specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    virtual bool RenameDirectory(const FileSys::Path& src_path, const FileSys::Path& dest_path) const = 0;
+
     /**
      * Open a directory specified by its path
      * @param path Path relative to the archive

src/core/file_sys/archive_romfs.cpp

@@ -43,6 +43,11 @@ bool Archive_RomFS::DeleteFile(const FileSys::Path& path) const {
     return false;
 }
 
+bool Archive_RomFS::RenameFile(const FileSys::Path& src_path, const FileSys::Path& dest_path) const {
+    ERROR_LOG(FILESYS, "Attempted to rename a file within ROMFS.");
+    return false;
+}
+
 /**
  * Delete a directory specified by its path
  * @param path Path relative to the archive
@@ -63,6 +68,11 @@ bool Archive_RomFS::CreateDirectory(const Path& path) const {
     return false;
 }
 
+bool Archive_RomFS::RenameDirectory(const FileSys::Path& src_path, const FileSys::Path& dest_path) const {
+    ERROR_LOG(FILESYS, "Attempted to rename a file within ROMFS.");
+    return false;
+}
+
 /**
  * Open a directory specified by its path
  * @param path Path relative to the archive

src/core/file_sys/archive_romfs.h

@@ -43,6 +43,14 @@ public:
      */
     bool DeleteFile(const FileSys::Path& path) const override;
 
+    /**
+     * Rename a File specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    bool RenameFile(const FileSys::Path& src_path, const FileSys::Path& dest_path) const override;
+
     /**
      * Delete a directory specified by its path
      * @param path Path relative to the archive
@@ -57,6 +65,14 @@ public:
      */
     bool CreateDirectory(const Path& path) const override;
 
+    /**
+     * Rename a Directory specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    bool RenameDirectory(const FileSys::Path& src_path, const FileSys::Path& dest_path) const override;
+
     /**
      * Open a directory specified by its path
      * @param path Path relative to the archive

src/core/file_sys/archive_sdmc.cpp

@@ -66,6 +66,10 @@ bool Archive_SDMC::DeleteFile(const FileSys::Path& path) const {
     return FileUtil::Delete(GetMountPoint() + path.AsString());
 }
 
+bool Archive_SDMC::RenameFile(const FileSys::Path& src_path, const FileSys::Path& dest_path) const {
+    return FileUtil::Rename(GetMountPoint() + src_path.AsString(), GetMountPoint() + dest_path.AsString());
+}
+
 /**
  * Delete a directory specified by its path
  * @param path Path relative to the archive
@@ -84,6 +88,10 @@ bool Archive_SDMC::CreateDirectory(const Path& path) const {
     return FileUtil::CreateDir(GetMountPoint() + path.AsString());
 }
 
+bool Archive_SDMC::RenameDirectory(const FileSys::Path& src_path, const FileSys::Path& dest_path) const {
+    return FileUtil::Rename(GetMountPoint() + src_path.AsString(), GetMountPoint() + dest_path.AsString());
+}
+
 /**
  * Open a directory specified by its path
  * @param path Path relative to the archive

src/core/file_sys/archive_sdmc.h

@@ -47,6 +47,14 @@ public:
      */
     bool DeleteFile(const FileSys::Path& path) const override;
 
+    /**
+     * Rename a File specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    bool RenameFile(const FileSys::Path& src_path, const FileSys::Path& dest_path) const override;
+
     /**
      * Delete a directory specified by its path
      * @param path Path relative to the archive
@@ -61,6 +69,14 @@ public:
      */
     bool CreateDirectory(const Path& path) const override;
 
+    /**
+     * Rename a Directory specified by its path
+     * @param src_path Source path relative to the archive
+     * @param dest_path Destination path relative to the archive
+     * @return Whether rename succeeded
+     */
+    bool RenameDirectory(const FileSys::Path& src_path, const FileSys::Path& dest_path) const override;
+
     /**
      * Open a directory specified by its path
      * @param path Path relative to the archive

src/core/hle/kernel/archive.cpp

@@ -340,49 +340,68 @@ ResultVal<Handle> OpenFileFromArchive(Handle archive_handle, const FileSys::Path
     return MakeResult<Handle>(handle);
 }
 
-/**
+ResultCode DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path) {
- * Delete a File from an Archive
- * @param archive_handle Handle to an open Archive object
- * @param path Path to the File inside of the Archive
- * @return Whether deletion succeeded
- */
-Result DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path) {
     Archive* archive = Kernel::g_object_pool.GetFast<Archive>(archive_handle);
     if (archive == nullptr)
-        return -1;
+        return InvalidHandle(ErrorModule::FS);
     if (archive->backend->DeleteFile(path))
-        return 0;
+        return RESULT_SUCCESS;
-    return -1;
+    return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
+                      ErrorSummary::Canceled, ErrorLevel::Status);
 }
 
-/**
+ResultCode RenameFileBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
- * Delete a Directory from an Archive
+                                     Handle dest_archive_handle, const FileSys::Path& dest_path) {
- * @param archive_handle Handle to an open Archive object
+    Archive* src_archive = Kernel::g_object_pool.GetFast<Archive>(src_archive_handle);
- * @param path Path to the Directory inside of the Archive
+    Archive* dest_archive = Kernel::g_object_pool.GetFast<Archive>(dest_archive_handle);
- * @return Whether deletion succeeded
+    if (src_archive == nullptr || dest_archive == nullptr)
- */
+        return InvalidHandle(ErrorModule::FS);
-Result DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path) {
+    if (src_archive == dest_archive) {
+        if (src_archive->backend->RenameFile(src_path, dest_path))
+            return RESULT_SUCCESS;
+    } else {
+        // TODO: Implement renaming across archives
+        return UnimplementedFunction(ErrorModule::FS);
+    }
+    return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
+                      ErrorSummary::NothingHappened, ErrorLevel::Status);
+}
+
+ResultCode DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path) {
     Archive* archive = Kernel::g_object_pool.GetFast<Archive>(archive_handle);
     if (archive == nullptr)
-        return -1;
+        return InvalidHandle(ErrorModule::FS);
     if (archive->backend->DeleteDirectory(path))
-        return 0;
+        return RESULT_SUCCESS;
-    return -1;
+    return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
+                      ErrorSummary::Canceled, ErrorLevel::Status);
 }
 
-/**
+ResultCode CreateDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path) {
- * Create a Directory from an Archive
- * @param archive_handle Handle to an open Archive object
- * @param path Path to the Directory inside of the Archive
- * @return Whether creation succeeded
- */
-Result CreateDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path) {
     Archive* archive = Kernel::g_object_pool.GetFast<Archive>(archive_handle);
     if (archive == nullptr)
-        return -1;
+        return InvalidHandle(ErrorModule::FS);
     if (archive->backend->CreateDirectory(path))
-        return 0;
+        return RESULT_SUCCESS;
-    return -1;
+    return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
+                      ErrorSummary::Canceled, ErrorLevel::Status);
+}
+
+ResultCode RenameDirectoryBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
+                                          Handle dest_archive_handle, const FileSys::Path& dest_path) {
+    Archive* src_archive = Kernel::g_object_pool.GetFast<Archive>(src_archive_handle);
+    Archive* dest_archive = Kernel::g_object_pool.GetFast<Archive>(dest_archive_handle);
+    if (src_archive == nullptr || dest_archive == nullptr)
+        return InvalidHandle(ErrorModule::FS);
+    if (src_archive == dest_archive) {
+        if (src_archive->backend->RenameDirectory(src_path, dest_path))
+            return RESULT_SUCCESS;
+    } else {
+        // TODO: Implement renaming across archives
+        return UnimplementedFunction(ErrorModule::FS);
+    }
+    return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
+                      ErrorSummary::NothingHappened, ErrorLevel::Status);
 }
 
 /**

src/core/hle/kernel/archive.h

@@ -50,7 +50,18 @@ ResultVal<Handle> OpenFileFromArchive(Handle archive_handle, const FileSys::Path
  * @param path Path to the File inside of the Archive
  * @return Whether deletion succeeded
  */
-Result DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path);
+ResultCode DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path);
+
+/**
+ * Rename a File between two Archives
+ * @param src_archive_handle Handle to the source Archive object
+ * @param src_path Path to the File inside of the source Archive
+ * @param dest_archive_handle Handle to the destination Archive object
+ * @param dest_path Path to the File inside of the destination Archive
+ * @return Whether rename succeeded
+ */
+ResultCode RenameFileBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
+                                     Handle dest_archive_handle, const FileSys::Path& dest_path);
 
 /**
  * Delete a Directory from an Archive
@@ -58,7 +69,7 @@ Result DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path);
  * @param path Path to the Directory inside of the Archive
  * @return Whether deletion succeeded
  */
-Result DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
+ResultCode DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
 
 /**
  * Create a Directory from an Archive
@@ -66,7 +77,18 @@ Result DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& pa
  * @param path Path to the Directory inside of the Archive
  * @return Whether creation of directory succeeded
  */
-Result CreateDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
+ResultCode CreateDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
+
+/**
+ * Rename a Directory between two Archives
+ * @param src_archive_handle Handle to the source Archive object
+ * @param src_path Path to the Directory inside of the source Archive
+ * @param dest_archive_handle Handle to the destination Archive object
+ * @param dest_path Path to the Directory inside of the destination Archive
+ * @return Whether rename succeeded
+ */
+ResultCode RenameDirectoryBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
+                                          Handle dest_archive_handle, const FileSys::Path& dest_path);
 
 /**
  * Open a Directory from an Archive

src/core/hle/service/fs_user.cpp

@@ -159,7 +159,49 @@ void DeleteFile(Service::Interface* self) {
     DEBUG_LOG(KERNEL, "type=%d size=%d data=%s",
               filename_type, filename_size, file_path.DebugStr().c_str());
 
-    cmd_buff[1] = Kernel::DeleteFileFromArchive(archive_handle, file_path);
+    cmd_buff[1] = Kernel::DeleteFileFromArchive(archive_handle, file_path).raw;
+    
+    DEBUG_LOG(KERNEL, "called");
+}
+
+/*
+ * FS_User::RenameFile service function
+ *  Inputs:
+ *      2 : Source archive handle lower word
+ *      3 : Source archive handle upper word
+ *      4 : Source file path type
+ *      5 : Source file path size
+ *      6 : Dest archive handle lower word
+ *      7 : Dest archive handle upper word
+ *      8 : Dest file path type
+ *      9 : Dest file path size
+ *      11: Source file path string data
+ *      13: Dest file path string
+ *  Outputs:
+ *      1 : Result of function, 0 on success, otherwise error code
+ */
+void RenameFile(Service::Interface* self) {
+    u32* cmd_buff = Service::GetCommandBuffer();
+
+    // TODO(Link Mauve): cmd_buff[2] and cmd_buff[6], aka archive handle lower word, aren't used according to
+    // 3dmoo's or ctrulib's implementations.  Triple check if it's really the case.
+    Handle src_archive_handle  = static_cast<Handle>(cmd_buff[3]);
+    auto src_filename_type     = static_cast<FileSys::LowPathType>(cmd_buff[4]);
+    u32 src_filename_size      = cmd_buff[5];
+    Handle dest_archive_handle = static_cast<Handle>(cmd_buff[7]);
+    auto dest_filename_type    = static_cast<FileSys::LowPathType>(cmd_buff[8]);
+    u32 dest_filename_size     = cmd_buff[9];
+    u32 src_filename_ptr       = cmd_buff[11];
+    u32 dest_filename_ptr      = cmd_buff[13];
+
+    FileSys::Path src_file_path(src_filename_type, src_filename_size, src_filename_ptr);
+    FileSys::Path dest_file_path(dest_filename_type, dest_filename_size, dest_filename_ptr);
+
+    DEBUG_LOG(KERNEL, "src_type=%d src_size=%d src_data=%s dest_type=%d dest_size=%d dest_data=%s",
+              src_filename_type, src_filename_size, src_file_path.DebugStr().c_str(),
+              dest_filename_type, dest_filename_size, dest_file_path.DebugStr().c_str());
+
+    cmd_buff[1] = Kernel::RenameFileBetweenArchives(src_archive_handle, src_file_path, dest_archive_handle, dest_file_path).raw;
     
     DEBUG_LOG(KERNEL, "called");
 }
@@ -190,7 +232,7 @@ void DeleteDirectory(Service::Interface* self) {
     DEBUG_LOG(KERNEL, "type=%d size=%d data=%s",
               dirname_type, dirname_size, dir_path.DebugStr().c_str());
     
-    cmd_buff[1] = Kernel::DeleteDirectoryFromArchive(archive_handle, dir_path);
+    cmd_buff[1] = Kernel::DeleteDirectoryFromArchive(archive_handle, dir_path).raw;
     
     DEBUG_LOG(KERNEL, "called");
 }
@@ -220,7 +262,49 @@ static void CreateDirectory(Service::Interface* self) {
 
     DEBUG_LOG(KERNEL, "type=%d size=%d data=%s", dirname_type, dirname_size, dir_path.DebugStr().c_str());
 
-    cmd_buff[1] = Kernel::CreateDirectoryFromArchive(archive_handle, dir_path);
+    cmd_buff[1] = Kernel::CreateDirectoryFromArchive(archive_handle, dir_path).raw;
+
+    DEBUG_LOG(KERNEL, "called");
+}
+
+/*
+ * FS_User::RenameDirectory service function
+ *  Inputs:
+ *      2 : Source archive handle lower word
+ *      3 : Source archive handle upper word
+ *      4 : Source dir path type
+ *      5 : Source dir path size
+ *      6 : Dest archive handle lower word
+ *      7 : Dest archive handle upper word
+ *      8 : Dest dir path type
+ *      9 : Dest dir path size
+ *      11: Source dir path string data
+ *      13: Dest dir path string
+ *  Outputs:
+ *      1 : Result of function, 0 on success, otherwise error code
+ */
+void RenameDirectory(Service::Interface* self) {
+    u32* cmd_buff = Service::GetCommandBuffer();
+
+    // TODO(Link Mauve): cmd_buff[2] and cmd_buff[6], aka archive handle lower word, aren't used according to
+    // 3dmoo's or ctrulib's implementations.  Triple check if it's really the case.
+    Handle src_archive_handle  = static_cast<Handle>(cmd_buff[3]);
+    auto src_dirname_type      = static_cast<FileSys::LowPathType>(cmd_buff[4]);
+    u32 src_dirname_size       = cmd_buff[5];
+    Handle dest_archive_handle = static_cast<Handle>(cmd_buff[7]);
+    auto dest_dirname_type     = static_cast<FileSys::LowPathType>(cmd_buff[8]);
+    u32 dest_dirname_size      = cmd_buff[9];
+    u32 src_dirname_ptr        = cmd_buff[11];
+    u32 dest_dirname_ptr       = cmd_buff[13];
+
+    FileSys::Path src_dir_path(src_dirname_type, src_dirname_size, src_dirname_ptr);
+    FileSys::Path dest_dir_path(dest_dirname_type, dest_dirname_size, dest_dirname_ptr);
+
+    DEBUG_LOG(KERNEL, "src_type=%d src_size=%d src_data=%s dest_type=%d dest_size=%d dest_data=%s",
+              src_dirname_type, src_dirname_size, src_dir_path.DebugStr().c_str(),
+              dest_dirname_type, dest_dirname_size, dest_dir_path.DebugStr().c_str());
+
+    cmd_buff[1] = Kernel::RenameDirectoryBetweenArchives(src_archive_handle, src_dir_path, dest_archive_handle, dest_dir_path).raw;
     
     DEBUG_LOG(KERNEL, "called");
 }
@@ -314,12 +398,12 @@ const Interface::FunctionInfo FunctionTable[] = {
     {0x080201C2, OpenFile,              "OpenFile"},
     {0x08030204, OpenFileDirectly,      "OpenFileDirectly"},
     {0x08040142, DeleteFile,            "DeleteFile"},
-    {0x08050244, nullptr,               "RenameFile"},
+    {0x08050244, RenameFile,            "RenameFile"},
     {0x08060142, DeleteDirectory,       "DeleteDirectory"},
     {0x08070142, nullptr,               "DeleteDirectoryRecursively"},
     {0x08080202, nullptr,               "CreateFile"},
     {0x08090182, CreateDirectory,       "CreateDirectory"},
-    {0x080A0244, nullptr,               "RenameDirectory"},
+    {0x080A0244, RenameDirectory,       "RenameDirectory"},
     {0x080B0102, OpenDirectory,         "OpenDirectory"},
     {0x080C00C2, OpenArchive,           "OpenArchive"},
     {0x080D0144, nullptr,               "ControlArchive"},