nsIZipWriter
An interface for a zip archiver that can be used from script.
The interface supports both a synchronous method of archiving data and a
queueing system to allow operations to be prepared then run in sequence
with notification after completion.
Operations added to the queue do not get performed until performQueue is
called at which point they will be performed in the order that they were
added to the queue.
Operations performed on the queue will throw any errors out to the
observer.
An attempt to perform a synchronous operation while the background queue
is in progress will throw NS_ERROR_IN_PROGRESS.
Entry names should use /’s as path separators and should not start with
a /.
It is not generally necessary to add directory entries in order to add file
entries within them, however it is possible that some zip programs may
experience problems what that.
Opens a zip file.
@throws NS_ERROR_ALREADY_INITIALIZED if a zip file is already open
@throws NS_ERROR_INVALID_ARG if aFile is null
@throws NS_ERROR_FILE_NOT_FOUND if aFile does not exist and flags did
not allow for creation
@throws NS_ERROR_FILE_CORRUPTED if the file does not contain zip markers
@throws
| aFile | the zip file to open |
| aIoFlags | the open flags for the zip file from prio.h |
Returns a nsIZipEntry describing a specified zip entry or null if there
is no such entry in the zip file
| aZipEntry | the path of the entry |
Checks whether the zipfile contains an entry specified by zipEntry.
| aZipEntry | the path of the entry |
Adds a new directory entry to the zip file. If aZipEntry does not end with
“/” then it will be added.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_FILE_ALREADY_EXISTS if the path already exists in the
file
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
| aZipEntry | the path of the directory entry |
| aModTime | the modification time of the entry in microseconds |
| aQueue | adds the operation to the background queue. Will be performed when processQueue is called. |
Adds a new file or directory to the zip file. If the specified file is
a directory then this will be equivalent to a call to
addEntryDirectory(aZipEntry, aFile.lastModifiedTime, aQueue)
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_FILE_ALREADY_EXISTS if the path already exists in the zip
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
@throws NS_ERROR_FILE_NOT_FOUND if file does not exist
| aZipEntry | the path of the file entry |
| aCompression | the compression level, 0 is no compression, 9 is best |
| aFile | the file to get the data and modification time from |
| aQueue | adds the operation to the background queue. Will be performed when processQueue is called. |
Adds data from a channel to the zip file. If the operation is performed
on the queue then the channel will be opened asynchronously, otherwise
the channel must support being opened synchronously.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_FILE_ALREADY_EXISTS if the path already exists in the zip
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
| aZipEntry | the path of the file entry |
| aModTime | the modification time of the entry in microseconds |
| aCompression | the compression level, 0 is no compression, 9 is best |
| aChannel | the channel to get the data from |
| aQueue | adds the operation to the background queue. Will be performed when processQueue is called. |
Adds data from an input stream to the zip file.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_FILE_ALREADY_EXISTS if the path already exists in the zip
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
| aZipEntry | the path of the file entry |
| aModTime | the modification time of the entry in microseconds |
| aCompression | the compression level, 0 is no compression, 9 is best |
| aStream | the input stream to get the data from |
| aQueue | adds the operation to the background queue. Will be performed when processQueue is called. |
Removes an existing entry from the zip file.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
@throws NS_ERROR_FILE_NOT_FOUND if no entry with the given path exists
@throws
| aZipEntry | the path of the entry to be removed |
| aQueue | adds the operation to the background queue. Will be performed when processQueue is called. |
Processes all queued items until complete or some error occurs. The
observer will be notified when the first operation starts and when the
last operation completes. Any failures will be passed to the observer.
The zip writer will be busy until the queue is complete or some error
halted processing of the queue early. In the event of an early failure,
remaining items will stay in the queue and calling processQueue will
continue.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_IN_PROGRESS if the queue is already in progress
Closes the zip file.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
@throws NS_ERROR_IN_PROGRESS if another operation is currently in progress
@throws
Make all stored(uncompressed) files align to given alignment size.
@throws NS_ERROR_INVALID_ARG if aAlignSize is invalid
@throws
| aAlignSize | is the alignment size, valid values from 2 to 32768, and must be power of 2. |
Gets or sets the comment associated with the open zip file.
@throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
Indicates that operations on the background queue are being performed.
The file that the zipwriter is writing to.
Some predefined compression levels