XrdClUtils.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_UTILS_HH__
#define __XRD_CL_UTILS_HH__
 
#include <string>
#include <vector>
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClLog.hh"
#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClXRootDResponses.hh"
#include "XrdCl/XrdClPropertyList.hh"
#include "XrdCl/XrdClDefaultEnv.hh"
#include "XrdCl/XrdClConstants.hh"
#include "XrdCl/XrdClPostMaster.hh"
#include "XrdCl/XrdClXRootDTransport.hh"
#include "XrdNet/XrdNetUtils.hh"
#include "XrdOuc/XrdOucTUtils.hh"
 
#include <sys/time.h>
 
#ifdef __linux__
#include <sys/fsuid.h>
#endif
 
namespace XrdCl
{
  class Message;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Utils
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      template<class Container>
      static void splitString( Container         &result,
                               const std::string &input,
                               const std::string &delimiter )
      {
          /*
           * This was done in order to not duplicate code as this method
           * is also used in XrdHttp
           * TODO: Maybe this method could be collapsed
           * to avoid this middle-man call here
           */
          XrdOucTUtils::splitString(result,input,delimiter);
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static int GetIntParameter( const URL         &url,
                                  const std::string &name,
                                  int                defaultVal );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string GetStringParameter( const URL         &url,
                                             const std::string &name,
                                             const std::string &defaultVal );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum AddressType
      {
        IPAuto        = 0,
        IPAll         = 1,
        IPv6          = 2,
        IPv4          = 3,
        IPv4Mapped6   = 4
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static AddressType String2AddressType( const std::string &addressType );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static Status GetHostAddresses( std::vector<XrdNetAddr> &addresses,
                                      const URL               &url,
                                      AddressType              type );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static void LogHostAddresses( Log                     *log,
                                    uint64_t                 type,
                                    const std::string       &hostId,
                                    std::vector<XrdNetAddr> &addresses );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string TimeToString( time_t timestamp );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static uint64_t GetElapsedMicroSecs( timeval start, timeval end );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static XRootDStatus GetRemoteCheckSum( std::string       &checkSum,
                                             const std::string &checkSumType,
                                             const URL         &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static XRootDStatus GetLocalCheckSum( std::string       &checkSum,
                                            const std::string &checkSumType,
                                            const std::string &path );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string BytesToString( uint64_t bytes );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static XRootDStatus CheckTPC( const std::string &server,
                                    uint16_t           timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static XRootDStatus CheckTPCLite( const std::string &server,
                                        uint16_t           timeout = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string FQDNToCC( const std::string &fqdn );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static Status GetDirectoryEntries( std::vector<std::string> &entries,
                                         const std::string        &path );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static Status ProcessConfig( std::map<std::string, std::string> &config,
                                   const std::string                  &file );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static Status ProcessConfigDir( std::map<std::string, std::string> &config,
                                      const std::string                  &dir );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static void Trim( std::string &str );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static void LogPropertyList( Log                *log,
                                   uint64_t            topic,
                                   const char         *format,
                                   const PropertyList &list );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string Char2Hex( uint8_t *array, uint16_t size );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string NormalizeChecksum( const std::string &name,
                                            const std::string &checksum );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::vector<std::string> GetSupportedCheckSums( const XrdCl::URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string InferChecksumType( const XrdCl::URL &source,
                                            const XrdCl::URL &destination,
                                            bool              zip = false );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static bool CheckEC( const Message *req, const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      inline static XrdCl::XRootDStatus GetProtocolVersion( const XrdCl::URL url, int &protver )
      {
        XrdCl::AnyObject  qryResult;
        XrdCl::XRootDStatus st = XrdCl::DefaultEnv::GetPostMaster()->
            QueryTransport( url, XrdCl::XRootDQuery::ProtocolVersion, qryResult );
        if( !st.IsOK() ) return st;
        int *tmp = 0;
        qryResult.Get( tmp );
        protver = *tmp;
        delete tmp;
        return XrdCl::XRootDStatus();
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      inline static bool HasXAttr( const XrdCl::URL &url )
      {
        if( url.IsLocalFile() ) return true;
        int protver = 0;
        auto st = GetProtocolVersion( url, protver );
        if( !st.IsOK() ) return false;
        return protver >= kXR_PROTXATTVERSION;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      inline static bool HasPgRW( const XrdCl::URL &url )
      {
        if( url.IsLocalFile() ) return false;
        int protver = 0;
        auto st = GetProtocolVersion( url, protver );
        if( !st.IsOK() ) return false;
        return protver >= kXR_PROTPGRWVERSION;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static void SplitChunks( std::vector<ChunkList> &listsvec,
                               const ChunkList        &chunks,
                               const uint32_t          maxcs,
                               const size_t            maxc );
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class ScopedDescriptor
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ScopedDescriptor( int descriptor ): pDescriptor( descriptor ) {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~ScopedDescriptor() { if( pDescriptor >= 0 ) close( pDescriptor ); }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      int Release()
      {
        int desc = pDescriptor;
        pDescriptor = -1;
        return desc;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      int GetDescriptor()
      {
        return pDescriptor;
      }
 
    private:
      int pDescriptor;
  };
 
#ifdef __linux__
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class ScopedFsUidSetter
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ScopedFsUidSetter(uid_t fsuid, gid_t fsgid, const std::string &streamName)
      : pFsUid(fsuid), pFsGid(fsgid), pStreamName(streamName)
      {
        pOk = true;
        pPrevFsUid = -1;
        pPrevFsGid = -1;
 
        //----------------------------------------------------------------------
        //----------------------------------------------------------------------
        if(pFsUid >= 0) {
          pPrevFsUid = setfsuid(pFsUid);
 
          if(setfsuid(pFsUid) != pFsUid) {
            pOk = false;
            return;
          }
        }
 
        //----------------------------------------------------------------------
        //----------------------------------------------------------------------
        if(pFsGid >= 0) {
          pPrevFsGid = setfsgid(pFsGid);
 
          if(setfsgid(pFsGid) != pFsGid) {
            pOk = false;
            return;
          }
        }
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~ScopedFsUidSetter() {
        Log *log = DefaultEnv::GetLog();
 
        if(pPrevFsUid >= 0) {
          int retcode = setfsuid(pPrevFsUid);
          log->Dump(XRootDTransportMsg, "[%s] Restored fsuid from %d to %d", pStreamName.c_str(), retcode, pPrevFsUid);
        }
 
        if(pPrevFsGid >= 0) {
          int retcode = setfsgid(pPrevFsGid);
          log->Dump(XRootDTransportMsg, "[%s] Restored fsgid from %d to %d", pStreamName.c_str(), retcode, pPrevFsGid);
        }
      }
 
      bool IsOk() const {
        return pOk;
      }
 
    private:
      int pFsUid;
      int pFsGid;
 
      const std::string &pStreamName;
 
      int pPrevFsUid;
      int pPrevFsGid;
 
      bool pOk;
  };
#endif
 
}
 
#endif // __XRD_CL_UTILS_HH__