hg/stx-libbasic2: comparison ZipArchive.st

equal deleted inserted replaced

-:532eccd8b51b
+:739af6adeb3a
 "{ NameSpace: Smalltalk }"
 Object subclass:#ZipArchive
 	instanceVariableNames:'file mode archiveName firstEntry lastEntry centralDirectory
 		startOfArchive endOfArchive zipMembersByName appendTrailingSlash'
-	classVariableNames:'Lobby RecentlyUsedZipArchives FlushBlock ZipFileFormatErrorSignal
+	classVariableNames:'RecentlyUsedZipArchives FlushBlock ZipFileFormatErrorSignal
-		UnsupportedZipFileFormatErrorSignal DefaultAppendTrailingSlash'
+		UnsupportedZipFileFormatErrorSignal DefaultAppendTrailingSlash
+		ZipFileCachingTime'
 	poolDictionaries:'ZipArchiveConstants'
 	category:'System-Support-FileFormats'
 !
 PeekableStream subclass:#AbstractZipStream
 "Sets the default trailing slash behavior, For details,
 see class documentation"
 DefaultAppendTrailingSlash := aBoolean
 "Created: / 19-11-2012 / 11:53:27 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+!
+zipFileCachingTime:seconds
+"by default, zip files are cached for some time,
+in case they are reconsulted soon.
+The defualt time is 60s, but can be changed by this setter"
+ZipFileCachingTime := seconds
 ! !
 !ZipArchive class methodsFor:'class initialization'!
 initialize
 UnsupportedZipFileFormatErrorSignal := ZipFileFormatErrorSignal newSignal.
 UnsupportedZipFileFormatErrorSignal nameClass:self message:#unsupportedZipFileFormatErrorSignal.
 UnsupportedZipFileFormatErrorSignal notifierString:'unsupported zip file format'.
 ].
-Lobby isNil ifTrue:[
-Lobby := Registry new.
-].
 DefaultAppendTrailingSlash := true.
 "
 self initialize
 "
 "forget about cached zipArchives"
 FlushBlock isNil ifTrue:[
 FlushBlock := [RecentlyUsedZipArchives := nil. FlushBlock := nil].
 ].
-Processor addTimedBlock:FlushBlock for:Processor timeoutHandlerProcess afterSeconds:60.
+Processor addTimedBlock:FlushBlock for:Processor timeoutHandlerProcess afterSeconds:(ZipFileCachingTime ? 60).
 "
 self installFlushBlock
 "
 "redefined, to raise ZipFileFormatErrorSignal"
 ZipFileFormatErrorSignal raiseErrorString:anErrorString.
 ! !
-!ZipArchive methodsFor:'finalization'!
-finalizationLobby
-"answer the registry used for finalization."
-^ Lobby
-!
-finalize
-"some Stream has been collected - close the file if not already done"
-self closeFile
-! !
 !ZipArchive methodsFor:'open & close'!
 close
-self closeFile
+file notNil ifTrue:[
+self flush.
+file close.
+file := archiveName := centralDirectory := zipMembersByName := nil.
+firstEntry := lastEntry := nil.
+].
 !
 flush
 "finish the zip archive, but do not close the underlying stream"
-file notNil ifTrue:[
+(file notNil and:[mode == #write]) ifTrue: [
-Lobby unregister:self.
+self addCentralZipDirectory
-mode == #write ifTrue: [
-self addCentralZipDirectory
-].
-file := nil.
 ]
 !
 name:name mode:readOrWriteMode
 "open read or writestream on archiveFileName"
 filename isDirectory ifTrue:[
 ^ OpenError raiseRequestWith:filename errorString:' - file is a directory'.
 ].
 file notNil ifTrue: [
-self closeFile.
+self close.
 ].
 archiveName := filename name.
 mode := readOrWriteMode.
 file position:(startOfArchive + lastMember dataStart + lastMember compressedSize).
 mode := #write.
 ].
 ] ensure:[
-mustCloseFile ifTrue:[self closeFile].
+mustCloseFile ifTrue:[self close].
 ].
 ] ifFalse:[
 zipMembersByName := Dictionary new.
 ].
 readingFrom:aPositionableStream
 "initialize the archive to read from aPositionableStream"
 file notNil ifTrue: [
 file ~~ aPositionableStream ifTrue: [
-self closeFile.
+self close.
 ].
 ].
 mode := #read.
 aPositionableStream binary.
 writingTo:aPositionableStream
 "initialize the archive to write to aPositionableStream"
 file notNil ifTrue: [
-self closeFile.
+self close.
 ].
 mode := #write.
 aPositionableStream binary.
 file := aPositionableStream.
 ! !
 !ZipArchive methodsFor:'private'!
 closeFile
-"finish the zip archive and close the stream"
+<resource: #obsolete>
+"backward compatibility"
-|savedFile|
+self obsoleteMethodWarning:'use #close'.
-file notNil ifTrue:[
-savedFile := file.
+self close.
-self flush.
-savedFile close.
-]
 !
 dataStartOf:zipEntry
 "fetch the absolute start address of the data of a given zipEntry.
 Note: extra field and extra field length may be different from that in
 ].
 ] ifFalse:[
 file := fn writeStream
 ].
 file binary.
-Lobby register:self.
 ].
 "Modified: / 31-08-2010 / 12:40:41 / sr"
 !
 lastEntry := zmemb.
 (zipMembersByName includesKey:zmemb fileName) ifTrue:[
 "ignore duplicate entries for backward compatibility.
 Argh: expecco once added wrong duplicates to the end of ets files.
 The first entry is valid."
-Logger info: 'Duplicate entry in ZIP (ignored): %1' with: zmemb fileName.
+Logger warning:'duplicate entry in ZIP file ignored: %1' with:zmemb fileName.
 ] ifFalse:[
 zipMembersByName at:zmemb fileName put:zmemb.
 ].
 ^ zmemb.
 self openFile.
 [
 isValidArchive := self checkZipArchive.
 ] ensure:[
-self closeFile.
+self close.
 ].
 ^ isValidArchive
 !
 findMember:name
 or:[eachMemberName = anArchivePathName]) ifTrue:[^ true]
 ].
 ^ false.
 ! !
 !ZipArchive methodsFor:'reading'!
 extract:fileName
 "extract an entry identified by fileName as a byteArray;
 aBlock value:zmemb value:dataStart.
 "Created: / 21-11-2010 / 11:51:41 / cg"
 ! !
 !ZipArchive methodsFor:'reading - stream'!
 extract:fileName intoStream: aWriteStream
 "extract an entry indentified by filename into aWriteStream"
 ].
 compressionMethod == COMPRESSION_DEFLATED ifTrue:[
 myZipStream isNil ifTrue: [
 file binary.
-myZipStream := ZipStream readOpenAsZipStreamOn: file.
+myZipStream := ZipStream readOpenAsZipStreamOn:file suppressHeaderAndChecksum:true.
 ].
 myZipStream next:nextBlockSize into:buffer startingAt:1.
 ] ifFalse:[compressionMethod == COMPRESSION_STORED ifTrue:[
 file nextBytes:nextBlockSize into:buffer startingAt:1.
 ] ifFalse:[
 zipEntry := ZipMember new default.
 theZipFileName := self validZipFileNameFrom:aFileName.
 zipEntry fileName: theZipFileName.
-zipEntry fileNameLength: theZipFileName size.
 zipEntry uncompressedSize: 0.
 isDirectory ifTrue: [
 theCompressMethod := COMPRESSION_STORED.
 zipEntry externalFileAttributes: EXTERNALFILEATTRIBUTES_ISDIRECTORY.
 nextBlockSize > 0 ifTrue: [
 unCompressedDataSize := unCompressedDataSize + nextBlockSize.
 crc32 := ZipStream crc32BytesIn: buffer from:1 to:nextBlockSize crc:crc32.
 theCompressMethod == COMPRESSION_DEFLATED ifTrue: [
 myZipStream isNil ifTrue: [
-myZipStream := ZipStream writeOpenAsZipStreamOn:file.
+myZipStream := ZipStream writeOpenAsZipStreamOn:file suppressHeaderAndChecksum:true.
 ].
 myZipStream nextPutBytes:nextBlockSize from:buffer startingAt:1.
 ] ifFalse: [theCompressMethod == COMPRESSION_STORED ifTrue: [
 file nextPutBytes:nextBlockSize from:buffer startingAt:1.
 ] ifFalse:[
 ].
 ].
 zipEntry compressedSize:(file position) - startDataPosition.
-"/ crc32 is allways reqired (not as written in docu to be zero in case of uncompressed mode)
+"/ crc32 is always required (not as written in docu to be zero in case of uncompressed mode)
 zipEntry crc32:crc32.
 zipEntry uncompressedSize: unCompressedDataSize.
 zipEntry rewriteCrcAndSizeTo:file.
 self addMember:zipEntry.
 !
 basicAddFile:aFileName withContents:data compressMethod:theCompressMethodArg asDirectory:isDirectory
 "do not create directories (isDirectory = true) - they are not compatible between operating systems"
-| zipEntry  theCompressedData theZipFileName  theCompressMethod |
+| zipEntry theCompressedData theZipFileName theCompressMethod  compressedDataOffset|
 (file isNil or:[ mode ~~ #write ]) ifTrue:[
 ^ self error:'ZipArchive not open for writing ...'.
 ].
 theCompressMethod := theCompressMethodArg.
-((theCompressMethod == COMPRESSION_DEFLATED)
+((theCompressMethod ~~ COMPRESSION_DEFLATED)
-or:[ theCompressMethod == COMPRESSION_STORED ])
+and:[theCompressMethod ~~ COMPRESSION_STORED]) ifTrue:[
-ifFalse:[
+UnsupportedZipFileFormatErrorSignal
-UnsupportedZipFileFormatErrorSignal
+raiseRequestErrorString:'unsupported compressMethod'.
-raiseRequestErrorString:'unsupported compressMethod'.
+"/ if proceeded, write as uncompressed
+theCompressMethod := COMPRESSION_STORED
-"/ if proceeded, write as uncompressed
+].
-theCompressMethod := COMPRESSION_STORED
-].
 zipEntry := ZipMember new default.
 theZipFileName := self validZipFileNameFrom:aFileName.
 zipEntry fileName:theZipFileName.
-zipEntry fileNameLength:theZipFileName size.
 (self appendTrailingSlash and:[isDirectory]) ifTrue:[
 theZipFileName last == $/ ifFalse:[
 zipEntry fileName:theZipFileName , $/.
 zipEntry fileNameLength:theZipFileName size + 1.
 "/ data and time in msdos format
 zipEntry setModificationTimeAndDateToNow.
 data notEmptyOrNil ifTrue:[
-"/ crc32 is allways reqired (not as written in docu to be zero in case of uncompressed mode)
+"/ crc32 is always required (not as written in docu to be zero in case of uncompressed mode)
-zipEntry crc32:(ZipStream crc32BytesIn:data).
+zipEntry crc32:(ZipStream crc32BytesIn:data from:1 to:data size crc:0).
 ].
 (isDirectory not and:[ theCompressMethod == COMPRESSION_DEFLATED ]) ifTrue:[
-| tmpCompressedData  tmpCompressedDataSize |
+|tmpCompressedDataSize|
-tmpCompressedData := ByteArray new:(data size + 16).
+theCompressedData := ByteArray new:(data size + 16).
-tmpCompressedDataSize := ZipStream compress:data into:tmpCompressedData.
+tmpCompressedDataSize := ZipStream compress:data into:theCompressedData.
-zipEntry compressedSize:(tmpCompressedDataSize - 6).
+zipEntry compressedSize:tmpCompressedDataSize - 6.
-theCompressedData := tmpCompressedData copyFrom:3.
+compressedDataOffset := 3.
-] ifFalse:[
+] ifFalse:["theCompressMethod == COMPRESSION_STORED"
-theCompressMethod == COMPRESSION_STORED ifTrue:[
+zipEntry compressedSize:zipEntry uncompressedSize.
-zipEntry compressedSize:zipEntry uncompressedSize.
+theCompressedData := data.
-theCompressedData := data.
+compressedDataOffset := 1.
-] ifFalse:[
-self error
-"/ cannot happen
-].
 ].
 "/ ensure that the file position is at the end
 file setToEnd.
 zipEntry writeTo:file.
 theCompressedData notNil ifTrue:[
-file nextPutBytes:zipEntry compressedSize from:theCompressedData.
+file nextPutBytes:zipEntry compressedSize from:theCompressedData startingAt:compressedDataOffset.
 ].
 self addMember:zipEntry.
 "Created: / 18-11-2010 / 19:31:10 / cg"
 "Modified: / 19-11-2010 / 17:47:01 / cg"
 ].
 theCompressMethod := theCompressMethodArg.
 ((theCompressMethod == COMPRESSION_DEFLATED)
-or:[ theCompressMethod == COMPRESSION_STORED ]) ifFalse:[
+or:[theCompressMethod == COMPRESSION_STORED]) ifFalse:[
 UnsupportedZipFileFormatErrorSignal raiseRequestErrorString:'unsupported compressMethod'.
 "/ if proceeded, write as uncompressed
 theCompressMethod := COMPRESSION_STORED
 ].
 zipEntry := ZipMember new default.
 theZipFileName := self validZipFileNameFrom:nameOfFileInArchive.
 zipEntry fileName: theZipFileName.
-zipEntry fileNameLength: theZipFileName size.
 zipEntry uncompressedSize: 0.
 zipEntry compressionMethod: theCompressMethod.
 zipEntry internalFileAttributes: 1.
 zipEntry externalFileAttributes: EXTERNALFILEATTRIBUTES_ISFILE.
 fileName:something
 fileName := something.
 !
 fileNameLength
+fileNameLength isNil ifTrue:[
+^ fileName size.
+].
 ^ fileNameLength
 !
 fileNameLength:something
 fileNameLength := something.
 lastModFileTime := 0.
 lastModFileDate := 0.
 crc32 := 0.
 compressedSize := 0.
 uncompressedSize := 0.
-fileNameLength := 0.
 extraFieldLength := 0.
 fileCommentLength := 0.
 diskNumberStart := 0.
 internalFileAttributes := 0.
 externalFileAttributes := 0.
 relativeLocalHeaderOffset := 0.
-fileName := nil.
+fileName := fileNameLength := nil.
 extraField := nil.
 fileComment := nil.
 dataStart := 0.
 data := nil.
 ! !
 nextPutInt16LSB:lastModFileTime;
 nextPutInt16LSB:lastModFileDate;
 nextPutInt32LSB:crc32;
 nextPutInt32LSB:compressedSize;
 nextPutInt32LSB:uncompressedSize;
-nextPutInt16LSB:fileNameLength;
+nextPutInt16LSB:self fileNameLength;
 nextPutInt16LSB:extraFieldLength;
 nextPutAll:fileName.
 extraField notNil ifTrue: [
 self assert:(extraField size = extraFieldLength).
 crc32 := 0.
 uncompressedDataSize := zipEntry uncompressedSize.
 readPosition := 0.
 zipEntry compressionMethod == COMPRESSION_DEFLATED ifTrue:[
-compressingStream := ZipStream readOpenAsZipStreamOn:zipFileStream.
+compressingStream := ZipStream readOpenAsZipStreamOn:zipFileStream suppressHeaderAndChecksum:true.
 ] ifFalse:[
 compressingStream := zipFileStream.
 compressingStream text.
 ].
 ].
 compressingStream := nil.
 zipEntry compressedSize:(zipFileStream position) - startDataPosition.
-"/ crc32 is allways reqired (not as written in docu to be zero in case of uncompressed mode)
+"/ crc32 is always reqired (not as written in docu to be zero in case of uncompressed mode)
 zipEntry crc32:crc32.
 zipEntry uncompressedSize:uncompressedDataSize.
 zipEntry rewriteCrcAndSizeTo:zipFileStream.
 startDataPosition := zipFileStream position.
 crc32 := 0.
 uncompressedDataSize := 0.
 zipEntry compressionMethod == COMPRESSION_DEFLATED ifTrue:[
-compressingStream := ZipStream writeOpenAsZipStreamOn:zipFileStream.
+compressingStream := ZipStream writeOpenAsZipStreamOn:zipFileStream suppressHeaderAndChecksum:true.
 ] ifFalse:[
 compressingStream := zipFileStream.
 ].
 "Modified: / 19-11-2010 / 15:46:57 / cg"

branch	jv
changeset 4213	739af6adeb3a
parent 4014	195df53729d3
parent 4200	089df8914384
child 4215	195c5c496e71