XrdOssArcCompose Class Reference

#include <XrdOssArcCompose.hh>

Collaboration diagram for XrdOssArcCompose:

Public Types
enum	pType {   isARC =0 ,   isBKP }

Public Member Functions
	XrdOssArcCompose (const char *path, XrdOucEnv *env, int &retc, bool isW=true, bool optfn=false)
	~XrdOssArcCompose ()
int	ArcMember (char *buff, int blen)
int	ArcPath (char *buff, int blen, bool addafn=false)

Static Public Member Functions
static std::string	Dir2DSN (const char *dir)
static std::string	DSN2Dir (const char *dsn)
static bool	isArcFile (const char *path)
static bool	isArcPath (const char *path)
static bool	isBkpPath (const char *path)
static bool	isMine (const char *path)
static int	Stat (const char *Scope, const char *Name, struct stat *Stat)

Public Attributes
std::string	arName
pType	didType
std::string	dsName
std::string	dsScope
std::string	flName
std::string	flScope

Detailed Description

Definition at line 39 of file XrdOssArcCompose.hh.

Member Enumeration Documentation

pType

enum XrdOssArcCompose::pType

Enumerator
isARC
isBKP

Definition at line 50 of file XrdOssArcCompose.hh.

{isARC=0, isBKP};

Constructor & Destructor Documentation

XrdOssArcCompose()

XrdOssArcCompose::XrdOssArcCompose	(	const char *	path,
		XrdOucEnv *	env,
		int &	retc,
		bool	isW = true,
		bool	optfn = false
	)

Definition at line 73 of file XrdOssArcCompose.cc.

{
   TraceInfo("Compose",0);
 
// By conventioon, the env["ossarc.fn"] holds the file did and the path is
// the dataset did both represented as paths. We only support two path
// prefixes: 1) the archive prefix, and 2) the backup prefix. These are
// removed but we track which one it was as they have different semantics.
//
 
// Determine the path type being referenced
//
        if (!strncmp(Config.arcvPathLFN, path, Config.arcvPathLEN))
           {didType = isARC;
            path += Config.arcvPathLEN;
           }
   else if (!strncmp(Config.arcvPathLFN, path, Config.arcvPathLEN-1)
        &&   strlen(path) < (size_t)Config.arcvPathLEN)
           {didType = isARC;
            path += Config.arcvPathLEN-1;
           }
   else if (!strncmp(Config.bkupPathLFN, path, Config.bkupPathLEN))
           {didType = isBKP;
            path += Config.bkupPathLEN;
            optfn = false;  // ossarc.fn is required for /backup
           }
   else {rc = EDOM; return;}  // This will forward the request
 
// Get the dataset name and if there is no ENV, we can return as this is
// only a construction for datasets.
//
   if ((rc = getDSN(path))) return;
   if (!env) {rc = 0; return;}
 
// Prepare for full construction (note: we know we have an env pointer)
//
   const char* theFN = 0;
   bool fl2arc = false;
   bool fscpDS = false;
 
// This is our domain and that domain is strictly read/only
//
   if (isW) {rc = EROFS; return;}
 
// Make sure we have an env file name to work with. This must come from the CGI
// if /backup and from either the CGI path for /archive. We support optional
// path specification to allow recursive copies of all dataset archive files.
// Noe that we ignore the CGI if specified via the path.
//
   if (didType == isARC && isArcFile(path))
      {const char* fn = rindex(path, '/');
       if (fn && fn != path)
          {theFN = fn + 1;
           dsName.erase(dsName.find_last_of("/"));
          }
      }
 
   if (!theFN && !(theFN = env->Get("ossarc.fn")))
      {if (optfn) rc = 0;
          else {rc = EINVAL;
                ecMsg.Msg("Compose","CGI ossarc.fn=<target_fname> not specified");
               }
       return;
      }
 
// If the archive if the target then env filename may refer to a specific
// archive or be a file that is to be used to determine the target archive.
// Otherwise, it should refer to a single file backups so an arc file suffix
// is disallowed as it makes to sense.
//
   if (isArcFile(theFN))
      {if (didType == isBKP)
          {rc = EINVAL;
           ecMsg.Msg("Compose","Backup filename cannot refer to an archive");
           return;
          }
       arName = theFN;
      } else fl2arc = true;
 
 
// Pick apart the filename if this is a backup reference or an indirect
// archive reference as we will need the scope and file.
//
   if ((didType == isBKP) || fl2arc)
      {const char* colon = index(theFN, ':');
       if (!colon)
          {flScope = dsScope;
           flName  = theFN;
           fscpDS  = true;  // For tracing purposes
          } else {
           if (*theFN == ':')
              {rc = EINVAL;
               ecMsg.Msg("Compose","File scope not specified though implied");
               return;
              }
           flScope.assign(theFN, colon - theFN);
           flName = colon+1;
          }
      if ((int)flName.length() < minLenDSN)
         {rc = EINVAL;
          ecMsg.Msg("Compose", "Dataset name is too short");
          return;
         }
      }
 
// Do some debugging
//
   const char* atName[] = {"Archive", "Backup"};
 
   DEBUG("Type="<<atName[didType]<<" f2a="<<fl2arc<<" fscpDF="<<fscpDS
        <<" dsScope="<<dsScope<<" dsName="<<dsName
        <<" flScope="<<flScope<<" flName="<<flName<<" arName="<<arName);
 
// Set the archive name if we need to
//
   rc = (fl2arc ? SetarName() : 0);
}

References XrdOssArcConfig::arcvPathLEN, XrdOssArcConfig::arcvPathLFN, XrdOssArcConfig::bkupPathLEN, XrdOssArcConfig::bkupPathLFN, XrdOssArcGlobals::Config, DEBUG, XrdOssArcGlobals::ecMsg, XrdOucEnv::Get(), XrdOucECMsg::Msg(), and TraceInfo.

Here is the call graph for this function:

~XrdOssArcCompose()

XrdOssArcCompose::~XrdOssArcCompose ( )

inline

Definition at line 73 of file XrdOssArcCompose.hh.

{}

Member Function Documentation

ArcMember()

int XrdOssArcCompose::ArcMember	(	char *	buff,
		int	blen
	)

Definition at line 196 of file XrdOssArcCompose.cc.

{
   if (snprintf(buff, blen, "%s:%s", flScope.c_str(), flName.c_str()) >= blen)
      {std::string fn = flScope + ":" + flName;
       Elog.Emsg("Compose", ENAMETOOLONG, "generate archive member name "
                            "in dataset", dsName.c_str());
       ecMsg.Msg("Compose", "Archive member name", fn.c_str(), "is too long");
       return ENAMETOOLONG;
      }
    return 0;
}

References XrdOssArcGlobals::ecMsg, XrdOssArcGlobals::Elog, XrdSysError::Emsg(), and XrdOucECMsg::Msg().

Referenced by XrdOssArcFile::Open().

Here is the call graph for this function:

Here is the caller graph for this function:

ArcPath()

int XrdOssArcCompose::ArcPath	(	char *	buff,
		int	blen,
		bool	addafn = false
	)

Definition at line 212 of file XrdOssArcCompose.cc.

{
   int n;
 
// The path to the archive is <tape_path>/<scope>/<dataset_did>/<arc_fname>
//
   if (addafn) n = snprintf(buff, blen, "%s/%s/%s/%s", Config.tapePath,
                            dsScope.c_str(), dsName.c_str(), arName.c_str());
      else n = snprintf(buff, blen, "%s/%s/%s", Config.tapePath,
                                    dsScope.c_str(), dsName.c_str());
 
// Verify that we did not truncate the path
//
   if (n >= blen)
      {std::string dsn = dsScope + ":" + dsName;
       Elog.Emsg("Compose", ENAMETOOLONG, "generate archive path for dataset",
                                          dsn.c_str());
       return ENAMETOOLONG;
      }
 
// All done
//
   return 0;
}

References XrdOssArcGlobals::Config, XrdOssArcGlobals::Elog, XrdSysError::Emsg(), and XrdOssArcConfig::tapePath.

Referenced by XrdOssArcFile::Open(), XrdOssArcDir::Opendir(), and XrdOssArc::Stat().

Here is the call graph for this function:

Here is the caller graph for this function:

Dir2DSN()

std::string XrdOssArcCompose::Dir2DSN ( const char *  dir )

static

Definition at line 255 of file XrdOssArcCompose.cc.

{
   std::string retdsn(dir);
   int n = retdsn.length();
 
   for (int i = 0; i < n; i++) if (retdsn[i] == '%') retdsn[i] = '/';
 
   return retdsn;
}

DSN2Dir()

std::string XrdOssArcCompose::DSN2Dir ( const char *  dsn )

static

Definition at line 241 of file XrdOssArcCompose.cc.

{
   std::string retdir(dsn);
   int n = retdir.length();
 
   for (int i = 0; i < n; i++) if (retdir[i] == '/') retdir[i] = '%';
 
   return retdir;
}

Referenced by XrdOssArcBackupTask::BkpXeq().

Here is the caller graph for this function:

isArcFile()

bool XrdOssArcCompose::isArcFile ( const char *  path )

static

Definition at line 305 of file XrdOssArcCompose.cc.

{
   int n = strlen(path);
 
// Is it's too short, it cannot end with ".zip" (or what it the suffix is)
//
   if (n <= Config.arfSfxLen) return false;
 
// Verify the ending
//
   return !strcmp(Config.arfSfx, path+n-Config.arfSfxLen);
}

References XrdOssArcConfig::arfSfx, XrdOssArcConfig::arfSfxLen, and XrdOssArcGlobals::Config.

isArcPath()

bool XrdOssArcCompose::isArcPath ( const char *  path )

static

Definition at line 322 of file XrdOssArcCompose.cc.

{
   return  !strncmp(Config.arcvPathLFN, path, Config.arcvPathLEN);
}

References XrdOssArcConfig::arcvPathLEN, XrdOssArcConfig::arcvPathLFN, and XrdOssArcGlobals::Config.

isBkpPath()

bool XrdOssArcCompose::isBkpPath ( const char *  path )

static

Definition at line 331 of file XrdOssArcCompose.cc.

{
   return  !strncmp(Config.bkupPathLFN, path, Config.bkupPathLEN);
}

References XrdOssArcConfig::bkupPathLEN, XrdOssArcConfig::bkupPathLFN, and XrdOssArcGlobals::Config.

isMine()

bool XrdOssArcCompose::isMine ( const char *  path )

static

Definition at line 340 of file XrdOssArcCompose.cc.

{
   return  !strncmp(Config.arcvPathLFN, path, Config.arcvPathLEN) ||
           !strncmp(Config.bkupPathLFN, path, Config.bkupPathLEN);
}

References XrdOssArcConfig::arcvPathLEN, XrdOssArcConfig::arcvPathLFN, XrdOssArcConfig::bkupPathLEN, XrdOssArcConfig::bkupPathLFN, and XrdOssArcGlobals::Config.

Referenced by XrdOssArc::Chmod(), XrdOssArc::Create(), XrdOssArc::Lfn2Pfn(), XrdOssArc::Mkdir(), XrdOssArc::Remdir(), XrdOssArc::Rename(), XrdOssArc::Truncate(), and XrdOssArc::Unlink().

Here is the caller graph for this function:

Stat()

int XrdOssArcCompose::Stat ( const char *  Scope, const char *  Name, struct stat *  Stat  )

static

Definition at line 407 of file XrdOssArcCompose.cc.

{
   TraceInfo("Stat", 0);
 
// Setup argument list for a stat call
//
   const char* argV[] = {"stat", "cgi", Scope, Name};
   int argC = sizeof(argV)/sizeof(char*);
   int rc, rc2 = 0;
 
// Do some tracing
//
    DEBUG("Running "<<Config.BkpUtilName<<' '<<argV[0]<<' '
                    <<argV[1]<<' '<<argV[2]<<' '<<argV[3]);
 
// Execute command, it should return a single line of output
//
   XrdOucStream cmdSup;
   bool aOK = false;
 
   if (!(rc = Config.BkpUtilProg->Run(&cmdSup, argV, argC)))
      {char* resp;
       if (cmdSup.GetLine() && (resp = cmdSup.GetToken()) && *resp)
          {if (*resp != '!')
              {if (!(rc = StatDecode(*Stat, resp))) aOK = true;
                  else if (!strcmp("!ENOENT", resp)) rc = ENOENT;
                          else rc = EINVAL;
              }
          }
       rc2 = Config.BkpUtilProg->RunDone(cmdSup);
      }
 
// Check if we have a result, that implies all went well enough
//
   if (aOK) return 0;
   if (rc)  return rc;
   if (rc2) return rc2;
   return EPROTO;
}

References XrdOssArcConfig::BkpUtilName, XrdOssArcConfig::BkpUtilProg, XrdOssArcGlobals::Config, DEBUG, XrdOucStream::GetLine(), XrdOucStream::GetToken(), XrdOucProg::Run(), XrdOucProg::RunDone(), Stat, and TraceInfo.

Referenced by XrdOssArc::Stat().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

arName

std::string XrdOssArcCompose::arName

Definition at line 48 of file XrdOssArcCompose.hh.

didType

pType XrdOssArcCompose::didType

Definition at line 51 of file XrdOssArcCompose.hh.

Referenced by XrdOssArcFile::Open(), XrdOssArcDir::Opendir(), and XrdOssArc::Stat().

dsName

std::string XrdOssArcCompose::dsName

Definition at line 45 of file XrdOssArcCompose.hh.

dsScope

std::string XrdOssArcCompose::dsScope

Definition at line 44 of file XrdOssArcCompose.hh.

flName

std::string XrdOssArcCompose::flName

Definition at line 47 of file XrdOssArcCompose.hh.

Referenced by XrdOssArc::Stat().

flScope

std::string XrdOssArcCompose::flScope

Definition at line 46 of file XrdOssArcCompose.hh.

Referenced by XrdOssArc::Stat().

---

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

• XrdOssArcCompose.hh
• XrdOssArcCompose.cc