utils: Adding collapsePath

library/public/utils.h

@@ -4,6 +4,7 @@
 #include "exception.h"
 #include "export.h"
 
+#include <filesystem>
 #include <map>
 #include <regex>
 #include <sstream>
@@ -55,6 +56,18 @@ class F3D_EXPORT utils
   [[nodiscard]] static std::vector<std::string> tokenize(std::string_view str);
   // clang-format on
 
+  /**
+   * Collapse a string filesystem path by:
+   * - Expanding tilda `~` into home dir in a cross-platform way
+   * - Transform relative path into an absolute path based on basedDirectory if provided, or the
+   * current directory if not
+   * - Remove any `..` if any
+   * Rely on vtksys::SystemTools::CollapseFullPath but return empty string if the provided
+   * string is empty.
+   */
+  [[nodiscard]] static std::filesystem::path collapsePath(
+    const std::filesystem::path& path, const std::filesystem::path& baseDirectory = {});
+
   /**
    * An exception that can be thrown by tokenize
    */

library/src/utils.cxx

@@ -1,6 +1,11 @@
 #include "utils.h"
 
 #include "levenshtein.h"
+#include "log.h"
+
+#include <vtksys/SystemTools.hxx>
+
+namespace fs = std::filesystem;
 
 namespace f3d
 {
@@ -97,6 +102,23 @@
   return tokens;
 }
 
+//----------------------------------------------------------------------------
+fs::path utils::collapsePath(const fs::path& path, const fs::path& baseDirectory)
+{
+  try
+  {
+    return path.empty() ? path
+      : baseDirectory.empty()
+      ? fs::path(vtksys::SystemTools::CollapseFullPath(path.string()))
+      : fs::path(vtksys::SystemTools::CollapseFullPath(path.string(), baseDirectory.string()));
+  }
+  catch (const fs::filesystem_error& ex)
+  {
+    log::error("Could not collapse path: ", ex.what());
+    return {};
+  }
+}
+
 //----------------------------------------------------------------------------
 utils::tokenize_exception::tokenize_exception(const std::string& what)
   : exception(what)

library/testing/TestSDKUtils.cxx

@@ -2,6 +2,10 @@
 
 #include <utils.h>
 
+#include <filesystem>
+
+namespace fs = std::filesystem;
+
 int TestSDKUtils(int argc, char* argv[])
 {
   PseudoUnitTest test;
@@ -101,5 +105,17 @@ int TestSDKUtils(int argc, char* argv[])
       .str(),
     "hello {foo}!");
 
+  //
+
+  test("collapsePath: empty", f3d::utils::collapsePath("").empty());
+  test("collapsePath: relative to absolute",
+    fs::path(f3d::utils::collapsePath("folder/file.ext")).is_absolute());
+  test("collapsePath: relative with folder",
+    fs::path(f3d::utils::collapsePath("folder/file.ext", "/")) == fs::path("/folder/file.ext"));
+  test(
+    "collapsePath: remove dotdot", f3d::utils::collapsePath("/folder/../file.ext") == "/file.ext");
+  test("collapsePath: expand home",
+    fs::path(f3d::utils::collapsePath("~/folder/file.ext")).is_absolute());
+
   return test.result();
 }

python/F3DPythonBindings.cxx

@@ -205,7 +205,8 @@ PYBIND11_MODULE(pyf3d, module)
   py::class_<f3d::utils> utils(module, "Utils");
 
   utils //
-    .def_static("text_distance", &f3d::utils::textDistance);
+    .def_static("text_distance", &f3d::utils::textDistance)
+    .def_static("collapse_path", &f3d::utils::collapsePath);
 
   // f3d::interactor
   py::class_<f3d::interaction_bind_t> interaction_bind(module, "InteractionBind");

python/testing/test_utils.py

@@ -3,3 +3,7 @@
 
 def test_text_distance():
     assert f3d.Utils.text_distance("modle", "model") == 2
+
+
+def test_collapse_path():
+    assert f3d.Utils.collapse_path("/folder/../file.ext", ".") == "/file.ext"