diff options
Diffstat (limited to 'src/utils/cpp')
-rw-r--r-- | src/utils/cpp/TARGETS | 11 | ||||
-rw-r--r-- | src/utils/cpp/tmp_dir.cpp | 64 | ||||
-rw-r--r-- | src/utils/cpp/tmp_dir.hpp | 54 |
3 files changed, 129 insertions, 0 deletions
diff --git a/src/utils/cpp/TARGETS b/src/utils/cpp/TARGETS index a0b23a5b..7c190a06 100644 --- a/src/utils/cpp/TARGETS +++ b/src/utils/cpp/TARGETS @@ -49,4 +49,15 @@ , "hdrs": ["vector.hpp"] , "stage": ["src", "utils", "cpp"] } +, "tmp_dir": + { "type": ["@", "rules", "CC", "library"] + , "name": ["tmp_dir"] + , "hdrs": ["tmp_dir.hpp"] + , "srcs": ["tmp_dir.cpp"] + , "deps": + [ ["src/buildtool/file_system", "file_system_manager"] + , ["@", "gsl-lite", "", "gsl-lite"] + ] + , "stage": ["src", "utils", "cpp"] + } } diff --git a/src/utils/cpp/tmp_dir.cpp b/src/utils/cpp/tmp_dir.cpp new file mode 100644 index 00000000..d821558f --- /dev/null +++ b/src/utils/cpp/tmp_dir.cpp @@ -0,0 +1,64 @@ +// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#include "src/utils/cpp/tmp_dir.hpp" + +#include "gsl-lite/gsl-lite.hpp" +#include "src/buildtool/file_system/file_system_manager.hpp" + +auto TmpDir::Create(std::filesystem::path const& prefix, + std::string const& dir_template) noexcept -> TmpDirPtr { + try { + // make sure prefix folder exists + if (not FileSystemManager::CreateDirectory(prefix)) { + Logger::Log(LogLevel::Error, + "TmpDir: could not create prefix directory {}", + prefix.string()); + return nullptr; + } + + auto full_template_str = + std::filesystem::weakly_canonical( + std::filesystem::absolute(prefix / dir_template)) + .string(); + + std::vector<char> c_tmpl(full_template_str.begin(), + full_template_str.end()); + c_tmpl.emplace_back('\0'); // get as c-string + + // attempt to make the tmp dir + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg) + char* tmp_dir = mkdtemp(&c_tmpl[0]); + if (tmp_dir == nullptr) { + return nullptr; + } + auto tmp_dir_obj = std::make_shared<TmpDir>(); + // need to explicitly transform to std::string first + tmp_dir_obj->tmp_dir_ = std::filesystem::path(std::string(tmp_dir)); + + return std::static_pointer_cast<TmpDir const>(tmp_dir_obj); + } catch (...) { + return nullptr; + } +} + +auto TmpDir::GetPath() const noexcept -> std::filesystem::path { + return tmp_dir_; +} + +TmpDir::~TmpDir() noexcept { + // try to remove the tmp dir and all its content + [[maybe_unused]] auto res = + FileSystemManager::RemoveDirectory(tmp_dir_, true); +} diff --git a/src/utils/cpp/tmp_dir.hpp b/src/utils/cpp/tmp_dir.hpp new file mode 100644 index 00000000..b0dd5e5e --- /dev/null +++ b/src/utils/cpp/tmp_dir.hpp @@ -0,0 +1,54 @@ +// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef INCLUDED_SRC_OTHER_TOOLS_TMP_DIR_HPP +#define INCLUDED_SRC_OTHER_TOOLS_TMP_DIR_HPP + +#include <cstdlib> +#include <filesystem> +#include <optional> +#include <string> + +std::string const kDefaultTemplate{"tmp.XXXXXX"}; + +class TmpDir; +using TmpDirPtr = std::shared_ptr<TmpDir const>; + +class TmpDir { + public: + // default ctor; not to be used! + TmpDir() = default; + + /// \brief Destroy the TmpDir object. It tries to remove the tmp folder. + ~TmpDir() noexcept; + + // no copies, only moves + TmpDir(TmpDir const&) = delete; + TmpDir(TmpDir&& other) noexcept = default; + auto operator=(TmpDir const&) = delete; + auto operator=(TmpDir&& other) noexcept -> TmpDir& = default; + + [[nodiscard]] auto GetPath() const noexcept -> std::filesystem::path; + + /// \brief Creates a completely unique directory in a given prefix path. + [[nodiscard]] static auto Create( + std::filesystem::path const& prefix, + std::string const& dir_template = kDefaultTemplate) noexcept + -> TmpDirPtr; + + private: + std::filesystem::path tmp_dir_{}; +}; + +#endif // INCLUDED_SRC_OTHER_TOOLS_TMP_DIR_HPP
\ No newline at end of file |