D4Group.cc

// -*- mode: c++; c-basic-offset:4 -*-

// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.

// Copyright (c) 2013 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// 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 Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.

#include "config.h"

//#define DODS_DEBUG

#include <cassert>

#include <iostream>
#include <sstream>
#include <iomanip>

#include <stdint.h>

#include "crc.h"

#include "BaseType.h"
#include "Array.h"

#include "XMLWriter.h"
#include "D4Attributes.h"
#include "D4Dimensions.h"
#include "D4Group.h"
#include "D4Enum.h"

#include "D4StreamMarshaller.h"
#include "D4StreamUnMarshaller.h"

#include "debug.h"

#undef INCLUDE_SOURCE_BYTE_ORDER

namespace libdap {

void D4Group::m_duplicate(const D4Group &g)
{
    DBG(cerr << "In D4Group::m_duplicate for " << g.name() << endl);

    // dims; deep copy, this is the parent
    if (g.d_dims) {
        d_dims = new D4Dimensions(*(g.d_dims));
        d_dims->set_parent(this);

        // Update all of the D4Dimension weak pointers in the Array objects.
        // This is a hack - we know that Constructor::m_duplicate() has been
        // called at this point and any Array instances have dimension pointers
        // that reference the 'old' dimensions (g.d_dims) and not the 'new'
        // dimensions made above. Scan every array and re-wire the weak pointers.
        // jhrg 8/15/14
        Vars_citer vi = d_vars.begin();
        while (vi != d_vars.end()) {
            if ((*vi)->type() == dods_array_c)
                static_cast<Array*>(*vi)->update_dimension_pointers(g.d_dims, d_dims);
            ++vi;
        }
    }

#if 0
    // Moved this block up inside the if because g.d_dims might be false. jhrg 9/14/15
    Vars_citer vi = d_vars.begin();
    while (vi != d_vars.end()) {
        if ((*vi)->type() == dods_array_c)
            static_cast<Array*>(*vi)->update_dimension_pointers(g.d_dims, d_dims);
        ++vi;
    }
#endif

    // enums; deep copy
    if (g.d_enum_defs) d_enum_defs = new D4EnumDefs(*g.d_enum_defs);

    // groups
    groupsCIter i = g.d_groups.begin();
    while(i != g.d_groups.end()) {
        // Only D4Groups are in the d_groups container.
        D4Group *g = static_cast<D4Group*>((*i++)->ptr_duplicate());
        add_group_nocopy(g);
    }

    DBG(cerr << "Exiting D4Group::m_duplicate" << endl);
}

D4Group::D4Group(const string &name)
    : Constructor(name, dods_group_c, /*is_dap4*/true), d_dims(0), d_enum_defs(0)
{}

D4Group::D4Group(const string &name, const string &dataset)
    : Constructor(name, dataset, dods_group_c, /*is_dap4*/true), d_dims(0), d_enum_defs(0)
{}

D4Group::D4Group(const D4Group &rhs) : Constructor(rhs), d_dims(0), d_enum_defs(0)
{
    DBG(cerr << "In D4Group::copy_ctor for " << rhs.name() << endl);
    m_duplicate(rhs);
}

D4Group::~D4Group()
{
    delete d_dims;
    delete d_enum_defs;

    groupsIter i = d_groups.begin();
    while(i != d_groups.end())
        delete *i++;
}

#if 0
D4Group *

// I think this was a mistake. jhrg 11/17/16
#endif
BaseType *
D4Group::ptr_duplicate()
{
    return new D4Group(*this);
}

D4Group &
D4Group::operator=(const D4Group &rhs)
{
    if (this == &rhs)
        return *this;

    dynamic_cast<Constructor &>(*this) = rhs; // run Constructor=

    m_duplicate(rhs);

    return *this;
}

string
D4Group::FQN() const
{
    // The root group is named "/" (always)
    return (name() == "/") ? "/" : static_cast<D4Group*>(get_parent())->FQN() + name() + "/";
}

// Note that in order for this to work the second argument must not be a reference.
// jhrg 8/20/13
static bool
name_eq(D4Group *g, const string name)
{
    return g->name() == name;
}

D4Group *
D4Group::find_child_grp(const string &grp_name)
{
    groupsIter g = find_if(grp_begin(), grp_end(), bind2nd(ptr_fun(name_eq), grp_name));
    return (g == grp_end()) ? 0: *g;
}

// TODO Add constraint param? jhrg 11/17/13
BaseType *
D4Group::find_first_var_that_uses_dimension(D4Dimension *dim)
{
    // for each group, starting with the root group
    //    for each variable in the group that is marked to send and is an array
    //        return the btp if it uses the D4Dimension
    //    if it contains child groups, search those
    //        return the btp if it uses the D4Dimension
    // return null

    // exhaustive breadth-first search for 'dim

    // root group
    for (Vars_iter i = var_begin(), e = var_end(); i != e; ++i) {
        if ((*i)->send_p() && (*i)->type() == dods_array_c) {
            Array *a = static_cast<Array*>(*i);
            for (Array::Dim_iter di = a->dim_begin(), de = a->dim_end(); di != de; ++di) {
                if (a->dimension_D4dim(di) == dim)
                    return a;
            }
        }
    }

    for (groupsIter i = grp_begin(), e = grp_end(); i != e; ++i) {
        BaseType *btp = (*i)->find_first_var_that_uses_dimension(dim);
        if (btp) return btp;
    }

    return 0;
}

BaseType *
D4Group::find_first_var_that_uses_enumeration(D4EnumDef *enum_def)
{
    // for each group, starting with the root group
    //    for each variable in the group that is marked to send and is an array
    //        return the btp if it uses the D4EnumDef
    //    if it contains child groups, search those
    //        return the btp if it uses the D4EnumDef
    // return null

    // exhaustive breadth-first search for 'dim

    // root group
    for (Vars_iter i = var_begin(), e = var_end(); i != e; ++i) {
        if ((*i)->send_p() && (*i)->type() == dods_enum_c) {
            D4Enum *e = static_cast<D4Enum*>(*i);
            if (e->enumeration() == enum_def)
                return e;
        }
    }

    for (groupsIter i = grp_begin(), e = grp_end(); i != e; ++i) {
        BaseType *btp = (*i)->find_first_var_that_uses_enumeration(enum_def);
        if (btp) return btp;
    }

    return 0;
}

D4Dimension *
D4Group::find_dim(const string &path)
{
    string lpath = path;        // get a mutable copy

    // special-case for the root group
    if (lpath[0] == '/') {
        if (name() != "/")
            throw InternalErr(__FILE__, __LINE__, "Lookup of a FQN starting in non-root group.");
        else
            lpath = lpath.substr(1);
    }

    string::size_type pos = lpath.find('/');
    if (pos == string::npos) {
        // name looks like 'bar'
        return dims()->find_dim(lpath);
    }

    // name looks like foo/bar/baz where foo and bar must be groups
    string grp_name = lpath.substr(0, pos);
    lpath = lpath.substr(pos + 1);

    D4Group *grp = find_child_grp(grp_name);
    return (grp == 0) ? 0: grp->find_dim(lpath);
}

Array *
D4Group::find_map_source(const string &path)
{
    BaseType *map_source = m_find_map_source_helper(path);

    // TODO more complete semantic checking jhrg 10/16/13
    if (map_source && map_source->type() == dods_array_c) return static_cast<Array*>(map_source);

    return 0;
}

BaseType *
D4Group::m_find_map_source_helper(const string &path)
{
    string lpath = path;        // get a mutable copy

    // special-case for the root group
    if (lpath[0] == '/') {
        if (name() != "/")
            throw InternalErr(__FILE__, __LINE__, "Lookup of a FQN starting in non-root group.");
        else
            lpath = lpath.substr(1);
    }

    string::size_type pos = lpath.find('/');
    if (pos == string::npos) {
        // name looks like 'bar'
        return var(lpath);
    }

    // name looks like foo/bar/baz where foo an bar must be groups
    string grp_name = lpath.substr(0, pos);
    lpath = lpath.substr(pos + 1);

    D4Group *grp = find_child_grp(grp_name);
    return (grp == 0) ? 0: grp->var(lpath);
}

D4EnumDef *
D4Group::find_enum_def(const string &path)
{
    string lpath = path;        // get a mutable copy

    // special-case for the root group
    if (lpath[0] == '/') {
        if (name() != "/")
            throw InternalErr(__FILE__, __LINE__, "Lookup of a FQN starting in non-root group.");
        else
            lpath = lpath.substr(1);
    }

    string::size_type pos = lpath.find('/');
    if (pos == string::npos) {
        // name looks like 'bar'
        return enum_defs()->find_enum_def(lpath);
    }

    // name looks like foo/bar/baz where foo and bar must be groups
    string grp_name = lpath.substr(0, pos);
    lpath = lpath.substr(pos + 1);

    D4Group *grp = find_child_grp(grp_name);
    return (grp == 0) ? 0: grp->enum_defs()->find_enum_def(lpath);
}

BaseType *
D4Group::find_var(const string &path)
{
    string lpath = path;        // get a mutable copy

    // special-case for the root group
    if (lpath[0] == '/') {
        if (name() != "/")
            throw InternalErr(__FILE__, __LINE__, "Lookup of a FQN starting in non-root group.");
        else
            lpath = lpath.substr(1);
    }

    string::size_type pos = lpath.find('/');
    if (pos == string::npos) {
        // name looks like 'bar' or bar.baz; lookup in the Constructor that's part of the Group
        return var(lpath);
    }

    // name looks like foo/bar/baz where foo and bar must be groups
    string grp_name = lpath.substr(0, pos);
    lpath = lpath.substr(pos + 1);

    D4Group *grp = find_child_grp(grp_name);
    return (grp == 0) ? 0 : grp->find_var(lpath);
}

long
D4Group::request_size(bool constrained)
{
    long long size = 0;
    // variables
    Constructor::Vars_iter v = var_begin();
    while (v != var_end()) {
        if (constrained) {
            if ((*v)->send_p())
                size += (*v)->width(constrained);
        }
        else {
            size += (*v)->width(constrained);
        }

        ++v;
    }

    // groups
    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        size += (*g++)->request_size(constrained);

    return size / 1024;
}

void
D4Group::set_read_p(bool state)
{
    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        (*g++)->set_read_p(state);

    Constructor::set_read_p(state);
}

void
D4Group::set_send_p(bool state)
{
    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        (*g++)->set_send_p(state);

    Constructor::set_send_p(state);
}

void
D4Group::intern_data(/*Crc32 &checksum, DMR &dmr, ConstraintEvaluator &eval*/)
{
    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        (*g++)->intern_data(/*checksum, dmr, eval*/);

    // Specialize how the top-level variables in any Group are sent; include
    // a checksum for them. A subset operation might make an interior set of
    // variables, but the parent structure will still be present and the checksum
    // will be computed for that structure. In other words, DAP4 does not try
    // to sort out which variables are the 'real' top-level variables and instead
    // simply computes the CRC for whatever appears as a variable in the root
    // group.
    for (Vars_iter i = d_vars.begin(); i != d_vars.end(); i++) {
        // Only send the stuff in the current subset.
        if ((*i)->send_p()) {
#if 0
            checksum.Reset();
#endif
            (*i)->intern_data(/*checksum, dmr, eval*/);
#if 0
            D4Attribute *a = new D4Attribute("DAP4_Checksum_CRC32", attr_str_c);

            ostringstream oss;
            oss.setf(ios::hex, ios::basefield);
            oss << setfill('0') << setw(8) << checksum.GetCrc32();
            a->add_value(oss.str());
#if INCLUDE_SOURCE_BYTE_ORDER
            if (um.is_source_big_endian())
                a->add_value("source:big-endian");
            else
                a->add_value("source:little-endian");
#endif
            (*i)->attributes()->add_attribute_nocopy(a);
            DBG(cerr << "CRC32: " << oss.str() << " for " << (*i)->name() << endl);
#endif
        }
    }
}

void
D4Group::serialize(D4StreamMarshaller &m, DMR &dmr, /*ConstraintEvaluator &eval,*/ bool filter)
{
#if 0
    // This will call Constructor read which will, for everything but a Sequence,
    // read all of the data in one shot. However, the serialize() methods for the
    // Arrays, Structures, etc., also have read() calls in them and those can be
    // used to control how long the data are in memory, e.g., limiting the lifetime
    // of a large array and avoiding having overlapping arrays when they are not
    // needed. For a sequence read() has different semantics. It is called once
    // for every instance and the read_p flag is not used.
    if (!read_p())
        read();  // read() throws Error
#endif

    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        (*g++)->serialize(m, dmr, filter);

    // Specialize how the top-level variables in any Group are sent; include
    // a checksum for them. A subset operation might make an interior set of
    // variables, but the parent structure will still be present and the checksum
    // will be computed for that structure. In other words, DAP4 does not try
    // to sort out which variables are the 'real' top-level variables and instead
    // simply computes the CRC for whatever appears as a variable in the root
    // group.
    for (Vars_iter i = d_vars.begin(); i != d_vars.end(); i++) {
        // Only send the stuff in the current subset.
        if ((*i)->send_p()) {
            m.reset_checksum();

            DBG(cerr << "Serializing variable " << (*i)->type_name() << " " << (*i)->name() << endl);
            (*i)->serialize(m, dmr, filter);

            DBG(cerr << "Wrote CRC32: " << m.get_checksum() << " for " << (*i)->name() << endl);
            m.put_checksum();
        }
    }
}

void D4Group::deserialize(D4StreamUnMarshaller &um, DMR &dmr)
{
    groupsIter g = d_groups.begin();
    while (g != d_groups.end()) {
        DBG(cerr << "Deserializing group " << (*g)->name() << endl);
        (*g++)->deserialize(um, dmr);
    }
    // Specialize how the top-level variables in any Group are received; read
    // their checksum and store the value in a magic attribute of the variable
    for (Vars_iter i = d_vars.begin(); i != d_vars.end(); i++) {
        DBG(cerr << "Deserializing variable " << (*i)->type_name() << " " << (*i)->name() << endl);
        (*i)->deserialize(um, dmr);

        D4Attribute *a = new D4Attribute("DAP4_Checksum_CRC32", attr_str_c);
        string crc = um.get_checksum_str();
        a->add_value(crc);
#if INCLUDE_SOURCE_BYTE_ORDER
        if (um.is_source_big_endian())
            a->add_value("source:big-endian");
        else
            a->add_value("source:little-endian");
#endif
        DBG(cerr << "Read CRC32: " << crc << " for " << (*i)->name() << endl);
        (*i)->attributes()->add_attribute_nocopy(a);
    }
}

void
D4Group::print_dap4(XMLWriter &xml, bool constrained)
{
    if (!name().empty() && name() != "/") {
        // For named groups, if constrained is true only print if this group
        // has variables that are marked for transmission. For the root group
        // this test is not made.
        if (constrained && !send_p())
            return;

        if (xmlTextWriterStartElement(xml.get_writer(), (const xmlChar*) type_name().c_str()) < 0)
            throw InternalErr(__FILE__, __LINE__, "Could not write " + type_name() + " element");

        if (xmlTextWriterWriteAttribute(xml.get_writer(), (const xmlChar*) "name", (const xmlChar*) name().c_str()) < 0)
            throw InternalErr(__FILE__, __LINE__, "Could not write attribute for name");
    }

    // dims
    if (!dims()->empty())
        dims()->print_dap4(xml, constrained);

    // enums
    if (!enum_defs()->empty())
        enum_defs()->print_dap4(xml, constrained);

    // variables
    Constructor::Vars_iter v = var_begin();
    while (v != var_end())
        (*v++)->print_dap4(xml, constrained);

    // attributes
    attributes()->print_dap4(xml);

    // groups
    groupsIter g = d_groups.begin();
    while (g != d_groups.end())
        (*g++)->print_dap4(xml, constrained);

    if (!name().empty() && name() != "/") {
        if (xmlTextWriterEndElement(xml.get_writer()) < 0)
            throw InternalErr(__FILE__, __LINE__, "Could not end " + type_name() + " element");
    }
}
#if 0

vector<BaseType *> *
D4Group::transform_to_dap2(AttrTable *parent_attr_table)
{
    return transform_to_dap2(parent_attr_table, false);
}
#endif

vector<BaseType *> *
D4Group::transform_to_dap2(AttrTable *parent_attr_table)
{
    DBG( cerr << __func__ << "() - BEGIN ("<< name() << ")" << endl);

    vector<BaseType *> *results = new vector<BaseType *>(); // LEAK

    // Get the D4Group's attributes
#if 0
    AttrTable *group_attrs = attributes()->get_AttrTable(name());
#else
    AttrTable *group_attrs = new AttrTable();
    attributes()->transform_attrs_to_dap2(group_attrs);
    group_attrs->set_name(name());
#endif

    // If this is the root group then copy all of its attributes into the parent_attr_table.
    // The group_attrs AttrTable* above will be replaced by the parent_attr_table.
    bool is_root = (name() == "/");

    if (is_root) {
        assert(name() == "/");
        for (AttrTable::Attr_iter i = group_attrs->attr_begin(), e = group_attrs->attr_end(); i != e; ++i) {
            if ((*i)->type == Attr_container) {
                // copy the source container so that the DAS passed in can be
                // deleted after calling this method.
                AttrTable *at = new AttrTable(*(*i)->attributes);
                parent_attr_table->append_container(at, at->get_name());
            }
            else {
                parent_attr_table->append_attr((*i)->name, AttrType_to_String((*i)->type), (*i)->attr);
            }
        }
        delete group_attrs;
        group_attrs = parent_attr_table;
    }

    // Now we process the child variables of this group

    vector<BaseType *> dropped_vars;
    for (D4Group::Vars_citer i = var_begin(), e = var_end(); i != e; ++i) {

        DBG( cerr << __func__ << "() - Processing member variable '" << (*i)->name() <<
            "' root: " << (is_root?"true":"false") << endl);

        vector<BaseType *> *new_vars = (*i)->transform_to_dap2(group_attrs);
        if (new_vars) {  // Might be un-mappable
            // It's not so game on..
            for (vector<BaseType*>::iterator vi = new_vars->begin(), ve = new_vars->end(); vi != ve; vi++) {
                string new_name = (is_root ? "" : FQN()) + (*vi)->name();
                (*vi)->set_name(new_name);
                (*vi)->set_parent(NULL);
                results->push_back((*vi));
#if 0
                (*vi) = NULL;
#endif
                DBG( cerr << __func__ << "() - Added member variable '" << (*i)->name() << "' " <<
                    "to results vector. root: "<< (is_root?"true":"false") << endl);
            }

            delete new_vars;
        }
        else {
            DBG( cerr << __func__ << "() - Dropping member variable " << (*i)->name() <<
                " root: " << (is_root?"true":"false") << endl);
            // Got back a NULL, so we are dropping this var.
            dropped_vars.push_back(*i);
        }
    }

    // Process dropped DAP4 vars
    DBG( cerr << __func__ << "() - Processing " << dropped_vars.size() << " Dropped Variable(s)" << endl);

    AttrTable *dv_attr_table = make_dropped_vars_attr_table(&dropped_vars);
    if (dv_attr_table) {
        group_attrs->append_container(dv_attr_table, dv_attr_table->get_name());
    }

    // Get all the child groups.
    for (D4Group::groupsIter gi = grp_begin(), ge = grp_end(); gi != ge; ++gi) {
        vector<BaseType *> *d2_vars = (*gi)->transform_to_dap2(group_attrs);
        if (d2_vars) {
            for (vector<BaseType *>::iterator i = d2_vars->begin(), e = d2_vars->end(); i != e; ++i) {
                results->push_back(*i);
            }
        }
    delete d2_vars;
    }

    if (!is_root) {
        group_attrs->set_name(name());
        parent_attr_table->append_container(group_attrs, group_attrs->get_name());
    }

    return results;
}


} /* namespace libdap */