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 #include <string>
36 #include <unordered_set>
37 #include <vector>
38 #include <regex>
39 
40 class XrdSysError;
41 class XrdOucString;
42 class XrdOucStream;
43 
45 {
46 public:
47 
48 static const mode_t pathMode = S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
49 
50 static int argList(char *args, char **argV, int argC);
51 
52 static char *bin2hex(char *inbuff, int dlen, char *buff, int blen, bool sep=true);
53 
54 static bool endsWith(const char *text, const char *ending, int endlen);
55 
56 static char *eText(int rc, char *eBuff, int eBlen);
57 
59  const char *what, const char *hname,
60  const char *nname, const char *pname);
61 
62 static bool findPgm(const char *pgm, XrdOucString& path);
63 
64 static int fmtBytes(long long val, char *buff, int bsz);
65 
66 static char *genPath(const char *path, const char *inst, const char *psfx=0);
67 
68 static int genPath(char *buff, int blen, const char *path, const char *psfx=0);
69 
70 static char *getFile(const char *path, int &rc, int maxsz=10240,
71  bool notempty=true);
72 
73 static bool getGID(const char *gName, gid_t &gID);
74 
75 static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0);
76 
77 static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0);
78 
79 static int GroupName(gid_t gID, char *gName, int gNsz);
80 
81 static const char *i2bstr(char *buff, int blen, int val, bool pad=false);
82 
83 static char *Ident(long long &mySID, char *iBuff, int iBlen,
84  const char *iHost, const char *iProg, const char *iName,
85  int Port);
86 
87 static const char *InstName(int TranOpt=0);
88 
89 static const char *InstName(const char *name, int Fillit=1);
90 
91 static int is1of(char *val, const char **clist);
92 
93 static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0,
94  bool pTrim=false);
95 
96 static int Log2(unsigned long long n);
97 
98 static int Log10(unsigned long long n);
99 
100 static void makeHome(XrdSysError &eDest, const char *inst);
101 
102 static bool makeHome(XrdSysError &eDest, const char *inst,
103  const char *path, mode_t mode);
104 
105 static int makePath(char *path, mode_t mode, bool reset=false);
106 
107 static bool mode2mask(const char *mode, mode_t &mask);
108 
110  const char *libName, char *&path, char **libparm);
111 
112 static char *parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode);
113 
114 static int ReLink(const char *path, const char *target, mode_t mode=0);
115 
116 static void Sanitize(char *instr, char subc='_');
117 
118 static char *subLogfn(XrdSysError &eDest, const char *inst, char *logfn);
119 
120 static void toLower(char *str);
121 
122 static int Token(const char **str, char delim, char *buff, int bsz);
123 
124 static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD = 0);
125 
126 static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0);
127 
128 static int UserName(uid_t uID, char *uName, int uNsz);
129 
130 static
131 const char *ValPath(const char *path, mode_t allow, bool isdir);
132 
133 static bool PidFile(XrdSysError &eDest, const char *path);
134 
135 static int getModificationTime(const char * path, time_t & modificationTime);
136 
137 static void trim(std::string & str);
138 
141 
142 };
143 #endif
static XrdSysError eDest(0,"crypto_")
static char * parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode)
static void Sanitize(char *instr, char subc='_')
static bool getGID(const char *gName, gid_t &gID)
Definition: XrdOucUtils.cc:524
static const mode_t pathMode
Definition: XrdOucUtils.hh:48
static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0, bool pTrim=false)
Definition: XrdOucUtils.cc:781
static int UserName(uid_t uID, char *uName, int uNsz)
static char * Ident(long long &mySID, char *iBuff, int iBlen, const char *iHost, const char *iProg, const char *iName, int Port)
Definition: XrdOucUtils.cc:713
static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0)
Definition: XrdOucUtils.cc:540
static int getModificationTime(const char *path, time_t &modificationTime)
static const char * ValPath(const char *path, mode_t allow, bool isdir)
static char * genPath(const char *path, const char *inst, const char *psfx=0)
Definition: XrdOucUtils.cc:428
static int Token(const char **str, char delim, char *buff, int bsz)
static int ReLink(const char *path, const char *target, mode_t mode=0)
static bool parseLib(XrdSysError &eDest, XrdOucStream &Config, const char *libName, char *&path, char **libparm)
static int is1of(char *val, const char **clist)
Definition: XrdOucUtils.cc:769
static const char * InstName(int TranOpt=0)
Definition: XrdOucUtils.cc:743
static char * eText(int rc, char *eBuff, int eBlen)
Definition: XrdOucUtils.cc:208
static int argList(char *args, char **argV, int argC)
Definition: XrdOucUtils.cc:135
static bool mode2mask(const char *mode, mode_t &mask)
Definition: XrdOucUtils.cc:959
static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0)
Definition: XrdOucUtils.cc:558
static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0)
static char * bin2hex(char *inbuff, int dlen, char *buff, int blen, bool sep=true)
Definition: XrdOucUtils.cc:174
static int Log10(unsigned long long n)
Definition: XrdOucUtils.cc:844
static int doIf(XrdSysError *eDest, XrdOucStream &Config, const char *what, const char *hname, const char *nname, const char *pname)
Definition: XrdOucUtils.cc:242
static int makePath(char *path, mode_t mode, bool reset=false)
Definition: XrdOucUtils.cc:928
static int GroupName(gid_t gID, char *gName, int gNsz)
Definition: XrdOucUtils.cc:607
static void trim(std::string &str)
static bool findPgm(const char *pgm, XrdOucString &path)
Definition: XrdOucUtils.cc:365
static bool PidFile(XrdSysError &eDest, const char *path)
static const char * i2bstr(char *buff, int blen, int val, bool pad=false)
Definition: XrdOucUtils.cc:644
static void toLower(char *str)
static int fmtBytes(long long val, char *buff, int bsz)
Definition: XrdOucUtils.cc:401
static int Log2(unsigned long long n)
Definition: XrdOucUtils.cc:829
static void makeHome(XrdSysError &eDest, const char *inst)
Definition: XrdOucUtils.cc:861
static bool endsWith(const char *text, const char *ending, int endlen)
Definition: XrdOucUtils.cc:194
static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD=0)
static char * getFile(const char *path, int &rc, int maxsz=10240, bool notempty=true)
Definition: XrdOucUtils.cc:467
static char * subLogfn(XrdSysError &eDest, const char *inst, char *logfn)
XrdCmsConfig Config