Add a new extend_permissions cache option. (#1404)

When enabled it overrides the creation permissions for files and
directories to enable access for all users in the system. This enables
different users in the system to access the cache.

Relates-To: OAM-2037

Signed-off-by: Mykhailo Kuchma <ext-mykhailo.kuchma@here.com>

Author: mykhailo-kuchma

olp-cpp-sdk-core/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (C) 2019-2021 HERE Europe B.V.
+# Copyright (C) 2019-2023 HERE Europe B.V.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -436,14 +436,37 @@ target_link_libraries(${PROJECT_NAME}
 )
 
 if(OLP_SDK_ENABLE_DEFAULT_CACHE)
+    include(CheckCXXSymbolExists)
+    check_cxx_symbol_exists(fdatasync "unistd.h" HAVE_FDATASYNC)
+    check_cxx_symbol_exists(F_FULLFSYNC "fcntl.h" HAVE_FULLFSYNC)
+    check_cxx_symbol_exists(O_CLOEXEC "fcntl.h" HAVE_O_CLOEXEC)
+
     target_include_directories(${PROJECT_NAME}
         PUBLIC
-            $<BUILD_INTERFACE:${leveldb_INCLUDE_DIR}>
+        $<BUILD_INTERFACE:${leveldb_INCLUDE_DIR}>
     )
     target_link_libraries(${PROJECT_NAME}
         PRIVATE
-            leveldb::leveldb
+        leveldb::leveldb
     )
+
+    if(HAVE_FDATASYNC)
+        target_compile_definitions(${PROJECT_NAME}
+            PRIVATE
+            HAVE_FDATASYNC)
+    endif()
+
+    if(HAVE_FULLFSYNC)
+        target_compile_definitions(${PROJECT_NAME}
+            PRIVATE
+            HAVE_FULLFSYNC)
+    endif()
+
+    if(HAVE_O_CLOEXEC)
+        target_compile_definitions(${PROJECT_NAME}
+            PRIVATE
+            HAVE_O_CLOEXEC)
+    endif()
 endif()
 
 if(OLP_SDK_ENABLE_DEFAULT_CACHE_LMDB)

olp-cpp-sdk-core/include/olp/core/cache/CacheSettings.h

@@ -162,6 +162,18 @@ struct CORE_API CacheSettings {
    * regardless of the network state.
    */
   boost::optional<std::string> disk_path_protected = boost::none;
+
+  /**
+   * @brief The extend permissions flag (applicable for Unix systems).
+   *
+   * A boolean option that controls the default permission for file and
+   * directory creation. When enabled, all permissions for files and directories
+   * will be set to 0666 and 0777 respectively, which allows read, write, and
+   * execute access to all users.
+   * 
+   * Note: the resulting permissions are affected by the umask.
+   */
+  bool extend_permissions = false;
 };
 
 #else

olp-cpp-sdk-core/include/olp/core/utils/Dir.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2020 HERE Europe B.V.
+ * Copyright (C) 2019-2023 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -91,10 +91,14 @@ class CORE_API Dir {
    * in the path.
    *
    * @param path The path of the directory.
+   * @param extend_permissions Controls the permission extension.
+   *
+   * Note: extend_permissions are applicable for Unix systems, if enabled, it
+   * sets the 0777 permissions for created folders.
    *
    * @return True if the operation is successful; false otherwise.
    */
-  static bool Create(const std::string& path);
+  static bool Create(const std::string& path, bool extend_permissions = false);
 
   /**
    * @brief Gets a platform-specific temporary path.

olp-cpp-sdk-core/src/cache/DefaultCacheImpl.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2022 HERE Europe B.V.
+ * Copyright (C) 2019-2023 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -828,7 +828,7 @@ DefaultCache::StorageOpenResult DefaultCacheImpl::SetupStorage() {
 }
 
 DefaultCache::StorageOpenResult DefaultCacheImpl::SetupProtectedCache() {
-  protected_cache_ = std::make_unique<DiskCache>();
+  protected_cache_ = std::make_unique<DiskCache>(settings_.extend_permissions);
 
   // Storage settings for protected cache are different. We want to specify the
   // max_file_size greater than the manifest file size. Or else leveldb will try
@@ -883,7 +883,7 @@ DefaultCache::StorageOpenResult DefaultCacheImpl::SetupProtectedCache() {
 DefaultCache::StorageOpenResult DefaultCacheImpl::SetupMutableCache() {
   auto storage_settings = CreateStorageSettings(settings_);
 
-  mutable_cache_ = std::make_unique<DiskCache>();
+  mutable_cache_ = std::make_unique<DiskCache>(settings_.extend_permissions);
   auto status = mutable_cache_->Open(settings_.disk_path_mutable.get(),
                                      settings_.disk_path_mutable.get(),
                                      storage_settings, settings_.openOptions);

olp-cpp-sdk-core/src/cache/DiskCache.cpp

@@ -146,7 +146,8 @@ int CheckCompactionFinished(leveldb::DB& db) {
 
 }  // anonymous namespace
 
-DiskCache::DiskCache() : env_(DiskCacheEnv::CreateEnv()){};
+DiskCache::DiskCache(bool extend_permissions)
+    : env_(DiskCacheEnv::CreateEnv(extend_permissions)){};
 DiskCache::~DiskCache() { Close(); }
 
 void DiskCache::LevelDBLogger::Logv(const char* format, va_list ap) {

olp-cpp-sdk-core/src/cache/DiskCache.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2021 HERE Europe B.V.
+ * Copyright (C) 2019-2023 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -109,7 +109,7 @@ class DiskCache {
     void Logv(const char* format, va_list ap) override;
   };
 
-  DiskCache();
+  explicit DiskCache(bool extend_permissions);
   ~DiskCache();
   OpenResult Open(const std::string& data_path,
                   const std::string& versioned_data_path,