RCReader.h
// -*- 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: 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 OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
// (c) COPYRIGHT URI/MIT 2001-2002
// Please read the full copyright statement in the file COPYRIGHT_URI.
//
// Authors:
// jose Jose Garcia <jgarcia@ucar.edu>
#ifndef _rc_reader_h_
#define _rc_reader_h_
#include <iostream>
#include <string>
#include "Error.h"
#include "util.h"
using namespace std;
namespace libdap
{
class RCReader
{
private:
string d_rc_file_path;
string d_cache_root;
bool _dods_use_cache; // 0- Disabled 1- Enabled
unsigned int _dods_cache_max; // Max cache size in Mbytes
unsigned int _dods_cached_obj; // Max cache entry size in Mbytes
int _dods_ign_expires; // 0- Honor expires 1- Ignore them
// NB: NEVER_DEFLATE: I added this (12/1/99 jhrg) because libwww 5.2.9
// cannot process compressed (i.e., deflated) documents in the cache.
// Users must be able to choose whether they want compressed data that
// will always be refreshed or uncompressed data that will be cached.
// When set this flag overrides the value passed into the Connect
// object's constructor. This gives users control over the value.
// Previously, this could only be set by the program that called
// Connect(...). Note that I've now (4/6/2000 jhrg) fixed libwww so this
// parameter is no longer needed.111
//
// Added back in, but with a better name (removed double negative).
// 6/27/2002 jhrg
bool _dods_deflate; // 1- request comp responses, 0- don't
int _dods_default_expires; // 24 hours in seconds
int _dods_always_validate; // Let libwww decide by default so set to 0
// flags for PROXY_SERVER=<protocol>,<host url>
string d_dods_proxy_server_protocol;
string d_dods_proxy_server_host;
int d_dods_proxy_server_port;
string d_dods_proxy_server_userpw;
// Should libcurl validate SSL hosts/certificates"
int d_validate_ssl;
string _dods_proxy_server_host_url; // deprecated
// The proxy-for stuff is all deprecated. 06/17/04 jhrg
// flags for PROXY_FOR=<regex>,<proxy host url>,<flags>
bool _dods_proxy_for; // true if proxy_for is used.
string _dods_proxy_for_regexp;
string _dods_proxy_for_proxy_host_url;
int _dods_proxy_for_regexp_flags; // not used w/libcurl. 6/27/2002 jhrg
//flags for NO_PROXY_FOR=<protocol>,<host>,<port>
bool d_dods_no_proxy_for; // true if no_proxy_for is used.
string d_dods_no_proxy_for_protocol;
string d_dods_no_proxy_for_host;
int _dods_no_proxy_for_port; // not used w/libcurl. 6/27/2002 jhrg
// Make this a vector of strings or support a PATH-style list. 02/26/03
// jhrg
string d_ais_database;
string d_cookie_jar;
static RCReader* _instance;
RCReader();
~RCReader();
// File I/O methods
bool write_rc_file(const string &pathname);
bool read_rc_file(const string &pathname);
// Look for the RC file
string check_env_var(const string &variable_name);
string check_string(string env_var);
static void initialize_instance();
static void delete_instance();
friend class RCReaderTest;
friend class HTTPConnectTest;
public:
static RCReader* instance();
#if 0
static RCReader* instance(const string &rc_file_path);
#endif
// GET METHODS
string get_dods_cache_root() const throw()
{
return d_cache_root;
}
bool get_use_cache() const throw()
{
return _dods_use_cache;
}
int get_max_cache_size() const throw()
{
return _dods_cache_max;
}
unsigned int get_max_cached_obj() const throw()
{
return _dods_cached_obj;
}
int get_ignore_expires() const throw()
{
return _dods_ign_expires;
}
int get_default_expires() const throw()
{
return _dods_default_expires;
}
int get_always_validate() const throw()
{
return _dods_always_validate;
}
int get_validate_ssl() const throw()
{
return d_validate_ssl;
}
bool get_deflate() const throw()
{
return _dods_deflate;
}
string get_proxy_server_protocol() const throw()
{
return d_dods_proxy_server_protocol;
}
string get_proxy_server_host() const throw()
{
return d_dods_proxy_server_host;
}
int get_proxy_server_port() const throw()
{
return d_dods_proxy_server_port;
}
string get_proxy_server_userpw() const throw()
{
return d_dods_proxy_server_userpw;
}
string get_proxy_server_host_url() const throw()
{
return (d_dods_proxy_server_userpw.empty() ? "" : d_dods_proxy_server_userpw + "@")
+ d_dods_proxy_server_host
+ ":" + long_to_string(d_dods_proxy_server_port);
}
// The whole regex/proxy-for implementation needs reworking. We really
// need a vector of structs which hold the information on a set of regexes
// and matching proxies. Then in the code that derefs a URL, we should
// check to see if the URL matches any of the regexs, et cetera. I'm
// going to disable the entire feature and see if anyone complains. If
// they do, we can fix it. If not, one less thing to do... 06/17/04 jhrg
bool is_proxy_for_used() throw()
{
return _dods_proxy_for;
}
string get_proxy_for_regexp() const throw()
{
return _dods_proxy_for_regexp;
}
string get_proxy_for_proxy_host_url() const throw()
{
return _dods_proxy_for_proxy_host_url;
}
int get_proxy_for_regexp_flags() const throw()
{
return _dods_proxy_for_regexp_flags;
}
// The whole no_proxy implementation also needs a rewrite. However, it is
// useful as it is since the user can give a domain and there's often a
// real need for suppressing proxy access for the local domain. The
// ..._port() method is bogus, however, so it is deprecated. There's no
// code that uses it. 06/17/04 jhrg
bool is_no_proxy_for_used() throw()
{
return d_dods_no_proxy_for;
}
string get_no_proxy_for_protocol() const throw()
{
return d_dods_no_proxy_for_protocol;
}
string get_no_proxy_for_host() const throw()
{
return d_dods_no_proxy_for_host;
}
int get_no_proxy_for_port() const throw()
{
return _dods_no_proxy_for_port;
}
string get_ais_database() const throw()
{
return d_ais_database;
}
string get_cookie_jar() const throw()
{
return d_cookie_jar;
}
// SET METHODS
void set_use_cache(bool b) throw()
{
_dods_use_cache = b;
}
void set_max_cache_size(int i) throw()
{
_dods_cache_max = i;
}
void set_max_cached_obj(int i) throw()
{
_dods_cached_obj = i;
}
void set_ignore_expires(int i) throw()
{
_dods_ign_expires = i;
}
void set_default_expires(int i) throw()
{
_dods_default_expires = i;
}
void set_always_validate(int i) throw()
{
_dods_always_validate = i;
}
void set_validate_ssl(int i) throw()
{
d_validate_ssl = i;
}
void set_deflate(bool b) throw()
{
_dods_deflate = b;
}
void set_proxy_server_protocol(const string &s) throw()
{
d_dods_proxy_server_protocol = s;
}
void set_proxy_server_host(const string &s) throw()
{
d_dods_proxy_server_host = s;
}
void set_proxy_server_port(int l) throw()
{
d_dods_proxy_server_port = l;
}
void set_proxy_server_userpw(const string &s) throw()
{
d_dods_proxy_server_userpw = s;
}
void set_proxy_server_host_url(const string &s) throw()
{
_dods_proxy_server_host_url = s;
}
void set_proxy_for_regexp(const string &s) throw()
{
_dods_proxy_for_regexp = s;
}
void set_proxy_for_proxy_host_url(const string &s) throw()
{
_dods_proxy_for_proxy_host_url = s;
}
void set_proxy_for_regexp_flags(int i) throw()
{
_dods_proxy_for_regexp_flags = i;
}
void set_no_proxy_for_protocol(const string &s) throw()
{
d_dods_no_proxy_for_protocol = s;
}
void set_no_proxy_for_host(const string &s) throw()
{
d_dods_no_proxy_for_host = s;
}
void set_no_proxy_for_port(int i) throw()
{
_dods_no_proxy_for_port = i;
}
void set_ais_database(const string &db) throw()
{
d_ais_database = db;
}
};
} // namespace libdap
#endif // _RCReader_h_
libdap::RCReader
Definition: RCReader.h:55
libdap::RCReader::set_no_proxy_for_port
void set_no_proxy_for_port(int i)
Definition: RCReader.h:349
libdap::RCReader::get_proxy_server_host
string get_proxy_server_host() const
Get the proxy host.
Definition: RCReader.h:181
libdap::RCReader::set_proxy_for_proxy_host_url
void set_proxy_for_proxy_host_url(const string &s)
Definition: RCReader.h:329
libdap::RCReader::get_no_proxy_for_port
int get_no_proxy_for_port() const
Definition: RCReader.h:250
libdap::RCReader::set_proxy_for_regexp
void set_proxy_for_regexp(const string &s)
Definition: RCReader.h:324
libdap::RCReader::get_proxy_server_port
int get_proxy_server_port() const
Get the proxy port.
Definition: RCReader.h:186
libdap::RCReader::get_proxy_server_userpw
string get_proxy_server_userpw() const
Get the proxy username and password.
Definition: RCReader.h:191
libdap::RCReader::get_proxy_for_regexp
string get_proxy_for_regexp() const
Definition: RCReader.h:215
libdap::RCReader::set_proxy_server_host_url
void set_proxy_server_host_url(const string &s)
Definition: RCReader.h:318
libdap::RCReader::get_proxy_server_host_url
string get_proxy_server_host_url() const
Definition: RCReader.h:196
libdap::RCReader::get_proxy_for_proxy_host_url
string get_proxy_for_proxy_host_url() const
Definition: RCReader.h:220
libdap::RCReader::get_proxy_server_protocol
string get_proxy_server_protocol() const
Get the proxy server protocol.
Definition: RCReader.h:176
libdap::RCReader::get_proxy_for_regexp_flags
int get_proxy_for_regexp_flags() const
Definition: RCReader.h:226
libdap::RCReader::is_proxy_for_used
bool is_proxy_for_used()
Definition: RCReader.h:210
libdap::RCReader::set_proxy_for_regexp_flags
void set_proxy_for_regexp_flags(int i)
Definition: RCReader.h:334
libdap
top level DAP object to house generic methods
Definition: AlarmHandler.h:36