[XrdCl] Expose --zip-mtln-cksum functionality through XRD_ZIPMTLNCKSU…

…M envar.

Also, it's possible tto enable the functionallity from Python using:

  EnvPutInt( "ZipMtlnCksum", 1 )

for more details see:

  https://github.com/xrootd/xrootd/blob/master/bindings/python/libs/client/env.py

docs/man/xrdcp.1

@@ -517,6 +517,12 @@ If set to 1 XRootD client will preserve tired/triedrc cgi opaque info for kXR_lo
 if set to 0 XRootD client will treat kXR_locate as any other passive request.
 .RE
 
+XRD_ZIPMTLNCKSUM
+.RS 5
+If set to 1, use the checksum available in a metalink file even if a file is being extracted from a ZIP archive.
+By defaut set to 0;
+.RE
+
 .SH RETURN CODES
 .RE
 \fB50\fR  : generic error (e.g. config, internal, data, OS, command line option)

src/XrdCl/XrdClClassicCopyJob.cc

@@ -756,12 +756,10 @@ namespace
                        const XrdCl::URL  *archive,
                        uint32_t           chunkSize,
                        uint8_t            parallelChunks,
-                       const std::string &ckSumType,
-                       bool               useMtlnCksum ):
+                       const std::string &ckSumType ):
                       XRootDSource( archive, chunkSize, parallelChunks, ckSumType ),
                       pFilename( filename ),
-                      pZipArchive( new XrdCl::ZipArchiveReader( *pFile ) ),
-                      pUseMtlnCksum( useMtlnCksum )
+                      pZipArchive( new XrdCl::ZipArchiveReader( *pFile ) )
       {
       }
 
@@ -835,7 +833,10 @@ namespace
         if( checkSumType == "zcrc32" )
           return pZipArchive->ZCRC32( checkSum );
 
-        if( pUseMtlnCksum && pUrl->IsMetalink() )
+        int useMtlnCksum = XrdCl::DefaultZipMtlnCksum;
+        XrdCl::Env *env = XrdCl::DefaultEnv::GetEnv();
+        env->GetInt( "ZipMtlnCksum", useMtlnCksum );
+        if( useMtlnCksum && pUrl->IsMetalink() )
         {
           XrdCl::RedirectorRegistry &registry   = XrdCl::RedirectorRegistry::Instance();
           XrdCl::VirtualRedirector  *redirector = registry.Get( *pUrl );
@@ -858,7 +859,6 @@ namespace
 
       const std::string         pFilename;
       XrdCl::ZipArchiveReader  *pZipArchive;
-      bool                      pUseMtlnCksum;
   };
 
   //----------------------------------------------------------------------------
@@ -1553,8 +1553,7 @@ namespace XrdCl
     uint16_t    parallelChunks;
     uint32_t    chunkSize;
     uint64_t    blockSize;
-    bool        posc, force, coerce, makeDir, dynamicSource, zip, xcp,
-                zipMtlnCksum;
+    bool        posc, force, coerce, makeDir, dynamicSource, zip, xcp;
     int32_t     nbXcpSources;
     long long   xRate;
 
@@ -1572,7 +1571,6 @@ namespace XrdCl
     pProperties->Get( "xcp",             xcp );
     pProperties->Get( "xcpBlockSize",    blockSize );
     pProperties->Get( "xrate",           xRate );
-    pProperties->Get( "zipMtlnCksum",    zipMtlnCksum );
 
     if( zip )
       pProperties->Get( "zipSource",     zipSource );
@@ -1587,7 +1585,7 @@ namespace XrdCl
     if( xcp )
       src.reset( new XRootDSourceXCp( &GetSource(), chunkSize, parallelChunks, nbXcpSources, blockSize ) );
     else if( zip ) // TODO make zip work for xcp
-      src.reset( new XRootDSourceZip( zipSource, &GetSource(), chunkSize, parallelChunks, checkSumType, zipMtlnCksum ) );
+      src.reset( new XRootDSourceZip( zipSource, &GetSource(), chunkSize, parallelChunks, checkSumType ) );
     else if( GetSource().GetProtocol() == "stdio" )
       src.reset( new StdInSource( checkSumType, chunkSize ) );
     else

src/XrdCl/XrdClConstants.hh

@@ -74,6 +74,7 @@ namespace XrdCl
   const int DefaultMaxMetalinkWait         = 60;
   const int DefaultPreserveLocateTried     = 1;
   const int DefaultNotAuthorizedRetryLimit = 3;
+  const int DefaultZipMtlnCksum            = 0;
 
   const char * const DefaultPollerPreference   = "built-in";
   const char * const DefaultNetworkStack       = "IPAuto";

src/XrdCl/XrdClCopy.cc

@@ -489,7 +489,6 @@ int main( int argc, char **argv )
   bool         makedir       = false;
   bool         dynSrc        = false;
   bool         delegate      = false;
-  bool         zipMtlnCksum  = false;
   std::string thirdParty = "none";
 
   if( config.Want( XrdCpConfig::DoPosc ) )     posc       = true;
@@ -512,7 +511,6 @@ int main( int argc, char **argv )
   if( config.Want( XrdCpConfig::DoRecurse ) )      makedir       = true;
   if( config.Want( XrdCpConfig::DoPath    ) )      makedir       = true;
   if( config.Want( XrdCpConfig::DoDynaSrc ) )      dynSrc        = true;
-  if( config.Want( XrdCpConfig::DoZipMtlnCksum ) ) zipMtlnCksum  = true;
 
   //----------------------------------------------------------------------------
   // Checksums
@@ -585,6 +583,9 @@ int main( int argc, char **argv )
   if( config.nStrm != 0 )
     env->PutInt( "SubStreamsPerChannel", config.nStrm + 1 /*stands for the control stream*/ );
 
+  if( config.Want( XrdCpConfig::DoZipMtlnCksum ) )
+    env->PutInt( "ZipMtlnCksum", 1 );
+
   int chunkSize = DefaultCPChunkSize;
   env->GetInt( "CPChunkSize", chunkSize );
 
@@ -783,7 +784,6 @@ int main( int argc, char **argv )
     properties.Set( "delegate",       delegate       );
     properties.Set( "targetIsDir",    targetIsDir    );
     properties.Set( "xrate",          config.xRate   );
-    properties.Set( "zipMtlnCksum",   zipMtlnCksum   );
 
     if( zip )
       properties.Set( "zipSource",    zipFile        );

src/XrdCl/XrdClCopyProcess.cc

@@ -169,7 +169,7 @@ namespace XrdCl
     pJobProperties.push_back( properties );
     PropertyList &p = pJobProperties.back();
 
-    const char *bools[] = {"target", "force", "posc", "coerce", "makeDir", "zipArchive", "xcp", "zipMtlnCksum", 0};
+    const char *bools[] = {"target", "force", "posc", "coerce", "makeDir", "zipArchive", "xcp", 0};
     for( int i = 0; bools[i]; ++i )
       if( !p.HasProperty( bools[i] ) )
         p.Set( bools[i], false );

src/XrdCl/XrdClDefaultEnv.cc

@@ -292,6 +292,7 @@ namespace XrdCl
     REGISTER_VAR_INT( varsInt, "MaxMetalinkWait",         DefaultMaxMetalinkWait         );
     REGISTER_VAR_INT( varsInt, "PreserveLocateTried",     DefaultPreserveLocateTried     );
     REGISTER_VAR_INT( varsInt, "NotAuthorizedRetryLimit", DefaultNotAuthorizedRetryLimit );
+    REGISTER_VAR_INT( varsInt, "ZipMtlnCksum",            DefaultZipMtlnCksum            );
 
     REGISTER_VAR_STR( varsStr, "PollerPreference",        DefaultPollerPreference        );
     REGISTER_VAR_STR( varsStr, "ClientMonitor",           DefaultClientMonitor           );