Bzip2 Class

Properties   Methods   Events   Config Settings   Errors  

The Bzip2 class implements a bzip2 compressor and decompressor. It is compliant with bzip2 specification.

Class Name

IPWorksZip_Bzip2

Procedural Interface

 ipworkszip_bzip2_open();
 ipworkszip_bzip2_close($res);
 ipworkszip_bzip2_register_callback($res, $id, $function);
 ipworkszip_bzip2_get_last_error($res);
 ipworkszip_bzip2_get_last_error_code($res);
 ipworkszip_bzip2_set($res, $id, $index, $value);
 ipworkszip_bzip2_get($res, $id, $index);
 ipworkszip_bzip2_do_abort($res);
 ipworkszip_bzip2_do_append($res);
 ipworkszip_bzip2_do_compress($res);
 ipworkszip_bzip2_do_config($res, $configurationstring);
 ipworkszip_bzip2_do_extract($res);
 ipworkszip_bzip2_do_extractall($res);
 ipworkszip_bzip2_do_reset($res);
 ipworkszip_bzip2_do_scan($res);

Remarks

The bzip2 file format is typically used only to archive a single file. Accordingly, the operation of the class is simpler than that of the other classs.

To compress with the class, set ArchiveFile to the name of the bzip2 file to be created, and FileDecompressedName to the name of the file to be compressed. Finally, invoke Compress. To extract the file, set ArchiveFile to the bzip2 archive and FileDecompressedName to the file where the class should extract. Finally, invoke the Extract or Compress method.

Example (Creating a Bzip2 File)

ZipControl.ArchiveFile = "c:\test.bz2" ZipControl.FileDecompressedName = "c:\test.txt" ZipControl.Compress() Example (Extracting from a Bzip2 File)

ZipControl.ArchiveFile = "c:\test.bz2" ZipControl.FileDecompressedName = "c:\test.txt" ZipControl.Extract()

This class is an implementation based on Julian Seward's bzip2 library (http://www.bzip.org).

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ArchiveFile Property (IPWorksZip_Bzip2 Class)

The name of the zip, gzip, tar, or jar archive.

Object Oriented Interface

public function getArchiveFile();
public function setArchiveFile($value);

Procedural Interface

ipworkszip_bzip2_get($res, 1 );
ipworkszip_bzip2_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the name of the archive to be read or written. This property is required when extracting files.

When Scan, Extract, or ExtractAll is invoked, the file specified by ArchiveFile will be opened for read. If the file does not exist, a trappable error will be generated.

When Compress is called, the file named by ArchiveFile will be written; if a file of this name already exists the Overwrite event will be fired. If ArchiveFile is set to the empty string (""), the archive will not be written to disk, and will be provided only through the Progress event.

The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the class.

If the file cannot be read, or written, as appropriate, a trappable error will be generated.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

Note: an archive already open for read may be closed by setting ArchiveFile to the empty string ("").

Data Type

String

Bzip2Data Property (IPWorksZip_Bzip2 Class)

(Decompression only) The bzip2 file contents as a byte array.

Object Oriented Interface

public function setBzip2Data($value);

Procedural Interface

ipworkszip_bzip2_set($res, 2, $value );

Default Value

''

Remarks

Normally you should set ArchiveFile before invoking Scan or Extract. If you prefer to read the bzip2 file from memory you may set Bzip2Data instead. Bzip2Data should be set to the entire contents of the bzip2 file; this will allow you to read from the bzip2 without writing any temporary files to disk.

If you would like to extract data from the archive without ever writing to disk you should also set WriteToProgressEvent to true, and after invoking Scan, you should set the value of FileDecompressedName to an empty string. Then, when you invoke Extract (or ExtractAll) the data will be provided in the Progress event.

This property is write-only. Note that modifying a bzip2 file stored in Bzip2Data is not supported, so Append will throw exceptions.

This property is write-only and not available at design time.

Data Type

Binary String

ExtractToPath Property (IPWorksZip_Bzip2 Class)

A base path to decompress to.

Object Oriented Interface

public function getExtractToPath();
public function setExtractToPath($value);

Procedural Interface

ipworkszip_bzip2_get($res, 3 );
ipworkszip_bzip2_set($res, 3, $value );

Default Value

''

Remarks

Setting the ExtractToPath property affects the operation of the Extract and ExtractAll methods. Setting this property to a nonempty string will cause all decompressed files to be written to the specified path. If pathnames are given in the values of FileDecompressedName they will be regarded as relative to ExtractToPath.

If the specified directory does not exist, it will be created when extraction is done.

ExtractToPath should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\temp\" on a Windows system.

Data Type

String

FileDecompressedName Property (IPWorksZip_Bzip2 Class)

File name to decompress to, or compress from.

Object Oriented Interface

public function getFileDecompressedName();
public function setFileDecompressedName($value);

Procedural Interface

ipworkszip_bzip2_get($res, 4 );
ipworkszip_bzip2_set($res, 4, $value );

Default Value

''

Remarks

FileDecompressedName contains the name of the file in the archive, as stored on the file system, outside the archive.

When compressing a file, this property should be specified with a path, if necessary, to allow the file to be found by the class. If the file cannot be found when Compress is called, a trappable error will be generated, and the archive will not be correctly written.

When decompressing files, this property may be set prior to calling Extract. If this property is set to the empty string when Extract is called, Extract will automatically set this property to an appropriate value.

Paths on the local file system should be specified in the format native to the host operating system. They may also be specified in standard (UNIX) format, in which case they will be immediately converted.

Data Type

String

FileInputData Property (IPWorksZip_Bzip2 Class)

The data of the file to be compressed.

Object Oriented Interface

public function getFileInputData();
public function setFileInputData($value);

Procedural Interface

ipworkszip_bzip2_get($res, 5 );
ipworkszip_bzip2_set($res, 5, $value );

Default Value

''

Remarks

When this property is set, the class will read in the data from this property instead of reading from the file contained in the FileDecompressedName property.

This property is not available at design time.

Data Type

Binary String

HasMoreData Property (IPWorksZip_Bzip2 Class)

Shows whether or not there is more data in the bzip2 archive.

Object Oriented Interface

public function getHasMoreData();

Procedural Interface

ipworkszip_bzip2_get($res, 6 );

Default Value

false

Remarks

The bzip2 format allows multiple bzip2 data members to be concatenated into a single file. However, due to the nature of the algorithm it is impossible to determine the number of data members until after the entire archive has been decompressed. The HasMoreData property can be used to cycle through the archive and extract each file.

Simply set the ArchiveFile and ExtractToPath properties, then call Extract as long as the class has available data.

Note: the class will not update FileDecompressedName unless you manually set FileDecompressedName on each loop before calling Extract.

Example (Extracting Multiple Files)

ZipControl.ArchiveFile = "c:\temp.bz2" ZipControl.ExtractToPath = "c:\extracted\" Do //here you may set the file name in FileDecompressedName prior to extraction ZipControl.Extract() While ZipControl.HasMoreData

This property is read-only.

Data Type

Boolean

Abort Method (IPWorksZip_Bzip2 Class)

Aborts the current operation.

Object Oriented Interface

public function doAbort();

Procedural Interface

ipworkszip_bzip2_do_abort($res);

Remarks

Abort may be used to immediately interrupt compression or decompression. Any files partially written by the class will be deleted.

Append Method (IPWorksZip_Bzip2 Class)

Adds specified file to an existing archive.

Object Oriented Interface

public function doAppend();

Procedural Interface

ipworkszip_bzip2_do_append($res);

Remarks

The file contained in the FileDecompressedName property will be appended to the archive specified by ArchiveFile.

This method may only be used to add files to an existing archive. To add files to a new archive, Compress method should be used.

Compress Method (IPWorksZip_Bzip2 Class)

Creates the compressed bzip2 archive.

Object Oriented Interface

public function doCompress();

Procedural Interface

ipworkszip_bzip2_do_compress($res);

Remarks

Invoking Compress creates the archive specified by ArchiveFile. When the method is called, the file specified by FileDecompressedName will be opened, and the file specified by ArchiveFile will contain the compressed output.

As the data is compressed the Progress event will be fired at regular intervals. This event may be used to stream out the bzip2 file, or to display a progress bar to the user.

Config Method (IPWorksZip_Bzip2 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkszip_bzip2_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Extract Method (IPWorksZip_Bzip2 Class)

Extracts the compressed file from the bzip2 archive.

Object Oriented Interface

public function doExtract();

Procedural Interface

ipworkszip_bzip2_do_extract($res);

Remarks

Invoking Extract decompresses the archive specified by ArchiveFile. The compressed file will be extracted, and written to disk.

If FileDecompressedName is set to a nonempty string the file will be written there. Otherwise the class will automatically set FileDecompressedName to an appropriate value:

If ArchiveFile ends in ".bz2", this filename, less the ".bz2" extension will be used.

If this condition does not hold, ".unzipped" will be appended to ArchiveFile.

ExtractAll Method (IPWorksZip_Bzip2 Class)

Extracts all files from the compressed archive.

Object Oriented Interface

public function doExtractAll();

Procedural Interface

ipworkszip_bzip2_do_extractall($res);

Remarks

ExtractAll extracts all files from the archive. The file(s) will be extracted to the directory specified by ExtractToPath, and given the names specified by FileDecompressedName.

The BeginFile and EndFile events will be fired before and after each file is extracted, and the Progress event will be fired as the data is extracted. If WriteToProgressEvent is set to true, the decompressed data will be streamed out through the Progress event.

Reset Method (IPWorksZip_Bzip2 Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkszip_bzip2_do_reset($res);

Remarks

Reset resets the state of the class. All properties will be set to their default values, and any files open will be closed.

Scan Method (IPWorksZip_Bzip2 Class)

Scans the compressed archive.

Object Oriented Interface

public function doScan();

Procedural Interface

ipworkszip_bzip2_do_scan($res);

Remarks

This method will scan the bzip archive specified by ArchiveFile. The archive will be read, and the header will be checked.

Unlike in the Zip, Tar, and Jar classs, it is never necessary to invoke this method, and it will not be automatically invoked by Extract. Suggested uses for this method would be to check that the file is a bzip file.

BeginFile Event (IPWorksZip_Bzip2 Class)

Fired before a file is processed.

Object Oriented Interface

public function fireBeginFile($param);

Procedural Interface

ipworkszip_bzip2_register_callback($res, 1, array($this, 'fireBeginFile'));

Parameter List

 'index'
 'skip'

Remarks

BeginFile is fired before compression or decompression begins. Index will contain 0.

You may use the Skip parameter to tell the class to skip the file when appending or decompressing.

EndFile Event (IPWorksZip_Bzip2 Class)

Fired after a file is processed.

Object Oriented Interface

public function fireEndFile($param);

Procedural Interface

ipworkszip_bzip2_register_callback($res, 2, array($this, 'fireEndFile'));

Parameter List

 'index'

Remarks

EndFile is fired when compression or decompression finishes. Index will contain 0.

Error Event (IPWorksZip_Bzip2 Class)

Information about non-fatal errors.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkszip_bzip2_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'description'
 'errorcode'
 'index'
 'filename'
 'ignore'

Remarks

The Error event is fired when non-fatal errors occur during compression or decompression. Note that if this event is fired during decompression this may indicate that the archive is corrupt.

By default these errors will cause the component to fail with an exception. The exception may be overridden by setting Ignore to true. This will cause the error to be ignored, the file will be skipped if necessary, and the class will continue operation.

ErrorCode will correspond to one of the following errors:

Description contains a textual description of the error. Index and Filename contain the array index (where appropriate) and filename of the file being processed at the time of the error.

Overwrite Event (IPWorksZip_Bzip2 Class)

Fired whenever a file exists and may be overwritten.

Object Oriented Interface

public function fireOverwrite($param);

Procedural Interface

ipworkszip_bzip2_register_callback($res, 4, array($this, 'fireOverwrite'));

Parameter List

 'filename'
 'overwrite'

Remarks

Overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression.

Filename contains the full name of the file, specified with its pathname.

Overwrite specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the OverwriteFiles property. For Gzip, this value defaults to true.

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the class, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

Progress Event (IPWorksZip_Bzip2 Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworkszip_bzip2_register_callback($res, 5, array($this, 'fireProgress'));

Parameter List

 'data'
 'filename'
 'bytesprocessed'
 'percentprocessed'

Remarks

The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

Config Settings (Bzip2 Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Bzip2 Config Settings

Base Config Settings

Trappable Errors (Bzip2 Class)

Errors

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

Note that some non-fatal errors may be trapped and explicitly ignored in the Error event. This will allow the class to continue operation even in case of error.

Bzip2 Errors