HTTPConnect.cc
// -*- mode: c++; c-basic-offset:4 -*-
// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.
// Copyright (c) 2002,2003 OPeNDAP, Inc.
// Author: 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.
#include "config.h"
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <sys/stat.h>
#ifdef WIN32
#include <io.h>
#endif
#include <string>
#include <vector>
#include <functional>
#include <algorithm>
#include <sstream>
#include <fstream>
#include <iterator>
#include <cstdlib>
#include <cstring>
#include <cerrno>
//#define DODS_DEBUG2
//#define HTTP_TRACE
//#define DODS_DEBUG
#undef USE_GETENV
#include "debug.h"
#include "mime_util.h"
#include "media_types.h"
#include "GNURegex.h"
#include "HTTPCache.h"
#include "HTTPConnect.h"
#include "RCReader.h"
#include "HTTPResponse.h"
#include "HTTPCacheResponse.h"
using namespace std;
namespace libdap {
// These global variables are not MT-Safe, but I'm leaving them as is because
// they are used only for debugging (set them in a debugger like gdb or ddd).
// They are not static because I think that many debuggers cannot access
// static variables. 08/07/02 jhrg
// Set this to 1 to turn on libcurl's verbose mode (for debugging).
int www_trace = 0;
// Set this to 1 to turn on libcurl's VERY verbose mode.
int www_trace_extensive = 0;
// Keep the temporary files; useful for debugging.
int dods_keep_temps = 0;
#define CLIENT_ERR_MIN 400
#define CLIENT_ERR_MAX 417
static const char *http_client_errors[CLIENT_ERR_MAX - CLIENT_ERR_MIN +1] =
{
"Bad Request:",
"Unauthorized: Contact the server administrator.",
"Payment Required.",
"Forbidden: Contact the server administrator.",
"Not Found: The data source or server could not be found.\n\
Often this means that the OPeNDAP server is missing or needs attention.\n\
Please contact the server administrator.",
"Method Not Allowed.",
"Not Acceptable.",
"Proxy Authentication Required.",
"Request Time-out.",
"Conflict.",
"Gone:.",
"Length Required.",
"Precondition Failed.",
"Request Entity Too Large.",
"Request URI Too Large.",
"Unsupported Media Type.",
"Requested Range Not Satisfiable.",
"Expectation Failed."
};
#define SERVER_ERR_MIN 500
#define SERVER_ERR_MAX 505
static const char *http_server_errors[SERVER_ERR_MAX - SERVER_ERR_MIN + 1] =
{
"Internal Server Error.",
"Not Implemented.",
"Bad Gateway.",
"Service Unavailable.",
"Gateway Time-out.",
"HTTP Version Not Supported."
};
static string
http_status_to_string(int status)
{
if (status >= CLIENT_ERR_MIN && status <= CLIENT_ERR_MAX)
return string(http_client_errors[status - CLIENT_ERR_MIN]);
else if (status >= SERVER_ERR_MIN && status <= SERVER_ERR_MAX)
return string(http_server_errors[status - SERVER_ERR_MIN]);
else
return string("Unknown Error: This indicates a problem with libdap++.\nPlease report this to support@opendap.org.");
}
static ObjectType
determine_object_type(const string &header_value)
{
// DAP4 Data: application/vnd.opendap.dap4.data
// DAP4 DMR: application/vnd.opendap.dap4.dataset-metadata+xml
string::size_type plus = header_value.find('+');
string base_type;
string type_extension = "";
if (plus != string::npos) {
base_type= header_value.substr(0, plus);
type_extension = header_value.substr(plus+1);
}
else
base_type = header_value;
if (base_type == DMR_Content_Type
|| (base_type.find("application/") != string::npos
&& base_type.find("dap4.dataset-metadata") != string::npos)) {
if (type_extension == "xml")
return dap4_dmr;
else
return unknown_type;
}
else if (base_type == DAP4_DATA_Content_Type
|| (base_type.find("application/") != string::npos
&& base_type.find("dap4.data") != string::npos)) {
return dap4_data;
}
else if (header_value.find("text/html") != string::npos) {
return web_error;
}
else
return unknown_type;
}
class ParseHeader : public unary_function<const string &, void>
{
ObjectType type; // What type of object is in the stream?
string server; // Server's version string.
string protocol; // Server's protocol version.
string location; // Url returned by server
public:
ParseHeader() : type(unknown_type), server("dods/0.0"), protocol("2.0")
{ }
void operator()(const string &line)
{
string name, value;
parse_mime_header(line, name, value);
DBG2(cerr << name << ": " << value << endl);
// Content-Type is used to determine the content of DAP4 responses, but allow the
// Content-Description header to override CT o preserve operation with DAP2 servers.
// jhrg 11/12/13
if (type == unknown_type && name == "content-type") {
type = determine_object_type(value); // see above
}
if (name == "content-description" && !(type == dap4_dmr || type == dap4_data || type == dap4_error)) {
type = get_description_type(value); // defined in mime_util.cc
}
// The second test (== "dods/0.0") tests if xopendap-server has already
// been seen. If so, use that header in preference to the old
// XDODS-Server header. jhrg 2/7/06
else if (name == "xdods-server" && server == "dods/0.0") {
server = value;
}
else if (name == "xopendap-server") {
server = value;
}
else if (name == "xdap") {
protocol = value;
}
else if (server == "dods/0.0" && name == "server") {
server = value;
}
else if (name == "location") {
location = value;
}
}
ObjectType get_object_type()
{
return type;
}
string get_server()
{
return server;
}
string get_protocol()
{
return protocol;
}
string get_location() {
return location;
}
};
static size_t
save_raw_http_headers(void *ptr, size_t size, size_t nmemb, void *resp_hdrs)
{
DBG2(cerr << "Inside the header parser." << endl);
vector<string> *hdrs = static_cast<vector<string> * >(resp_hdrs);
// Grab the header, minus the trailing newline. Or \r\n pair.
string complete_line;
if (nmemb > 1 && *(static_cast<char*>(ptr) + size * (nmemb - 2)) == '\r')
complete_line.assign(static_cast<char *>(ptr), size * (nmemb - 2));
else
complete_line.assign(static_cast<char *>(ptr), size * (nmemb - 1));
// Store all non-empty headers that are not HTTP status codes
if (complete_line != "" && complete_line.find("HTTP") == string::npos) {
DBG(cerr << "Header line: " << complete_line << endl);
hdrs->push_back(complete_line);
}
return size * nmemb;
}
static int
curl_debug(CURL *, curl_infotype info, char *msg, size_t size, void *)
{
string message(msg, size);
switch (info) {
case CURLINFO_TEXT:
cerr << "Text: " << message; break;
case CURLINFO_HEADER_IN:
cerr << "Header in: " << message; break;
case CURLINFO_HEADER_OUT:
cerr << "Header out: " << message; break;
case CURLINFO_DATA_IN:
if (www_trace_extensive)
cerr << "Data in: " << message; break;
case CURLINFO_DATA_OUT:
if (www_trace_extensive)
cerr << "Data out: " << message; break;
case CURLINFO_END:
cerr << "End: " << message; break;
#ifdef CURLINFO_SSL_DATA_IN
case CURLINFO_SSL_DATA_IN:
cerr << "SSL Data in: " << message; break;
#endif
#ifdef CURLINFO_SSL_DATA_OUT
case CURLINFO_SSL_DATA_OUT:
cerr << "SSL Data out: " << message; break;
#endif
default:
if (www_trace_extensive)
cerr << "Curl info: " << message; break;
}
return 0;
}
void
HTTPConnect::www_lib_init()
{
d_curl = curl_easy_init();
if (!d_curl)
throw InternalErr(__FILE__, __LINE__, "Could not initialize libcurl.");
// Now set options that will remain constant for the duration of this
// CURL object.
// Set the proxy host.
if (!d_rcr->get_proxy_server_host().empty()) {
DBG(cerr << "Setting up a proxy server." << endl);
DBG(cerr << "Proxy host: " << d_rcr->get_proxy_server_host()
<< endl);
DBG(cerr << "Proxy port: " << d_rcr->get_proxy_server_port()
<< endl);
DBG(cerr << "Proxy pwd : " << d_rcr->get_proxy_server_userpw()
<< endl);
curl_easy_setopt(d_curl, CURLOPT_PROXY,
d_rcr->get_proxy_server_host().c_str());
curl_easy_setopt(d_curl, CURLOPT_PROXYPORT,
d_rcr->get_proxy_server_port());
// As of 4/21/08 only NTLM, Digest and Basic work.
#ifdef CURLOPT_PROXYAUTH
curl_easy_setopt(d_curl, CURLOPT_PROXYAUTH, (long)CURLAUTH_ANY);
#endif
// Password might not be required. 06/21/04 jhrg
if (!d_rcr->get_proxy_server_userpw().empty())
curl_easy_setopt(d_curl, CURLOPT_PROXYUSERPWD,
d_rcr->get_proxy_server_userpw().c_str());
}
curl_easy_setopt(d_curl, CURLOPT_ERRORBUFFER, d_error_buffer);
// We have to set FailOnError to false for any of the non-Basic
// authentication schemes to work. 07/28/03 jhrg
curl_easy_setopt(d_curl, CURLOPT_FAILONERROR, 0);
// This means libcurl will use Basic, Digest, GSS Negotiate, or NTLM,
// choosing the the 'safest' one supported by the server.
// This requires curl 7.10.6 which is still in pre-release. 07/25/03 jhrg
curl_easy_setopt(d_curl, CURLOPT_HTTPAUTH, (long)CURLAUTH_ANY);
curl_easy_setopt(d_curl, CURLOPT_NOPROGRESS, 1);
curl_easy_setopt(d_curl, CURLOPT_NOSIGNAL, 1);
curl_easy_setopt(d_curl, CURLOPT_HEADERFUNCTION, save_raw_http_headers);
// In read_url a call to CURLOPT_WRITEHEADER is used to set the fourth
// param of save_raw_http_headers to a vector<string> object.
// Follow 302 (redirect) responses
curl_easy_setopt(d_curl, CURLOPT_FOLLOWLOCATION, 1);
curl_easy_setopt(d_curl, CURLOPT_MAXREDIRS, 5);
// If the user turns off SSL validation...
if (d_rcr->get_validate_ssl() == 0) {
curl_easy_setopt(d_curl, CURLOPT_SSL_VERIFYPEER, 0);
curl_easy_setopt(d_curl, CURLOPT_SSL_VERIFYHOST, 0);
}
// Set libcurl to use netrc to access data behind URS auth.
// libcurl will use the provided pathname for the ~/.netrc info. 08/23/19 kln
curl_easy_setopt(d_curl, CURLOPT_NETRC, 1);
// Look to see if cookies are turned on in the .dodsrc file. If so,
// activate here. We honor 'session cookies' (cookies without an
// expiration date) here so that session-based SSO systems will work as
// expected.
if (!d_cookie_jar.empty()) {
DBG(cerr << "Setting the cookie jar to: " << d_cookie_jar << endl);
curl_easy_setopt(d_curl, CURLOPT_COOKIEJAR, d_cookie_jar.c_str());
curl_easy_setopt(d_curl, CURLOPT_COOKIESESSION, 1);
}
if (www_trace) {
cerr << "Curl version: " << curl_version() << endl;
curl_easy_setopt(d_curl, CURLOPT_VERBOSE, 1);
curl_easy_setopt(d_curl, CURLOPT_DEBUGFUNCTION, curl_debug);
}
}
class BuildHeaders : public unary_function<const string &, void>
{
struct curl_slist *d_cl;
public:
BuildHeaders() : d_cl(0)
{}
void operator()(const string &header)
{
DBG(cerr << "Adding '" << header.c_str() << "' to the header list."
<< endl);
d_cl = curl_slist_append(d_cl, header.c_str());
}
struct curl_slist *get_headers()
{
return d_cl;
}
};
long
HTTPConnect::read_url(const string &url, FILE *stream, vector<string> *resp_hdrs, const vector<string> *headers)
{
curl_easy_setopt(d_curl, CURLOPT_URL, url.c_str());
#ifdef WIN32
// See the curl documentation for CURLOPT_FILE (aka CURLOPT_WRITEDATA)
// and the CURLOPT_WRITEFUNCTION option. Quote: "If you are using libcurl as
// a win32 DLL, you MUST use the CURLOPT_WRITEFUNCTION option if you set the
// CURLOPT_WRITEDATA option or you will experience crashes". At the root of
// this issue is that one should not pass a FILE * to a windows DLL. Close
// inspection of libcurl yields that their default write function when using
// the CURLOPT_WRITEDATA is just "fwrite".
curl_easy_setopt(d_curl, CURLOPT_WRITEDATA, stream);
curl_easy_setopt(d_curl, CURLOPT_WRITEFUNCTION, &fwrite);
#else
curl_easy_setopt(d_curl, CURLOPT_WRITEDATA, stream);
#endif
DBG(copy(d_request_headers.begin(), d_request_headers.end(),
ostream_iterator<string>(cerr, "\n")));
BuildHeaders req_hdrs;
req_hdrs = for_each(d_request_headers.begin(), d_request_headers.end(),
req_hdrs);
if (headers)
req_hdrs = for_each(headers->begin(), headers->end(), req_hdrs);
curl_easy_setopt(d_curl, CURLOPT_HTTPHEADER, req_hdrs.get_headers());
// Turn off the proxy for this URL?
bool temporary_proxy = false;
if ((temporary_proxy = url_uses_no_proxy_for(url))) {
DBG(cerr << "Suppress proxy for url: " << url << endl);
curl_easy_setopt(d_curl, CURLOPT_PROXY, 0);
}
string::size_type at_sign = url.find('@');
// Assume username:password present *and* assume it's an HTTP URL; it *is*
// HTTPConnect, after all. 7 is position after "http://"; the second arg
// to substr() is the sub string length.
if (at_sign != url.npos)
d_upstring = url.substr(7, at_sign - 7);
if (!d_upstring.empty())
curl_easy_setopt(d_curl, CURLOPT_USERPWD, d_upstring.c_str());
// Pass save_raw_http_headers() a pointer to the vector<string> where the
// response headers may be stored. Callers can use the resp_hdrs
// value/result parameter to get the raw response header information .
curl_easy_setopt(d_curl, CURLOPT_WRITEHEADER, resp_hdrs);
// This is the call that causes curl to go and get the remote resource and "write it down"
// utilizing the configuration state that has been previously conditioned by various perturbations
// of calls to curl_easy_setopt().
CURLcode res = curl_easy_perform(d_curl);
// Free the header list and null the value in d_curl.
curl_slist_free_all(req_hdrs.get_headers());
curl_easy_setopt(d_curl, CURLOPT_HTTPHEADER, 0);
// Reset the proxy?
if (temporary_proxy && !d_rcr->get_proxy_server_host().empty())
curl_easy_setopt(d_curl, CURLOPT_PROXY,
d_rcr->get_proxy_server_host().c_str());
if (res != 0)
throw Error(d_error_buffer);
long status;
res = curl_easy_getinfo(d_curl, CURLINFO_HTTP_CODE, &status);
if (res != 0)
throw Error(d_error_buffer);
char *ct_ptr = 0;
res = curl_easy_getinfo(d_curl, CURLINFO_CONTENT_TYPE, &ct_ptr);
if (res == CURLE_OK && ct_ptr)
d_content_type = ct_ptr;
else
d_content_type = "";
return status;
}
bool
HTTPConnect::url_uses_proxy_for(const string &url)
{
if (d_rcr->is_proxy_for_used()) {
Regex host_regex(d_rcr->get_proxy_for_regexp().c_str());
int index = 0, matchlen;
return host_regex.search(url.c_str(), url.size(), matchlen, index) != -1;
}
return false;
}
bool
HTTPConnect::url_uses_no_proxy_for(const string &url) throw()
{
return d_rcr->is_no_proxy_for_used()
&& url.find(d_rcr->get_no_proxy_for_host()) != string::npos;
}
// Public methods. Mostly...
HTTPConnect::HTTPConnect(RCReader *rcr, bool use_cpp) : d_username(""), d_password(""), d_cookie_jar(""),
d_dap_client_protocol_major(2), d_dap_client_protocol_minor(0), d_use_cpp_streams(use_cpp)
{
d_accept_deflate = rcr->get_deflate();
d_rcr = rcr;
// Load in the default headers to send with a request. The empty Pragma
// headers overrides libcurl's default Pragma: no-cache header (which
// will disable caching by Squid, et c.). The User-Agent header helps
// make server logs more readable. 05/05/03 jhrg
d_request_headers.push_back(string("Pragma:"));
string user_agent = string("User-Agent: ") + string(CNAME)
+ string("/") + string(CVER);
d_request_headers.push_back(user_agent);
if (d_accept_deflate)
d_request_headers.push_back(string("Accept-Encoding: deflate, gzip, compress"));
// HTTPCache::instance returns a valid ptr or 0.
if (d_rcr->get_use_cache())
d_http_cache = HTTPCache::instance(d_rcr->get_dods_cache_root(),true);
else
d_http_cache = 0;
DBG2(cerr << "Cache object created (" << hex << d_http_cache << dec
<< ")" << endl);
if (d_http_cache) {
d_http_cache->set_cache_enabled(d_rcr->get_use_cache());
d_http_cache->set_expire_ignored(d_rcr->get_ignore_expires() != 0);
d_http_cache->set_max_size(d_rcr->get_max_cache_size());
d_http_cache->set_max_entry_size(d_rcr->get_max_cached_obj());
d_http_cache->set_default_expiration(d_rcr->get_default_expires());
d_http_cache->set_always_validate(d_rcr->get_always_validate() != 0);
}
d_cookie_jar = rcr->get_cookie_jar();
www_lib_init(); // This may throw either Error or InternalErr
}
HTTPConnect::~HTTPConnect()
{
DBG2(cerr << "Entering the HTTPConnect dtor" << endl);
curl_easy_cleanup(d_curl);
DBG2(cerr << "Leaving the HTTPConnect dtor" << endl);
}
class HeaderMatch : public unary_function<const string &, bool> {
const string &d_header;
public:
HeaderMatch(const string &header) : d_header(header) {}
bool operator()(const string &arg) { return arg.find(d_header) == 0; }
};
HTTPResponse *
HTTPConnect::fetch_url(const string &url)
{
#ifdef HTTP_TRACE
cout << "GET " << url << " HTTP/1.0" << endl;
#endif
HTTPResponse *stream;
if (/*d_http_cache && d_http_cache->*/is_cache_enabled()) {
stream = caching_fetch_url(url);
}
else {
stream = plain_fetch_url(url);
}
#ifdef HTTP_TRACE
stringstream ss;
ss << "HTTP/1.0 " << stream->get_status() << " -" << endl;
for (size_t i = 0; i < stream->get_headers()->size(); i++) {
ss << stream->get_headers()->at(i) << endl;
}
cout << ss.str();
#endif
ParseHeader parser;
// An apparent quirk of libcurl is that it does not pass the Content-type
// header to the callback used to save them, but check and add it from the
// saved state variable only if it's not there (without this a test failed
// in HTTPCacheTest). jhrg 11/12/13
if (!d_content_type.empty() && find_if(stream->get_headers()->begin(), stream->get_headers()->end(),
HeaderMatch("Content-Type:")) == stream->get_headers()->end())
stream->get_headers()->push_back("Content-Type: " + d_content_type);
parser = for_each(stream->get_headers()->begin(), stream->get_headers()->end(), ParseHeader());
#ifdef HTTP_TRACE
cout << endl << endl;
#endif
// handle redirection case (2007-04-27, gaffigan@sfos.uaf.edu)
if (parser.get_location() != "" &&
url.substr(0,url.find("?",0)).compare(parser.get_location().substr(0,url.find("?",0))) != 0) {
delete stream;
return fetch_url(parser.get_location());
}
stream->set_type(parser.get_object_type()); // uses the value of content-description
stream->set_version(parser.get_server());
stream->set_protocol(parser.get_protocol());
if (d_use_cpp_streams) {
stream->transform_to_cpp();
}
return stream;
}
// Look around for a reasonable place to put a temporary file. Check first
// the value of the TMPDIR env var. If that does not yeild a path that's
// writable (as defined by access(..., W_OK|R_OK)) then look at P_tmpdir (as
// defined in stdio.h. If both come up empty, then use `./'.
// Change this to a version that either returns a string or an open file
// descriptor. Use information from https://buildsecurityin.us-cert.gov/
// (see open()) to make it more secure. Ideal solution: get deserialize()
// methods to read from a stream returned by libcurl, not from a temporary
// file. 9/21/07 jhrg Updated to use strings, other misc changes. 3/22/11
static string
get_tempfile_template(const string &file_template)
{
string c;
// Windows has one idea of the standard name(s) for a temporary files dir
#ifdef WIN32
// white list for a WIN32 directory
Regex directory("[-a-zA-Z0-9_:\\]*");
// If we're OK to use getenv(), try it.
#ifdef USE_GETENV
c = getenv("TEMP");
if (c && directory.match(c.c_str(), c.length()) && (access(c.c_str(), 6) == 0))
goto valid_temp_directory;
c= getenv("TMP");
if (c && directory.match(c.c_str(), c.length()) && (access(c.c_str(), 6) == 0))
goto valid_temp_directory;
#endif // USE_GETENV
// The windows default
c = "c:\tmp";
if (c && directory.match(c.c_str(), c.length()) && (access(c.c_str(), 6) == 0))
goto valid_temp_directory;
#else // Unix/Linux/OSX has another...
// white list for a directory
Regex directory("[-a-zA-Z0-9_/]*");
#ifdef USE_GETENV
c = getenv("TMPDIR");
if (directory.match(c.c_str(), c.length()) && (access(c.c_str(), W_OK | R_OK) == 0))
goto valid_temp_directory;
#endif // USE_GETENV
// Unix defines this sometimes - if present, use it.
#ifdef P_tmpdir
if (access(P_tmpdir, W_OK | R_OK) == 0) {
c = P_tmpdir;
goto valid_temp_directory;
}
#endif
// The Unix default
c = "/tmp";
if (directory.match(c.c_str(), c.length()) && (access(c.c_str(), W_OK | R_OK) == 0))
goto valid_temp_directory;
#endif // WIN32
// If we found nothing useful, use the current directory
c = ".";
valid_temp_directory:
#ifdef WIN32
c += "\\" + file_template;
#else
c += "/" + file_template;
#endif
return c;
}
string
get_temp_file(FILE *&stream) throw(Error)
{
string dods_temp = get_tempfile_template((string)"dodsXXXXXX");
vector<char> pathname(dods_temp.length() + 1);
strncpy(&pathname[0], dods_temp.c_str(), dods_temp.length());
DBG(cerr << "pathanme: " << &pathname[0] << " (" << dods_temp.length() + 1 << ")" << endl);
// Open truncated for update. NB: mkstemp() returns a file descriptor.
#if defined(WIN32) || defined(TEST_WIN32_TEMPS)
stream = fopen(_mktemp(&pathname[0]), "w+b");
#else
// Make sure that temp files are accessible only by the owner.
int mask = umask(077);
if (mask < 0)
throw Error("Could not set the file creation mask: " + string(strerror(errno)));
int fd = mkstemp(&pathname[0]);
if (fd < 0)
throw Error("Could not create a temporary file to store the response: " + string(strerror(errno)));
stream = fdopen(fd, "w+");
umask(mask);
#endif
if (!stream)
throw Error("Failed to open a temporary file for the data values (" + dods_temp + ")");
dods_temp = &pathname[0];
return dods_temp;
}
void
close_temp(FILE *s, const string &name)
{
int res = fclose(s);
if (res)
throw InternalErr(__FILE__, __LINE__, "!FAIL! " + long_to_string(res));
res = unlink(name.c_str());
if (res != 0)
throw InternalErr(__FILE__, __LINE__, "!FAIL! " + long_to_string(res));
}
HTTPResponse *
HTTPConnect::caching_fetch_url(const string &url)
{
DBG(cerr << "Is this URL (" << url << ") in the cache?... ");
vector<string> *headers = new vector<string>;
string file_name;
FILE *s = d_http_cache->get_cached_response(url, *headers, file_name);
if (!s) {
// url not in cache; get it and cache it
DBGN(cerr << "no; getting response and caching." << endl);
delete headers; headers = 0;
time_t now = time(0);
HTTPResponse *rs = plain_fetch_url(url);
d_http_cache->cache_response(url, now, *(rs->get_headers()), rs->get_stream());
return rs;
}
else { // url in cache
DBGN(cerr << "yes... ");
if (d_http_cache->is_url_valid(url)) { // url in cache and valid
DBGN(cerr << "and it's valid; using cached response." << endl);
HTTPCacheResponse *crs = new HTTPCacheResponse(s, 200, headers, file_name, d_http_cache);
return crs;
}
else { // url in cache but not valid; validate
DBGN(cerr << "but it's not valid; validating... ");
d_http_cache->release_cached_response(s); // This closes 's'
headers->clear();
vector<string> cond_hdrs = d_http_cache->get_conditional_request_headers(url);
FILE *body = 0;
string dods_temp = get_temp_file(body);
time_t now = time(0); // When was the request made (now).
long http_status;
try {
http_status = read_url(url, body, /*resp_hdrs*/headers, &cond_hdrs);
rewind(body);
}
catch (Error &e) {
close_temp(body, dods_temp);
delete headers;
throw ;
}
switch (http_status) {
case 200: { // New headers and new body
DBGN(cerr << "read a new response; caching." << endl);
d_http_cache->cache_response(url, now, /* *resp_hdrs*/*headers, body);
HTTPResponse *rs = new HTTPResponse(body, http_status, /*resp_hdrs*/headers, dods_temp);
return rs;
}
case 304: { // Just new headers, use cached body
DBGN(cerr << "cached response valid; updating." << endl);
close_temp(body, dods_temp);
d_http_cache->update_response(url, now, /* *resp_hdrs*/ *headers);
string file_name;
FILE *hs = d_http_cache->get_cached_response(url, *headers, file_name);
HTTPCacheResponse *crs = new HTTPCacheResponse(hs, 304, headers, file_name, d_http_cache);
return crs;
}
default: { // Oops.
close_temp(body, dods_temp);
if (http_status >= 400) {
delete headers; headers = 0;
string msg = "Error while reading the URL: ";
msg += url;
msg
+= ".\nThe OPeNDAP server returned the following message:\n";
msg += http_status_to_string(http_status);
throw Error(msg);
}
else {
delete headers; headers = 0;
throw InternalErr(__FILE__, __LINE__,
"Bad response from the HTTP server: " + long_to_string(http_status));
}
}
}
}
}
throw InternalErr(__FILE__, __LINE__, "Should never get here");
}
HTTPResponse *
HTTPConnect::plain_fetch_url(const string &url)
{
DBG(cerr << "Getting URL: " << url << endl);
FILE *stream = 0;
string dods_temp = get_temp_file(stream);
vector<string> *resp_hdrs = new vector<string>;
int status = -1;
try {
status = read_url(url, stream, resp_hdrs); // Throws Error.
if (status >= 400) {
// delete resp_hdrs; resp_hdrs = 0;
string msg = "Error while reading the URL: ";
msg += url;
msg += ".\nThe OPeNDAP server returned the following message:\n";
msg += http_status_to_string(status);
throw Error(msg);
}
}
catch (Error &e) {
delete resp_hdrs;
close_temp(stream, dods_temp);
throw;
}
#if 0
if (d_use_cpp_streams) {
fclose(stream);
fstream *in = new fstream(dods_temp.c_str(), ios::in|ios::binary);
return new HTTPResponse(in, status, resp_hdrs, dods_temp);
}
else {
#endif
rewind(stream);
return new HTTPResponse(stream, status, resp_hdrs, dods_temp);
#if 0
}
#endif
}
void
HTTPConnect::set_accept_deflate(bool deflate)
{
d_accept_deflate = deflate;
if (d_accept_deflate) {
if (find(d_request_headers.begin(), d_request_headers.end(),
"Accept-Encoding: deflate, gzip, compress") == d_request_headers.end())
d_request_headers.push_back(string("Accept-Encoding: deflate, gzip, compress"));
DBG(copy(d_request_headers.begin(), d_request_headers.end(),
ostream_iterator<string>(cerr, "\n")));
}
else {
vector<string>::iterator i;
i = remove_if(d_request_headers.begin(), d_request_headers.end(),
bind2nd(equal_to<string>(),
string("Accept-Encoding: deflate, gzip, compress")));
d_request_headers.erase(i, d_request_headers.end());
}
}
void
HTTPConnect::set_xdap_protocol(int major, int minor)
{
// Look for, and remove if one exists, an XDAP-Accept header
vector<string>::iterator i;
i = find_if(d_request_headers.begin(), d_request_headers.end(),
HeaderMatch("XDAP-Accept:"));
if (i != d_request_headers.end())
d_request_headers.erase(i);
// Record and add the new header value
d_dap_client_protocol_major = major;
d_dap_client_protocol_minor = minor;
ostringstream xdap_accept;
xdap_accept << "XDAP-Accept: " << major << "." << minor;
d_request_headers.push_back(xdap_accept.str());
DBG(copy(d_request_headers.begin(), d_request_headers.end(),
ostream_iterator<string>(cerr, "\n")));
}
void
HTTPConnect::set_credentials(const string &u, const string &p)
{
if (u.empty())
return;
// Store the credentials locally.
d_username = u;
d_password = p;
d_upstring = u + ":" + p;
}
} // namespace libdap
libdap::HTTPCache::set_cache_enabled
void set_cache_enabled(bool mode)
Definition: HTTPCache.cc:635
libdap::HTTPCache::instance
static HTTPCache * instance(const string &cache_root, bool force=false)
Definition: HTTPCache.cc:129
libdap::HTTPCache::set_max_size
void set_max_size(unsigned long size)
Definition: HTTPCache.cc:724
libdap::ObjectType
ObjectType
The type of object in the stream coming from the data server.
Definition: ObjectType.h:58
libdap::Error
A class for error processing.
Definition: Error.h:92
libdap::HTTPCache::set_always_validate
void set_always_validate(bool validate)
Definition: HTTPCache.cc:841
libdap::InternalErr
A class for software fault reporting.
Definition: InternalErr.h:64
libdap::HTTPConnect::set_credentials
void set_credentials(const string &u, const string &p)
Definition: HTTPConnect.cc:1074
libdap::HTTPResponse
Definition: HTTPResponse.h:56
libdap::HTTPCache::release_cached_response
void release_cached_response(FILE *response)
Definition: HTTPCache.cc:1571
libdap::get_description_type
ObjectType get_description_type(const string &value)
Definition: mime_util.cc:339
libdap::HTTPConnect::is_cache_enabled
bool is_cache_enabled()
Definition: HTTPConnect.h:157
libdap::HTTPCache::is_url_valid
bool is_url_valid(const string &url)
Definition: HTTPCache.cc:1388
libdap::HTTPCache::update_response
void update_response(const string &url, time_t request_time, const vector< string > &headers)
Definition: HTTPCache.cc:1319
libdap::HTTPConnect::fetch_url
HTTPResponse * fetch_url(const string &url)
Definition: HTTPConnect.cc:627
libdap
top level DAP object to house generic methods
Definition: AlarmHandler.h:35
libdap::RCReader
Definition: RCReader.h:54
libdap::parse_mime_header
void parse_mime_header(const string &header, string &name, string &value)
Definition: mime_util.cc:912
libdap::HTTPConnect::set_xdap_protocol
void set_xdap_protocol(int major, int minor)
Definition: HTTPConnect.cc:1037
libdap::Regex
Definition: GNURegex.h:35
libdap::HTTPCache::get_conditional_request_headers
vector< string > get_conditional_request_headers(const string &url)
Definition: HTTPCache.cc:1249
libdap::HTTPCache::cache_response
bool cache_response(const string &url, time_t request_time, const vector< string > &headers, const FILE *body)
Definition: HTTPCache.cc:1156
libdap::get_temp_file
string get_temp_file(FILE *&stream)
Definition: HTTPConnect.cc:779
libdap::HTTPConnect::set_accept_deflate
void set_accept_deflate(bool defalte)
Definition: HTTPConnect.cc:1008
libdap::close_temp
void close_temp(FILE *s, const string &name)
Definition: HTTPConnect.cc:819
libdap::HTTPResponse::transform_to_cpp
void transform_to_cpp()
Definition: HTTPResponse.h:151
libdap::HTTPCache::set_max_entry_size
void set_max_entry_size(unsigned long size)
Definition: HTTPCache.cc:772
libdap::HTTPCache::set_default_expiration
void set_default_expiration(int exp_time)
Definition: HTTPCache.cc:819
libdap::HTTPCache::set_expire_ignored
void set_expire_ignored(bool mode)
Definition: HTTPCache.cc:690
libdap::HTTPCache::get_cached_response
FILE * get_cached_response(const string &url, vector< string > &headers, string &cacheName)
Definition: HTTPCache.cc:1480