From 45afc15aa6b9b1798a321bc053171deb765d7681 Mon Sep 17 00:00:00 2001
From: archshift <admin@archshift.com>
Date: Sun, 23 Nov 2014 23:20:04 -0800
Subject: [PATCH] Implemented RenameFile in FS:USER

---
 src/core/file_sys/archive.h         |  8 ++++++
 src/core/file_sys/archive_romfs.cpp | 11 ++++++++
 src/core/file_sys/archive_romfs.h   |  8 ++++++
 src/core/file_sys/archive_sdmc.cpp  | 10 +++++++
 src/core/file_sys/archive_sdmc.h    |  8 ++++++
 src/core/hle/kernel/archive.cpp     | 24 ++++++++++++++++
 src/core/hle/kernel/archive.h       | 11 ++++++++
 src/core/hle/service/fs_user.cpp    | 44 ++++++++++++++++++++++++++++-
 8 files changed, 123 insertions(+), 1 deletion(-)

diff --git a/src/core/file_sys/archive.h b/src/core/file_sys/archive.h
index 2e79bb8839..703742a1f1 100644
--- a/src/core/file_sys/archive.h
+++ b/src/core/file_sys/archive.h
@@ -191,6 +191,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
diff --git a/src/core/file_sys/archive_romfs.cpp b/src/core/file_sys/archive_romfs.cpp
index 53dc579545..5594c59105 100644
--- a/src/core/file_sys/archive_romfs.cpp
+++ b/src/core/file_sys/archive_romfs.cpp
@@ -43,6 +43,17 @@ bool Archive_RomFS::DeleteFile(const FileSys::Path& path) const {
     return false;
 }
 
+/**
+ * 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 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
diff --git a/src/core/file_sys/archive_romfs.h b/src/core/file_sys/archive_romfs.h
index 0649dde995..d14372a011 100644
--- a/src/core/file_sys/archive_romfs.h
+++ b/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
diff --git a/src/core/file_sys/archive_sdmc.cpp b/src/core/file_sys/archive_sdmc.cpp
index c2ffcd40d2..24bc43a025 100644
--- a/src/core/file_sys/archive_sdmc.cpp
+++ b/src/core/file_sys/archive_sdmc.cpp
@@ -66,6 +66,16 @@ bool Archive_SDMC::DeleteFile(const FileSys::Path& path) const {
     return FileUtil::Delete(GetMountPoint() + path.AsString());
 }
 
+/**
+ * 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 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
diff --git a/src/core/file_sys/archive_sdmc.h b/src/core/file_sys/archive_sdmc.h
index 74ce29c0d0..0dbed987b0 100644
--- a/src/core/file_sys/archive_sdmc.h
+++ b/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
diff --git a/src/core/hle/kernel/archive.cpp b/src/core/hle/kernel/archive.cpp
index e273444c98..0bf31ea2f5 100644
--- a/src/core/hle/kernel/archive.cpp
+++ b/src/core/hle/kernel/archive.cpp
@@ -355,6 +355,30 @@ Result DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path) {
     return -1;
 }
 
+/**
+ * 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
+ */
+Result RenameFileBetweenArchives(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 -1;
+    if (src_archive == dest_archive) {
+        if (src_archive->backend->RenameFile(src_path, dest_path))
+            return 0;
+    } else {
+        // TODO: Implement renaming across archives
+        return -1;
+    }
+    return -1;
+}
+
 /**
  * Delete a Directory from an Archive
  * @param archive_handle Handle to an open Archive object
diff --git a/src/core/hle/kernel/archive.h b/src/core/hle/kernel/archive.h
index 6fc4f0f256..5158fbae8c 100644
--- a/src/core/hle/kernel/archive.h
+++ b/src/core/hle/kernel/archive.h
@@ -52,6 +52,17 @@ ResultVal<Handle> OpenFileFromArchive(Handle archive_handle, const FileSys::Path
  */
 Result 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
+ */
+Result 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
  * @param archive_handle Handle to an open Archive object
diff --git a/src/core/hle/service/fs_user.cpp b/src/core/hle/service/fs_user.cpp
index 435be5b5dd..e9756e2eb3 100644
--- a/src/core/hle/service/fs_user.cpp
+++ b/src/core/hle/service/fs_user.cpp
@@ -164,6 +164,48 @@ void DeleteFile(Service::Interface* self) {
     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);
+    
+    DEBUG_LOG(KERNEL, "called");
+}
+
 /*
  * FS_User::DeleteDirectory service function
  *  Inputs:
@@ -314,7 +356,7 @@ 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"},