DefaultPolicyFile.cc

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#include "lsst/pex/policy/DefaultPolicyFile.h"
#include "lsst/pex/exceptions.h"

#include <algorithm>
#include <cctype>
#include <functional>

namespace fs = boost::filesystem;
namespace pexExcept = lsst::pex::exceptions;

namespace lsst {
namespace pex {
namespace policy {

DefaultPolicyFile::DefaultPolicyFile(const char* const productName, const std::string& filepath,
                                     const std::string& repos, bool strict)
        : PolicyFile(), _repos(), _strict(strict) {
    _repos = getInstallPath(productName);
    if (repos.length() > 0) _repos /= repos;
    _file = _repos / filepath;
}

fs::path DefaultPolicyFile::getInstallPath(const char* const productName) {
    return DefaultPolicyFile::installPathFor(productName);
}

/*
 * return the file path to the installation directory of a given
 * named product.  The installation directory will be taken from
 * the value of an environment variable PRODUCTNAME_DIR where
 * PRODUCTNAME is the given name of the product with all letters
 * converted to upper case.
 * @exception lsst::pex::exception::NotFoundError  if the
 *    environement variable is not defined.
 */
fs::path DefaultPolicyFile::installPathFor(const char* const productName) {
    std::string productName_DIR(productName);

    // transform to upper case
    std::transform(productName_DIR.begin(), productName_DIR.end(), productName_DIR.begin(),
                   std::ptr_fun<int, int>(std::toupper));

    // append _DIR
    productName_DIR += "_DIR";

    // get installation directory from environment
    const char* ipath = getenv(productName_DIR.c_str());
    if (ipath == 0)
        throw LSST_EXCEPT(pexExcept::NotFoundError, productName_DIR + ": environment variable not set");

    return fs::path(ipath);
}

/*
 * load the data from this Policy source into a Policy object.  This
 * implementation will automatically de-reference any file include
 * directives in the policy file.
 * @param policy    the policy object to load the data into
 * @exception ParserException  if an error occurs while parsing the data
 * @exception IOError   if an I/O error occurs while reading from the
 *                       source stream.
 */
void DefaultPolicyFile::load(Policy& policy) const {
    PolicyFile::load(policy);
    policy.loadPolicyFiles(_repos, _strict);
}

}  // namespace policy
}  // namespace pex
}  // namespace lsst