NgapBuildDmrppContainer.cc

// NgapBuildDmrppContainer.cc
 
// -*- mode: c++; c-basic-offset:4 -*-
 
// This file is part of builddmrpp_module, A C++ module that can be loaded in to
// the OPeNDAP Back-End Server (BES) and is able to handle remote requests.
 
// Copyright (c) 2023 OPeNDAP, Inc.
// Authors: Daniel Holloway <dholloway@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.
// Authors:
//      dan       Daniel Holloway <dholloway@opendap.org>
//      ndp       Nathan Potter <ndp@opendap.org>
 
#include "config.h"
 
#include <map>
#include <memory>
#include <string>
 
#include "BESStopWatch.h"
#include "BESLog.h"
#include "BESSyntaxUserError.h"
#include "BESInternalError.h"
#include "BESDebug.h"
#include "BESContextManager.h"
#include "CurlUtils.h"
#include "RemoteResource.h"
 
#include "NgapApi.h"
#include "NgapNames.h"
#include "NgapBuildDmrppContainer.h"
 
#define prolog std::string("NgapBuildDmrppContainer::").append(__func__).append("() - ")
 
using namespace std;
using namespace ngap;
 
namespace builddmrpp {

NgapBuildDmrppContainer::NgapBuildDmrppContainer(const string &sym_name, const string &real_name,  const string &type) :
        BESContainer(sym_name, real_name, type) {
    initialize();
}
 
void NgapBuildDmrppContainer::initialize()
{
    BESDEBUG(MODULE, prolog << "BEGIN (obj_addr: "<< (void *) this << ")" << endl);
    BESDEBUG(MODULE, prolog << "sym_name: "<< get_symbolic_name() << endl);
    BESDEBUG(MODULE, prolog << "real_name: "<< get_real_name() << endl);
    BESDEBUG(MODULE, prolog << "type: "<< get_container_type() << endl);
 
#if 0
    // Removed jhrg 10/20/23
    // I removed this becase the uid was used by convert_ngap_resty_...() only as part of
    // the key for cached data. The cache has been moved out of that code and into the
    // NgapContainer class.
    
    bool found;
    string uid = BESContextManager::TheManager()->get_context(EDL_UID_KEY, found);
    BESDEBUG(MODULE, prolog << "EDL_UID_KEY(" << EDL_UID_KEY << "): " << uid << endl);
#endif
 
    string data_access_url = ngap::NgapApi::convert_ngap_resty_path_to_data_access_url(get_real_name());
 
    set_real_name(data_access_url);
 
    BESDEBUG(MODULE, prolog << "END (obj_addr: "<< (void *) this << ")" << endl);
}
 
NgapBuildDmrppContainer::NgapBuildDmrppContainer(const NgapBuildDmrppContainer &copy_from) :
        BESContainer(copy_from), d_data_rresource(copy_from.d_data_rresource), d_real_name(copy_from.d_real_name) {
 
    BESDEBUG(MODULE, prolog << "BEGIN   object address: "<< (void *) this << " Copying from: " << (void *) &copy_from << endl);
    // We can not make a copy of this container once the request has been made.
    if (d_data_rresource) {
        throw BESInternalError("The Container has already been accessed, cannot create a copy of this container.",
                               __FILE__, __LINE__);
    }
    BESDEBUG(MODULE, prolog << "object address: "<< (void *) this << endl);
}

void NgapBuildDmrppContainer::_duplicate(NgapBuildDmrppContainer &copy_to) {
    BESDEBUG(MODULE, prolog << "BEGIN   object address: "<< (void *) this << " Copying to: " << (void *) &copy_to << endl);
 
    if (copy_to.d_data_rresource) {
        throw BESInternalError("The Container has already been accessed, cannot duplicate this resource.",
                               __FILE__, __LINE__);
    }
 
    BESContainer::_duplicate(copy_to);
 
    copy_to.d_real_name = d_real_name;
    copy_to.d_data_rresource = d_data_rresource;
}
 
BESContainer *
NgapBuildDmrppContainer::ptr_duplicate() {
    auto container = make_unique<NgapBuildDmrppContainer>();
    _duplicate(*container.get());
    BESDEBUG(MODULE, prolog << "object address: "<< (void *) this << " to: " << container.get() << endl);
    return container.release();
}

string NgapBuildDmrppContainer::access() {
    BESDEBUG(MODULE, prolog << "BEGIN  (obj_addr: "<< (void *) this << ")" << endl);
 
    // Since this the ngap we know that the real_name is a URL.
    string data_access_url_str = get_real_name();
 
    BESDEBUG(MODULE, prolog << " data_access_url: " << data_access_url_str << endl);
 
    string href="href=\"";
    string trusted_url_hack= R"(" dmrpp:trust="true")";
 
    string data_access_url_key = href + DATA_ACCESS_URL_KEY + "\"";
    BESDEBUG(MODULE, prolog << "                   data_access_url_key: " << data_access_url_key << endl);
 
    string data_access_url_with_trusted_attr_str = href + data_access_url_str + trusted_url_hack;
    BESDEBUG(MODULE, prolog << " data_access_url_with_trusted_attr_str: " << data_access_url_with_trusted_attr_str << endl);
 
    if (!d_data_rresource) {
        BESDEBUG(MODULE, prolog << "Building new RemoteResource (dmr++)." << endl);
        map<string, string> content_filters;
 
        auto data_url(std::make_shared<http::url>(data_access_url_str, true));
        {
            d_data_rresource = std::make_shared<http::RemoteResource>(data_url);
            BES_STOPWATCH_START(MODULE, prolog + "DMR++ retrieval: " + data_url->str());
            d_data_rresource->retrieve_resource();
        }
        BESDEBUG(MODULE, prolog << "Retrieved remote resource: " << data_url->str() << endl);
    }
 
    string tmp_filename = d_data_rresource->get_filename();
 
    BESDEBUG(MODULE, prolog << "Using local cache file: " << tmp_filename << endl);
    BESDEBUG(MODULE, prolog << "Done retrieving:  " << data_access_url_str << " returning cached file " << tmp_filename << endl);
    BESDEBUG(MODULE, prolog << "END  (obj_addr: "<< (void *) this << ")" << endl);
 
    return tmp_filename;    // this should return the dmr++ file name from the NgapCache
}

void NgapBuildDmrppContainer::dump(ostream &strm) const {
    strm << BESIndent::LMarg << "NgapBuildDmrppContainer::dump - (" << (void *) this << ")" << endl;
    BESIndent::Indent();
    BESContainer::dump(strm);
    if (d_data_rresource) {
        strm << BESIndent::LMarg << "RemoteResource.getCacheFileName(): " << d_data_rresource->get_filename()
             << endl;
    } else {
        strm << BESIndent::LMarg << "response not yet obtained" << endl;
    }
    BESIndent::UnIndent();
}
 
}   // namespace builddmrpp