bes Updated for version 3.20.10
FONcRequestHandler.cc
1// FONcRequestHandler.cc
2
3// This file is part of bes, A C++ back-end server implementation framework
4// for the OPeNDAP Data Access Protocol.
5
6// Copyright (c) 2004,2005 University Corporation for Atmospheric Research
7// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8//
9// This library is free software; you can redistribute it and/or
10// modify it under the terms of the GNU Lesser General Public
11// License as published by the Free Software Foundation; either
12// version 2.1 of the License, or (at your option) any later version.
13//
14// This library is distributed in the hope that it will be useful,
15// but WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17// Lesser General Public License for more details.
18//
19// You should have received a copy of the GNU Lesser General Public
20// License along with this library; if not, write to the Free Software
21// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22//
23// You can contact University Corporation for Atmospheric Research at
24// 3080 Center Green Drive, Boulder, CO 80301
25
26// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27// Please read the full copyright statement in the file COPYRIGHT_UCAR.
28//
29// Authors:
30// pwest Patrick West <pwest@ucar.edu>
31// jgarcia Jose Garcia <jgarcia@ucar.edu>
32
33#include "config.h"
34
35#include <string>
36#include <sstream>
37
38#include <BESResponseHandler.h>
39#include <BESResponseNames.h>
40#include <BESVersionInfo.h>
41#include <BESDataNames.h>
42#include <BESDataNames.h>
43#include <TheBESKeys.h>
44#include <BESDebug.h>
45#include <BESUtil.h>
46
47#include "FONcRequestHandler.h"
48
49#define FONC_TEMP_DIR "/tmp"
50#define FONC_TEMP_DIR_KEY "FONc.Tempdir"
51
52// I think this should be true always. I'm leaving it in for now
53// but the code does not use the key. Maybe this will be used when
54// there is more comprehensive support for DAP4. jhrg 11/30/15
55#define FONC_BYTE_TO_SHORT true
56#define FONC_BYTE_TO_SHORT_KEY "FONc.ByteToShort"
57
58#define FONC_USE_COMP true
59#define FONC_USE_COMP_KEY "FONc.UseCompression"
60
61#define FONC_CHUNK_SIZE 4096
62#define FONC_CHUNK_SIZE_KEY "FONc.ChunkSize"
63
64#define FONC_CLASSIC_MODEL true
65#define FONC_CLASSIC_MODEL_KEY "FONc.ClassicModel"
66
67#define FONC_NO_GLOBAL_ATTRS false
68#define FONC_NO_GLOBAL_ATTRS_KEY "FONc.NoGlobalAttrs"
69
70std::string FONcRequestHandler::temp_dir;
71bool FONcRequestHandler::byte_to_short;
72bool FONcRequestHandler::use_compression;
73int FONcRequestHandler::chunk_size;
74bool FONcRequestHandler::classic_model;
75bool FONcRequestHandler::no_global_attrs;
76
77using namespace std;
78
88static void read_key_value(const string &key_name, bool &key, const bool default_value)
89{
90 bool key_found = false;
91 string value;
92 TheBESKeys::TheKeys()->get_value(key_name, value, key_found);
93 // 'key' holds the string value at this point if key_found is true
94 if (key_found) {
95 value = BESUtil::lowercase(value);
96 key = (value == "true" || value == "yes");
97 }
98 else {
99 key = default_value;
100 }
101}
102
103static void read_key_value(const string &key_name, string &key, const string &default_value)
104{
105 bool key_found = false;
106 TheBESKeys::TheKeys()->get_value(key_name, key, key_found);
107 // 'key' holds the string value at this point if key_found is true
108 if (key_found) {
109 if (key[key.length() - 1] == '/') key.erase(key.length() - 1);
110 }
111 else {
112 key = default_value;
113 }
114}
115
116static void read_key_value(const string &key_name, int &key, const int default_value)
117{
118 bool key_found = false;
119 string value;
120 TheBESKeys::TheKeys()->get_value(key_name, value, key_found);
121 // 'key' holds the string value at this point if key_found is true
122 if (key_found) {
123 istringstream iss(value);
124 iss >> key;
125 if (iss.eof() || iss.bad() || iss.fail()) key = default_value;
126 }
127 else {
128 key = default_value;
129 }
130}
131
132
142 : BESRequestHandler( name )
143{
146
147 if (FONcRequestHandler::temp_dir.empty()) {
148 read_key_value(FONC_TEMP_DIR_KEY, FONcRequestHandler::temp_dir, FONC_TEMP_DIR);
149 }
150
151 // Not currently used. jhrg 11/30/15
152 read_key_value(FONC_BYTE_TO_SHORT_KEY, FONcRequestHandler::byte_to_short, FONC_BYTE_TO_SHORT);
153
154 read_key_value(FONC_USE_COMP_KEY, FONcRequestHandler::use_compression, FONC_USE_COMP);
155
156 read_key_value(FONC_CHUNK_SIZE_KEY, FONcRequestHandler::chunk_size, FONC_CHUNK_SIZE);
157
158 read_key_value(FONC_CLASSIC_MODEL_KEY, FONcRequestHandler::classic_model, FONC_CLASSIC_MODEL);
159
160 read_key_value(FONC_NO_GLOBAL_ATTRS_KEY, FONcRequestHandler::no_global_attrs, FONC_NO_GLOBAL_ATTRS);
161
162 BESDEBUG("fonc", "FONcRequestHandler::temp_dir: " << FONcRequestHandler::temp_dir << endl);
163 BESDEBUG("fonc", "FONcRequestHandler::byte_to_short: " << FONcRequestHandler::byte_to_short << endl);
164 BESDEBUG("fonc", "FONcRequestHandler::use_compression: " << FONcRequestHandler::use_compression << endl);
165 BESDEBUG("fonc", "FONcRequestHandler::chunk_size: " << FONcRequestHandler::chunk_size << endl);
166 BESDEBUG("fonc", "FONcRequestHandler::classic_model: " << FONcRequestHandler::classic_model << endl);
167 BESDEBUG("fonc", "FONcRequestHandler::turn_off_global_attrs: " << FONcRequestHandler::no_global_attrs << endl);
168}
169
173{
174}
175
188{
189 BESResponseObject *response = dhi.response_handler->get_response_object();
190 BESInfo *info = dynamic_cast<BESInfo *>(response);
191 if (!info) throw BESInternalError("cast error", __FILE__, __LINE__);
192
193 bool found = false;
194 string key = "FONc.Reference";
195 string ref;
196 TheBESKeys::TheKeys()->get_value(key, ref, found);
197 if (ref.empty()) ref = "https://docs.opendap.org/index.php/BES_-_Modules_-_FileOut_Netcdf";
198 map<string, string> attrs;
199 attrs["name"] = MODULE_NAME;
200 attrs["version"] = MODULE_VERSION;
201 attrs["reference"] = ref;
202 info->begin_tag("module", &attrs);
203 info->end_tag("module");
204
205 return true;
206}
207
216{
217 BESResponseObject *response = dhi.response_handler->get_response_object();
218 BESVersionInfo *info = dynamic_cast<BESVersionInfo *>(response);
219 if (!info) throw BESInternalError("cast error", __FILE__, __LINE__);
220
221 info->add_module(MODULE_NAME, MODULE_VERSION);
222
223 return true;
224}
225
232void
233FONcRequestHandler::dump( ostream &strm ) const
234{
235 strm << BESIndent::LMarg << "FONcRequestHandler::dump - ("
236 << (void *)this << ")" << endl ;
237 BESIndent::Indent() ;
239 BESIndent::UnIndent() ;
240}
241
Structure storing information used by the BES to handle the request.
informational response object
Definition: BESInfo.h:63
exception thrown if internal error encountered
Represents a specific data type request handler.
virtual bool add_method(const std::string &name, p_request_handler_method method)
add a handler method to the request handler that knows how to fill in a specific response object
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual BESResponseObject * get_response_object()
return the current response object
Abstract base class representing a specific set of information in response to a request to the BES.
static std::string lowercase(const std::string &s)
Definition: BESUtil.cc:206
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual ~FONcRequestHandler(void)
Any cleanup that needs to take place.
FONcRequestHandler(const std::string &name)
Constructor for FileOut NetCDF module.
static bool build_help(BESDataHandlerInterface &dhi)
adds help information for FileOut NetCDF to a help request
static bool build_version(BESDataHandlerInterface &dhi)
add version information to a version response
void get_value(const std::string &s, std::string &val, bool &found)
Retrieve the value of a given key, if set.
Definition: TheBESKeys.cc:340
static TheBESKeys * TheKeys()
Definition: TheBESKeys.cc:71