User.hpp

/*
 * User.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_USER_HPP
#define LAUNCHER_PLUGINS_USER_HPP
 
#include <string>
#include <unistd.h>
 
#include <PImpl.hpp>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
namespace system {
 
class FilePath;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
typedef uid_t  UidType;
typedef gid_t  GidType;
 
class User
{
public:
 
   static FilePath getUserHomePath(const std::string& in_envOverride = std::string());
 
    explicit User(bool in_isEmpty = false);
 
   User(const User& in_other);
 
   User(User&& in_other) noexcept = default;
 
   static Error getCurrentUser(User& out_currentUser);
 
   static Error getUserFromIdentifier(const std::string& in_username, User& out_user);
 
   static Error getUserFromIdentifier(UidType in_userId, User& out_user);
 
   User& operator=(const User& in_other);
 
   User& operator=(User&& in_other) noexcept = default;
 
   bool operator==(const User& in_other) const;
 
   bool operator!=(const User& in_other) const;
 
   bool exists() const;
 
   bool isAllUsers() const;
 
   bool isEmpty() const;
 
   const FilePath& getHomePath() const;
 
   GidType getGroupId() const;
   
   const std::string& getShell() const;
 
   const std::string& getRealName() const;
 
   UidType getUserId() const;
 
   const std::string& getUsername() const;
 
private:
   // The private implementation of User.
   PRIVATE_IMPL(m_impl);
};
 
} // namesapce system
} // namespace launcher_plugins
} // namespace rstudio
 
#endif