libdap++  Updated for version 3.13.1
libdap Namespace Reference

Classes

class  AlarmHandler
 
class  Ancillary
 
class  Array
 A multidimensional array of identical data types. More...
 
class  AttrTable
 Contains the attributes for a dataset. More...
 
class  BaseType
 The basic data type for the DODS DAP types. More...
 
class  BaseTypeFactory
 
class  Byte
 Holds a single byte. More...
 
struct  ce_parser_arg
 
struct  Clause
 Holds a fragment of a constraint expression. More...
 
class  Connect
 Holds information about the link from a DAP2 client to a dataset. More...
 
class  ConstraintEvaluator
 Evaluate a constraint expression. More...
 
class  Constructor
 
class  D4BaseTypeFactory
 
class  D4Dimensions
 
class  D4EnumDef
 
class  D4Group
 
class  D4Maps
 
class  D4ParseError
 
class  D4ParserSax2
 
class  DAP4StreamMarshaller
 Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiver-makes-right scheme. This code adds checksums to the stream and uses the xdr library to encode real values if the underlying representation is not IEEE 754. It also supports computing the checksum only. More...
 
class  DAP4StreamUnMarshaller
 Read data from the stream made by DAP4StreamMarshaller. More...
 
class  DapIndent
 class with static methods to help with indentation of debug information. More...
 
class  DapObj
 libdap base object for common functionality of libdap objects More...
 
class  DAS
 Hold attribute data for a DAP2 dataset. More...
 
class  DataDDS
 Holds a DAP2 DDS. More...
 
class  DDS
 
class  DDXParseFailed
 
class  DDXParser
 
class  DODSFilter
 Common functions for DODS server filter programs. More...
 
class  Error
 A class for error processing. More...
 
class  EventHandler
 
class  Float32
 Holds a 32-bit floating point value. More...
 
class  Float64
 Holds a 64-bit (double precision) floating point value. More...
 
class  Grid
 Holds the Grid data type. More...
 
class  HTTPCache
 
class  HTTPCacheInterruptHandler
 
class  HTTPCacheResponse
 
class  HTTPCacheTable
 
class  HTTPConnect
 
class  HTTPResponse
 
class  Int16
 Holds a 16-bit signed integer value. More...
 
class  Int32
 Holds a 32-bit signed integer. More...
 
class  Int64
 Holds a64-bit signed integer. More...
 
class  Int8
 Holds a 16-bit signed integer value. More...
 
class  InternalErr
 A class for software fault reporting. More...
 
class  Keywords
 
class  Marshaller
 abstract base class used to marshal/serialize dap data objects More...
 
struct  parser_arg
 Pass parameters by reference to a parser. More...
 
class  PipeResponse
 Encapsulate a response. This class provides special treatment for 'stream pipes.' It arranges to close them using pclose() instead of fclose(). More...
 
class  RCReader
 
class  Resource
 Associate a rule with an ancillary resource. More...
 
class  Response
 
class  ResponseTooBigErr
 
class  rvalue
 
class  Sequence
 Holds a sequence. More...
 
class  ServerFunction
 
class  ServerFunctionsList
 
class  SignalHandler
 
class  SignalHandlerRegisteredErr
 
class  StdinResponse
 Encapsulate a response read from stdin. More...
 
class  Str
 Holds character string data. More...
 
class  Structure
 Holds a structure (aggregate) type. More...
 
class  TestHandler
 
class  UInt16
 Holds an unsigned 16-bit integer. More...
 
class  UInt32
 Holds a 32-bit unsigned integer. More...
 
class  UInt64
 Holds a 64-bit unsigned integer. More...
 
class  UnMarshaller
 abstract base class used to unmarshall/deserialize dap data objects More...
 
class  Url
 Holds an Internet address (URL). More...
 
class  Vector
 Holds a one-dimensional collection of DAP2 data types. More...
 
class  XDRFileMarshaller
 marshaller that knows how to marshall/serialize dap data objects to a file using XDR More...
 
class  XDRFileUnMarshaller
 unmarshaller that knows how to unmarshall/deserialize dap objects using XDR from a file More...
 
class  XDRStreamMarshaller
 marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using XDR More...
 
class  XDRStreamUnMarshaller
 unmarshaller that knows how to unmarshall/deserialize dap objects using XDR from a file More...
 
class  XDRUtils
 
class  XMLWriter
 

Typedefs

typedef vector< BaseType * > BaseTypeRow
 
typedef std::vector< dods_byte > * byte_arg_list
 
typedef uint8_t dods_byte
 
typedef float dods_float32
 
typedef double dods_float64
 
typedef int16_t dods_int16
 
typedef int32_t dods_int32
 
typedef int64_t dods_int64
 
typedef int8_t dods_int8
 
typedef uint16_t dods_uint16
 
typedef uint32_t dods_uint32
 
typedef uint64_t dods_uint64
 
typedef int ErrorCode
 An enumerated type for common errors. More...
 
typedef std::vector
< dods_float32 > * 
float32_arg_list
 
typedef std::vector
< dods_float64 > * 
float64_arg_list
 
typedef std::vector< dods_int16 > * int16_arg_list
 
typedef std::vector< dods_int32 > * int32_arg_list
 
typedef std::vector< rvalue * > rvalue_list
 
typedef std::vector< rvalue * >
::const_iterator 
rvalue_list_citer
 
typedef std::vector< rvalue * >
::iterator 
rvalue_list_iter
 
typedef vector< BaseTypeRow * > SequenceValues
 
typedef void Sigfunc (int)
 
typedef std::vector
< dods_uint16 > * 
uint16_arg_list
 
typedef std::vector
< dods_uint32 > * 
uint32_arg_list
 

Enumerations

enum  AttrType {
  Attr_unknown, Attr_container, Attr_byte, Attr_int16,
  Attr_uint16, Attr_int32, Attr_uint32, Attr_float32,
  Attr_float64, Attr_string, Attr_url, Attr_other_xml
}
 
enum  CacheDisconnectedMode { DISCONNECT_NONE = 0, DISCONNECT_NORMAL = 1, DISCONNECT_EXTERNAL = 2 }
 
enum  EncodingType {
  unknown_enc, deflate, x_plain, gzip,
  binary
}
 The type of encoding used on the current stream. More...
 
enum  ObjectType {
  unknown_type, dods_das, dods_dds, dods_data,
  dods_error, web_error, dap4_ddx, dap4_data,
  dap4_error, dap4_data_ddx, dods_ddx
}
 The type of object in the stream coming from the data server. More...
 
enum  Part { nil, array, maps }
 Names the parts of multi-section constructor data types. More...
 
enum  Type {
  dods_null_c, dods_byte_c, dods_int16_c, dods_uint16_c,
  dods_int32_c, dods_uint32_c, dods_float32_c, dods_float64_c,
  dods_str_c, dods_url_c, dods_array_c, dods_structure_c,
  dods_sequence_c, dods_grid_c, dods_int8_c, dods_uint8_c,
  dods_int64_c, dods_uint64_c, dods_url4_c, dods_enum_c,
  dods_group_c
}
 Identifies the data type. More...
 

Functions

rvalue_listappend_rvalue_list (rvalue_list *rvals, rvalue *rv)
 
string AttrType_to_String (const AttrType at)
 
BaseType ** build_btp_args (rvalue_list *args, DDS &dds)
 
string char2ASCII (string s, const string escape="%[0-7][0-9a-fA-F]")
 
int check_byte (const char *val)
 Is the value a valid byte? More...
 
int check_float32 (const char *val)
 Is the value a valid float? More...
 
int check_float64 (const char *val)
 
int check_int16 (const char *val)
 Is the value a valid integer? More...
 
int check_int32 (const char *val)
 
int check_uint16 (const char *val)
 
int check_uint32 (const char *val)
 
int check_url (const char *val)
 Is the value a valid URL? More...
 
void close_temp (FILE *s, const string &name)
 
template<class T1 , class T2 >
bool Cmp (int op, T1 v1, T2 v2)
 
string dap_version ()
 
string date_time_str (time_t *calendar, bool local)
 
bool dir_exists (const string &dir)
 
bool double_eq (double lhs, double rhs, double epsilon=1.0e-5)
 
void downcase (string &s)
 
string esc2underscore (string s)
 
string escape_double_quotes (string source)
 
string escattr (string s)
 
double * extract_double_array (Array *a)
 
double extract_double_value (BaseType *arg)
 
string extract_string_argument (BaseType *arg)
 
int get_hash (const string &url)
 
string get_temp_file (FILE *&stream) throw (InternalErr)
 
Type get_type (const char *name)
 
int glob (const char *c, const char *s)
 
string hexstring (unsigned char val)
 
string id2www (string in, const string &allowable)
 
string id2www_ce (string in, const string &allowable)
 
string id2xml (string in, const string &not_allowed)
 
bool is_constructor_type (Type t)
 Returns true if the instance is a constructor (i.e., Structure, Sequence or Grid) type variable. More...
 
bool is_hop_by_hop_header (const string &header)
 
bool is_integer_type (Type t)
 
bool is_keyword (string id, const string &keyword)
 
bool is_quoted (const string &s)
 
bool is_simple_type (Type t)
 Returns true if the instance is a numeric, string or URL type variable. More...
 
bool is_vector_type (Type t)
 Returns true if the instance is a vector (i.e., array) type variable. More...
 
const char * libdap_name ()
 
const char * libdap_root ()
 
const char * libdap_version ()
 
rvalue_listmake_rvalue_list (rvalue *rv)
 
string munge_error_message (string msg)
 
string octal_to_hex (const string &octal_digits)
 
string octstring (unsigned char val)
 
void parse_error (const char *msg, const int line_num, const char *context)
 
time_t parse_time (const char *str, bool expand)
 
string path_to_filename (string path)
 
string prune_spaces (const string &name)
 
string remove_quotes (const string &s)
 
void save_str (char *dst, const char *src, const int line_num)
 Save a string to a temporary variable during the parse. More...
 
void save_str (string &dst, const char *src, const int)
 
void set_array_using_double (Array *dest, double *src, int src_len)
 
void set_mime_binary (ostream &strm, ObjectType type, EncodingType enc, const time_t last_modified, const string &protocol)
 
void set_mime_html (ostream &strm, ObjectType type, EncodingType enc, const time_t last_modified, const string &protocol)
 
void set_mime_multipart (ostream &strm, const string &boundary, const string &start, ObjectType type, EncodingType enc, const time_t last_modified, const string &protocol, const string &url)
 
void set_mime_text (ostream &strm, ObjectType type, EncodingType enc, const time_t last_modified, const string &protocol)
 
template<class T1 , class T2 >
bool StrCmp (int op, T1 v1, T2 v2)
 
AttrType String_to_AttrType (const string &s)
 
template<class T1 , class UT2 >
bool SUCmp (int op, T1 v1, UT2 v2)
 
string systime ()
 
string type_name (Type t)
 Returns the type of the class instance as a string. More...
 
string unescape_double_quotes (string source)
 
string unescattr (string s)
 
string unhexstring (string s)
 
bool unique_names (vector< BaseType * > l, const string &var_name, const string &type_name, string &msg)
 
string unoctstring (string s)
 
template<class UT1 , class T2 >
bool USCmp (int op, UT1 v1, T2 v2)
 
uint8_t * WriteVarint64ToArrayInline (uint64_t value, uint8_t *target)
 
string www2id (const string &in, const string &escape, const string &except)
 
string xml2id (string in)
 
MIME Utilities

A collection of useful functions for writing MIME headers for OPeNDAP servers.

The CGI utilities include a variety of functions useful to programmers developing OPeNDAP CGI filter programs. However, before jumping in and using these, look at the class ResponseBuilder. Always choose to use that class over these functions if you can. Many of these functions were used by the CGI programs that made up the first DAP server; all of those are deprecated and the ResponseBuilder class should be used instead. Some of the other functions are used by ResponseBuilder and the client-side parsing code that needs to identify MIME headers, boundaries, etc.

See also
ResponseBuilder, Connect, DDXParserSAX2
time_t last_modified_time (const string &name)
 
string rfc822_date (const time_t t)
 
bool do_version (const string &script_ver, const string &dataset_ver)
 Send a version number. More...
 
void ErrMsgT (const string &Msgt)
 Logs an error message. More...
 
string name_path (const string &path)
 Returns the filename portion of a pathname. More...
 
ObjectType get_type (const string &value)
 
ObjectType get_description_type (const string &value)
 
string get_next_mime_header (FILE *in)
 
string get_next_mime_header (istream &in)
 
void parse_mime_header (const string &header, string &name, string &value)
 
bool is_boundary (const char *line, const string &boundary)
 
string read_multipart_boundary (FILE *in, const string &boundary)
 
string read_multipart_boundary (istream &in, const string &boundary)
 
void read_multipart_headers (FILE *in, const string &content_type, const ObjectType object_type, const string &cid)
 
void read_multipart_headers (istream &in, const string &content_type, const ObjectType object_type, const string &cid)
 
string cid_to_header_value (const string &cid)
 
bool remove_mime_header (FILE *in)
 Read and discard the MIME header of the stream in. More...
 
MIME utility functions

These functions are used to create the MIME headers for a message from a server to a client. They are public but should not be called directly unless absolutely necessary. Use DODSFilter instead.

NB: These functions actually write both the response status line and the header.

Deprecated:

Use ResponseBuilder instead.

See also
DODSFilter
void set_mime_text (FILE *out, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_text (ostream &strm, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_html (FILE *out, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_html (ostream &strm, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_binary (FILE *out, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_binary (ostream &strm, ObjectType type, const string &ver, EncodingType enc, const time_t last_modified)
 
void set_mime_multipart (ostream &strm, const string &boundary, const string &start, ObjectType type, const string &version, EncodingType enc, const time_t last_modified)
 
void set_mime_ddx_boundary (ostream &strm, const string &boundary, const string &cid, ObjectType type, EncodingType enc)
 
void set_mime_data_boundary (ostream &strm, const string &boundary, const string &cid, ObjectType type, EncodingType enc)
 
void set_mime_error (FILE *out, int code, const string &reason, const string &version)
 
void set_mime_error (ostream &strm, int code, const string &reason, const string &version)
 
void set_mime_not_modified (FILE *out)
 Send a `Not Modified' response. More...
 
void set_mime_not_modified (ostream &strm)
 Send a `Not Modified' response. More...
 
void set_mime_text (std::ostream &out, ObjectType type=unknown_type, EncodingType enc=x_plain, const time_t last_modified=0, const std::string &protocol="")
 
void set_mime_html (std::ostream &out, ObjectType type=unknown_type, EncodingType enc=x_plain, const time_t last_modified=0, const std::string &protocol="")
 
void set_mime_binary (std::ostream &out, ObjectType type=unknown_type, EncodingType enc=x_plain, const time_t last_modified=0, const std::string &protocol="")
 
void set_mime_multipart (std::ostream &out, const std::string &boundary, const std::string &start, ObjectType type=unknown_type, EncodingType enc=x_plain, const time_t last_modified=0, const std::string &protocol="", const std::string &url="")
 
parse_error

Generate error messages for the various parsers.

parser_error() generates error messages for the various parsers used by libdap. There are two versions of the function, one which takes a const char *message and a const int line_num and writes the message and line number too stderr and a second which takes an additional parser_arg arg parameter and writes the error message into an Error object which is returned to the caller via the arg parameter.

Note
{The second version of this function also accepts a third parameter (const char *context) which can be used to provide an additional line of information beyond what is in the string message.}
Returns
void
void parse_error (parser_arg *arg, const char *msg, const int line_num, const char *context)
 
void parse_error (const string &msg, const int line_num, const char *context)
 
Integer to string conversion functions

Fast, safe conversions from long to a character representation which gets appended to a string. This method will take a long value 'val' and it will recursively divide it by 'base' in order to "extract" one by one the digits which compose it; these digits will be appended to the string str_val which will become the textual representation of 'val'. Please notice that the digits ``extracted'' from `val' will vary depending on the base chosen for the conversion; for example val=15 converted to base 10 will yield the digits (1,5), converted to base 16 will yield (F) and converted to base 2 will yield (1,1,1,1).

Parameters
valThe long value we which to convert to string.
baseA value in the range [2,36] which is the base to use while transforming the long value 'val' to its textual representation. Typical bases are 2 (binary), 10 (decimal) and 16 (hexadecimal).
str_valThis is the string that will hold the textual representation of 'val'. The string str_val should be pre-set to an empty string ("") otherwise the output of this function will just append the textual representation of val to whatever data is there; these feature may be useful if you wish to append a long value to a string s1 (just like operator+ does) without having to create a new string object s2 and then use string::operator+ between s1 and s2.
Returns
void. This method returns nothing however be aware that it will throw and exception of type std::invalid_argument if the parameter base is not in the valid range.
void append_long_to_string (long val, int base, string &str_val)
 
string long_to_string (long val, int base)
 
Double to string conversion functions

Conversions from double to a character representation which gets appended to a string. This function depends on the standard routine sprintf to convert a double to a textual representation which gets appended to the string 'str'.

Parameters
numThe double you wish to append to str.
strThe string where the textual representation of num will be appended.
Returns
void.
void append_double_to_string (const double &num, string &str)
 
string double_to_string (const double &num)
 
Security functions
bool size_ok (unsigned int sz, unsigned int nelem)
 sanitize the size of an array. Test for integer overflow when dynamically allocating an array. More...
 
bool pathname_ok (const string &path, bool strict)
 Does the string name a potentially valid pathname? Test the given pathname to verify that it is a valid name. We define this as: Contains only printable characters; and Is less then 256 characters. If strict is true, test that the pathname consists of only letters, digits, and underscore, dash and dot characters instead of the more general case where a pathname can be composed of any printable characters. More...
 

Variables

int dods_keep_temps = 0
 
const int DODS_MAX_ARRAY = DODS_INT_MAX
 
const string double_quote = "\""
 
const size_t line_length = 1024
 
const unsigned int max_str_len = DODS_USHRT_MAX - 1
 
const unsigned int max_url_len = 255
 
const string usage
 
int www_trace = 0
 
const int XDR_DAP_BUFF_SIZE = 4096
 

Typedef Documentation

typedef vector<BaseType *> libdap::BaseTypeRow

The type BaseTypeRow is used to store single rows of values in an instance of Sequence. Values are stored in instances of BaseType.

Definition at line 69 of file Sequence.h.

typedef std::vector<dods_byte>* libdap::byte_arg_list

Definition at line 71 of file RValue.h.

typedef uint8_t libdap::dods_byte

Definition at line 41 of file dods-datatypes-static.h.

typedef float libdap::dods_float32

Definition at line 45 of file dods-datatypes-static.h.

typedef double libdap::dods_float64

Definition at line 43 of file dods-datatypes-static.h.

typedef int16_t libdap::dods_int16

Definition at line 37 of file dods-datatypes-static.h.

typedef int32_t libdap::dods_int32

Definition at line 33 of file dods-datatypes-static.h.

typedef int64_t libdap::dods_int64

Definition at line 50 of file dods-datatypes-static.h.

typedef int8_t libdap::dods_int8

Definition at line 48 of file dods-datatypes-static.h.

typedef uint16_t libdap::dods_uint16

Definition at line 39 of file dods-datatypes-static.h.

typedef uint32_t libdap::dods_uint32

Definition at line 35 of file dods-datatypes-static.h.

typedef uint64_t libdap::dods_uint64

Definition at line 52 of file dods-datatypes-static.h.

typedef int libdap::ErrorCode

The most common errors within DAP2 have special codes so that they can be spotted easily by the client software. Any error without a matching code gets the unknown_error code.

Definition at line 55 of file Error.h.

typedef std::vector<dods_float32>* libdap::float32_arg_list

Definition at line 76 of file RValue.h.

typedef std::vector<dods_float64>* libdap::float64_arg_list

Definition at line 77 of file RValue.h.

typedef std::vector<dods_int16>* libdap::int16_arg_list

Definition at line 72 of file RValue.h.

typedef std::vector<dods_int32>* libdap::int32_arg_list

Definition at line 74 of file RValue.h.

typedef std::vector<rvalue *> libdap::rvalue_list

Definition at line 67 of file RValue.h.

typedef std::vector<rvalue *>::const_iterator libdap::rvalue_list_citer

Definition at line 68 of file RValue.h.

typedef std::vector<rvalue *>::iterator libdap::rvalue_list_iter

Definition at line 69 of file RValue.h.

This type holds all of the values of a Sequence.

Definition at line 72 of file Sequence.h.

typedef void libdap::Sigfunc(int)

Definition at line 37 of file SignalHandler.h.

typedef std::vector<dods_uint16>* libdap::uint16_arg_list

Definition at line 73 of file RValue.h.

typedef std::vector<dods_uint32>* libdap::uint32_arg_list

Definition at line 75 of file RValue.h.

Enumeration Type Documentation

AttrType identifies the data types which may appear in an attribute table object.

See also
AttrTable
Enumerator
Attr_unknown 
Attr_container 
Attr_byte 
Attr_int16 
Attr_uint16 
Attr_int32 
Attr_uint32 
Attr_float32 
Attr_float64 
Attr_string 
Attr_url 
Attr_other_xml 

Definition at line 81 of file AttrTable.h.

Disconnected Operation

The cache can be set to handle disconnected operation where it does not use the network to validate entries and does not attempt to load new documents. All requests that cannot be fulfilled by the cache will be returned with a "504 Gateway Timeout" response. There are two operational disconnected modes:

No network activity at all: Here it uses its own persistent cache to answer the request, if possible.

Forward all disconnected requests to a proxy cache: Here it uses the HTTP/1.1 cache-control header to indicate that the proxy should operate in disconnected mode.

Enumerator
DISCONNECT_NONE 
DISCONNECT_NORMAL 
DISCONNECT_EXTERNAL 

Definition at line 47 of file HTTPCacheDisconnectedMode.h.

libdap understands two types of encoding: x-plain and deflate, which correspond to plain uncompressed data and data compressed with zlib's LZW algorithm respectively.

enum EncodingType { unknown_enc, deflate, x_plain, gzip, binary };

Enumerator
unknown_enc 
deflate 
x_plain 
gzip 
binary 

Definition at line 48 of file EncodingType.h.

When a version 2.x or greater DAP data server sends an object, it uses the Content-Description header of the response to indicate the type of object contained in the response. During the parse of the header a member of Connect is set to one of these values so that other mfuncs can tell the type of object without parsing the stream themselves.

 enum ObjectType {
   unknown_type,
   dods_das,
   dods_dds,
   dods_data,
   dods_error,
   web_error,
   dods_ddx,
   dap4_ddx,
   dap4_data,
   dap4_error,
   dap4_data_ddx
 };
 
Enumerator
unknown_type 
dods_das 
dods_dds 
dods_data 
dods_error 
web_error 
dap4_ddx 
dap4_data 
dap4_error 
dap4_data_ddx 
dods_ddx 

Definition at line 57 of file ObjectType.h.

Part names the parts of multi-section constructor types. For example, the Grid class has an array and the array maps. Use the nil value for data types that don't have separate parts.

enum Part {
};
See also
Grid
BaseType
Enumerator
nil 
array 
maps 

Definition at line 95 of file BaseType.h.

Type identifies the data type stored in a particular type class. All the DODS Data Access Protocol (DAP) types inherit from the BaseType class.

See also
BaseType
Enumerator
dods_null_c 
dods_byte_c 
dods_int16_c 
dods_uint16_c 
dods_int32_c 
dods_uint32_c 
dods_float32_c 
dods_float64_c 
dods_str_c 
dods_url_c 
dods_array_c 
dods_structure_c 
dods_sequence_c 
dods_grid_c 
dods_int8_c 
dods_uint8_c 
dods_int64_c 
dods_uint64_c 
dods_url4_c 
dods_enum_c 
dods_group_c 

Definition at line 137 of file BaseType.h.

Function Documentation

void libdap::append_double_to_string ( const double &  num,
string &  str 
)

Definition at line 781 of file util.cc.

Referenced by double_to_string().

void libdap::append_long_to_string ( long  val,
int  base,
string &  str_val 
)

Definition at line 744 of file util.cc.

Referenced by libdap::InternalErr::InternalErr(), long_to_string(), and parse_error().

rvalue_list * libdap::append_rvalue_list ( rvalue_list *  rvals,
rvalue *  rv 
)

Definition at line 73 of file RValue.cc.

Referenced by make_rvalue_list().

string libdap::AttrType_to_String ( const AttrType  at)

Convert an AttrType to it's string representation.

Parameters
atThe Attribute Type.
Returns
The type's string representation

Definition at line 98 of file AttrTable.cc.

References Attr_byte, Attr_container, Attr_float32, Attr_float64, Attr_int16, Attr_int32, Attr_other_xml, Attr_string, Attr_uint16, Attr_uint32, and Attr_url.

Referenced by libdap::AttrTable::dump(), and libdap::AttrTable::get_type().

BaseType ** libdap::build_btp_args ( rvalue_list *  args,
DDS &  dds 
)

Build an argument list suitable for calling a btp_func, bool_func, and so on. Since this takes an rvalue_list and not an rvalue, it is a function rather than a class member.

This function performs a common task but does not fit within the RValue class well. It is used by Clause and ce_expr.y.

Parameters
argsA list of RValue objects
ddsUse this DDS when evaluating functions

Definition at line 92 of file RValue.cc.

References long_to_string(), malformed_expr, and size_ok().

Referenced by libdap::rvalue::bvalue(), and libdap::Clause::value().

Here is the call graph for this function:

string libdap::char2ASCII ( string  s,
const string  escape = "%[0-7][0-9a-fA-F]" 
)
int libdap::check_byte ( const char *  val)

Check to see if val is a valid byte value. If not, generate an error message using parser_error(). There are two versions of check_byte(), one which calls parser_error() and prints an error message to stderr an one which calls parser_error() and generates and Error object.

Returns
Returns: True if val is a byte value, False otherwise.

Definition at line 179 of file parser-util.cc.

References DBG, DODS_SCHAR_MIN, DODS_UCHAR_MAX, FALSE, and TRUE.

int libdap::check_float32 ( const char *  val)

Like check_byte() but for 64-bit float values.

Definition at line 304 of file parser-util.cc.

References DBG, DODS_FLT_MAX, DODS_FLT_MIN, FALSE, and TRUE.

int libdap::check_float64 ( const char *  val)

Definition at line 337 of file parser-util.cc.

References DBG, DODS_DBL_MAX, DODS_DBL_MIN, FALSE, and TRUE.

int libdap::check_int16 ( const char *  val)

Like check_byte() but for 32-bit integers (check_uint() is for unsigned integers).

Definition at line 205 of file parser-util.cc.

References DODS_SHRT_MAX, DODS_SHRT_MIN, FALSE, and TRUE.

int libdap::check_int32 ( const char *  val)

Definition at line 237 of file parser-util.cc.

References DODS_INT_MAX, DODS_INT_MIN, FALSE, and TRUE.

int libdap::check_uint16 ( const char *  val)

Definition at line 221 of file parser-util.cc.

References DODS_USHRT_MAX, FALSE, and TRUE.

int libdap::check_uint32 ( const char *  val)

Definition at line 265 of file parser-util.cc.

References DODS_UINT_MAX, FALSE, and TRUE.

int libdap::check_url ( const char *  val)

Currently this function always returns true.

Definition at line 374 of file parser-util.cc.

References TRUE.

string libdap::cid_to_header_value ( const string &  cid)

Given a Content-Id read from the DDX, return the value to look for in a MPM Content-Id header. This function downcases the CID to match the value returned by parse_mime_header.

Parameters
cidThe Content-Id read from the DDX
Returns
The header value to look for.
Exceptions
Errorif the CID does not start with the string "cid:"

Definition at line 1064 of file mime_util.cc.

References downcase().

Here is the call graph for this function:

void libdap::close_temp ( FILE *  s,
const string &  name 
)

Close the temporary file opened for read_url().

Definition at line 740 of file HTTPConnect.cc.

References long_to_string().

Referenced by libdap::HTTPResponse::~HTTPResponse().

Here is the call graph for this function:

template<class T1 , class T2 >
bool libdap::Cmp ( int  op,
T1  v1,
T2  v2 
)

Compare two numerical types, both of which are either signed or unsigned. This class is one implementation of the comparison policy used by rops.

See also
rops
USCmp
SUCmp

Definition at line 54 of file Operators.h.

string libdap::dap_version ( )

Get the version of the DAP library.

Deprecated:

Definition at line 1026 of file util.cc.

References libdap_version().

Here is the call graph for this function:

string libdap::date_time_str ( time_t *  calendar,
bool  local 
)

Given a time in seconds since midnight 1 Jan 1970, return the RFC 1123 date string. Example result string: Sun, 06 Nov 1994 08:49:37 GMT

Parameters
calendarTime in seconds
localIf true, return the local time, if false return GMT. The default value is false.
Returns
A RFC 1123 date string.

Definition at line 281 of file util_mit.cc.

Referenced by libdap::HTTPCache::get_conditional_request_headers().

bool libdap::dir_exists ( const string &  dir)

Does the directory exist?

Parameters
dirThe pathname to test.
Returns
True if the directory exists, false otherwise

Definition at line 735 of file util.cc.

bool libdap::do_version ( const string &  script_ver,
const string &  dataset_ver 
)

This sends a formatted block of text to the client, containing version information about various aspects of the server. The arguments allow you to enclose version information about the filter program and the dataset in the message. Either argument (or both) may be omitted, in which case no script or dataset version information will be printed.

Parameters
script_verThe version of the filter script executing this function.
dataset_verThe version of the dataset.
Returns
TRUE for success. Always returns true.

Definition at line 187 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, and DVR.

Referenced by libdap::DODSFilter::send_version_info().

bool libdap::double_eq ( double  lhs,
double  rhs,
double  epsilon = 1.0e-5 
)
inline

Is lhs equal to rhs? Use epsilon to determine equality.

Definition at line 55 of file util.h.

string libdap::double_to_string ( const double &  num)

Definition at line 792 of file util.cc.

References append_double_to_string().

Here is the call graph for this function:

void libdap::downcase ( string &  s)

Downcase the source string. This function modifies its argument.

Parameters
Thestring to modify

Definition at line 428 of file util.cc.

Referenced by cid_to_header_value(), is_keyword(), parse_mime_header(), and String_to_AttrType().

void libdap::ErrMsgT ( const string &  Msgt)

Prints an error message in the httpd system log file, along with a time stamp and the client host name (or address).

Use this instead of the functions in liberrmsg.a in the programs run by the CGIs to report errors so those errors show up in HTTPD's log files.

Deprecated:
Returns
void

Definition at line 220 of file mime_util.cc.

Referenced by libdap::DODSFilter::print_usage().

string libdap::esc2underscore ( string  s)

Return a string that has all the %<hex digit><hex digit> sequences replaced with underscores (`_').

Parameters
sThe string to transform
Returns
The modified string.

Definition at line 354 of file escaping.cc.

string libdap::escape_double_quotes ( string  source)

Rip through a string and replace all the double quotes with " sequences.

Parameters
source
Returns
result

Definition at line 470 of file escaping.cc.

string libdap::escattr ( string  s)

Escape non-printable characters and quotes from an HDF attribute.

Parameters
sThe attribute to modify.
Returns
The modified attribute.

Definition at line 368 of file escaping.cc.

References octstring().

Referenced by libdap::Str::print_val().

Here is the call graph for this function:

double * libdap::extract_double_array ( Array *  a)

Given a pointer to an Array which holds a numeric type, extract the values and return in an array of doubles. This function allocates the array using 'new double[n]' so delete[] MUST be used when you are done the data.

Definition at line 223 of file util.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_int16_c, dods_int32_c, dods_str_c, dods_uint16_c, dods_uint32_c, dods_url_c, libdap::BaseType::is_simple_type(), malformed_expr, libdap::BaseType::name(), libdap::BaseType::read_p(), libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

double libdap::extract_double_value ( BaseType *  arg)

Given a BaseType pointer, extract the numeric value it contains and return it in a C++ double.

Parameters
argThe BaseType pointer
Returns
A C++ double
Exceptions
Errorthrown if the referenced BaseType object does not contain a DAP numeric value.

Definition at line 268 of file util.cc.

References dods_byte_c, dods_float32_c, dods_float64_c, dods_int16_c, dods_int32_c, dods_str_c, dods_uint16_c, dods_uint32_c, dods_url_c, libdap::BaseType::is_simple_type(), malformed_expr, libdap::BaseType::read_p(), and libdap::BaseType::type().

Here is the call graph for this function:

string libdap::extract_string_argument ( BaseType *  arg)

Given a BaseType pointer, extract the string value it contains and return it.

Parameters
argThe BaseType pointer
Returns
A C++ string
Exceptions
Errorthrown if the referenced BaseType object does not contain a DAP String.

Definition at line 96 of file util.cc.

References DBG, dods_str_c, malformed_expr, libdap::BaseType::read_p(), and libdap::BaseType::type().

Here is the call graph for this function:

ObjectType libdap::get_description_type ( const string &  value)

This function returns the ObjectType value that matches the given string. Modified to include tests for the descriptions that use hyphens in addition to underscores. 8/1/08 jhrg

Parameters
valueValue from the HTTP response header

Definition at line 340 of file mime_util.cc.

References dap4_data, dap4_data_ddx, dap4_ddx, dap4_error, dods_das, dods_data, dods_dds, dods_ddx, dods_error, unknown_type, and web_error.

Referenced by read_multipart_headers().

int libdap::get_hash ( const string &  url)

Compute the hash value for a URL.

Parameters
url
Returns
An integer hash code between 0 and CACHE_TABLE_SIZE.

Definition at line 101 of file HTTPCacheTable.cc.

References CACHE_TABLE_SIZE.

Referenced by libdap::HTTPCacheTable::CacheEntry::CacheEntry(), libdap::HTTPCacheTable::get_locked_entry_from_cache_table(), libdap::HTTPCacheTable::get_write_locked_entry_from_cache_table(), and libdap::HTTPCacheTable::remove_entry_from_cache_table().

string libdap::get_next_mime_header ( FILE *  in)

Read the next MIME header from the input stream and return it in a string object. This function consumes any leading whitespace before the next header. It returns an empty string when the blank line that separates the headers from the body is found. This function works for header and separator lines that use either a CRLF pair (the correct line ending) or just a newline (a common error).

Deprecated:
Parameters
inRead from this stream (FILE *)
Returns
A string that contains the next header line or is empty indicating the separator has been read.
Exceptions
Erroris thrown if no header or separator is found.
See also
parse_mime_header()

Definition at line 837 of file mime_util.cc.

References CRLF, and line_length.

string libdap::get_next_mime_header ( istream &  in)

Definition at line 858 of file mime_util.cc.

References CRLF, and line_length.

Referenced by read_multipart_boundary(), and read_multipart_headers().

string libdap::get_temp_file ( FILE *&  stream)
throw (InternalErr
)

Open a temporary file and return its name. This method opens a temporary file using get_tempfile_template(). The FILE* stream is opened for both reads and writes; if it already exists (highly unlikely), it is truncated. If used on Unix, it's the callers responsibility to unlink the named file so that when all descriptors to it are closed, it will be deleted. On Win32 platforms, this method pushes the name of the temporary file onto a vector which is used during object destruction to delete all the temporary files.

Note
Delete the returned char* using delete[].

A private method.

Parameters
streamA value-result parameter; the open file descriptor is returned via this parameter.
Returns
The name of the temporary file.
Exceptions
InternalErrthrown if the FILE* could not be opened.

Definition at line 709 of file HTTPConnect.cc.

References DBG.

ObjectType libdap::get_type ( const string &  value)

This function returns the ObjectType value that matches the given string. Modified to include tests for the descriptions that use hyphens in addition to underscores. 8/1/08 jhrg

Deprecated:

Definition at line 308 of file mime_util.cc.

References dap4_data, dap4_data_ddx, dap4_ddx, dap4_error, dods_das, dods_data, dods_dds, dods_ddx, dods_error, unknown_type, and web_error.

Referenced by libdap::D4ParserSax2::ddx_end_element(), and libdap::DDXParser::ddx_sax2_end_element().

Type libdap::get_type ( const char *  name)
int libdap::glob ( const char *  c,
const char *  s 
)

glob: match a string against a simple pattern

Understands the following patterns:

  • any number of characters ? any single character [a-z] any single character in the range a-z [^a-z] any single character not in the range a-z match x
Parameters
cThe pattern
sThe string
Returns
0 on success, -1 if the pattern is exhausted but there are characters remaining in the string and 1 if the pattern does not match

Definition at line 888 of file util.cc.

References BITLISTSIZE, and CHECK_BIT.

string libdap::hexstring ( unsigned char  val)

Definition at line 82 of file escaping.cc.

Referenced by id2www().

string libdap::id2www ( string  in,
const string &  allowable 
)

Replace characters that are not allowed in DAP2 identifiers.

-In the DAP itself, id2www() is called in:

  1. Array::print_decl() where dimension names are escaped
  2. AttrTable::print() (which calls AttrTable::simple_print()) where attribute names are escaped
  3. BaseType::print_decl() where variable names are escaped.
  4. Constructor::print_decl() where the name of the constructor type is printed.
  5. DDS::print() and DDS::print_constrained() where the name of the dataset is printed.
  6. Grid::print_decl() where the name of the grid is printed.

-In the client code:

  1. id2www_ce() is called five times in the five methods that are used to request responses where a CE is appended to a URL (Connect::request_version, request_protocol, request_das, request_dds, request_data).
Parameters
inReplace characters in this string.
allowableThe set of characters that are allowed in a URI. default: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-+_/.\\*"
See also
id2www_ce()
Returns
The modified identifier.

Definition at line 153 of file escaping.cc.

References DBG, DBGN, and hexstring().

Referenced by id2www_ce(), libdap::AttrTable::print(), libdap::DDS::print(), libdap::DDS::print_constrained(), libdap::Constructor::print_decl(), libdap::Grid::print_decl(), libdap::Array::print_decl(), libdap::BaseType::print_decl(), and libdap::AttrTable::simple_print().

Here is the call graph for this function:

string libdap::id2www_ce ( string  in,
const string &  allowable 
)

Replace characters that are not allowed in WWW URLs using rules specific to Constraint Expressions. This has changed over time and now the only difference is that '*' is escaped by this function while it is not escaped by id2www().

Parameters
inThe string in which to replace characters.
allowableThe set of characters that are allowed in a URI. default: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-+_/.\\"
See also
id2www()
Returns
The modified identifier.

Definition at line 178 of file escaping.cc.

References id2www().

Referenced by libdap::Connect::request_das(), libdap::Connect::request_data(), libdap::Connect::request_data_ddx(), libdap::Connect::request_dds(), libdap::Connect::request_ddx(), libdap::Connect::request_protocol(), and libdap::Connect::request_version().

Here is the call graph for this function:

string libdap::id2xml ( string  in,
const string &  not_allowed 
)

Replace characters that are not allowed in XML

Parameters
inThe string in which to replace characters.
not_allowedThe set of characters that are not allowed in XML. default: ><&'(single quote)"(double quote)
Returns
The modified identifier.

Definition at line 272 of file escaping.cc.

References octal_to_hex().

Referenced by libdap::AttrTable::print_xml().

Here is the call graph for this function:

bool libdap::is_boundary ( const char *  line,
const string &  boundary 
)

Is this string the same as the MPM boundary value?

Note
Since fgets() is used to read into line, it is guaranteed to be null terminated.
Parameters
lineThe input to test
boundaryThe complete boundary line to test for, excluding terminating characters.
Returns
true is line is a MPM boundary

Definition at line 926 of file mime_util.cc.

Referenced by libdap::DDXParser::intern_stream(), and read_multipart_boundary().

bool libdap::is_hop_by_hop_header ( const string &  header)

Is the header a hop by hop header? If so, we're not supposed to store it in the cache. See RFC 2616, Section 13.5.1.

Returns
True if the header is, otherwise False.

Definition at line 935 of file HTTPCache.cc.

bool libdap::is_integer_type ( Type  t)

Is this an integer type?

Returns
True if the type holds an integer value, false otherwise.

Definition at line 710 of file util.cc.

References dods_byte_c, dods_int16_c, dods_int32_c, dods_int64_c, dods_int8_c, dods_uint16_c, dods_uint32_c, dods_uint64_c, and dods_uint8_c.

bool libdap::is_keyword ( string  id,
const string &  keyword 
)

Definition at line 171 of file parser-util.cc.

References DBG, downcase(), and prune_spaces().

Here is the call graph for this function:

bool libdap::is_quoted ( const string &  s)

Is the string surrounded by double quotes?

Parameters
sThe source string True if the string is quoted, false otherwise.

Definition at line 440 of file util.cc.

Referenced by remove_quotes().

bool libdap::is_simple_type ( Type  t)
time_t libdap::last_modified_time ( const string &  name)

Get the last modified time. Assume name is a file and find its last modified time. If name is not a file, then return now as the last modified time.

Parameters
nameThe name of a file.
Returns
The last modified time or the current time.

Definition at line 93 of file mime_util.cc.

Referenced by libdap::DODSFilter::get_das_last_modified_time(), libdap::DODSFilter::get_data_last_modified_time(), libdap::DODSFilter::get_dataset_last_modified_time(), and libdap::DODSFilter::get_dds_last_modified_time().

const char * libdap::libdap_name ( )

Definition at line 392 of file util.cc.

References PACKAGE_NAME.

const char * libdap::libdap_root ( )

Definition at line 375 of file util.cc.

References LIBDAP_ROOT.

const char * libdap::libdap_version ( )

Return the version string for this package.

Note
This function has C linkage so that it can be found using autoconf tests.
Returns
The version string.

Definition at line 385 of file util.cc.

References PACKAGE_VERSION.

Referenced by dap_version().

rvalue_list * libdap::make_rvalue_list ( rvalue *  rv)

Definition at line 58 of file RValue.cc.

References append_rvalue_list().

Here is the call graph for this function:

string libdap::munge_error_message ( string  msg)

Definition at line 448 of file escaping.cc.

string libdap::name_path ( const string &  path)

Given a pathname, this function returns just the file name component of the path. That is, given /a/b/c/ralph.nc.das, it returns ralph.nc.

Parameters
pathA C-style simple string containing a pathname to be parsed.
Returns
A C-style simple string containing the filename component of the given pathname.

Definition at line 266 of file mime_util.cc.

References FILE_DELIMITER.

string libdap::octal_to_hex ( const string &  octal_digits)

Definition at line 253 of file escaping.cc.

Referenced by id2xml().

string libdap::octstring ( unsigned char  val)

Definition at line 103 of file escaping.cc.

Referenced by escattr().

void libdap::parse_error ( parser_arg *  arg,
const char *  msg,
const int  line_num,
const char *  context 
)

Definition at line 90 of file parser-util.cc.

References append_long_to_string(), FALSE, libdap::parser_arg::set_error(), libdap::parser_arg::set_status(), and unknown_error.

Referenced by parse_error(), and save_str().

Here is the call graph for this function:

void libdap::parse_error ( const char *  msg,
const int  line_num,
const char *  context 
)

Definition at line 121 of file parser-util.cc.

References append_long_to_string().

Here is the call graph for this function:

void libdap::parse_error ( const string &  msg,
const int  line_num,
const char *  context 
)

Definition at line 150 of file parser-util.cc.

References parse_error().

Here is the call graph for this function:

void libdap::parse_mime_header ( const string &  header,
string &  name,
string &  value 
)

Given a string that contains a MIME header line, parse it into the the header (name) and its value. Both are downcased.

Parameters
headerThe input line, striped of the ending crlf pair
nameA value-result parameter that holds the header name
valueA value-result parameter that holds the header's value.

Definition at line 899 of file mime_util.cc.

References downcase(), and line_length.

Referenced by read_multipart_headers().

Here is the call graph for this function:

time_t libdap::parse_time ( const char *  str,
bool  expand 
)

Parse a string in GMT format to a local time time_t representation Four formats are accepted: Wkd, 00 Mon 0000 00:00:00 GMT (rfc1123) Weekday, 00-Mon-00 00:00:00 GMT (rfc850) Wkd Mon 00 00:00:00 0000 GMT (ctime) 1*DIGIT (delta-seconds)

Copied from libwww. 09/19/02 jhrg

Parameters
strThe time string.
expandIf the time is given in delta seconds, adjust it to seconds since midnight 1 Jan 1970 if this is true. If false, simply convert the string to a time_t and return. The default value is true.
Returns
The time in seconds since midnight 1 Jan 1970.

Definition at line 129 of file util_mit.cc.

References DBG.

Referenced by libdap::HTTPCacheTable::parse_headers(), and libdap::HTTPCache::set_cache_control().

string libdap::path_to_filename ( string  path)

Get the filename part from a path. This function can be used to return a string that has the directory components stripped from a path. This is useful when building error message strings.

If WIN32 is defined, use '\' as the path separator, otherwise use '/' as the path separator.

Returns
A string containing only the filename given a path.

Definition at line 824 of file util.cc.

bool libdap::pathname_ok ( const string &  path,
bool  strict 
)
Note
Using this function does not guarantee that the path is valid, only that the path could be valid. The intent is foil attacks where an exploit is encoded in a string then passed to a library function. This code does not address whether the pathname references a valid resource.
Parameters
pathThe pathname to test
strictApply more restrictive tests (true by default)
Returns
true if the pathname consists of legal characters and is of legal size, false otherwise.

Definition at line 1000 of file util.cc.

string libdap::prune_spaces ( const string &  name)

Removed spaces from the front of a URL and also from the front of the CE. This function assumes that there are no holes in both the URL and the CE. It will remove leading space, but not other spaces.

Parameters
nameThe URL to process
Returns
Returns a new string object that contains the pruned URL.

Definition at line 315 of file util.cc.

Referenced by libdap::Connect::Connect(), and is_keyword().

string libdap::read_multipart_boundary ( FILE *  in,
const string &  boundary 
)

Read the next line of input and test to see if it is a multipart MIME boundary line. If the value of boundary is the default (an empty string) then just test that the line starts with "--". In either case, return the value of boundary just read.

Parameters
boundaryValue of the boundary to look for - optional
inRead from this FILE*
Returns
The value of teh boundary header read
Exceptions
Errorif no boundary was found.

Definition at line 944 of file mime_util.cc.

References get_next_mime_header(), and is_boundary().

Here is the call graph for this function:

string libdap::read_multipart_boundary ( istream &  in,
const string &  boundary 
)

Definition at line 958 of file mime_util.cc.

References get_next_mime_header(), and is_boundary().

Here is the call graph for this function:

void libdap::read_multipart_headers ( FILE *  in,
const string &  content_type,
const ObjectType  object_type,
const string &  cid 
)

Consume the Multipart MIME headers that prefix the DDX in a DataDDX response. The stream pointer is advanced to the start of the DDX. It might seem odd that this function both takes the value of the MPM boundary as a parameter and returns that value as a result, but this code can be used in two different situations. In one case, it is called on a partial document read from stdin and needs to return the value of boundary to the downstream DDX parser so that code can sense the end of the DDX. In the other case, this function is told the value of boundary and tests for it to ensure document correctness.

Parameters
inRead from this stream
content_typeThe expected value of the Content-Type header
object_typeThe expected value of the Content-Description header
cidThe expected value of the Content-Id header - optional.
Returns
The value of the MIME boundary
Exceptions
Errorif the boundary is not found or if any of the expected header values don't match. The optional values are tested only if they are given (the default values are not tested).

Definition at line 992 of file mime_util.cc.

References get_description_type(), get_next_mime_header(), and parse_mime_header().

Here is the call graph for this function:

void libdap::read_multipart_headers ( istream &  in,
const string &  content_type,
const ObjectType  object_type,
const string &  cid 
)

Definition at line 1024 of file mime_util.cc.

References get_description_type(), get_next_mime_header(), and parse_mime_header().

Here is the call graph for this function:

bool libdap::remove_mime_header ( FILE *  in)

Read the input stream in and discard the MIME header. The MIME header is separated from the body of the document by a single blank line. If no MIME header is found, then the input stream is `emptied' and will contain nothing.

Deprecated:
Returns
True if a MIME header is found, false otherwise.

Definition at line 1199 of file mime_util.cc.

References CRLF.

string libdap::remove_quotes ( const string &  s)

Return a new string that is not quoted. This will return a new string regardless of whether the source string is actualy quoted.

Parameters
sThe source string
Returns
A new string without quotes

Definition at line 452 of file util.cc.

References is_quoted().

Here is the call graph for this function:

string libdap::rfc822_date ( const time_t  t)

Given a constant pointer to a time_t, return a RFC 822/1123 style date.

This function returns the RFC 822 date with the exception that the RFC 1123 modification for four-digit years is implemented.

Returns
The RFC 822/1123 style date in a C++ string.
Parameters
tA const time_t pointer.

Definition at line 154 of file mime_util.cc.

Referenced by set_mime_binary(), set_mime_error(), set_mime_html(), set_mime_multipart(), set_mime_not_modified(), and set_mime_text().

void libdap::save_str ( char *  dst,
const char *  src,
const int  line_num 
)

Given a string (const char *src), save it to the temporary variable pointed to by dst. If the string is longer than ID_MAX, generate and error indicating that src was truncated to ID_MAX characters during the copy operation. There are two versions of this function; one calls the version of parser_error() which writes to stderr. The version which accepts the parser_arg *arg argument calls the version of parser_error() which generates and Error object.

Returns
void

Definition at line 155 of file parser-util.cc.

References ID_MAX, long_to_string(), and parse_error().

Here is the call graph for this function:

void libdap::save_str ( string &  dst,
const char *  src,
const int   
)

Definition at line 166 of file parser-util.cc.

void libdap::set_array_using_double ( Array *  dest,
double *  src,
int  src_len 
)

Given an array that holds some sort of numeric data, load it with values using an array of doubles. This function makes several assumptions. First, it assumes the caller really wants to put the doubles into whatever types the array holds! Caveat emptor. Second, it assumes that if the size of source (src) array is different than the destination (dest) the caller has made a mistake. In that case it will throw an Error object.

After setting the values, this method sets the read_p property for dest. Setting read_p tells the serialization methods in libdap that this variable already holds data values and, given that, the serialization code will not try to read the values.

Parameters
destAn Array. The values are written to this array, reusing its storage. Existing values are lost.
srcThe source data.
src_lenThe number of elements in the src array.
Exceptions
ErrorThrown if dest is not a numeric-type array (Byte, ..., Float64) or if the number of elements in src does not match the number is dest.

Definition at line 150 of file util.cc.

References dods_array_c, dods_byte_c, dods_float32_c, dods_float64_c, dods_int16_c, dods_int32_c, dods_str_c, dods_uint16_c, dods_uint32_c, dods_url_c, libdap::BaseType::is_simple_type(), libdap::Vector::length(), long_to_string(), libdap::Vector::set_read_p(), libdap::BaseType::type(), and libdap::Vector::var().

Here is the call graph for this function:

void libdap::set_mime_binary ( std::ostream &  out,
ObjectType  type = unknown_type,
EncodingType  enc = x_plain,
const time_t  last_modified = 0,
const std::string &  protocol = "" 
)
void libdap::set_mime_binary ( FILE *  out,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Write an HTTP 1.0 response header for our binary response document (i.e., the DataDDS object).

Deprecated:
Parameters
outWrite the MIME header to this FILE pointer.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 624 of file mime_util.cc.

References set_mime_binary().

Referenced by libdap::DODSFilter::send_data().

Here is the call graph for this function:

void libdap::set_mime_binary ( ostream &  strm,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Write an HTTP 1.0 response header for our binary response document (i.e., the DataDDS object).

Deprecated:
Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 647 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, DVR, rfc822_date(), and x_plain.

Here is the call graph for this function:

void libdap::set_mime_binary ( ostream &  strm,
ObjectType  type,
EncodingType  enc,
const time_t  last_modified,
const string &  protocol 
)

Write an HTTP 1.0 response header for our binary response document (i.e., the DataDDS object).

Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 691 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, DVR, rfc822_date(), and x_plain.

Referenced by set_mime_binary().

Here is the call graph for this function:

void libdap::set_mime_data_boundary ( ostream &  strm,
const string &  boundary,
const string &  cid,
ObjectType  type,
EncodingType  enc 
)

Definition at line 808 of file mime_util.cc.

References CRLF, and x_plain.

Referenced by libdap::DODSFilter::dataset_constraint_ddx().

void libdap::set_mime_ddx_boundary ( ostream &  strm,
const string &  boundary,
const string &  cid,
ObjectType  type,
EncodingType  enc 
)

Definition at line 795 of file mime_util.cc.

References CRLF, and x_plain.

Referenced by libdap::DODSFilter::dataset_constraint_ddx().

void libdap::set_mime_error ( FILE *  out,
int  code,
const string &  reason,
const string &  version 
)

Generate an HTTP 1.0 response header for an Error object.

Deprecated:
Parameters
outWrite the MIME header to this FILE pointer.
codeHTTP 1.0 response code. Should be 400, ... 500, ...
reasonReason string of the HTTP 1.0 response header.
versionThe version string; denotes the DAP spec and implementation version.

Definition at line 1087 of file mime_util.cc.

References set_mime_error().

Here is the call graph for this function:

void libdap::set_mime_error ( ostream &  strm,
int  code,
const string &  reason,
const string &  version 
)

Generate an HTTP 1.0 response header for an Error object.

Deprecated:
Parameters
strmWrite the MIME header to this stream.
codeHTTP 1.0 response code. Should be 400, ... 500, ...
reasonReason string of the HTTP 1.0 response header.
versionThe version string; denotes the DAP spec and implementation version.

Definition at line 1104 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, DVR, and rfc822_date().

Referenced by set_mime_error().

Here is the call graph for this function:

void libdap::set_mime_html ( std::ostream &  out,
ObjectType  type = unknown_type,
EncodingType  enc = x_plain,
const time_t  last_modified = 0,
const std::string &  protocol = "" 
)
void libdap::set_mime_html ( FILE *  out,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Generate an HTTP 1.0 response header for a html document.

Deprecated:
Parameters
outWrite the MIME header to this FILE pointer.
typeThe type of this this response.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 510 of file mime_util.cc.

References set_mime_html().

Here is the call graph for this function:

void libdap::set_mime_html ( ostream &  strm,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Generate an HTTP 1.0 response header for a html document.

Deprecated:
Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 530 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, dods_error, DVR, rfc822_date(), and x_plain.

Here is the call graph for this function:

void libdap::set_mime_html ( ostream &  strm,
ObjectType  type,
EncodingType  enc,
const time_t  last_modified,
const string &  protocol 
)

Generate an HTTP 1.0 response header for a html document.

Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 575 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, dods_error, DVR, rfc822_date(), and x_plain.

Referenced by set_mime_html().

Here is the call graph for this function:

void libdap::set_mime_multipart ( std::ostream &  out,
const std::string &  boundary,
const std::string &  start,
ObjectType  type = unknown_type,
EncodingType  enc = x_plain,
const time_t  last_modified = 0,
const std::string &  protocol = "",
const std::string &  url = "" 
)
void libdap::set_mime_multipart ( ostream &  strm,
const string &  boundary,
const string &  start,
ObjectType  type,
const string &  version,
EncodingType  enc,
const time_t  last_modified 
)

Definition at line 721 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, DVR, rfc822_date(), and x_plain.

Referenced by libdap::DODSFilter::send_data_ddx().

Here is the call graph for this function:

void libdap::set_mime_multipart ( ostream &  strm,
const string &  boundary,
const string &  start,
ObjectType  type,
EncodingType  enc,
const time_t  last_modified,
const string &  protocol,
const string &  url 
)

Build the initial headers for the DAP4 data response

Definition at line 757 of file mime_util.cc.

References CRLF, DAP_PROTOCOL_VERSION, DVR, rfc822_date(), and x_plain.

Here is the call graph for this function:

void libdap::set_mime_not_modified ( FILE *  out)

Use this function to create a response signaling that the target of a conditional get has not been modified relative to the condition given in the request. This will have to be a date until the servers support ETags.

Deprecated:
Parameters
outWrite the response to this FILE pointer.

Definition at line 1132 of file mime_util.cc.

References set_mime_not_modified().

Referenced by libdap::DODSFilter::send_das(), libdap::DODSFilter::send_data(), libdap::DODSFilter::send_data_ddx(), libdap::DODSFilter::send_dds(), and libdap::DODSFilter::send_ddx().

Here is the call graph for this function:

void libdap::set_mime_not_modified ( ostream &  strm)

Use this function to create a response signaling that the target of a conditional get has not been modified relative to the condition given in the request. This will have to be a date until the servers support ETags.

Deprecated:
Parameters
strmWrite the response to this stream.

Definition at line 1147 of file mime_util.cc.

References CRLF, and rfc822_date().

Referenced by set_mime_not_modified().

Here is the call graph for this function:

void libdap::set_mime_text ( std::ostream &  out,
ObjectType  type = unknown_type,
EncodingType  enc = x_plain,
const time_t  last_modified = 0,
const std::string &  protocol = "" 
)
void libdap::set_mime_text ( FILE *  out,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Generate an HTTP 1.0 response header for a text document. This is used when returning a serialized DAS or DDS object.

Deprecated:
Parameters
outWrite the MIME header to this FILE pointer.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 382 of file mime_util.cc.

References set_mime_text().

Referenced by libdap::DODSFilter::send_das(), libdap::DODSFilter::send_dds(), and libdap::DODSFilter::send_ddx().

Here is the call graph for this function:

void libdap::set_mime_text ( ostream &  strm,
ObjectType  type,
const string &  ver,
EncodingType  enc,
const time_t  last_modified 
)

Generate an HTTP 1.0 response header for a text document. This is used when returning a serialized DAS or DDS object.

Deprecated:
Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 404 of file mime_util.cc.

References CRLF, dap4_ddx, DAP_PROTOCOL_VERSION, dods_error, DVR, rfc822_date(), and x_plain.

Here is the call graph for this function:

void libdap::set_mime_text ( ostream &  strm,
ObjectType  type,
EncodingType  enc,
const time_t  last_modified,
const string &  protocol 
)

Generate an HTTP 1.0 response header for a text document. This is used when returning a serialized DAS or DDS object.

Note
In Hyrax these headers are not used. Instead the front end of the server will build the response headers
Parameters
strmWrite the MIME header to this stream.
typeThe type of this this response. Defaults to application/octet-stream.
verThe version string; denotes the libdap implementation version.
encHow is this response encoded? Can be plain or deflate or the x_... versions of those. Default is x_plain.
last_modifiedThe time to use for the Last-Modified header value. Default is zero which means use the current time.

Definition at line 459 of file mime_util.cc.

References CRLF, dap4_ddx, DAP_PROTOCOL_VERSION, dods_error, DVR, rfc822_date(), and x_plain.

Referenced by set_mime_text().

Here is the call graph for this function:

bool libdap::size_ok ( unsigned int  sz,
unsigned int  nelem 
)
Parameters
nelemNumber of elements.
szsize of each element.
Returns
True if the nelem elements of sz size will overflow an array.

Definition at line 978 of file util.cc.

Referenced by build_btp_args().

template<class T1 , class T2 >
bool libdap::StrCmp ( int  op,
T1  v1,
T2  v2 
)

Compare two string types. This class is one implementation of the comparison policy used by rops.

See also
rops

Definition at line 154 of file Operators.h.

AttrType libdap::String_to_AttrType ( const string &  s)

Definition at line 128 of file AttrTable.cc.

References Attr_byte, Attr_container, Attr_float32, Attr_float64, Attr_int16, Attr_int32, Attr_other_xml, Attr_string, Attr_uint16, Attr_uint32, Attr_unknown, Attr_url, and downcase().

Referenced by libdap::AttrTable::append_attr().

Here is the call graph for this function:

template<class T1 , class UT2 >
bool libdap::SUCmp ( int  op,
T1  v1,
UT2  v2 
)

Compare two numerical types, the first one signed and the second unsigned. If the signed argument is negative, zero is used in the comparison. This class is one implementation of the comparison policy used by rops. This class is here to make writing the Byte::ops, ... member functions simpler. It is not necessary since the functions could twidle the order of arguments to rops and use USCmp. Having this class make Byte:ops, ... simpler to read and write.

See also
Byte::ops
USCmp
Cmp
ops

Definition at line 126 of file Operators.h.

string libdap::systime ( )

Use the system time() function to get the current time. Return a string, removing the trailing newline that time() includes in its response.

Returns
A C++ string with the current system time as formatted by time()

Definition at line 403 of file util.cc.

string libdap::unescape_double_quotes ( string  source)

Rip through a string and replace all the escaped double quotes with regular double quotes.

Parameters
source
Returns
result

Definition at line 487 of file escaping.cc.

string libdap::unescattr ( string  s)

Un-escape special characters, quotes and backslashes from an HDF attribute.

Note: A regex to match one \ must be defined as: Regex foo = "\\\\"; because both C++ strings and GNU's Regex also employ \ as an escape character!

Parameters
sThe escaped attribute.
Returns
The unescaped attribute.

Definition at line 407 of file escaping.cc.

References DBG, and unoctstring().

Here is the call graph for this function:

string libdap::unhexstring ( string  s)

Definition at line 91 of file escaping.cc.

Referenced by www2id().

bool libdap::unique_names ( vector< BaseType * >  l,
const string &  var_name,
const string &  type_name,
string &  msg 
)

Definition at line 338 of file util.cc.

References DBG.

Referenced by libdap::Constructor::check_semantics(), and libdap::DDS::check_semantics().

string libdap::unoctstring ( string  s)

Definition at line 113 of file escaping.cc.

References DBG.

Referenced by unescattr().

template<class UT1 , class T2 >
bool libdap::USCmp ( int  op,
UT1  v1,
T2  v2 
)

Compare two numerical types, the first one unsigned and the second signed. If the signed argument is negative, zero is used in the comparison. This class is one implementation of the comparison policy used by rops.

See also
rops
SUCmp
Cmp

Definition at line 91 of file Operators.h.

uint8_t* libdap::WriteVarint64ToArrayInline ( uint64_t  value,
uint8_t *  target 
)
inline
string libdap::www2id ( const string &  in,
const string &  escape,
const string &  except 
)

Given a string that contains WWW escape sequences, translate those escape sequences back into the ASCII characters they represent. Return the modified string.

-Places in the dap code where www2id() is called:

  1. Array::append_dim() the name is decoded before it is added
  2. AttrTable::set_name(), AttrTable::append_attr(), AttrTable::append_container(), AttrTable::del_attr(), AttrTable::add_container_alias(), AttrTable::add_value_alias() names are decoded before that are set/used.
  3. BaseType::set_name() Names are decoded before they are set
  4. When the constraint expression parser looks for a variable, the name is first decoded.
  5. DAS::DAS() Named attribute containers are decoded
  6. DDS::var() When a DDS searches for a variable, the name is first decoded.
  7. Grid::var(), Sequence::var(), Structure::var() Variable names are decoded.

-In the server code:

  1. ResponseBuilder::initialize() The dataset name is decoded except that %20 is not removed.
  2. ResponseBuilder::set_ce() The CE is decoded, except for spaces (%20).
  3. ResponseBuilder::set_dataset_name() same logic as the first case.
  4. The ResponseBuilder methods supersede methods with the same names from DODSFilter, which is still in the code although deprecated.
Parameters
inThe string to modify.
escapeThe character used to signal the beginning of an escape sequence. default: "%"
exceptIf there are some escape codes that should not be removed by this call (e.g., you might not want to remove spaces, %20) use this parameter to specify those codes. The function will then transform all escapes except those given. For example, to suppress translation of both spaces and the ampersand, pass "%20%26" for 'except'. default: ""
Returns
The modified string.

Definition at line 220 of file escaping.cc.

References unhexstring().

Referenced by libdap::AttrTable::add_container_alias(), libdap::AttrTable::add_value_alias(), libdap::AttrTable::append_attr(), libdap::AttrTable::append_container(), libdap::Array::append_dim(), libdap::AttrTable::del_attr(), libdap::DODSFilter::initialize(), libdap::Keywords::parse_keywords(), libdap::Array::prepend_dim(), libdap::DODSFilter::set_ce(), libdap::DODSFilter::set_dataset_name(), libdap::BaseType::set_name(), libdap::AttrTable::set_name(), libdap::Constructor::var(), libdap::Grid::var(), libdap::Vector::var(), and libdap::DDS::var().

Here is the call graph for this function:

string libdap::xml2id ( string  in)

Given a string that contains XML escape sequences (i.e., entities), translate those back into ASCII characters. Return the modified string.

Parameters
inThe string to modify.
Returns
The modified string.

Definition at line 322 of file escaping.cc.

Variable Documentation

int libdap::dods_keep_temps = 0

Definition at line 77 of file HTTPConnect.cc.

Referenced by main(), and libdap::HTTPResponse::~HTTPResponse().

const string libdap::double_quote = "\""

Definition at line 1038 of file AttrTable.cc.

const size_t libdap::line_length = 1024

Definition at line 821 of file mime_util.cc.

Referenced by get_next_mime_header(), and parse_mime_header().

const unsigned int libdap::max_str_len = DODS_USHRT_MAX - 1
const unsigned int libdap::max_url_len = 255

Definition at line 57 of file Url.h.

const string libdap::usage
Initial value:
=
"Usage: <handler name> -o <response> -u <url> [options ...] [data set]\n\
\n\
options: -o <response>: DAS, DDS, DataDDS, DDX, BLOB or Version (Required)\n\
-u <url>: The complete URL minus the CE (required for DDX)\n\
-c: Compress the response using the deflate algorithm.\n\
-e <expr>: When returning a DataDDS, use <expr> as the constraint.\n\
-v <version>: Use <version> as the version number\n\
-d <dir>: Look for ancillary file in <dir> (deprecated).\n\
-f <file>: Look for ancillary data in <file> (deprecated).\n\
-r <dir>: Use <dir> as a cache directory\n\
-l <time>: Conditional request; if data source is unchanged since\n\
<time>, return an HTTP 304 response.\n\
-t <seconds>: Timeout the handler after <seconds>.\n\
-h: This message."

Definition at line 84 of file DODSFilter.cc.

Referenced by main().

int libdap::www_trace = 0

Definition at line 74 of file HTTPConnect.cc.

Referenced by main().