AbstractUserProfiles.hpp

/*
 * AbstractUserProfiles.hpp
 *
 * Copyright (C) 2020 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_ABSTRACT_USER_PROFILES_HPP
#define LAUNCHER_PLUGINS_ABSTRACT_USER_PROFILES_HPP
 
#include <Noncopyable.hpp>
 
#include <functional>
 
#include <PImpl.hpp>
#include <map>
#include <set>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
namespace system {
 
class FilePath;
class User;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace options {
 
typedef std::function<Error(const std::string& in_value)> CustomValueValidator;
 
class AbstractUserProfiles : Noncopyable
{
public:
   virtual ~AbstractUserProfiles() = default;
 
   Error initialize();
 
protected:
   AbstractUserProfiles();
 
   explicit AbstractUserProfiles(const std::string& in_pluginName);
 
   template <typename T>
   Error getValueForUser(const std::string& in_valueName, const system::User& in_user, T& out_value) const;
 
   static bool isValueNotFoundError(const Error& in_error);
 
   template <typename T>
   Error validateValue(const std::string& in_valueName) const;
 
   Error validateValue(
      const std::string& in_valueName,
      const CustomValueValidator& in_validator) const;
 
private:
   virtual const system::FilePath& getConfigurationFile() const;
 
   virtual const std::set<std::string>& getValidFieldNames() const = 0;
 
   virtual Error validateValues() const = 0;
 
   // The private implementation of AbstractUserProfiles.
   PRIVATE_IMPL(m_impl);
};
 
} // namespace options
} // namespace launcher_plugins
} // namespace rstudio
 
#endif