Class: Archiver

• Inheritance
• Description
• Class protocol
  • classAccess
  • columns
  • command strings
  • commandOutputReader
  • initialization
  • instance creation
  • queries
• Instance protocol
  • accessing
  • actions
  • actions-basic
  • actions-private
  • command execution
  • command strings
  • initialization & release
• Private classes

Inheritance:

   Object
   |
   +--Archiver
      |
      +--Archiver::CompressedFile
      |
      +--Archiver::CompressedTarArchive
      |
      +--Archiver::MultiFileArchive

Package:

stx:libbasic2

Category:

System-Support-FileFormats

Version:

rev: 1.100 date: 2024/04/09 12:14:19

user: stefan

file: Archiver.st directory: libbasic2

module: stx stc-classLibrary: libbasic2

Description:

this is a soon to be obsoleted helper class for the fileBrowser.
it wraps OS-specific command line archivers (tar, zip, rar, etc)
into a common protocol useful to display an archive's contents.

will be removed - do not use for your projects.

copyright
COPYRIGHT (c) 2002 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 arArchive

 gzipArchive

 lzipArchive

 tarArchive

 tarGZipArchive

 zipArchive

 columns

** This method must be redefined in concrete classes (subclassResponsibility) **

 stringWithQuotedStrings: aColOfStrings

used to generate command line arguments;
if aColOfFiles is a non-empty collection,
return them as one space-separated string, with elements quoted, prefixed by a space.
Otherwise return an empty string

 commandOutputParser

 commandOutputParserClass

 initializeMimeTypeMapping

abstract - special handling

 classForMimeType: aMimeType fileName: aFileNameOrNil

hard coded heuristics...

Usage example(s):

self classForMimeType:nil fileName:nil self classForMimeType:'application/x-tar-compressed' fileName:nil self classForMimeType:'application/x-tar' fileName:nil self classForMimeType:'application/x-foo' fileName:nil self classForMimeType:'application/x-squeak-archive' fileName:nil self classForMimeType:'application/java-archive' fileName:nil 'foo.sar' asFilename mimeTypeFromName 'foo.jar' asFilename mimeTypeFromName 'foo.a' asFilename mimeTypeFromName

 newFor: aFilename

instantiate an archiver for the given filename;
will try to extract the mime type from it first

 with: aFilename

 canAddFiles

 canDragnDrop

 canExtractFiles

 canRemoveFiles

 canViewFile

 hasTitleLine

 isAbstract

(comment from inherited method)
Return if this class is an abstract class.
True is returned for Object here; false for subclasses.
Abstract subclasses must redefine this again.

 numTitleLines

Instance protocol:

 errorStream

return the value of the instance variable 'errorStream' (automatically generated)

 errorStream: something

set the value of the instance variable 'errorStream' (automatically generated)

 fileName

return the value of the instance variable 'fileName' (automatically generated)

 fileName: something

set the value of the instance variable 'fileName' (automatically generated)

 outStream

return the value of the instance variable 'outStream' (automatically generated)

 outStream: something

set the value of the instance variable 'outStream' (automatically generated)

 outStream: anOutStream errorStream: anErrorStream synchron: aBoolean

 process

return the value of the instance variable 'process' (automatically generated)

 process: something

set the value of the instance variable 'process' (automatically generated)

 synchron

return the value of the instance variable 'synchron' (automatically generated)

 synchron: something

set the value of the instance variable 'synchron' (automatically generated)

 temporaryDirectory

return the value of the instance variable 'temporaryDirectory' (automatically generated)

 useBuiltinArchiver

by default, we use the underlying OS's command line tools to list and extract entries.
However, under windows, if no winrar/rar is installed,
we must use our builtin zip archiver.
This flag is automatically set, if we detect that situation

 useBuiltinArchiver: aBoolean

by default, we use the underlying OS's command line tools to list and extract entries.
However, under windows, if no winrar/rar is installed,
we must use our builtin zip archiver.
This flag is automatically set, if we detect that situation

 extractFilesTo: aDirectory

 getCommandToListFiles: aColOfFiles

** This method must be redefined in concrete classes (subclassResponsibility) **

 listFiles: aColOfFiles

no list command configured/found.

 removeFilesFromArchive: aColOfFiles

** This method must be redefined in concrete classes (subclassResponsibility) **

 addFilesToArchive: colOfFiles

** This method must be redefined in concrete classes (subclassResponsibility) **

 extractFiles: aColOfFilesOrNil to: aDirectory

** This method must be redefined in concrete classes (subclassResponsibility) **

 removeTemporaryDirectory

 stopProcess

 executeCommand: cmd directory: aDirectory

do it lineWise, since outStream may be an ActorStream

 isValidOutputLine: line

return true, if line contains a valid list-files output line

** This method must be redefined in concrete classes (subclassResponsibility) **

 listFilesReader

 addDoubleQuotedBaseNames: collectionOfFilenames toStream: aStream

 addDoubleQuotedFilenames: collectionOfFilenames toStream: aStream

 release

(comment from inherited method)
remove all references to objects that may refer to self.
Subclasses may redefine this method but should do a 'super release'.

Private classes:

    ArArchive
    ArchiverOutputParser
    BZ2Compressed
    CompressedFile
    CompressedTarArchive
    GZipCompressed
    LZipArchive
    MultiFileArchive
    SevenZipArchive
    TarArchive
    TarBZ2Archive
    TarGZipArchive
    XarArchive
    ZipArchive