XrdOucGatherConf Class Reference

#include <XrdOucGatherConf.hh>

Collaboration diagram for XrdOucGatherConf:

Public Types
enum	Level {   full_lines = 0 ,   trim_lines ,   only_body ,   trim_body }

Public Member Functions
	XrdOucGatherConf (const char **&want, XrdSysError *errP=0)
	XrdOucGatherConf (const char *want, XrdSysError *errP=0)
	~XrdOucGatherConf ()
void	EchoLine ()
void	EchoOrder (bool doBefore)
int	Gather (const char *cfname, Level lvl, const char *parms=0)
char *	GetLine ()
char *	GetToken (char **rest=0, int lowcase=0)
bool	hasData ()
const char *	LastLine ()
void	MsgE (const char *txt1, const char *txt2=0, const char *txt3=0, const char *txt4=0, const char *txt5=0, const char *txt6=0)
void	MsgfE (const char *fmt,...)
void	MsgfW (const char *fmt,...)
void	MsgW (const char *txt1, const char *txt2=0, const char *txt3=0, const char *txt4=0, const char *txt5=0, const char *txt6=0)
void	RetToken ()
void	Tabs (int x=1)
bool	useData (const char *data)

Detailed Description

Definition at line 35 of file XrdOucGatherConf.hh.

Member Enumeration Documentation

Level

enum XrdOucGatherConf::Level

Gather information from a config file.

Note

You must call this method or a successful useData() before calling any Get/Ret methods.

Parameters

cfname	Path to the configuration file.
lvl	Indicates how the gathered directives are to be saved: full_lines - the full directive line, including newline. trim_lines - Like full_lines but the prefix (i.e.characters the dot) are discarded. Useful only when gathering a single prefix. only_body Saves the body of each wanted directive as a space separated string blob. trim_body Like only_body but also includes the directive characters after the dot. Useful only when gathering a single prefix.
parms	Optional pointer to initial configuration parameters. These may be present for plugins.

Returns

> 0 Success, configuration data has been gathered.

= 0 Nothing was gathered.

< 0 Problem reading the config file, returned value is -errno.

Enumerator
full_lines	Complete lines.
trim_lines	Prefix trimmed lines.
only_body	Only directive bodies as a string blob.
trim_body	Prefix trimmed lines as a string blob.

Definition at line 84 of file XrdOucGatherConf.hh.

            {full_lines = 0,  
             trim_lines,      
             only_body,       
             trim_body        
            };

Constructor & Destructor Documentation

XrdOucGatherConf() [1/2]

XrdOucGatherConf::XrdOucGatherConf	(	const char *	want,
		XrdSysError *	errP = 0
	)

Constructor #1

Note

This object collects relevant configuration directives ready to be processed by the Get/Ret methods. All if-fi, set, and variable substitutions are performed.

Parameters

want	A space separated list of directive prefixes (i.e. end with a dot) and actual directives that should be gathered.
errP	Optional pointer to an error object. When supplied, gathered lines are echoed. Additionally, error messages are issued. supplied XrdSysError object or using std::cerr using a

Definition at line 70 of file XrdOucGatherConf.cc.

                 : gcP(new XrdOucGatherConfData(errP))
{
   XrdOucString wlist(want), wtoken;
   int wlen, wPos = 0;
  
   while((wPos = wlist.tokenize(wtoken, wPos, ' ')) != -1)
        {wlen = (wtoken.endswith('.') ? wtoken.length() : 0);
         gcP->Match = new XrdOucTList(wtoken.c_str(), wlen, gcP->Match);
        }
}

References XrdOucString::c_str(), XrdOucString::endswith(), XrdOucString::length(), and XrdOucGatherConfData::Match.

Here is the call graph for this function:

XrdOucGatherConf() [2/2]

XrdOucGatherConf::XrdOucGatherConf	(	const char **&	want,
		XrdSysError *	errP = 0
	)

Constructor #2

Note

This is the same as constructor #1 but uses vector to hold the wanted directives or directive prefixes.

Parameters

want	A vector of strings of directive prefixes (i.e. end with a dot) and actual directives that should be gathered. The end of the vector is indicated by a nil pointer (e,g, const char *want[] = {"x.c", "y.", 0};
errP	Optional pointer to an error object. When supplied, gathered lines are echoed. Additionally, error messages are issued. supplied XrdSysError object or using std::cerr using a

Definition at line 86 of file XrdOucGatherConf.cc.

                 : gcP(new XrdOucGatherConfData(errP))
{
   int n, i = 0;
 
   while(want[i])
       {if ((n = strlen(want[i])))
           {if (*(want[i]+(n-1)) != '.') n = 0;
            gcP->Match = new XrdOucTList(want[i], n, gcP->Match);
           }
       }
}

References XrdOucGatherConfData::Match.

~XrdOucGatherConf()

XrdOucGatherConf::~XrdOucGatherConf

(

)

Definition at line 103 of file XrdOucGatherConf.cc.

{
   XrdOucTList *tP;
 
   while((tP = gcP->Match))
        {gcP->Match = tP->next;
         delete tP;
        }
 
   if (gcP->gBuff)     free(gcP->gBuff);
 
   delete gcP;
}

References XrdOucGatherConfData::gBuff, XrdOucGatherConfData::Match, and XrdOucTList::next.

Member Function Documentation

EchoLine()

void XrdOucGatherConf::EchoLine

(

)

Echo the last line retrieved using GetLine() using proper framing.

@notes 1) An exception is thrown if a XrdSysError object was not supplied.

Definition at line 121 of file XrdOucGatherConf.cc.

{
 
// Make sure we can actually display anything
//
   if (!(gcP->eDest))
      throw std::invalid_argument("XrdSysError object not supplied!");
 
// Echo only when we have something to echo
//
   if (gcP->lline.length()) gcP->eDest->Say("=====> ", gcP->lline.c_str());
}

References XrdOucString::c_str(), XrdOucGatherConfData::eDest, XrdOucString::length(), XrdOucGatherConfData::lline, and XrdSysError::Say().

Here is the call graph for this function:

EchoOrder()

void XrdOucGatherConf::EchoOrder

(

bool

doBefore

)

Specift the order in which the last line is displayed vs a message.

@paramn doBefore - When true, the line is displayed before the message. When false, it is displayed after the message (default).

@notes 1) This call is only relevant to calls to MsgE(), MsgW(), MsgfE(), and MsgfW.

Definition at line 138 of file XrdOucGatherConf.cc.

{
   gcP->echobfr = doBefore;
}

References XrdOucGatherConfData::echobfr.

Gather()

int XrdOucGatherConf::Gather	(	const char *	cfname,
		Level	lvl,
		const char *	parms = 0
	)

Definition at line 147 of file XrdOucGatherConf.cc.

{
   XrdOucEnv myEnv;
   XrdOucStream Config(gcP->eDest, getenv("XRDINSTANCE"), &myEnv, "=====> ");
   XrdOucTList *tP;
   XrdOucString theGrab;
   char *var, drctv[64], body[4096];
   int cfgFD, n, rc;
   bool trim = false, addKey = true;
 
// Make sure we have something to compare
//
   if (!(gcP->Match)) return 0;
 
// Reset the buffer if it has been set
//
   if (gcP->gBuff)
      {free(gcP->gBuff);
       gcP->gBuff = 0;
       gcP->Tokenizer.Attach(0);
      }
 
// Open the config file
//
   if ( (cfgFD = open(cfname, O_RDONLY, 0)) < 0)
      {rc = errno;
       if (gcP->eDest) gcP->eDest->Emsg("Gcf", rc, "open config file", cfname);
       return -rc;
      }
 
// Attach the file to our stream object and size the grab buffer
//
   Config.Attach(cfgFD, 4096);
   theGrab.resize(4096);
   if (parms && *parms) theGrab = parms;
 
// Setup for processing
//
   switch(lvl)
         {case full_lines: *drctv = '\n'; trim = false; addKey = true;  break;
          case trim_lines: *drctv = '\n'; trim = true;  addKey = true;  break;
          case only_body:  *drctv = ' ';  trim = false; addKey = false; break;
          case trim_body:  *drctv = ' ';  trim = true;  addKey = true;  break;
          default: break;  return 0;    // Should never happen
                           break;
         }
 
// Process the config file
//
   while((var = Config.GetMyFirstWord()))
        {tP = gcP->Match;
         while(tP && ((tP->val && strncmp(var, tP->text, tP->val)) ||
                     (!tP->val && strcmp( var, tP->text)))) tP = tP->next;
 
         if (tP)
            {if (addKey)
                {if (trim)
                    {char *dot = index(var, '.');
                     if (dot && *(dot+1)) var = dot+1;
                    }
                 int n =  snprintf(drctv+1, sizeof(drctv)-1, "%s ", var);
                 if (n >= (int)sizeof(drctv)-1)
                    {if (gcP->eDest) gcP->eDest->Emsg("Gcf", E2BIG, "handle", var);
                     return -E2BIG;
                    }
                } else drctv[1] = 0;
 
              if (!Config.GetRest(body, sizeof(body)))
                 {if (gcP->eDest) gcP->eDest->Emsg("Gcf", E2BIG, "handle arguments");
                  return -E2BIG;
                 }
 
              if (*body || addKey)
                 {theGrab += drctv;
                  theGrab += body;
                 }
            }
        }
 
// Now check if any errors occurred during file i/o
//
   if ((rc = Config.LastError()))
      {if (gcP->eDest) gcP->eDest->Emsg("Gcf", rc, "read config file", cfname);
       return (rc < 0 ? rc : -rc);
      }
 
 
// Copy the grab to a modifiable buffer.
//
   if ((n = theGrab.length()) <= 1) n = 0;
      else {gcP->gBuff = (char *)malloc(n);
            strcpy(gcP->gBuff, theGrab.c_str()+1); // skip 1st byte but add null
            gcP->Tokenizer.Attach(gcP->gBuff);
            n--;
           }
   return n;
}

References XrdOucTokenizer::Attach(), XrdOucString::c_str(), XrdCms::Config, XrdOucGatherConfData::eDest, XrdSysError::Emsg(), full_lines, XrdOucGatherConfData::gBuff, XrdOucString::length(), XrdOucGatherConfData::Match, XrdOucTList::next, only_body, open, XrdOucString::resize(), XrdOucTList::text, XrdOucGatherConfData::Tokenizer, trim(), trim_body, and trim_lines.

Referenced by XrdOssStats::FileSystem::Config(), XrdHttpCorsHandler::Configure(), and XrdOfsgetPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLine()

char * XrdOucGatherConf::GetLine

(

)

Sequence to the next line in the configuration file.

Returns

Pointer to the next line that will be tokenized or NIL if there are no more lines left.

@notes 1) You must call GetLine() before calling GetToken().

Definition at line 249 of file XrdOucGatherConf.cc.

{
   char* theLine = gcP->Tokenizer.GetLine();
 
   while(theLine && *theLine == 0) theLine = gcP->Tokenizer.GetLine();
 
   if (!theLine) gcP->lline = "";
      else       gcP->lline = theLine;
 
   return theLine;
}

References XrdOucTokenizer::GetLine(), XrdOucGatherConfData::lline, and XrdOucGatherConfData::Tokenizer.

Referenced by XrdOssStats::FileSystem::Config(), XrdHttpCorsHandler::Configure(), and XrdOfsgetPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

GetToken()

char * XrdOucGatherConf::GetToken	(	char **	rest = 0,
		int	lowcase = 0
	)

Get the next blank-delimited token in the record returned by Getline().

Parameters

rest	- Address of a char pointer. When specified, a pointer to the first non-blank character after the returned token.
lowcasee	- When 1, all characters are converted to lower case. When 0, the default, the characters are not changed.

Returns

A pointer to the next token. If the end of the line has been reached, a NIL pointer is returned.

Definition at line 265 of file XrdOucGatherConf.cc.

{
   return gcP->Tokenizer.GetToken(rest, lowcase);
}

References XrdOucTokenizer::GetToken(), and XrdOucGatherConfData::Tokenizer.

Referenced by XrdOssStats::FileSystem::Config(), XrdHttpCorsHandler::Configure(), and XrdOfsgetPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

hasData()

bool XrdOucGatherConf::hasData

(

)

Check if data is present.

Returns

True if data is present and false, otherwise.

Definition at line 274 of file XrdOucGatherConf.cc.

{
   return gcP->gBuff != 0 && *(gcP->gBuff) != 0;
}

References XrdOucGatherConfData::gBuff.

LastLine()

const char * XrdOucGatherConf::LastLine

(

)

Get the last line.

Returns

pointer to the last line. If no last line exists a null string is returned. The pointer is valid until GetLine() is called.

Definition at line 283 of file XrdOucGatherConf.cc.

{
   if (gcP->lline.capacity() == 0) return "";
   return gcP->lline.c_str();  
}

References XrdOucString::c_str(), XrdOucString::capacity(), and XrdOucGatherConfData::lline.

Here is the call graph for this function:

MsgE()

void XrdOucGatherConf::MsgE	(	const char *	txt1,
		const char *	txt2 = 0,
		const char *	txt3 = 0,
		const char *	txt4 = 0,
		const char *	txt5 = 0,
		const char *	txt6 = 0
	)

Display a space delimited error/warning message.

Parameters

txt1,txt2,txt3,txt4,txt5,txt6

the message components formatted as "txt1 [txt2] [txt3] [txt4] [txt5] [txt6]"

@notes 1) This methods throws an exception if a XrdSysError object was not passed to the constructor. 2) The last line returned by this object will be displayed either before or after the message (see EchoOrder()). 3) Messages are truncated at 2048 bytes. 4} Use MsgE for errors. The text is prefixed by "Config mistake:" Use MsgW for warnings. The text is prefixed by "Config warning:"

Definition at line 293 of file XrdOucGatherConf.cc.

{
  const char* mVec[7];
  int n = 0;
 
            mVec[n++] = "Config mistake:";
  if (txt1) mVec[n++] = txt1;
  if (txt2) mVec[n++] = txt2;
  if (txt3) mVec[n++] = txt3;
  if (txt4) mVec[n++] = txt4;
  if (txt5) mVec[n++] = txt5;
  if (txt6) mVec[n++] = txt6;
 
  MsgX(mVec, n+1);
}

MsgfE()

void XrdOucGatherConf::MsgfE	(	const char *	fmt,
			...
	)

Display a formated error/warning message using variable args (i.e. vprintf).

Parameters

fmt	the message formatting template (i.e. printf format).
...	the arguments that should be used with the template. The formatted message is truncated at 2048 bytes.

@notes 1) This methods throws an exception if a XrdSysError object was not passed to the constructor. 2) The last line returned by this object will be displayed either before or after the message (see EchoOrder()). 3) Messages are truncated at 2048 bytes. 4} Use MsgfE for errors. The text is prefixed by "Config mistake:" Use MsgfW for warnings. The text is prefixed by "Config warning:"

Definition at line 362 of file XrdOucGatherConf.cc.

{
   char buffer[2048];
   va_list  args;
   va_start (args, fmt);
 
// Format the message
//
   vsnprintf(buffer, sizeof(buffer), fmt, args);
 
// Go print the message
//
   MsgfX("Config mistake: ", buffer);
}

MsgfW()

void XrdOucGatherConf::MsgfW	(	const char *	fmt,
			...
	)

Definition at line 381 of file XrdOucGatherConf.cc.

{
   char buffer[2048];
   va_list  args;
   va_start (args, fmt);
 
// Format the message
//
   vsnprintf(buffer, sizeof(buffer), fmt, args);
 
// Go print the message
//
   MsgfX("Config warning: ", buffer);
}

MsgW()

void XrdOucGatherConf::MsgW	(	const char *	txt1,
		const char *	txt2 = 0,
		const char *	txt3 = 0,
		const char *	txt4 = 0,
		const char *	txt5 = 0,
		const char *	txt6 = 0
	)

Definition at line 314 of file XrdOucGatherConf.cc.

{
  const char* mVec[7];
  int n = 0;
 
            mVec[n++] = "Config warning:";
  if (txt1) mVec[n++] = txt1;
  if (txt2) mVec[n++] = txt2;
  if (txt3) mVec[n++] = txt3;
  if (txt4) mVec[n++] = txt4;
  if (txt5) mVec[n++] = txt5;
  if (txt6) mVec[n++] = txt6;
 
  MsgX(mVec, n+1);
}

RetToken()

void XrdOucGatherConf::RetToken

(

)

Backups the token scanner just prior to the last returned token.

@notes 1) Only one backup is allowed. Calling RetToken() more than once without an intervening GetToken() call results in undefined behaviour. 2) This call is useful for backing up due to an overscan.

Definition at line 419 of file XrdOucGatherConf.cc.

{
   return gcP->Tokenizer.RetToken();
}

References XrdOucTokenizer::RetToken(), and XrdOucGatherConfData::Tokenizer.

Here is the call graph for this function:

Tabs()

void XrdOucGatherConf::Tabs

(

int

x = 1

)

Specify how tag characters should be handled.

Parameters

x	- When 0, tabs are converted to spaces. When 1, tabs are untouched (the default).

Definition at line 428 of file XrdOucGatherConf.cc.

{
   gcP->Tokenizer.Tabs(x);
}

References XrdOucTokenizer::Tabs(), and XrdOucGatherConfData::Tokenizer.

Here is the call graph for this function:

useData()

bool XrdOucGatherConf::useData

(

const char *

data

)

Attempt to use pre-existing data.

Parameters

data	- Pointer to null terminated pre-existing data.

Returns

False if the pointer is nil or points to a null string; true o/w.

Definition at line 437 of file XrdOucGatherConf.cc.

{
   if (!data || *data == 0) return false;
 
   if (gcP->gBuff) free(gcP->gBuff);
   gcP->gBuff = strdup(data);
   gcP->Tokenizer.Attach(gcP->gBuff);
   return true;
}

References XrdOucTokenizer::Attach(), XrdOucGatherConfData::gBuff, and XrdOucGatherConfData::Tokenizer.

Referenced by XrdOfsgetPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• XrdOucGatherConf.hh
• XrdOucGatherConf.cc