BESInfo.cc

Go to the documentation of this file.

// BESInfo.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 <cerrno>
#include <sstream>
#include <iostream>
#include <fstream>
#include <cstring>

using std::ostringstream;
using std::ifstream;

#include "BESInfo.h"
#include "TheBESKeys.h"
#include "BESInternalError.h"

#define BES_INFO_FILE_BUFFER_SIZE 4096

BESInfo::BESInfo() :
        _strm(0), _strm_owned(false), _buffered(true), _response_started(false)
{
    _strm = new ostringstream;
    _strm_owned = true;
}

BESInfo::BESInfo(const string &key, ostream *strm, bool strm_owned) :
        _strm(0), _strm_owned(false), _buffered(true)
{
    bool found = false;
    vector < string > vals;
    string b;
    TheBESKeys::TheKeys()->get_value(key, b, found);
    if (b == "true" || b == "True" || b == "TRUE" || b == "yes" || b == "Yes" || b == "YES") {
        _strm = new ostringstream;
        _strm_owned = true;
        _buffered = true;
        if (strm && strm_owned) delete strm;
    }
    else {
        if (!strm) {
            string s = "Informational response not buffered but no stream passed";
            throw BESInternalError(s, __FILE__, __LINE__);
        }
        _strm = strm;
        _strm_owned = strm_owned;
        _buffered = false;
    }
}

BESInfo::~BESInfo()
{
    if (_strm && _strm_owned) {
        delete _strm;
        _strm = 0;
    }
}

void BESInfo::begin_response(const string &response_name, BESDataHandlerInterface &/*dhi*/)
{
    _response_started = true;
    _response_name = response_name;
}

void BESInfo::end_response()
{
    _response_started = false;
    if (_tags.size()) {
        string s = "Not all tags were ended in info response";
        throw BESInternalError(s, __FILE__, __LINE__);
    }
}

void BESInfo::begin_tag(const string &tag_name, map<string, string> */*attrs*/)
{
    _tags.push(tag_name);
}

void BESInfo::end_tag(const string &tag_name)
{
    if (_tags.size() == 0 || _tags.top() != tag_name) {
        string s = (string) "tag " + tag_name + " already ended or not started";
        throw BESInternalError(s, __FILE__, __LINE__);
    }
    else {
        _tags.pop();
    }
}

void BESInfo::add_data(const string &s)
{
    // If not buffered then we've been passed a stream to use.
    // If it is buffered then we created the stream.
    (*_strm) << s;
}

void BESInfo::add_data_from_file(const string &key, const string &name)
{
    bool found = false;
    string file;
    try {
        TheBESKeys::TheKeys()->get_value(key, file, found);
    }
    catch (...) {
        found = false;
    }
    if (found == false) {
        add_data(name + " file key " + key + " not found, information not available\n");
    }
    else {
        ifstream ifs(file.c_str());
        int myerrno = errno;
        if (!ifs) {
            string serr = name + " file " + file + " not found, information not available: ";
            char *err = strerror(myerrno);
            if (err)
                serr += err;
            else
                serr += "Unknown error";

            serr += "\n";

            add_data(serr);
        }
        else {
            char line[BES_INFO_FILE_BUFFER_SIZE];
            while (!ifs.eof()) {
                ifs.getline(line, BES_INFO_FILE_BUFFER_SIZE);
                if (!ifs.eof()) {
                    add_data(line);
                    add_data("\n");
                }
            }
            ifs.close();
        }
    }
}

void BESInfo::add_exception(BESError &e, const string &admin)
{
    begin_tag("BESError");
    ostringstream stype;
    stype << e.get_error_type();
    add_tag("Type", stype.str());
    add_tag("Message", e.get_message());
    add_tag("Administrator", admin);
#ifdef BES_DEVELOPER
    begin_tag( "Location" );
    add_tag( "File", e.get_file() );
    ostringstream sline;
    sline << e.get_line();
    add_tag( "Line", sline.str() );
    end_tag( "Location" );
#endif
    end_tag("BESError");
}

void BESInfo::print(ostream &strm)
{
    if (_buffered) {
        strm << ((ostringstream *) _strm)->str();
    }
}

void BESInfo::dump(ostream &strm) const
{
    strm << BESIndent::LMarg << "BESInfo::dump - (" << (void *) this << ")" << endl;
    BESIndent::Indent();
    strm << BESIndent::LMarg << "response name: " << _response_name << endl;
    strm << BESIndent::LMarg << "is it buffered? " << _buffered << endl;
    strm << BESIndent::LMarg << "has response been started? " << _response_started << endl;
    if (_tags.size()) {
        strm << BESIndent::LMarg << "tags:" << endl;
        BESIndent::Indent();
        stack < string > temp_tags = _tags;
        while (!temp_tags.empty()) {
            string tag = temp_tags.top();
            strm << BESIndent::LMarg << tag << endl;
            temp_tags.pop();
        }
        BESIndent::UnIndent();
    }
    else {
        strm << BESIndent::LMarg << "tags: empty" << endl;
    }
    BESIndent::UnIndent();
}