XrdOucUtils.hh

Go to the documentation of this file.

#ifndef __XRDOUCUTILS_HH__
#define __XRDOUCUTILS_HH__
/******************************************************************************/
/*                                                                            */
/*                        X r d O u c U t i l s . h h                         */
/*                                                                            */
/* (c) 2005 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <sys/types.h>
#include <sys/stat.h>
#include <string>
#include <unordered_set>
#include <vector>
#include <cstdint>
 
class XrdSysError;
class XrdOucString;
class XrdOucStream;
 
class XrdOucUtils
{
public:
 
static const mode_t pathMode = S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
 
static int   argList(char *args, char **argV, int argC);
 
static char *bin2hex(char *inbuff, int dlen, char *buff, int blen, bool sep=true);
 
static int hex2bin(const char *hex, char *bin, int size);
 
static bool  endsWith(const char *text, const char *ending, int endlen);
 
static char *eText(int rc, char *eBuff, int eBlen);
 
static int   doIf(XrdSysError *eDest, XrdOucStream &Config,
                  const char *what, const char *hname, 
                                    const char *nname, const char *pname);
 
static bool  findPgm(const char *pgm, XrdOucString& path);
 
static int   fmtBytes(long long val, char *buff, int bsz);
 
static std::string genHumanSize(size_t size, uint64_t base);
 
static char *genPath(const char *path, const char *inst, const char *psfx=0);
 
static int   genPath(char *buff, int blen, const char *path, const char *psfx=0);
 
static char *getFile(const char *path, int &rc, int maxsz=10240,
                     bool notempty=true);
 
static bool  getGID(const char *gName, gid_t &gID);
 
static bool  getUID(const char *uName, uid_t &uID, gid_t *gID=0);
 
static int   GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0);
 
static int   GroupName(gid_t gID, char *gName, int gNsz);
 
static const char *i2bstr(char *buff, int blen, int val, bool pad=false);
 
static const char *HSize(size_t bytes, char* buff, int bsz);
 
static char *Ident(long long  &mySID, char *iBuff, int iBlen,
                   const char *iHost, const char *iProg, const char *iName,
                   int Port);
 
static const char *InstName(int TranOpt=0);
 
static const char *InstName(const char *name, int Fillit=1);
 
static int   is1of(char *val, const char **clist);
 
static int   isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0,
                   bool pTrim=false);
 
static int   Log2(unsigned long long n);
 
static int   Log10(unsigned long long n);
 
static void  makeHome(XrdSysError &eDest, const char *inst);
 
static bool  makeHome(XrdSysError &eDest, const char *inst,
                                          const char *path, mode_t mode);
 
static int   makePath(char *path, mode_t mode, bool reset=false);
 
static bool  mode2mask(const char *mode, mode_t &mask);
 
static bool  parseLib(XrdSysError &eDest, XrdOucStream &Config,
                      const char *libName, char *&path, char **libparm);
 
static char *parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode);
 
static int   ReLink(const char *path, const char *target, mode_t mode=0);
 
static void  Sanitize(char *instr, char subc='_');
 
static char *subLogfn(XrdSysError &eDest, const char *inst, char *logfn);
 
static void  toLower(char *str);
 
static int   Token(const char **str, char delim, char *buff, int bsz);
 
static void  Undercover(XrdSysError &eDest, int noLog, int *pipeFD = 0);
 
static int   UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0);
 
static int   UserName(uid_t uID, char *uName, int uNsz);
 
static
const char  *ValPath(const char *path, mode_t allow, bool isdir);
 
static bool PidFile(XrdSysError &eDest, const char *path);
 
static int getModificationTime(const char * path, time_t & modificationTime);
 
static void trim(std::string & str);
 
static void trim(std::string_view & sv);
 
static uint8_t touint8_t(const std::string_view sv);
 
static std::string UrlEncode(const std::string &input);
 
static std::string UrlDecode(const std::string &input);
 
    XrdOucUtils() {}
    ~XrdOucUtils() {}
 
};
#endif