add special-folder to rsutils::os

Author: maloel

third-party/rsutils/include/rsutils/os/special-folder.h

@@ -0,0 +1,32 @@
+// License: Apache 2.0. See LICENSE file in root directory.
+// Copyright(c) 2023 Intel Corporation. All Rights Reserved.
+#pragma once
+
+#include <string>
+
+
+namespace rsutils {
+namespace os {
+
+
+enum class special_folder
+{
+    user_desktop,
+    user_documents,
+    user_pictures,
+    user_videos,
+    temp_folder,
+    app_data
+};
+
+
+// Get the path to one of the special folders listed above. These differ based on operating system.
+// Meant to be used to append a filename to it: may or may not end with a directory separator slash!
+// Throws invalid_argument if an invalid folder was passed in.
+// Throws runtime_error on failure.
+//
+std::string get_special_folder( special_folder );
+
+
+}  // namespace os
+}  // namespace rsutils

third-party/rsutils/py/pyrsutils.cpp

@@ -10,6 +10,7 @@
 #include <rsutils/number/running-average.h>
 #include <rsutils/number/stabilized-value.h>
 #include <rsutils/os/executable-name.h>
+#include <rsutils/os/special-folder.h>
 
 
 #define NAME pyrsutils
@@ -141,4 +142,13 @@ PYBIND11_MODULE(NAME, m) {
         .def( "clear", &stabilized_value::clear )
         .def( "to_string", to_string )
         .def( "__str__", to_string );
+
+    py::enum_< rsutils::os::special_folder >( m, "special_folder" )
+        .value( "app_data", rsutils::os::special_folder::app_data )
+        .value( "temp_folder", rsutils::os::special_folder::temp_folder )
+        .value( "user_desktop", rsutils::os::special_folder::user_desktop )
+        .value( "user_documents", rsutils::os::special_folder::user_documents )
+        .value( "user_pictures", rsutils::os::special_folder::user_pictures )
+        .value( "user_videos", rsutils::os::special_folder::user_videos );
+    m.def( "get_special_folder", rsutils::os::get_special_folder );
 }

third-party/rsutils/src/special-folder.cpp

@@ -0,0 +1,141 @@
+// License: Apache 2.0. See LICENSE file in root directory.
+// Copyright(c) 2023 Intel Corporation. All Rights Reserved.
+
+#include <rsutils/os/special-folder.h>
+#include <rsutils/easylogging/easyloggingpp.h>
+
+#ifdef _WIN32
+
+#include <rsutils/os/hresult.h>
+#include <KnownFolders.h>
+#include <shlobj.h>
+
+#elif defined __linux__ || defined __APPLE__
+
+#include <unistd.h>
+#include <sys/types.h>
+#include <pwd.h>
+
+#endif
+
+
+namespace rsutils {
+namespace os {
+
+
+std::string get_folder_path( special_folder f )
+{
+    std::string res;
+#ifdef _WIN32
+
+
+    if( f == special_folder::temp_folder )
+    {
+        TCHAR buf[MAX_PATH];
+        if( GetTempPath( MAX_PATH, buf ) != 0 )
+        {
+            char str[1024];
+            wcstombs( str, buf, 1023 );
+            res = str;
+        }
+    }
+    else
+    {
+        GUID folder;
+        HRESULT hr;
+        switch( f )
+        {
+        case special_folder::user_desktop:
+            folder = FOLDERID_Desktop;
+            break;
+        case special_folder::user_documents:
+            folder = FOLDERID_Documents;
+            // The user's Documents folder location may get overridden, as we know OneDrive does in certain
+            // circumstances. In such cases, the new function, SHGetKnownFolderPath, does not always return the new
+            // path, while the deprecated function does.
+            CHAR path[MAX_PATH];
+            CHECK_HR( SHGetFolderPathA( NULL, CSIDL_PERSONAL, NULL, 0, path ) );
+            res = path;
+            res += "\\";
+            return res;
+        case special_folder::user_pictures:
+            folder = FOLDERID_Pictures;
+            break;
+        case special_folder::user_videos:
+            folder = FOLDERID_Videos;
+            break;
+        case special_folder::app_data:
+            folder = FOLDERID_RoamingAppData;
+            break;
+        default:
+            throw std::invalid_argument( std::string( "Value of f (" ) + std::to_string( (int)f )
+                                         + std::string( ") is not supported" ) );
+        }
+
+        PWSTR folder_path = NULL;
+        hr = SHGetKnownFolderPath( folder, KF_FLAG_DEFAULT_PATH, NULL, &folder_path );
+        if( SUCCEEDED( hr ) )
+        {
+            char str[1024];
+            wcstombs( str, folder_path, 1023 );
+            CoTaskMemFree( folder_path );
+            res = str;
+            res += "\\";
+        }
+        else
+        {
+            throw std::runtime_error( "Failed to get requested special folder" );
+        }
+    }
+
+
+#endif  //_WIN32
+#if defined __linux__ || defined __APPLE__
+    if( f == special_folder::temp_folder )
+    {
+        const char * tmp_dir = getenv( "TMPDIR" );
+        res = tmp_dir ? tmp_dir : "/tmp/";
+    }
+    else
+    {
+        const char * home_dir = getenv( "HOME" );
+        if( ! home_dir )
+        {
+            struct passwd * pw = getpwuid( getuid() );
+            home_dir = ( pw && pw->pw_dir ) ? pw->pw_dir : "";
+        }
+        if( home_dir )
+        {
+            res = home_dir;
+            switch( f )
+            {
+            case special_folder::user_desktop:
+                res += "/Desktop/";
+                break;
+            case special_folder::user_documents:
+                res += "/Documents/";
+                break;
+            case special_folder::user_pictures:
+                res += "/Pictures/";
+                break;
+            case special_folder::user_videos:
+                res += "/Videos/";
+                break;
+            case special_folder::app_data:
+                res += "/.";
+                break;
+            default:
+                throw std::invalid_argument( std::string( "Value of f (" ) + std::to_string( (int)f )
+                                             + std::string( ") is not supported" ) );
+            }
+        }
+    }
+
+
+#endif  // defined __linux__ || defined __APPLE__
+    return res;
+}
+
+
+}  // namespace os
+}  // namespace rsutils