NodeDirectories.h

Go to the documentation of this file.

 
#pragma once
 
#include "RobotRaconteur/RobotRaconteurConstants.h"
#include "RobotRaconteur/NodeID.h"
 
#include <boost/filesystem/path.hpp>
 
namespace RobotRaconteur
{
class ROBOTRACONTEUR_CORE_API NodeDirectories
{
  public:
    boost::filesystem::path system_data_dir;

    boost::filesystem::path system_config_dir;

    boost::filesystem::path system_state_dir;

    boost::filesystem::path system_cache_dir;

    boost::filesystem::path system_run_dir;

    boost::filesystem::path user_data_dir;

    boost::filesystem::path user_config_dir;

    boost::filesystem::path user_state_dir;

    boost::filesystem::path user_cache_dir;

    boost::filesystem::path user_run_dir;
};
 
class NodeDirectoriesFD;

class ROBOTRACONTEUR_CORE_API NodeDirectoriesUtil
{
  public:
    static NodeDirectories GetDefaultNodeDirectories(
        const RR_SHARED_PTR<RobotRaconteurNode>& node = RR_SHARED_PTR<RobotRaconteurNode>());

    static std::string GetLogonUserName();

    static bool IsLogonUserRoot();

    // TODO
    // static void CreateUserNodeDirectory(const boost::filesystem::path& dir);

    // TODO
    // static void CreateSystemPrivateNodeDirectory(const boost::filesystem::path& dir);

    // TODO
    // static void CreateSystemPublicNodeDirectory(const boost::filesystem::path& dir);

    // TODO
    // static void CreateUserRunDirectory(const NodeDirectories& node_dirs);

    static bool ReadInfoFile(const boost::filesystem::path& fname, std::map<std::string, std::string>& data);

    static RR_SHARED_PTR<NodeDirectoriesFD> CreatePidFile(const boost::filesystem::path& path);

    static RR_SHARED_PTR<NodeDirectoriesFD> CreateInfoFile(const boost::filesystem::path& path,
                                                           std::map<std::string, std::string> info);

    static void RefreshInfoFile(const RR_SHARED_PTR<NodeDirectoriesFD>& h_info,
                                const std::map<std::string, std::string>& updated_info);
};

class ROBOTRACONTEUR_CORE_API GetUuidForNameAndLockResult
{
  public:
    NodeID uuid;
    std::string name;
    std::vector<std::string> scope;
    RR_SHARED_PTR<NodeDirectoriesFD> fd;
};

ROBOTRACONTEUR_CORE_API GetUuidForNameAndLockResult GetUuidForNameAndLock(const NodeDirectories& node_dirs,
                                                                          boost::string_ref name,
                                                                          const std::vector<std::string>& scope);

class ROBOTRACONTEUR_CORE_API NodeDirectoriesResourceAlreadyInUse : public std::runtime_error
{
  public:
    NodeDirectoriesResourceAlreadyInUse() : runtime_error("Identifier UUID or Name already in use"){};
};
 
} // namespace RobotRaconteur