xrootd
XrdOucUtils.hh
Go to the documentation of this file.
1 #ifndef __XRDOUCUTILS_HH__
2 #define __XRDOUCUTILS_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d O u c U t i l s . h h */
6 /* */
7 /* (c) 2005 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <sys/types.h>
34 #include <sys/stat.h>
35 
36 class XrdSysError;
37 class XrdOucStream;
38 
40 {
41 public:
42 
43 static const mode_t pathMode = S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
44 
45 static bool endsWith(const char *text, const char *ending, int endlen);
46 
47 static char *eText(int rc, char *eBuff, int eBlen);
48 
49 static int doIf(XrdSysError *eDest, XrdOucStream &Config,
50  const char *what, const char *hname,
51  const char *nname, const char *pname);
52 
53 static int fmtBytes(long long val, char *buff, int bsz);
54 
55 static char *genPath(const char *path, const char *inst, const char *psfx=0);
56 
57 static int genPath(char *buff, int blen, const char *path, const char *psfx=0);
58 
59 static bool getGID(const char *gName, gid_t &gID);
60 
61 static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0);
62 
63 static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0);
64 
65 static int GroupName(gid_t gID, char *gName, int gNsz);
66 
67 static char *Ident(long long &mySID, char *iBuff, int iBlen,
68  const char *iHost, const char *iProg, const char *iName,
69  int Port);
70 
71 static const char *InstName(int TranOpt=0);
72 
73 static const char *InstName(const char *name, int Fillit=1);
74 
75 static int is1of(char *val, const char **clist);
76 
77 static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0,
78  bool pTrim=false);
79 
80 static int Log2(unsigned long long n);
81 
82 static int Log10(unsigned long long n);
83 
84 static void makeHome(XrdSysError &eDest, const char *inst);
85 
86 static bool makeHome(XrdSysError &eDest, const char *inst,
87  const char *path, mode_t mode);
88 
89 static int makePath(char *path, mode_t mode, bool reset=false);
90 
91 static bool parseLib(XrdSysError &eDest, XrdOucStream &Config,
92  const char *libName, char *&path, char **libparm);
93 
94 static char *parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode);
95 
96 static int ReLink(const char *path, const char *target, mode_t mode=0);
97 
98 static void Sanitize(char *instr, char subc='_');
99 
100 static char *subLogfn(XrdSysError &eDest, const char *inst, char *logfn);
101 
102 static void toLower(char *str);
103 
104 static int Token(const char **str, char delim, char *buff, int bsz);
105 
106 static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD = 0);
107 
108 static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0);
109 
110 static int UserName(uid_t uID, char *uName, int uNsz);
111 
112 static
113 const char *ValPath(const char *path, mode_t allow, bool isdir);
114 
115 static bool PidFile(XrdSysError &eDest, const char *path);
116 
119 };
120 #endif
static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0)
static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD=0)
static int doIf(XrdSysError *eDest, XrdOucStream &Config, const char *what, const char *hname, const char *nname, const char *pname)
static int fmtBytes(long long val, char *buff, int bsz)
Definition: XrdOucStream.hh:46
static void makeHome(XrdSysError &eDest, const char *inst)
static bool PidFile(XrdSysError &eDest, const char *path)
static int Log10(unsigned long long n)
~XrdOucUtils()
Definition: XrdOucUtils.hh:118
static int Log2(unsigned long long n)
static int Token(const char **str, char delim, char *buff, int bsz)
Definition: XrdSysError.hh:89
static const char * InstName(int TranOpt=0)
static const mode_t pathMode
Definition: XrdOucUtils.hh:43
static void Sanitize(char *instr, char subc='_')
XrdCmsConfig Config
static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0)
XrdOucUtils()
Definition: XrdOucUtils.hh:117
static bool endsWith(const char *text, const char *ending, int endlen)
static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0, bool pTrim=false)
static int UserName(uid_t uID, char *uName, int uNsz)
static char * subLogfn(XrdSysError &eDest, const char *inst, char *logfn)
static void toLower(char *str)
static int is1of(char *val, const char **clist)
static char * eText(int rc, char *eBuff, int eBlen)
static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0)
static const char * ValPath(const char *path, mode_t allow, bool isdir)
static int ReLink(const char *path, const char *target, mode_t mode=0)
static char * Ident(long long &mySID, char *iBuff, int iBlen, const char *iHost, const char *iProg, const char *iName, int Port)
static char * genPath(const char *path, const char *inst, const char *psfx=0)
static bool parseLib(XrdSysError &eDest, XrdOucStream &Config, const char *libName, char *&path, char **libparm)
static bool getGID(const char *gName, gid_t &gID)
Definition: XrdOucUtils.hh:39
static int makePath(char *path, mode_t mode, bool reset=false)
static int GroupName(gid_t gID, char *gName, int gNsz)
static char * parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode)