OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESUtil Class Reference

#include <BESUtil.h>

Collaboration diagram for BESUtil:
Collaboration graph

Classes

struct  url
 

Static Public Member Functions

MIME utility functions

These functions are used to create the MIME headers for a message from a server to a client.

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

See Also
libdap::escaping.cc
libdap::mime_util.cc
static void set_mime_text (ostream &strm)
 Generate an HTTP 1.0 response header for a text document. More...
 
static void set_mime_html (ostream &strm)
 Generate an HTTP 1.0 response header for a html document. More...
 
static string www2id (const string &in, const string &escape="%", const string &except="")
 This functions are used to unescape hex characters from strings. More...
 
static string unhexstring (string s)
 
static string lowercase (const string &s)
 Convert a string to all lower case. More...
 
static string unescape (const string &s)
 Unescape characters with backslash before them. More...
 
static void check_path (const string &path, const string &root, bool follow_sym_links)
 Check if the specified path is valid. More...
 
static char * fastpidconverter (char *buf, int base)
 convert pid and place in provided buffer More...
 
static char * fastpidconverter (long val, char *buf, int base)
 
static void removeLeadingAndTrailingBlanks (string &key)
 remove leading and trailing blanks from a string More...
 
static string id2xml (string in, const string &not_allowed="><&'\"")
 convert characters not allowed in xml to escaped characters More...
 
static string xml2id (string in)
 unescape xml escaped characters More...
 
static void explode (char delim, const string &str, list< string > &values)
 explode a string into an array given a delimiter More...
 
static string implode (const list< string > &values, char delim)
 implode a list of values into a single string delimited by delim More...
 
static void url_explode (const string &url_str, BESUtil::url &url_parts)
 Given a url, break the url into its different parts. More...
 
static string url_create (BESUtil::url &url_parts)
 

Detailed Description

Definition at line 44 of file BESUtil.h.

Member Function Documentation

void BESUtil::check_path ( const string &  path,
const string &  root,
bool  follow_sym_links 
)
static

Check if the specified path is valid.

Checks to see if the specified path is a valid path or not. The root directory specified is assumed to be valid, so we don't check that part of the path. The path parameter is relative to the root directory.

If follow_sym_links is false, then if any part of the specified path is a symbolic link, this function will return false, set the passed has_sym_link parameter. No error message is specified.

If there is a problem accessing the specified path then the error string will be filled with whatever system error message is provided.

param path path to check param root root directory path, assumed to be valid param follow_sym_links specifies whether allowed to follow symbolic links throws BESForbiddenError if the user is not allowed to traverse the path throws BESNotFoundError if there is a problem accessing the path or the path does not exist.

Definition at line 249 of file BESUtil.cc.

Referenced by BESContainerStorageVolatile::add_container(), and BESCatalogDirectory::show_catalog().

void BESUtil::explode ( char  delim,
const string &  str,
list< string > &  values 
)
static

explode a string into an array given a delimiter

Given a string of values separated by a delimiter, break out the values and store in the list.

Quoted values must be escaped.

If values contain the delimiter then the value must be wrapped in quotes.

Parameters
delimdelimiter separating the values
strthe original string
valueslist of the delimited values returned to caller
Exceptions
BESInternalErrorif missing ending quote or delimiter does not follow end quote

Definition at line 513 of file BESUtil.cc.

Referenced by BESCatalogUtils::BESCatalogUtils().

char * BESUtil::fastpidconverter ( char *  buf,
int  base 
)
static

convert pid and place in provided buffer

Definition at line 383 of file BESUtil.cc.

Referenced by BESProcIdResponseHandler::execute(), and fastpidconverter().

char * BESUtil::fastpidconverter ( long  val,
char *  buf,
int  base 
)
static

Definition at line 389 of file BESUtil.cc.

References fastpidconverter().

Here is the call graph for this function:

string BESUtil::id2xml ( string  in,
const string &  not_allowed = "><&'\"" 
)
static

convert characters not allowed in xml to escaped characters

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 454 of file BESUtil.cc.

string BESUtil::implode ( const list< string > &  values,
char  delim 
)
static

implode a list of values into a single string delimited by delim

Given a list of string values create a single string of values delimited by delim.

If the delimiter exists in a value in the list then that value must be enclosed in quotes

Parameters
valueslist of string values to implode
delimthe delimiter to use in creating the resulting string
Returns
the delim delimited string of values

Definition at line 607 of file BESUtil.cc.

Referenced by DapRequestHandler::dap_build_help().

string BESUtil::lowercase ( const string &  s)
static
void BESUtil::removeLeadingAndTrailingBlanks ( string &  key)
static

remove leading and trailing blanks from a string

Definition at line 417 of file BESUtil.cc.

Referenced by BESXMLUtils::GetChild(), BESXMLUtils::GetNodeInfo(), and BESXMLUtils::GetProps().

void BESUtil::set_mime_html ( ostream &  strm)
static

Generate an HTTP 1.0 response header for a html document.

Parameters
strmWrite the MIME header to this ostream.

Definition at line 85 of file BESUtil.cc.

References CRLF, and PACKAGE_STRING.

Referenced by BESHTMLInfo::add_data(), BESBasicHttpTransmitter::send_html(), and BESBasicTransmitter::send_html().

void BESUtil::set_mime_text ( ostream &  strm)
static

Generate an HTTP 1.0 response header for a text document.

Parameters
strmWrite the MIME header to this ostream.

Definition at line 65 of file BESUtil.cc.

References CRLF, and PACKAGE_STRING.

Referenced by BESTextInfo::add_data(), BESBasicHttpTransmitter::send_text(), and BESBasicTransmitter::send_text().

string BESUtil::unescape ( const string &  s)
static

Unescape characters with backslash before them.

Definition at line 202 of file BESUtil.cc.

string BESUtil::unhexstring ( string  s)
static

Definition at line 160 of file BESUtil.cc.

Referenced by www2id().

string BESUtil::url_create ( BESUtil::url url_parts)
static
void BESUtil::url_explode ( const string &  url_str,
BESUtil::url url_parts 
)
static

Given a url, break the url into its different parts.

The different parts are the protocol, the domain name, a username if specified, a password if specified, a port if specified, and a path if specified.

struct url { string protocol ; string domain ; string uname ; string psswd ; string port ; string path ; } ;

Parameters
urlstring representation of the URL

Definition at line 651 of file BESUtil.cc.

References BESUtil::url::domain, BESUtil::url::path, BESUtil::url::port, BESUtil::url::protocol, BESUtil::url::psswd, and BESUtil::url::uname.

string BESUtil::www2id ( const string &  in,
const string &  escape = "%",
const string &  except = "" 
)
static

This functions are used to unescape hex characters from strings.

Definition at line 174 of file BESUtil.cc.

References unhexstring().

Here is the call graph for this function:

string BESUtil::xml2id ( string  in)
static

unescape xml escaped characters

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 473 of file BESUtil.cc.

Referenced by BESXMLUtils::GetNodeInfo(), and BESXMLUtils::GetProps().


The documentation for this class was generated from the following files: