/*****************************************************************************
 *
 * This file is part of Mapnik (c++ mapping toolkit)
 *
 * Copyright (C) 2011 Artem Pavlenko
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/

// mapnik
#include <mapnik/debug.hpp>
#include <mapnik/load_map.hpp>
#include <mapnik/xml_tree.hpp>
#include <mapnik/version.hpp>
#include <mapnik/image_compositing.hpp>
#include <mapnik/image_scaling.hpp>
#include <mapnik/color.hpp>
#include <mapnik/color_factory.hpp>
#include <mapnik/symbolizer.hpp>
#include <mapnik/symbolizer_utils.hpp>
#include <mapnik/feature_type_style.hpp>
#include <mapnik/layer.hpp>
#include <mapnik/datasource_cache.hpp>
#include <mapnik/font_engine_freetype.hpp>
#include <mapnik/font_set.hpp>
#include <mapnik/xml_loader.hpp>
#include <mapnik/expression.hpp>
#include <mapnik/parse_path.hpp>
#include <mapnik/parse_transform.hpp>
#include <mapnik/raster_colorizer.hpp>
#include <mapnik/svg/svg_path_parser.hpp>
#include <mapnik/text/placements/registry.hpp>
#include <mapnik/text/placements/dummy.hpp>
#include <mapnik/rule.hpp>
#include <mapnik/config_error.hpp>
#include <mapnik/util/dasharray_parser.hpp>
#include <mapnik/util/conversions.hpp>
#include <mapnik/util/trim.hpp>
#include <mapnik/marker_cache.hpp>
#include <mapnik/noncopyable.hpp>
#include <mapnik/util/fs.hpp>
#include <mapnik/image_filter_types.hpp>
#include <mapnik/projection.hpp>
#include <mapnik/group/group_rule.hpp>
#include <mapnik/transform_expression.hpp>
#include <mapnik/evaluate_global_attributes.hpp>
#include <mapnik/boolean.hpp>

// boost
#include <boost/optional.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/tokenizer.hpp>
#include <boost/property_tree/ptree.hpp>
#include <boost/property_tree/xml_parser.hpp>
#include <boost/static_assert.hpp>

// agg
#include "agg_trans_affine.h"

using boost::tokenizer;

namespace mapnik
{
using boost::optional;

constexpr unsigned name2int(const char *str, int off = 0)
{
    return !str[off] ? 5381 : (name2int(str, off+1)*33) ^ str[off];
}

class map_parser : mapnik::noncopyable
{
public:
    map_parser(bool strict, std::string const& filename = "") :
        strict_(strict),
        filename_(filename),
        font_manager_(font_engine_),
        xml_base_path_()
    {}

    void parse_map(Map & map, xml_node const& node, std::string const& base_path);
private:
    void parse_map_include(Map & map, xml_node const& node);
    void parse_style(Map & map, xml_node const& node);
    void parse_layer(Map & map, xml_node const& node);
    void parse_symbolizer_base(symbolizer_base &sym, xml_node const& node);
    void parse_fontset(Map & map, xml_node const & node);
    bool parse_font(font_set & fset, xml_node const& f);
    void parse_rule(feature_type_style & style, xml_node const & node);
    void parse_symbolizers(rule & rule, xml_node const & node);
    void parse_point_symbolizer(rule & rule, xml_node const& node);
    void parse_line_pattern_symbolizer(rule & rule, xml_node const& node);
    void parse_polygon_pattern_symbolizer(rule & rule, xml_node const& node);
    void parse_text_symbolizer(rule & rule, xml_node const& node);
    void parse_shield_symbolizer(rule & rule, xml_node const& node);
    void parse_line_symbolizer(rule & rule, xml_node const& node);
    void parse_polygon_symbolizer(rule & rule, xml_node const& node);
    void parse_building_symbolizer(rule & rule, xml_node const& node);
    void parse_raster_symbolizer(rule & rule, xml_node const& node);
    void parse_markers_symbolizer(rule & rule, xml_node const& node);
    void parse_group_symbolizer(rule &rule, xml_node const& node);
    void parse_debug_symbolizer(rule & rule, xml_node const& node);
    void parse_group_rule(group_symbolizer_properties &prop, xml_node const& node);
    void parse_simple_layout(group_symbolizer_properties &prop, xml_node const& node);
    void parse_pair_layout(group_symbolizer_properties &prop, xml_node const& node);
    bool parse_raster_colorizer(raster_colorizer_ptr const& rc, xml_node const& node);
    void parse_stroke(symbolizer_base & symbol, xml_node const& node);
    void ensure_font_face(std::string const& face_name);
    void find_unused_nodes(xml_node const& root);
    void find_unused_nodes_recursive(xml_node const& node, std::string & error_text);
    std::string ensure_relative_to_xml(boost::optional<std::string> const& opt_path);
    void ensure_exists(std::string const& file_path);
    boost::optional<color> get_opt_color_attr(boost::property_tree::ptree const& node,
                                              std::string const& name);

    bool strict_;
    std::string filename_;
    std::map<std::string,parameters> datasource_templates_;
    freetype_engine font_engine_;
    face_manager<freetype_engine> font_manager_;
    std::map<std::string,std::string> file_sources_;
    std::map<std::string,font_set> fontsets_;
    std::string xml_base_path_;
};

//#include <mapnik/internal/dump_xml.hpp>
void load_map(Map & map, std::string const& filename, bool strict, std::string base_path)
{
    // TODO - use xml encoding?
    xml_tree tree("utf8");
    tree.set_filename(filename);
    read_xml(filename, tree.root());
    map_parser parser(strict, filename);
    parser.parse_map(map, tree.root(), base_path);
    //dump_xml(tree.root());
}

void load_map_string(Map & map, std::string const& str, bool strict, std::string base_path)
{
    // TODO - use xml encoding?
    xml_tree tree("utf8");
    if (!base_path.empty())
    {
        read_xml_string(str, tree.root(), base_path); // accept base_path passed into function
    }
    else
    {
        read_xml_string(str, tree.root(), map.base_path()); // FIXME - this value is not fully known yet
    }
    map_parser parser(strict, base_path);
    parser.parse_map(map, tree.root(), base_path);
}

void map_parser::parse_map(Map & map, xml_node const& node, std::string const& base_path)
{
    try
    {
        xml_node const& map_node = node.get_child("Map");
        try
        {
            optional<std::string> base_path_from_xml = map_node.get_opt_attr<std::string>("base");
            if (!base_path.empty())
            {
                map.set_base_path(base_path);
            }
            else if (base_path_from_xml)
            {
                map.set_base_path(*base_path_from_xml);
            }
            else if (!filename_.empty())
            {
                map.set_base_path(mapnik::util::dirname(filename_));
            }
            xml_base_path_ = map.base_path();

            optional<color> bgcolor = map_node.get_opt_attr<color>("background-color");
            if (bgcolor)
            {
                map.set_background(*bgcolor);
            }

            optional<std::string> image_filename = map_node.get_opt_attr<std::string>("background-image");
            if (image_filename)
            {
                map.set_background_image(ensure_relative_to_xml(image_filename));
            }

            optional<std::string> comp_op_name = map_node.get_opt_attr<std::string>("background-image-comp-op");
            if (comp_op_name)
            {
                optional<composite_mode_e> comp_op = comp_op_from_string(*comp_op_name);
                if (comp_op)
                {
                    map.set_background_image_comp_op(*comp_op);
                }
                else
                {
                    throw config_error("failed to parse background-image-comp-op: '" + *comp_op_name + "'");
                }
            }

            optional<double> opacity = map_node.get_opt_attr<double>("background-image-opacity");
            if (opacity)
            {
                map.set_background_image_opacity(*opacity);
            }

            std::string srs = map_node.get_attr("srs", map.srs());
            try
            {
                // create throwaway projection object here to ensure it is valid
                projection proj(srs,true);
            }
            catch (std::exception const& ex)
            {
                throw mapnik::config_error(ex.what());
            }
            map.set_srs(srs);

            optional<unsigned> buffer_size = map_node.get_opt_attr<unsigned>("buffer-size");
            if (buffer_size)
            {
                map.set_buffer_size(*buffer_size);
            }

            optional<std::string> maximum_extent = map_node.get_opt_attr<std::string>("maximum-extent");
            if (maximum_extent)
            {
                box2d<double> box;
                if (box.from_string(*maximum_extent))
                {
                    map.set_maximum_extent(box);
                }
                else
                {
                    std::string s_err("failed to parse Map maximum-extent '");
                    s_err += *maximum_extent + "'";
                    if (strict_)
                    {
                        throw config_error(s_err);
                    }
                    else
                    {
                        MAPNIK_LOG_ERROR(load_map) << "map_parser: " << s_err;
                    }
                }
            }

            optional<std::string> font_directory = map_node.get_opt_attr<std::string>("font-directory");
            if (font_directory)
            {
                if (!freetype_engine::register_fonts(ensure_relative_to_xml(font_directory), false))
                {
                    if (strict_)
                    {
                        throw config_error(std::string("Failed to load fonts from: ") + *font_directory);
                    }
                }
            }

            optional<std::string> min_version_string = map_node.get_opt_attr<std::string>("minimum-version");

            if (min_version_string)
            {
                boost::char_separator<char> sep(".");
                boost::tokenizer<boost::char_separator<char> > tokens(*min_version_string, sep);
                unsigned i = 0;
                bool success = false;
                int n[3];
                for (auto const& beg : tokens)
                {
                    std::string item = mapnik::util::trim_copy(beg);
                    if (!mapnik::util::string2int(item,n[i]))
                    {
                        throw config_error(std::string("Invalid version string encountered: '")
                                           + beg + "' in '" + *min_version_string + "'");
                    }
                    if (i==2)
                    {
                        success = true;
                        break;
                    }
                    ++i;
                }
                if (success)
                {
                    int min_version = (n[0] * 100000) + (n[1] * 100) + (n[2]);
                    if (min_version > MAPNIK_VERSION)
                    {
                        throw config_error(std::string("This map uses features only present in Mapnik version ") + *min_version_string + " and newer");
                    }

                }

            }
        }
        catch (config_error const& ex)
        {
            ex.append_context(map_node);
            throw;
        }

        parse_map_include(map, map_node);
    }
    catch (node_not_found const&)
    {
        throw config_error("Not a map file. Node 'Map' not found.");
    }
    find_unused_nodes(node);
}

void map_parser::parse_map_include(Map & map, xml_node const& node)
{
    try
    {
        for (auto const& n : node)
        {
            if (n.is_text()) continue;
            if (n.is("Include"))
            {
                parse_map_include(map, n);
            }
            else if (n.is("Style"))
            {
                parse_style(map, n);
            }
            else if (n.is("Layer"))
            {
                parse_layer(map, n);
            }
            else if (n.is("FontSet"))
            {
                parse_fontset(map, n);
            }
            else if (n.is("FileSource"))
            {
                file_sources_[n.get_attr<std::string>("name")] = n.get_text();
            }
            else if (n.is("Datasource"))
            {
                std::string name = n.get_attr("name", std::string("Unnamed"));
                parameters params;
                for (auto const& p: n)
                {
                    if (p.is("Parameter"))
                    {
                        params[p.get_attr<std::string>("name")] = p.get_text();
                    }
                }
                datasource_templates_[std::move(name)] = std::move(params);
            }
            else if (n.is("Parameters"))
            {
                parameters & params = map.get_extra_parameters();
                for (auto const& p: n)
                {
                    if (p.is("Parameter"))
                    {
                        bool is_string = true;
                        boost::optional<std::string> type = p.get_opt_attr<std::string>("type");
                        if (type)
                        {
                            if (*type == "int")
                            {
                                is_string = false;
                                params[p.get_attr<std::string>("name")] = p.get_value<mapnik::value_integer>();
                            }
                            else if (*type == "float")
                            {
                                is_string = false;
                                params[p.get_attr<std::string>("name")] = p.get_value<mapnik::value_double>();
                            }
                        }
                        if (is_string)
                        {
                            params[p.get_attr<std::string>("name")] = p.get_text();
                        }
                    }
                }
            }
        }
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_style(Map & map, xml_node const& node)
{
    std::string name("<missing name>");
    try
    {
        name = node.get_attr<std::string>("name");
        feature_type_style style;

        filter_mode_e filter_mode = node.get_attr<filter_mode_e>("filter-mode", FILTER_ALL);
        style.set_filter_mode(filter_mode);

        // compositing
        optional<std::string> comp_op_name = node.get_opt_attr<std::string>("comp-op");
        if (comp_op_name)
        {
            optional<composite_mode_e> comp_op = comp_op_from_string(*comp_op_name);
            if (comp_op)
            {
                style.set_comp_op(*comp_op);
            }
            else
            {
                throw config_error("failed to parse comp-op: '" + *comp_op_name + "'");
            }
        }

        optional<double> opacity = node.get_opt_attr<double>("opacity");
        if (opacity) style.set_opacity(*opacity);

        optional<mapnik::boolean_type> image_filters_inflate = node.get_opt_attr<mapnik::boolean_type>("image-filters-inflate");
        if (image_filters_inflate)
        {
            style.set_image_filters_inflate(*image_filters_inflate);
        }

        // image filters
        optional<std::string> filters = node.get_opt_attr<std::string>("image-filters");
        if (filters)
        {
            if (!parse_image_filters(*filters, style.image_filters())) {
                throw config_error("failed to parse image-filters: '" + *filters + "'");
            }
        }

        // direct image filters (applied directly on main image buffer
        // TODO : consider creating a separate XML node e.g
        // <ImageFilter name="myfilter" op="blur emboss"/>
        //
        optional<std::string> direct_filters = node.get_opt_attr<std::string>("direct-image-filters");
        if (direct_filters)
        {
            if (!parse_image_filters(*direct_filters, style.direct_image_filters())) {
                throw config_error("failed to parse direct-image-filters: '" + *direct_filters + "'");
            }
        }

        style.reserve(node.size());
        // rules
        for (auto const& rule_ : node)
        {
            if (rule_.is("Rule"))
            {
                parse_rule(style, rule_);
            }
        }
        map.insert_style(name, std::move(style));
    }
    catch (config_error const& ex)
    {
        ex.append_context(std::string("in style '") + name + "'", node);
        throw;
    }
}

void map_parser::parse_fontset(Map & map, xml_node const& node)
{
    std::string name("<missing name>");
    try
    {
        name = node.get_attr<std::string>("name");
        font_set fontset(name);
        bool success = false;
        for (auto const& n: node)
        {
            if (n.is("Font"))
            {
                if (parse_font(fontset, n))
                {
                    success = true;
                }
            }
        }

        // if not at least one face-name is valid
        if (!success)
        {
            throw mapnik::config_error("no valid fonts could be loaded");
        }

        // XXX Hack because map object isn't accessible by text_symbolizer
        // when it's parsed
        fontsets_.emplace(name, fontset);
        map.insert_fontset(name, std::move(fontset));
    }
    catch (config_error const& ex)
    {
        ex.append_context(std::string("in FontSet '") + name + "'", node);
        throw;
    }
}

bool map_parser::parse_font(font_set &fset, xml_node const& f)
{
    optional<std::string> face_name = f.get_opt_attr<std::string>("face-name");
    if (face_name)
    {
        face_ptr face = font_manager_.get_face(*face_name);
        if (face)
        {
            fset.add_face_name(*face_name);
            return true;
        }
        else if (strict_)
        {
            throw config_error("Failed to find font face '" +
                               *face_name + "'");
        }
    }
    else
    {
        throw config_error("Must have 'face-name' set", f);
    }
    return false;
}

void map_parser::parse_layer(Map & map, xml_node const& node)
{
    std::string name;
    try
    {
        optional<mapnik::boolean_type> status = node.get_opt_attr<mapnik::boolean_type>("status");

        // return early is status is off
        if (status && !(*status)){
            node.set_ignore(true);
            return;
        }

        name = node.get_attr("name", std::string("Unnamed"));

        // If no projection is given inherit from map
        std::string srs = node.get_attr("srs", map.srs());
        try
        {
            // create throwaway projection object here to ensure it is valid
            projection proj(srs,true);
        }
        catch (std::exception const& ex)
        {
            throw mapnik::config_error(ex.what());
        }
        layer lyr(name, srs);


        if (status)
        {
            lyr.set_active(* status);
        }

        optional<double> min_zoom = node.get_opt_attr<double>("minzoom");
        if (min_zoom)
        {
            lyr.set_min_zoom(* min_zoom);
        }


        optional<double> max_zoom = node.get_opt_attr<double>("maxzoom");
        if (max_zoom)
        {
            lyr.set_max_zoom(* max_zoom);
        }

        optional<mapnik::boolean_type> queryable = node.get_opt_attr<mapnik::boolean_type>("queryable");
        if (queryable)
        {
            lyr.set_queryable(* queryable);
        }

        optional<mapnik::boolean_type> clear_cache =
            node.get_opt_attr<mapnik::boolean_type>("clear-label-cache");
        if (clear_cache)
        {
            lyr.set_clear_label_cache(* clear_cache);
        }

        optional<mapnik::boolean_type> cache_features =
            node.get_opt_attr<mapnik::boolean_type>("cache-features");
        if (cache_features)
        {
            lyr.set_cache_features(* cache_features);
        }

        optional<std::string> group_by =
            node.get_opt_attr<std::string>("group-by");
        if (group_by)
        {
            lyr.set_group_by(* group_by);
        }

        optional<unsigned> buffer_size = node.get_opt_attr<unsigned>("buffer-size");
        if (buffer_size)
        {
            lyr.set_buffer_size(*buffer_size);
        }

        optional<std::string> maximum_extent = node.get_opt_attr<std::string>("maximum-extent");
        if (maximum_extent)
        {
            box2d<double> box;
            if (box.from_string(*maximum_extent))
            {
                lyr.set_maximum_extent(box);
            }
            else
            {
                std::string s_err("failed to parse Layer maximum-extent '");
                s_err += *maximum_extent + "' for '" + name + "'";
                if (strict_)
                {
                    throw config_error(s_err);
                }
                else
                {
                    MAPNIK_LOG_ERROR(load_map) << "map_parser: " << s_err;
                }
            }
        }

        for (auto const& child: node)
        {

            if (child.is("StyleName"))
            {
                std::string const& style_name = child.get_text();
                if (style_name.empty())
                {
                    std::string ss("StyleName is empty in Layer: '");
                    ss += lyr.name() + "'";
                    if (strict_)
                    {
                        throw config_error(ss);
                    }
                    else
                    {
                        MAPNIK_LOG_WARN(load_map) << "map_parser: " << ss;
                    }
                }
                else
                {
                    lyr.add_style(style_name);
                }
            }
            else if (child.is("Datasource"))
            {
                parameters params;
                optional<std::string> base = child.get_opt_attr<std::string>("base");
                if(base)
                {
                    std::map<std::string,parameters>::const_iterator base_itr = datasource_templates_.find(*base);
                    if (base_itr != datasource_templates_.end())
                    {
                        params = base_itr->second;
                    }
                    else
                    {
                        MAPNIK_LOG_ERROR(datasource) << "Datasource template '" << *base
                                                     << "' not found for layer '" << name << "'";
                    }
                }

                for (auto const& n : child)
                {
                    if (n.is("Parameter"))
                    {
                        params[n.get_attr<std::string>("name")] = n.get_text();
                    }
                }

                boost::optional<std::string> base_param = params.get<std::string>("base");
                boost::optional<std::string> file_param = params.get<std::string>("file");

                if (base_param)
                {
                    params["base"] = ensure_relative_to_xml(base_param);
                }

                else if (file_param)
                {
                    params["file"] = ensure_relative_to_xml(file_param);
                }

                //now we are ready to create datasource
                try
                {
                    std::shared_ptr<datasource> ds =
                        datasource_cache::instance().create(params);
                    lyr.set_datasource(ds);
                }
                catch (std::exception const& ex)
                {
                    throw config_error(ex.what());
                }
                catch (...)
                {
                    throw config_error("Unknown exception occured attempting to create datasoure for layer '" + lyr.name() + "'");
                }
            }
        }
        map.add_layer(std::move(lyr));
    }
    catch (config_error const& ex)
    {
        if (!name.empty())
        {
            ex.append_context(std::string(" encountered during parsing of layer '") + name + "'", node);
        }
        throw;
    }
}

void map_parser::parse_rule(feature_type_style & style, xml_node const& node)
{
    std::string name;
    try
    {
        name = node.get_attr("name", std::string());
        rule rule(name);

        xml_node const* child = node.get_opt_child("Filter");
        if (child)
        {
            rule.set_filter(child->get_value<expression_ptr>());
        }

        if (node.has_child("ElseFilter"))
        {
            rule.set_else(true);
        }

        if (node.has_child("AlsoFilter"))
        {
            rule.set_also(true);
        }

        child = node.get_opt_child("MinScaleDenominator");
        if (child)
        {
            rule.set_min_scale(child->get_value<double>());
        }

        child = node.get_opt_child("MaxScaleDenominator");
        if (child)
        {
            rule.set_max_scale(child->get_value<double>());
        }

        parse_symbolizers(rule, node);
        style.add_rule(std::move(rule));

    }
    catch (config_error const& ex)
    {
        if (!name.empty())
        {
            ex.append_context(std::string("in rule '") + name + "'", node);
        }
        throw;
    }
}

void map_parser::parse_symbolizers(rule & rule, xml_node const & node)
{
    rule.reserve(node.size());
    for (auto const& sym_node : node)
    {
        switch (name2int(sym_node.name().c_str()))
        {
        case name2int("PointSymbolizer"):
            parse_point_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("LinePatternSymbolizer"):
            parse_line_pattern_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("PolygonPatternSymbolizer"):
            parse_polygon_pattern_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("TextSymbolizer"):
            parse_text_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("ShieldSymbolizer"):
            parse_shield_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("LineSymbolizer"):
            parse_line_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("PolygonSymbolizer"):
            parse_polygon_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("BuildingSymbolizer"):
            parse_building_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("RasterSymbolizer"):
            parse_raster_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("MarkersSymbolizer"):
            parse_markers_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("GroupSymbolizer"):
            parse_group_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        case name2int("DebugSymbolizer"):
            parse_debug_symbolizer(rule, sym_node);
            sym_node.set_processed(true);
            break;
        default:
            break;
        }
    }
}

void map_parser::parse_symbolizer_base(symbolizer_base &sym, xml_node const& node)
{
    set_symbolizer_property<symbolizer_base,double>(sym, keys::simplify_tolerance, node);
    set_symbolizer_property<symbolizer_base,double>(sym, keys::smooth, node);
    set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::clip, node);
    set_symbolizer_property<symbolizer_base,composite_mode_e>(sym, keys::comp_op, node);
    set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::geometry_transform, node);
    set_symbolizer_property<symbolizer_base,simplify_algorithm_e>(sym, keys::simplify_algorithm, node);
}

void map_parser::parse_point_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        optional<std::string> file = node.get_opt_attr<std::string>("file");
        optional<std::string> base = node.get_opt_attr<std::string>("base");

        point_symbolizer sym;
        parse_symbolizer_base(sym, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::opacity, node);
        set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::allow_overlap, node);
        set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::ignore_placement, node);
        set_symbolizer_property<symbolizer_base,point_placement_enum>(sym, keys::point_placement_type, node);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::image_transform, node);
        if (file && !file->empty())
        {
            if(base)
            {
                std::map<std::string,std::string>::const_iterator itr = file_sources_.find(*base);
                if (itr!=file_sources_.end())
                {
                    *file = itr->second + "/" + *file;
                }
            }
            *file = ensure_relative_to_xml(file);
            std::string filename = *file;
            ensure_exists(filename);
            put(sym, keys::file, parse_path(filename));
        }

        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_markers_symbolizer(rule & rule, xml_node const& node)
{
    try
    {
        std::string filename("");
        optional<std::string> file = node.get_opt_attr<std::string>("file");
        optional<std::string> base = node.get_opt_attr<std::string>("base");

        if (file && !file->empty())
        {
            if (base)
            {
                std::map<std::string,std::string>::const_iterator itr = file_sources_.find(*base);
                if (itr!=file_sources_.end())
                {
                    *file = itr->second + "/" + *file;
                }
            }

            filename = ensure_relative_to_xml(file);
        }

        optional<std::string> marker_type = node.get_opt_attr<std::string>("marker-type");
        if (marker_type)
        {
            // TODO - revisit whether to officially deprecate marker-type
            // https://github.com/mapnik/mapnik/issues/1427
            //MAPNIK_LOG_WARN(markers_symbolizer) << "'marker-type' is deprecated and will be removed in Mapnik 3.x, use file='shape://<type>' to specify known svg shapes";
            // back compatibility with Mapnik 2.0.0
            if (!marker_type->empty() && filename.empty())
            {
                if (*marker_type == "ellipse")
                {
                    filename = marker_cache::instance().known_svg_prefix_ + "ellipse";
                }
                else if (*marker_type == "arrow")
                {
                    filename = marker_cache::instance().known_svg_prefix_ + "arrow";
                }
            }
        }

        markers_symbolizer sym;
        parse_symbolizer_base(sym, node);
        if (!filename.empty())
        {
            ensure_exists(filename);
            put(sym,keys::file, parse_path(filename));
        }
        set_symbolizer_property<symbolizer_base,double>(sym, keys::opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::fill_opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::spacing, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::max_error, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::offset, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::width, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::height, node);
        set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::allow_overlap, node);
        set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::avoid_edges, node);
        set_symbolizer_property<symbolizer_base,boolean_type>(sym, keys::ignore_placement, node);
        set_symbolizer_property<symbolizer_base,color>(sym, keys::fill, node);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::image_transform, node);
        set_symbolizer_property<symbolizer_base,marker_placement_enum>(sym, keys::markers_placement_type, node);
        set_symbolizer_property<symbolizer_base,marker_multi_policy_enum>(sym, keys::markers_multipolicy, node);
        parse_stroke(sym,node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_line_pattern_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        std::string file = node.get_attr<std::string>("file");
        if (file.empty())
        {
            throw config_error("empty file attribute");
        }

        optional<std::string> base = node.get_opt_attr<std::string>("base");

        if(base)
        {
            std::map<std::string,std::string>::const_iterator itr = file_sources_.find(*base);
            if (itr!=file_sources_.end())
            {
                file = itr->second + "/" + file;
            }
        }

        file = ensure_relative_to_xml(file);
        ensure_exists(file);
        line_pattern_symbolizer sym;
        parse_symbolizer_base(sym, node);
        put(sym, keys::file, parse_path(file));
        set_symbolizer_property<symbolizer_base,double>(sym, keys::opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::offset, node);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::image_transform, node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_polygon_pattern_symbolizer(rule & rule,
                                                  xml_node const & node)
{
    try
    {
        std::string file = node.get_attr<std::string>("file");

        if (file.empty())
        {
            throw config_error("empty file attribute");
        }

        optional<std::string> base = node.get_opt_attr<std::string>("base");

        if (base)
        {
            std::map<std::string,std::string>::const_iterator itr = file_sources_.find(*base);
            if (itr!=file_sources_.end())
            {
                file = itr->second + "/" + file;
            }
        }

        file = ensure_relative_to_xml(file);
        ensure_exists(file);
        polygon_pattern_symbolizer sym;
        parse_symbolizer_base(sym, node);
        put(sym, keys::file, parse_path(file));
        set_symbolizer_property<symbolizer_base,double>(sym, keys::opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::gamma, node);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::image_transform, node);
        set_symbolizer_property<symbolizer_base,pattern_alignment_enum>(sym, keys::alignment, node);
        set_symbolizer_property<symbolizer_base,gamma_method_enum>(sym, keys::gamma_method, node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_text_symbolizer(rule & rule, xml_node const& node)
{
    try
    {
        text_placements_ptr placements;
        optional<std::string> placement_type = node.get_opt_attr<std::string>("placement-type");
        if (placement_type)
        {
            placements = placements::registry::instance().from_xml(*placement_type, node, fontsets_);
        }
        else
        {
            placements = std::make_shared<text_placements_dummy>();
            placements->defaults.from_xml(node, fontsets_);
        }
        if (strict_ && !placements->defaults.format_defaults.fontset)
        {
            ensure_font_face(placements->defaults.format_defaults.face_name);
        }
        text_symbolizer sym;
        parse_symbolizer_base(sym, node);
        put<text_placements_ptr>(sym, keys::text_placements_, placements);
        set_symbolizer_property<symbolizer_base,composite_mode_e>(sym, keys::halo_comp_op, node);
        set_symbolizer_property<symbolizer_base,halo_rasterizer_enum>(sym, keys::halo_rasterizer, node);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::halo_transform, node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_shield_symbolizer(rule & rule, xml_node const& node)
{
    try
    {
        text_placements_ptr placements;
        optional<std::string> placement_type = node.get_opt_attr<std::string>("placement-type");
        if (placement_type)
        {
            placements = placements::registry::instance().from_xml(*placement_type, node, fontsets_);
        } else {
            placements = std::make_shared<text_placements_dummy>();
        }
        placements->defaults.from_xml(node, fontsets_);
        if (strict_ &&
            !placements->defaults.format_defaults.fontset)
        {
            ensure_font_face(placements->defaults.format_defaults.face_name);
        }

        shield_symbolizer sym;
        parse_symbolizer_base(sym, node);
        put<text_placements_ptr>(sym, keys::text_placements_, placements);
        set_symbolizer_property<symbolizer_base,transform_type>(sym, keys::image_transform, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::shield_dx, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::shield_dy, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::text_opacity, node);
        set_symbolizer_property<symbolizer_base,mapnik::boolean_type>(sym, keys::unlock_image, node);

        std::string file = node.get_attr<std::string>("file");
        if (file.empty())
        {
            throw config_error("empty file attribute");
        }

        optional<std::string> base = node.get_opt_attr<std::string>("base");
        if(base)
        {
            std::map<std::string,std::string>::const_iterator itr = file_sources_.find(*base);
            if (itr!=file_sources_.end())
            {
                file = itr->second + "/" + file;
            }
        }

        // no_text - removed property in 2.1.x that used to have a purpose
        // before you could provide an expression with an empty string
        optional<mapnik::boolean_type> no_text = node.get_opt_attr<mapnik::boolean_type>("no-text");
        if (no_text)
        {
            MAPNIK_LOG_ERROR(shield_symbolizer) << "'no-text' is deprecated and will be removed in Mapnik 3.x, to create a ShieldSymbolizer without text just provide an element like: \"<ShieldSymbolizer ... />' '</>\"";
            // FIXME
//            if (*no_text)
            //              put(shield_symbol, "no-text", set_name(parse_expression("' '"));
        }

        file = ensure_relative_to_xml(file);
        ensure_exists(file);
        put(sym, keys::file , parse_path(file));
        optional<halo_rasterizer_e> halo_rasterizer_ = node.get_opt_attr<halo_rasterizer_e>("halo-rasterizer");
        if (halo_rasterizer_) put(sym, keys::halo_rasterizer, halo_rasterizer_enum(*halo_rasterizer_));
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_stroke(symbolizer_base & sym, xml_node const & node)
{
    set_symbolizer_property<symbolizer_base,double>(sym, keys::stroke_gamma, node);
    set_symbolizer_property<symbolizer_base,double>(sym, keys::stroke_dashoffset, node);
    set_symbolizer_property<symbolizer_base,double>(sym, keys::stroke_miterlimit, node);
    set_symbolizer_property<symbolizer_base,double>(sym, keys::stroke_width, node);
    set_symbolizer_property<symbolizer_base,double>(sym, keys::stroke_opacity, node);
    set_symbolizer_property<symbolizer_base,color>(sym, keys::stroke, node);
    set_symbolizer_property<symbolizer_base,line_join_enum>(sym, keys::stroke_linejoin, node);
    set_symbolizer_property<symbolizer_base,line_cap_enum>(sym, keys::stroke_linecap, node);
    set_symbolizer_property<symbolizer_base,gamma_method_enum>(sym, keys::stroke_gamma_method, node);
    set_symbolizer_property<symbolizer_base,dash_array>(sym, keys::stroke_dasharray, node);
}

void map_parser::parse_line_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        line_symbolizer sym;
        parse_symbolizer_base(sym, node);
        parse_stroke(sym, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::offset, node);
        set_symbolizer_property<symbolizer_base,line_rasterizer_enum>(sym, keys::line_rasterizer, node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_polygon_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        polygon_symbolizer sym;
        parse_symbolizer_base(sym, node);
        set_symbolizer_property<symbolizer_base,color>(sym, keys::fill, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::fill_opacity, node);
        set_symbolizer_property<symbolizer_base,double>(sym, keys::gamma, node);
        set_symbolizer_property<symbolizer_base,gamma_method_enum>(sym, keys::gamma_method, node);
        rule.append(std::move(sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_building_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        building_symbolizer building_sym;
        parse_symbolizer_base(building_sym, node);
        set_symbolizer_property<building_symbolizer,color>(building_sym, keys::fill, node);
        set_symbolizer_property<building_symbolizer,double>(building_sym, keys::fill_opacity, node);
        // TODO
        optional<expression_ptr> height = node.get_opt_attr<expression_ptr>("height");
        if (height) put(building_sym, keys::height, *height);
        rule.append(std::move(building_sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_raster_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        raster_symbolizer raster_sym;
        parse_symbolizer_base(raster_sym, node);
        // mode
        optional<std::string> mode = node.get_opt_attr<std::string>("mode");
        if (mode)
        {
            std::string mode_string = *mode;
            if (boost::algorithm::find_first(mode_string,"_"))
            {
                MAPNIK_LOG_ERROR(raster_symbolizer) << "'mode' values using \"_\" are deprecated and will be removed in Mapnik 3.x, use \"-\"instead";
                boost::algorithm::replace_all(mode_string,"_","-");
            }
            put(raster_sym, keys::mode, mode_string);
        }

        // scaling
        optional<std::string> scaling = node.get_opt_attr<std::string>("scaling");
        if (scaling)
        {
            std::string scaling_method = *scaling;
            if (scaling_method == "fast")
            {
                MAPNIK_LOG_ERROR(raster_symbolizer) << "'scaling' value of 'fast' is deprecated and will be removed in Mapnik 3.x, use 'near' with Mapnik >= 2.1.x";
                put(raster_sym, keys::scaling, SCALING_NEAR);
            }
            else
            {
                boost::optional<scaling_method_e> method = scaling_method_from_string(scaling_method);
                if (method)
                {
                    put(raster_sym, keys::scaling, *method);
                }
                else
                {
                    throw config_error("failed to parse 'scaling': '" + *scaling + "'");
                }
            }
        }

        // opacity
        optional<double> opacity = node.get_opt_attr<double>("opacity");
        if (opacity) put(raster_sym, keys::opacity, *opacity);

        // filter factor
        optional<double> filter_factor = node.get_opt_attr<double>("filter-factor");
        if (filter_factor) put(raster_sym, keys::filter_factor, *filter_factor);

        // mesh-size
        optional<unsigned> mesh_size = node.get_opt_attr<unsigned>("mesh-size");
        if (mesh_size) put<value_integer>(raster_sym, keys::mesh_size, *mesh_size);

        // premultiplied status of image
        optional<mapnik::boolean_type> premultiplied = node.get_opt_attr<mapnik::boolean_type>("premultiplied");
        if (premultiplied) put(raster_sym, keys::premultiplied, *premultiplied);

        bool found_colorizer = false;
        for ( auto const& css : node)
        {
            if (css.is("RasterColorizer"))
            {
                found_colorizer = true;
                raster_colorizer_ptr colorizer = std::make_shared<raster_colorizer>();
                put(raster_sym, keys::colorizer, colorizer);
                if (parse_raster_colorizer(colorizer, css))
                    put(raster_sym, keys::colorizer, colorizer);
            }
        }
        //look for properties one level up
        if (!found_colorizer)
        {
            raster_colorizer_ptr colorizer = std::make_shared<raster_colorizer>();
            if (parse_raster_colorizer(colorizer, node))
                put(raster_sym, keys::colorizer, colorizer);
        }
        rule.append(std::move(raster_sym));
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_group_symbolizer(rule & rule, xml_node const & node)
{
    try
    {
        group_symbolizer symbol;
        parse_symbolizer_base(symbol, node);
        group_symbolizer_properties_ptr prop = std::make_shared<group_symbolizer_properties>();
        set_symbolizer_property<symbolizer_base, value_integer>(symbol, keys::num_columns, node);
        set_symbolizer_property<symbolizer_base, value_integer>(symbol, keys::start_column, node);
        set_symbolizer_property<symbolizer_base, expression_ptr>(symbol, keys::repeat_key, node);
        text_placements_ptr placements = std::make_shared<text_placements_dummy>();
        placements->defaults.text_properties_from_xml(node);
        put<text_placements_ptr>(symbol, keys::text_placements_, placements);

        size_t layout_count = 0;
        for (auto const& child_node : node)
        {
            if (child_node.is("GroupRule"))
            {
                parse_group_rule(*prop, child_node);
                child_node.set_processed(true);
            }
            else if (child_node.is("SimpleLayout"))
            {
                parse_simple_layout(*prop, child_node);
                child_node.set_processed(true);
                ++layout_count;
            }
            else if (child_node.is("PairLayout"))
            {
                parse_pair_layout(*prop, child_node);
                child_node.set_processed(true);
                ++layout_count;
            }
            if (layout_count > 1)
            {
                throw config_error("Provide only one layout for a GroupSymbolizer.");
            }
        }
        put(symbol, keys::group_properties, prop);
        rule.append(std::move(symbol));
    }
    catch (const config_error & ex)
    {
        ex.append_context(node);
        throw;
    }
}

void map_parser::parse_debug_symbolizer(rule & rule, xml_node const & node)
{
    debug_symbolizer symbol;
    parse_symbolizer_base(symbol, node);
    // TODO
    optional<debug_symbolizer_mode_e> mode = node.get_opt_attr<debug_symbolizer_mode_e>("mode");
    if (mode) put(symbol, keys::mode, debug_symbolizer_mode_enum(*mode));
    rule.append(std::move(symbol));
}

bool map_parser::parse_raster_colorizer(raster_colorizer_ptr const& rc,
                                        xml_node const& node)
{
    bool found_stops = false;
    try
    {
        // mode
        colorizer_mode default_mode =
            node.get_attr<colorizer_mode>("default-mode", COLORIZER_LINEAR);

        if(default_mode == COLORIZER_INHERIT)
        {
            throw config_error("RasterColorizer mode must not be INHERIT. ");
        }
        rc->set_default_mode(default_mode);

        // default colour
        optional<color> default_color = node.get_opt_attr<color>("default-color");
        if (default_color)
        {
            rc->set_default_color(*default_color);
        }

        // epsilon
        optional<float> eps = node.get_opt_attr<float>("epsilon");
        if (eps)
        {
            if(*eps < 0)
            {
                throw config_error("RasterColorizer epsilon must be > 0. ");
            }
            rc->set_epsilon(*eps);
        }

        float maximumValue = -std::numeric_limits<float>::max();
        for (auto const& n : node)
        {
            if (n.is("stop"))
            {
                found_stops = true;
                // colour is optional.
                optional<color> stopcolor = n.get_opt_attr<color>("color");
                if (!stopcolor)
                {
                    *stopcolor = *default_color;
                }

                // mode default to INHERIT
                colorizer_mode mode = n.get_attr<colorizer_mode>("mode", COLORIZER_INHERIT);

                // value is required, and it must be bigger than the previous
                optional<float> value = n.get_opt_attr<float>("value");

                if(!value)
                {
                    throw config_error("stop tag missing value");
                }

                if(value < maximumValue)
                {
                    throw config_error("stop tag values must be in ascending order");
                }
                maximumValue = *value;

                optional<std::string> label = n.get_opt_attr<std::string>("label");

                //append the stop
                colorizer_stop tmpStop;
                tmpStop.set_color(*stopcolor);
                tmpStop.set_mode(mode);
                tmpStop.set_value(*value);
                if (label)
                {
                    tmpStop.set_label(*label);
                }

                rc->add_stop(tmpStop);
            }
        }
    }
    catch (config_error const& ex)
    {
        ex.append_context(node);
        throw;
    }
    return found_stops;
}

void map_parser::parse_group_rule(group_symbolizer_properties & prop, xml_node const & node)
{
    try
    {
        rule fake_rule;
        expression_ptr filter, repeat_key;

        xml_node const *filter_child = node.get_opt_child("Filter"),
                       *rptkey_child = node.get_opt_child("RepeatKey");

        if (filter_child)
        {
            filter = filter_child->get_value<expression_ptr>();
        }
        else
        {
            filter = std::make_shared<mapnik::expr_node>(true);
        }

        if (rptkey_child)
        {
            repeat_key = rptkey_child->get_value<expression_ptr>();
        }

        group_rule_ptr rule = std::make_shared<group_rule>(filter, repeat_key);

        parse_symbolizers(fake_rule, node);

        for (auto const& sym : fake_rule)
        {
           rule->append(std::move(sym));
        }

        prop.add_rule(std::move(rule));
     }
     catch (const config_error & ex)
     {
         ex.append_context(node);
         throw;
     }
}

void map_parser::parse_simple_layout(group_symbolizer_properties & prop, xml_node const & node)
{
    simple_row_layout layout;

    optional<double> item_margin = node.get_opt_attr<double>("item-margin");
    if (item_margin) layout.set_item_margin(*item_margin);

    prop.set_layout(std::move(layout));
}

void map_parser::parse_pair_layout(group_symbolizer_properties & prop, xml_node const & node)
{
    pair_layout layout;

    optional<double> item_margin = node.get_opt_attr<double>("item-margin");
    if (item_margin) layout.set_item_margin(*item_margin);

    optional<double> max_difference = node.get_opt_attr<double>("max-difference");
    if (max_difference) layout.set_max_difference(*max_difference);

    prop.set_layout(std::move(layout));
}

void map_parser::ensure_font_face(std::string const& face_name)
{
    if (! font_manager_.get_face(face_name))
    {
        throw config_error("Failed to find font face '" +
                           face_name + "'");
    }
}

std::string map_parser::ensure_relative_to_xml(boost::optional<std::string> const& opt_path)
{
    if (marker_cache::instance().is_uri(*opt_path))
        return *opt_path;

    if (!xml_base_path_.empty())
    {
        std::string starting_path = *opt_path;
        if (mapnik::util::is_relative(starting_path))
        {
            return mapnik::util::make_absolute(starting_path,xml_base_path_);
        }
    }
    return *opt_path;
}

void map_parser::ensure_exists(std::string const& file_path)
{
    if (marker_cache::instance().is_uri(file_path))
        return;
    // validate that the filename exists if it is not a dynamic PathExpression
    if (!boost::algorithm::find_first(file_path,"[") && !boost::algorithm::find_first(file_path,"]"))
    {
        if (!mapnik::util::exists(file_path))
        {
            throw mapnik::config_error("file could not be found: '" + file_path + "'");
        }
    }
}

void map_parser::find_unused_nodes(xml_node const& root)
{
    std::string error_message;
    find_unused_nodes_recursive(root, error_message);
    if (!error_message.empty())
    {
        std::string msg("Unable to process some data while parsing '" + filename_ + "':" + error_message);
        if (strict_)
        {
            throw config_error(msg);
        }
        else
        {
            MAPNIK_LOG_ERROR(load_map) << msg;
        }
    }
}

void map_parser::find_unused_nodes_recursive(xml_node const& node, std::string & error_message)
{
    if (!node.ignore())
    {
        if (!node.processed())
        {
            if (node.is_text())
            {
                error_message += "\n* text '" + node.text() + "'";
            }
            else
            {
                error_message += "\n* node '" + node.name() + "' at line " + node.line_to_string();
            }
            return; //All attributes and children are automatically unprocessed, too.
        }
        xml_node::attribute_map const& attrs = node.get_attributes();
        for (auto const& attr : attrs)
        {
            if (!attr.second.processed)
            {
                error_message += "\n* attribute '" + attr.first +
                    "' with value '" + attr.second.value +
                    "' at line " + node.line_to_string();
            }
        }
        for (auto const& child_node : node)
        {
            find_unused_nodes_recursive(child_node, error_message);
        }
    }
}

} // end of namespace mapnik