PolicyFile.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 <fstream>

#include <boost/filesystem/convenience.hpp>

#include "lsst/pex/policy/PolicyFile.h"
#include "lsst/pex/policy/PolicyParser.h"
#include "lsst/pex/policy/exceptions.h"
#include "lsst/pex/policy/parserexceptions.h"
#include "lsst/pex/policy/paf/PAFParserFactory.h"
/*
 * Workaround for boost::filesystem v2 (not needed in boost >= 1.46)
 */
#include "boost/version.hpp"
#include "boost/filesystem/config.hpp"
#if BOOST_VERSION <= 104600 || BOOST_FILESYSTEM_VERSION < 3
namespace boost { namespace filesystem {
    path absolute(const path& p)
    {
        return complete(p);
    }
}}
#endif
namespace fs = boost::filesystem;

namespace lsst {
namespace pex {
namespace policy {

//@cond

using std::string;
using std::ifstream;
using boost::regex;
using boost::regex_match;
using boost::regex_search;
using std::unique_ptr;
using lsst::pex::policy::paf::PAFParserFactory;

namespace pexExcept = lsst::pex::exceptions;

const string PolicyFile::EXT_PAF(".paf");
const string PolicyFile::EXT_XML(".xml");

const regex PolicyFile::SPACE_RE("^\\s*$");
const regex PolicyFile::COMMENT("^\\s*#");
const regex
          PolicyFile::CONTENTID("^\\s*#\\s*<\\?cfg\\s+\\w+(\\s+\\w+)*\\s*\\?>",
                                regex::icase);

/*
 * create a Policy file that points a file with given path.
 * @param filepath   the path to the file
 */
PolicyFile::PolicyFile(const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(),
      _file(PolicyParserFactory::UNRECOGNIZED), _format(), _pfact()
{ }

PolicyFile::PolicyFile(const string& filepath,
                       const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(), _file(filepath), _format(), _pfact()
{ }

PolicyFile::PolicyFile(const char *filepath,
                       const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(), _file(filepath), _format(), _pfact()
{ }

PolicyFile::PolicyFile(const fs::path& filepath,
                       const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(), _file(filepath), _format(), _pfact()
{ }

PolicyFile::PolicyFile(const string& filepath,
                       const PolicyParserFactory::Ptr& parserFactory)
    : PolicySource(), Persistable(),
      _file(filepath), _format(), _pfact(parserFactory)
{
    if (! _pfact.get()) _format = _pfact->getFormatName();
}

PolicyFile::PolicyFile(const fs::path& filepath,
                       const PolicyParserFactory::Ptr& parserFactory)
    : PolicySource(), Persistable(),
      _file(filepath), _format(), _pfact(parserFactory)
{
    if (! _pfact.get()) _format = _pfact->getFormatName();
}

PolicyFile::PolicyFile(const string& filepath, const fs::path& reposDir,
                       const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(), _file(filepath), _format(), _pfact()
{
    if (! _file.has_root_path() && ! reposDir.empty())
        _file = reposDir / _file;
}

PolicyFile::PolicyFile(const fs::path& filepath, const fs::path& reposDir,
                       const SupportedFormats::Ptr& fmts)
    : PolicySource(fmts), Persistable(), _file(filepath), _format(), _pfact()
{
    if (! _file.has_root_path() && ! reposDir.empty())
        _file = reposDir / _file;
}

PolicyFile::PolicyFile(const string& filepath, const fs::path& reposDir,
                       const PolicyParserFactory::Ptr& parserFactory)
    : PolicySource(), Persistable(),
      _file(filepath), _format(), _pfact(parserFactory)
{
    if (! _file.has_root_path() && ! reposDir.empty())
        _file = reposDir / _file;
    if (! _pfact.get()) _format = _pfact->getFormatName();
}

PolicyFile::PolicyFile(const fs::path& filepath, const fs::path& reposDir,
                       const PolicyParserFactory::Ptr& parserFactory)
    : PolicySource(), Persistable(),
      _file(filepath), _format(), _pfact(parserFactory)
{
    if (! _file.has_root_path() && ! reposDir.empty())
        _file = reposDir / _file;
    if (! _pfact.get()) _format = _pfact->getFormatName();
}

/*
 * return the name of the format that the data is stored in.  This may
 * cause the first few records of the source to be read.
 * @exception IOError   if an error occurs while reading the first few
 *                      characters of the source stream.
 */
const string& PolicyFile::getFormatName() {
    if (_format.size() != 0) return _format;
    if (_file.empty()) return PolicyParserFactory::UNRECOGNIZED;

    // check the extension first
    string ext = fs::extension(_file);
    if (! ext.empty()) {
        if (ext == EXT_PAF) {
            if (_formats->supports(PAFParserFactory::FORMAT_NAME))
                return cacheName(PAFParserFactory::FORMAT_NAME);
        }
        else if (ext == EXT_XML) {
            return cacheName("XML");
        }
    }

    // try reading the initial characters
    if (fs::exists(_file)) {
        ifstream is(_file.string().c_str());
        if (is.fail())
            throw LSST_EXCEPT(pexExcept::IoError,
                              "failure opening Policy file: "
                              + fs::absolute(_file).string());

        // skip over comments
        string line;
        getline(is, line);
        while (is.good() &&
               (regex_match(line, SPACE_RE) ||
                (regex_search(line, COMMENT) && !regex_search(line, COMMENT))))
        { }

        if (is.fail())
            throw LSST_EXCEPT(pexExcept::IoError,
                              "failure reading Policy file: "
                              + fs::absolute(_file).string());
        if (is.eof() &&
            (regex_match(line, SPACE_RE) ||
             (regex_search(line, COMMENT) && !regex_search(line, COMMENT))))
        {
            // empty file; let's just assume PAF (but don't cache the name).
            return PAFParserFactory::FORMAT_NAME;
        }

        return cacheName(_formats->recognizeType(line));
    }

    return PolicyParserFactory::UNRECOGNIZED;
}

/*
 * load the data from this Policy source into a Policy object
 * @param policy    the policy object to load the data into
 * @exception ParserError  if an error occurs while parsing the data
 * @exception IOError   if an I/O error occurs while reading from the
 *                       source stream.
 */
void PolicyFile::load(Policy& policy) const {

    PolicyParserFactory::Ptr pfactory = _pfact;
    if (! pfactory.get()) {
        const string& fmtname = getFormatName();
        if (fmtname.empty())
            throw LSST_EXCEPT(ParserError, "Unknown Policy format: " + _file.string());

        pfactory = _formats->getFactory(fmtname);
    }

    std::unique_ptr<PolicyParser> parser(pfactory->createParser(policy));

    ifstream fs(_file.string().c_str());
    if (fs.fail())
        throw LSST_EXCEPT(pexExcept::IoError,
                          "failure opening Policy file: "
                          + fs::absolute(_file).string());

    parser->parse(fs);
    fs.close();
}

//@endcond

}}}   // end lsst::pex::policy