FilePath.hpp

/*
 * FilePath.hpp
 *
 * Copyright (C) 2022 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LAUNCHER_PLUGINS_FILE_PATH_HPP
#define LAUNCHER_PLUGINS_FILE_PATH_HPP
 
#include <Noncopyable.hpp>
 
#include <cstdint>
#include <ctime>
 
#include <functional>
#include <iosfwd>
#include <memory>
#include <string>
#include <vector>
 
#include <Error.hpp>
#include <PImpl.hpp>
#include <logging/Logger.hpp>
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
class User;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
enum class FileMode
{
   USER_READ_WRITE,
   USER_READ_WRITE_EXECUTE,
   USER_READ_WRITE_GROUP_READ,
   USER_READ_WRITE_ALL_READ,
   USER_READ_WRITE_EXECUTE_ALL_READ_EXECUTE,
   USER_READ_WRITE_EXECUTE_GROUP_READ_WRITE_EXECUTE_ALL_READ_EXECUTE,
   ALL_READ,
   ALL_READ_WRITE,
   ALL_READ_WRITE_EXECUTE
};
 
class FilePath
{
public:
   enum MoveType
   {
      MoveDirect,
 
      MoveCrossDevice
   };
 
   typedef std::function<bool(int, const FilePath&)> RecursiveIterationFunction;
 
   FilePath();
 
   explicit FilePath(const std::string& in_absolutePath);
 
   explicit FilePath(const char* in_absolutePath);
 
   bool operator==(const FilePath& in_other) const;
 
   bool operator!=(const FilePath& in_other) const;
 
   bool operator<(const FilePath& in_other) const;
 
   static std::string createAliasedPath(const FilePath& in_filePath, const FilePath& in_userHomePath);
 
   static bool exists(const std::string& in_filePath);
 
   static bool isEqualCaseInsensitive(const FilePath& in_filePath1, const FilePath& in_filePath2);
 
   static bool isRootPath(const std::string& in_filePath);
 
   static Error makeCurrent(const std::string& in_filePath);
 
   static FilePath resolveAliasedPath(const std::string& in_aliasedPath, const FilePath& in_userHomePath);
 
   static FilePath safeCurrentPath(const FilePath& in_revertToPath);
 
   static Error tempFilePath(FilePath& out_filePath);
 
   static Error tempFilePath(const std::string& in_extension, FilePath& out_filePath);
 
   static Error uniqueFilePath(const std::string& in_basePath, FilePath& out_filePath);
 
   static Error uniqueFilePath(const std::string& in_basePath, const std::string& in_extension, FilePath& out_filePath);
 
   Error changeFileMode(const std::string& in_fileModeStr) const;
 
   Error changeFileMode(FileMode in_fileMode, bool in_setStickyBit = false) const;
 
   Error changeOwnership(
      const system::User& in_newUser,
      bool in_recursive = false,
      const RecursiveIterationFunction& in_shouldChown = RecursiveIterationFunction()) const;
 
   FilePath completeChildPath(const std::string& in_filePath) const;
 
   Error completeChildPath(const std::string& in_filePath, FilePath& out_childPath) const;
 
   FilePath completePath(const std::string& in_filePath) const;
 
   Error copy(const FilePath& in_targetPath, bool overwrite = false) const;
 
   Error copyDirectoryRecursive(const FilePath& in_targetPath, bool overwrite = false) const;
 
   Error createDirectory(const std::string& in_filePath) const;
 
   Error ensureDirectory() const;
 
   Error ensureFile() const;
 
   bool exists() const;
 
   std::string getAbsolutePath() const;
 
   std::string getAbsolutePathNative() const;
 
   std::string getCanonicalPath() const;
 
   Error getChildren(std::vector<FilePath>& out_filePaths) const;
 
   Error getChildrenRecursive(const RecursiveIterationFunction& in_iterationFunction) const;
 
   std::string getExtension() const;
 
   std::string getExtensionLowerCase() const;
 
   Error getFileMode(FileMode& out_fileMode) const;
 
   std::string getFilename() const;
 
   std::time_t getLastWriteTime() const;
 
   std::string getLexicallyNormalPath() const;
 
   std::string getMimeContentType(const std::string& in_defaultType = "text/plain") const;
 
   FilePath getParent() const;
 
   std::string getRelativePath(const FilePath& in_parentPath) const;
 
   uintmax_t getSize() const;
 
   uintmax_t getSizeRecursive() const;
 
   std::string getStem() const;
 
   bool hasExtension(const std::string& in_extension) const;
 
   bool hasExtensionLowerCase(const std::string& in_extension) const;
 
   bool hasTextMimeType() const;
 
   bool isDirectory() const;
 
   bool isEmpty() const;
 
   bool isEquivalentTo(const FilePath& in_other) const;
 
   bool isHidden() const;
 
   Error isReadable(bool& out_readable) const;
 
   bool isRegularFile() const;
 
   bool isSymlink() const;
 
   bool isWithin(const FilePath& in_scopePath) const;
 
   Error isWriteable(bool& out_writeable) const;
 
   Error makeCurrentPath(bool in_autoCreate = false) const;
 
   Error move(const FilePath& in_targetPath, MoveType in_type = MoveCrossDevice, bool overwrite = false) const;
 
   Error moveIndirect(const FilePath& in_targetPath, bool overwrite = false) const;
 
   Error openForRead(std::shared_ptr<std::istream>& out_stream) const;
 
   Error openForWrite(std::shared_ptr<std::ostream>& out_stream, bool in_truncate = true) const;
 
   Error remove() const;
 
   Error removeIfExists() const;
 
   Error resetDirectory() const;
 
   FilePath resolveSymlink() const;
 
   void setLastWriteTime(std::time_t in_time = ::time(nullptr)) const;
 
   Error testWritePermissions() const;
 
private:
   // The private implementation of FilePath.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
struct PathScopeImpl;
 
struct PathScopeImplDeleter
{
   void operator()(PathScopeImpl*);
};
 
class RestoreCurrentPathScope : Noncopyable
{
public:
   RestoreCurrentPathScope(FilePath in_restorePath, ErrorLocation in_location);
 
   virtual ~RestoreCurrentPathScope();
 
private:
   // The private implementation of RestoreCurrentPathScope
   std::unique_ptr<PathScopeImpl, PathScopeImplDeleter> m_impl;
};
 
class RemoveOnExitScope : Noncopyable
{
public:
   RemoveOnExitScope(FilePath in_restorePath, ErrorLocation in_location);
 
   virtual ~RemoveOnExitScope();
 
private:
   // The private implementation of RemoveOnExitScope
   std::unique_ptr<PathScopeImpl, PathScopeImplDeleter> m_impl;
};
 
std::ostream& operator<<(std::ostream& io_ostream, const FilePath& in_filePath);
 
Error fileExistsError(const ErrorLocation& in_location);
 
Error fileExistsError(const FilePath& in_filePath, const ErrorLocation& in_location);
 
bool isFileNotFoundError(const Error& in_error);
 
Error fileNotFoundError(const ErrorLocation& in_location);
 
Error fileNotFoundError(const std::string& in_filePath, const ErrorLocation& in_location);
 
Error fileNotFoundError(const FilePath& in_filePath, const ErrorLocation& in_location);
 
bool isPathNotFoundError(const Error& error);
 
Error pathNotFoundError(const ErrorLocation& in_location);
 
Error pathNotFoundError(const std::string& in_filePath, const ErrorLocation& in_location);
 
bool isNotFoundError(const Error& in_error);
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
#endif