NgapOwnedContainer.h

// -*- mode: c++; c-basic-offset:4 -*-
 
// This file is part of ngap_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) 2020, 2024 OPeNDAP, Inc.
// Author: Nathan Potter <ndp@opendap.org>,
//         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.
 
 
#ifndef NgapOwnedContainer_h_
#define NgapOwnedContainer_h_ 1
 
#include <string>
#include <map>
#include <memory>
 
#include "BESContainer.h"
 
namespace http {
class RemoteResource;
}
 
namespace ngap {

class NgapOwnedContainer: public BESContainer {
 
    std::string d_ngap_path;    // The (in)famous REST path
    static std::string d_data_source_location;
    static bool d_use_opendap_bucket;
    static bool d_inject_data_url;
 
    bool get_dmrpp_from_cache_or_remote_source(std::string &dmrpp_string) const;
 
    // I made these static so that they will be in the class' namespace but still
    // be easy to test in the unit tests. jhrg 4/29/24
    static bool file_to_string(int fd, std::string &content);
 
    static bool get_daac_content_filters(const std::string &data_url, std::map<std::string, std::string, std::less<>> &content_filters);
    static bool get_opendap_content_filters(std::map<std::string, std::string, std::less<>> &content_filters);
    static void filter_response(const std::map<std::string, std::string, std::less<>> &content_filters, std::string &content);
 
    static std::string build_dmrpp_url_to_owned_bucket(const std::string &rest_path, const std::string &data_source);
    static std::string build_data_url_to_daac_bucket(const std::string &rest_path);
 
    bool dmrpp_read_from_opendap_bucket(std::string &dmrpp_string) const;
    void dmrpp_read_from_daac_bucket(std::string &dmrpp_string) const;
 
    bool get_item_from_dmrpp_cache(std::string &dmrpp_string) const;
    bool put_item_in_dmrpp_cache(const std::string &dmrpp_string) const;
 
    friend class NgapOwnedContainerTest;
 
protected:
    void _duplicate(NgapOwnedContainer &copy_to) {
        copy_to.d_ngap_path = d_ngap_path;
        BESContainer::_duplicate(copy_to);
    }
 
public:
    NgapOwnedContainer() = default;
    NgapOwnedContainer(const NgapOwnedContainer &copy_from) = delete;
    NgapOwnedContainer(NgapOwnedContainer &&move_from) = delete;
    NgapOwnedContainer &operator=(const NgapOwnedContainer &rhs) = delete;
    NgapOwnedContainer &operator=(NgapOwnedContainer &&rhs) = delete;
    ~NgapOwnedContainer() override = default;
 
    NgapOwnedContainer(const std::string &sym_name, const std::string &real_name, const std::string &);
 
    BESContainer *ptr_duplicate() override {
        auto container = std::make_unique<NgapOwnedContainer>();
        _duplicate(*container);
        return container.release();
    }
 
    void set_ngap_path(const std::string &ngap_path) { d_ngap_path = ngap_path; }
    std::string get_ngap_path() const { return d_ngap_path; }

    static void set_data_source_location(const std::string &data_source_location) {
        d_data_source_location = data_source_location;
    }
    static std::string get_data_source_location() { return d_data_source_location; }
 
    std::string access() override;
 
    bool release() override {
        return true;
    }
 
    void dump(std::ostream &strm) const override;
};
 
} // namespace ngap
 
#endif // NgapOwnedContainer_h_