BESCatalogResponseHandler.cc

// BESCatalogResponseHandler.cc
 
// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.
 
// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// 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 University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301
 
// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>
 
#include "config.h"
 
#include "BESCatalogResponseHandler.h"
#include "BESInfoList.h"
#include "BESInfo.h"
#include "BESNames.h"
#include "BESDataNames.h"
#include "BESCatalogList.h"
#include "BESCatalog.h"
#include "BESCatalogEntry.h"
#include "BESCatalogUtils.h"
#include "BESStopWatch.h"
#include "BESNotFoundError.h"
#include "BESDebug.h"
 
using std::endl;
using std::ostream;
using std::string;
 
const auto MODULE="BESCatalog";
#define prolog std::string("BESCatalogResponseHandler::").append(__func__).append("() - ")
 
 
BESCatalogResponseHandler::BESCatalogResponseHandler(const string &name) :
    BESResponseHandler(name)
{
}
 
BESCatalogResponseHandler::~BESCatalogResponseHandler()
{
}

void BESCatalogResponseHandler::execute(BESDataHandlerInterface &dhi)
{
    BES_STOPWATCH_START_DHI(MODULE, prolog + "Timer", &dhi);
 
    BESInfo *info = BESInfoList::TheList()->build_info();
    d_response_object = info;
 
    // Remove all of the leading slashes from the container (path) name
    string container = dhi.data[CONTAINER];
    string::size_type notslash = container.find_first_not_of("/", 0);
    if (notslash != string::npos) {
        container = container.substr(notslash);
    }
    if (container.empty()) container = "/";
 
    BESCatalog *besCatalog = nullptr;
    string catalog = dhi.data[CATALOG];
    if(catalog.empty()){
        // Use default catalog to service request
        besCatalog = BESCatalogList::TheCatalogList()->default_catalog();
        catalog = besCatalog->get_catalog_name();
    }
    else {
        // Use the specified catalog.
        besCatalog = BESCatalogList::TheCatalogList()->find_catalog(catalog);
        if (!besCatalog) {
            string err = (string) "Not able to find the catalog '" + catalog + "'";
            throw BESInternalError(err, __FILE__, __LINE__);
        }
    }
 
    BESCatalogEntry *entry = nullptr;
    // we always want to get the container information from the
    // default catalog, whether the node is / or not
    entry = besCatalog->show_catalog(container, entry);
    if (!entry) {
        string err = (string) "Failed to find node " + container;
        throw BESNotFoundError(err, __FILE__, __LINE__);
    }
 
    // now that we have all the catalog entry information, display it
    // start the response depending on if show catalog or show info
    info->begin_response(CATALOG_RESPONSE_STR, dhi);
    dhi.action_name = CATALOG_RESPONSE_STR;
 
    // start with the first level entry
    BESCatalogUtils::display_entry(entry, info);
 
    BESCatalogEntry::catalog_citer ei = entry->get_beginning_entry();
    BESCatalogEntry::catalog_citer ee = entry->get_ending_entry();
    for (; ei != ee; ei++) {
        BESCatalogUtils::display_entry((*ei).second, info);
        info->end_tag("dataset");
    }
 
    info->end_tag("dataset");
 
    // end the response object
    info->end_response();
 
    delete entry;
}

void BESCatalogResponseHandler::transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
{
    if (d_response_object) {
        BESInfo *info = dynamic_cast<BESInfo *>(d_response_object);
        if (!info) throw BESInternalError("cast error", __FILE__, __LINE__);
        info->transmit(transmitter, dhi);
    }
}

void BESCatalogResponseHandler::dump(ostream &strm) const
{
    strm << BESIndent::LMarg << "BESCatalogResponseHandler::dump - (" << (void *) this << ")" << endl;
    BESIndent::Indent();
    BESResponseHandler::dump(strm);
    BESIndent::UnIndent();
}
 
BESResponseHandler *
BESCatalogResponseHandler::CatalogResponseBuilder(const string &name)
{
    return new BESCatalogResponseHandler(name);
}