25 #ifndef SRC_XRDZIP_XRDZIPARCHIVE_HH_
26 #define SRC_XRDZIP_XRDZIPARCHIVE_HH_
40 #include <unordered_map>
65 friend class ::MicroTest;
67 template<
typename RSP>
93 uint16_t timeout = 0 );
107 uint32_t crc32 = 0 );
124 uint16_t timeout = 0 )
127 return ReadFrom( openfn, offset, size, buffer, handler, timeout );
145 uint16_t timeout = 0 )
148 return PgReadFrom( openfn, offset, size, buffer, handler, timeout );
167 uint16_t timeout = 0 );
185 uint16_t timeout = 0 );
199 uint16_t timeout = 0 )
201 if( openstage != Done || openfn.empty() )
204 return WriteImpl( size, buffer, handler, timeout );
231 uint16_t timeout = 0 );
242 if( openstage != Done )
245 auto cditr = cdmap.find( fn );
246 if( cditr == cdmap.end() )
249 info = make_stat( fn );
266 return Stat( openfn, info );
278 if( openstage != Done )
281 auto cditr = cdmap.find( fn );
282 if( cditr == cdmap.end() )
284 cksum = cdvec[cditr->second]->ZCRC32;
292 auto cditr = cdmap.find( fn );
293 if( cditr == cdmap.end() )
302 0,
"The compression algorithm is not supported!" );
311 uint64_t cdOffset = zip64eocd ? zip64eocd->cdOffset : eocd->cdOffset;
312 uint64_t nextRecordOffset = ( cditr->second + 1 < cdvec.size() ) ?
315 if( filesize == std::numeric_limits<uint32_t>::max() && cdfh->
extra )
316 filesize = cdfh->
extra->compressedSize;
319 offset = nextRecordOffset - filesize - descsize;
331 uint16_t timeout = 0 );
339 if( openstage != Done || openfn.empty() )
341 0,
"Archive not opened." );
358 return openstage == Done;
366 return archive.IsSecure();
372 inline bool SetProperty(
const std::string &name,
const std::string &value )
374 return archive.SetProperty( name, value );
380 inline bool GetProperty(
const std::string &name, std::string &value )
382 return archive.GetProperty( name, value );
421 uint16_t timeout = 0 );
443 template<
typename Response>
446 if( !rsp )
return nullptr;
455 template<
typename Response>
470 template<
typename Response>
473 if( !handler )
return Free( st, rsp );
504 if (!st.
IsOK())
return nullptr;
505 std::unique_ptr<StatInfo> stinfo( infoptr );
506 auto itr = cdmap.find( fn );
507 if( itr == cdmap.end() )
return nullptr;
508 size_t index = itr->second;
509 uint64_t uncompressedSize = cdvec[index]->uncompressedSize;
510 if( cdvec[index]->extra && uncompressedSize == std::numeric_limits<uint32_t>::max() )
511 uncompressedSize = cdvec[index]->extra->uncompressedSize;
512 return make_stat( *stinfo, uncompressedSize );
556 NewFile( uint64_t offset, std::unique_ptr<LFH> lfh ) : offset( offset ),
557 lfh(
std::move( lfh ) ),
563 lfh(
std::move( nf.lfh ) ),
564 overwrt( nf.overwrt )
576 typedef std::unordered_map<std::string, ZipCache>
zipcache_t;
Definition: XrdClAnyObject.hh:33
void Set(Type object, bool own=true)
Definition: XrdClAnyObject.hh:59
static PostMaster * GetPostMaster()
Get default post master.
Directory list.
Definition: XrdClXRootDResponses.hh:650
A file.
Definition: XrdClFile.hh:46
void QueueJob(Job *job, void *arg=0)
Add a job to be run.
Definition: XrdClJobManager.hh:92
JobManager * GetJobManager()
Get the job manager object user by the post master.
Handle an async response.
Definition: XrdClXRootDResponses.hh:1126
Call the user callback.
Definition: XrdClResponseJob.hh:31
Object stat info.
Definition: XrdClXRootDResponses.hh:400
@ IsWritable
Write access is allowed.
Definition: XrdClXRootDResponses.hh:414
uint32_t GetFlags() const
Get flags.
void SetSize(uint64_t size)
Set size.
void SetFlags(uint32_t flags)
Set flags.
Write operation (.
Definition: XrdClFileOperations.hh:546
Request status.
Definition: XrdClXRootDResponses.hh:219
Definition: XrdClZipArchive.hh:60
OpenStages
Stages of opening and parsing a ZIP archive.
Definition: XrdClZipArchive.hh:540
@ HaveCdRecords
Definition: XrdClZipArchive.hh:545
@ HaveZip64EocdlBlk
Definition: XrdClZipArchive.hh:543
@ Done
Definition: XrdClZipArchive.hh:546
@ HaveEocdBlk
Definition: XrdClZipArchive.hh:542
@ HaveZip64EocdBlk
Definition: XrdClZipArchive.hh:544
@ Error
Definition: XrdClZipArchive.hh:547
File & GetFile()
Get the underlying File object.
Definition: XrdClZipArchive.hh:388
XRootDStatus ReadFrom(const std::string &fn, uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
buffer_t orgcdbuf
Definition: XrdClZipArchive.hh:590
XRootDStatus PgRead(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClZipArchive.hh:141
bool IsSecure()
Check if the underlying file is using an encrypted connection.
Definition: XrdClZipArchive.hh:364
bool cdexists
Definition: XrdClZipArchive.hh:581
static XRootDStatus * make_status(const XRootDStatus &status=XRootDStatus())
Allocate new XRootDStatus object.
Definition: XrdClZipArchive.hh:518
XRootDStatus Stat(const std::string &fn, StatInfo *&info)
Definition: XrdClZipArchive.hh:240
XRootDStatus Write(uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClZipArchive.hh:196
XRootDStatus UpdateMetadata(uint32_t crc32)
uint64_t archsize
Definition: XrdClZipArchive.hh:580
bool GetProperty(const std::string &name, std::string &value)
Get property on the underlying File object.
Definition: XrdClZipArchive.hh:380
XRootDStatus WriteImpl(uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout)
static void Schedule(ResponseHandler *handler, XRootDStatus *st, Response *rsp=nullptr)
Definition: XrdClZipArchive.hh:471
std::unique_ptr< char[]> buffer
Definition: XrdClZipArchive.hh:583
static AnyObject * PkgRsp(Response *rsp)
Definition: XrdClZipArchive.hh:444
XRootDStatus OpenArchive(const std::string &url, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus OpenOnly(const std::string &url, bool update, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus List(DirectoryList *&list)
bool ckpinit
Definition: XrdClZipArchive.hh:596
XRootDStatus AppendFile(const std::string &fn, uint32_t crc32, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0)
bool SetProperty(const std::string &name, const std::string &value)
Set property on the underlying File object.
Definition: XrdClZipArchive.hh:372
new_files_t newfiles
Definition: XrdClZipArchive.hh:597
std::unique_ptr< LFH > lfh
Definition: XrdClZipArchive.hh:595
XRootDStatus Stat(StatInfo *&info)
Definition: XrdClZipArchive.hh:262
void Clear()
Clear internal ZipArchive objects.
Definition: XrdClZipArchive.hh:526
cdvec_t cdvec
Definition: XrdClZipArchive.hh:585
uint32_t orgcdsz
Definition: XrdClZipArchive.hh:588
StatInfo * make_stat(const std::string &fn)
Definition: XrdClZipArchive.hh:500
OpenStages openstage
Definition: XrdClZipArchive.hh:592
zipcache_t zipcache
Definition: XrdClZipArchive.hh:594
XRootDStatus CloseArchive(ResponseHandler *handler, uint16_t timeout=0)
Create the central directory at the end of ZIP archive and close it.
std::unique_ptr< EOCD > eocd
Definition: XrdClZipArchive.hh:584
std::unordered_map< std::string, NewFile > new_files_t
Definition: XrdClZipArchive.hh:577
bool IsOpen()
Definition: XrdClZipArchive.hh:356
XRootDStatus GetOffset(const std::string &fn, uint64_t &offset)
Definition: XrdClZipArchive.hh:288
static StatInfo * make_stat(const StatInfo &starch, uint64_t size)
Definition: XrdClZipArchive.hh:485
XRootDStatus PgReadFrom(const std::string &fn, uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
virtual ~ZipArchive()
Destructor.
XRootDStatus CloseFile()
Definition: XrdClZipArchive.hh:337
File archive
Definition: XrdClZipArchive.hh:579
friend XRootDStatus ReadFromImpl(ZipArchive &, const std::string &, uint64_t, uint32_t, void *, ResponseHandler *, uint16_t)
uint32_t orgcdcnt
Definition: XrdClZipArchive.hh:589
std::unique_ptr< ZIP64_EOCD > zip64eocd
Definition: XrdClZipArchive.hh:591
std::unordered_map< std::string, ZipCache > zipcache_t
Type that maps file name to its cache.
Definition: XrdClZipArchive.hh:576
bool updated
Definition: XrdClZipArchive.hh:582
XRootDStatus GetCRC32(const std::string &fn, uint32_t &cksum)
Definition: XrdClZipArchive.hh:276
ZipArchive(bool enablePlugIns=true)
Constructor.
cdmap_t cdmap
Definition: XrdClZipArchive.hh:586
XRootDStatus OpenFile(const std::string &fn, OpenFlags::Flags flags=OpenFlags::None, uint64_t size=0, uint32_t crc32=0)
XRootDStatus Read(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClZipArchive.hh:120
std::string openfn
Definition: XrdClZipArchive.hh:593
uint64_t cdoff
Definition: XrdClZipArchive.hh:587
static void Free(XRootDStatus *st, Response *rsp)
Free status and response.
Definition: XrdClZipArchive.hh:456
void SetCD(const buffer_t &buffer)
Definition: XrdClZipArchive.hh:45
Definition: XrdEcReader.hh:58
Definition: XrdEcStrmWriter.hh:53
Definition: XrdClAction.hh:34
StatImpl< false > Stat(Ctx< File > file, Arg< bool > force, uint16_t timeout=0)
Definition: XrdClFileOperations.hh:535
const uint16_t stError
An error occurred that could potentially be retried.
Definition: XrdClStatus.hh:32
const uint16_t errNotFound
Definition: XrdClStatus.hh:100
ZipReadFromImpl< false > ReadFrom(Ctx< ZipArchive > zip, Arg< std::string > fn, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
Factory for creating ArchiveReadImpl objects.
Definition: XrdClZipOperations.hh:302
const uint16_t errInvalidOp
Definition: XrdClStatus.hh:51
const uint16_t errNotSupported
Definition: XrdClStatus.hh:62
Definition: XrdClZipArchive.hh:45
Definition: XrdZipCDFH.hh:40
std::vector< std::unique_ptr< CDFH > > cdvec_t
Definition: XrdZipCDFH.hh:44
std::vector< char > buffer_t
Definition: XrdZipUtils.hh:54
std::unordered_map< std::string, size_t > cdmap_t
Definition: XrdZipCDFH.hh:54
Definition: XrdOucJson.hh:4517
none object for initializing empty Optional
Definition: XrdClOptional.hh:35
Flags
Open flags, may be or'd when appropriate.
Definition: XrdClFileSystem.hh:76
@ None
Nothing.
Definition: XrdClFileSystem.hh:77
bool IsOK() const
We're fine.
Definition: XrdClStatus.hh:124
LFH of a newly appended file (in case it needs to be overwritten)
Definition: XrdClZipArchive.hh:555
uint64_t offset
Definition: XrdClZipArchive.hh:568
bool overwrt
Definition: XrdClZipArchive.hh:570
NewFile(NewFile &&nf)
Definition: XrdClZipArchive.hh:562
std::unique_ptr< LFH > lfh
Definition: XrdClZipArchive.hh:569
NewFile(uint64_t offset, std::unique_ptr< LFH > lfh)
Definition: XrdClZipArchive.hh:556
Definition: XrdZipCDFH.hh:65
static uint64_t GetOffset(const CDFH &cdfh)
Definition: XrdZipCDFH.hh:225
std::unique_ptr< Extra > extra
Definition: XrdZipCDFH.hh:343
uint16_t compressionMethod
Definition: XrdZipCDFH.hh:330
bool HasDataDescriptor()
Definition: XrdZipCDFH.hh:322
uint32_t compressedSize
Definition: XrdZipCDFH.hh:333
bool IsZIP64() const
Definition: XrdZipCDFH.hh:314
static uint8_t GetSize(bool zip64)
Definition: XrdZipDataDescriptor.hh:35