1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#include "nsISupports.idl"
interface nsIChannel;
interface nsIInputStream;
interface nsIRequestObserver;
interface nsIFile;
interface nsIZipEntry;
/**
* 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.
*/
[scriptable, uuid(3ca10750-797e-4a22-bcfe-66170b5e96dd)]
interface nsIZipWriter : nsISupports
{
/**
* Some predefined compression levels
*/
const uint32_t COMPRESSION_NONE = 0;
const uint32_t COMPRESSION_FASTEST = 1;
const uint32_t COMPRESSION_DEFAULT = 6;
const uint32_t COMPRESSION_BEST = 9;
/**
* Gets or sets the comment associated with the open zip file.
*
* @throws NS_ERROR_NOT_INITIALIZED if no zip file has been opened
*/
attribute ACString comment;
/**
* Indicates that operations on the background queue are being performed.
*/
readonly attribute boolean inQueue;
/**
* The file that the zipwriter is writing to.
*/
readonly attribute nsIFile file;
/**
* Opens a zip file.
*
* @param aFile the zip file to open
* @param aIoFlags the open flags for the zip file from prio.h
*
* @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 <other-error> on failure to open zip file (most likely corrupt
* or unsupported form)
*/
void open(in nsIFile aFile, in int32_t aIoFlags);
/**
* Returns a nsIZipEntry describing a specified zip entry or null if there
* is no such entry in the zip file
*
* @param aZipEntry the path of the entry
*/
nsIZipEntry getEntry(in AUTF8String aZipEntry);
/**
* Checks whether the zipfile contains an entry specified by zipEntry.
*
* @param aZipEntry the path of the entry
*/
boolean hasEntry(in AUTF8String aZipEntry);
/**
* Adds a new directory entry to the zip file. If aZipEntry does not end with
* "/" then it will be added.
*
* @param aZipEntry the path of the directory entry
* @param aModTime the modification time of the entry in microseconds
* @param aQueue adds the operation to the background queue. Will be
* performed when processQueue is called.
*
* @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
*/
void addEntryDirectory(in AUTF8String aZipEntry, in PRTime aModTime,
in boolean aQueue);
/**
* 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)
*
* @param aZipEntry the path of the file entry
* @param aCompression the compression level, 0 is no compression, 9 is best
* @param aFile the file to get the data and modification time from
* @param aQueue adds the operation to the background queue. Will be
* performed when processQueue is called.
*
* @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
*/
void addEntryFile(in AUTF8String aZipEntry,
in int32_t aCompression, in nsIFile aFile,
in boolean aQueue);
/**
* 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.
*
* @param aZipEntry the path of the file entry
* @param aModTime the modification time of the entry in microseconds
* @param aCompression the compression level, 0 is no compression, 9 is best
* @param aChannel the channel to get the data from
* @param aQueue adds the operation to the background queue. Will be
* performed when processQueue is called.
*
* @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
*/
void addEntryChannel(in AUTF8String aZipEntry, in PRTime aModTime,
in int32_t aCompression, in nsIChannel aChannel,
in boolean aQueue);
/**
* Adds data from an input stream to the zip file.
*
* @param aZipEntry the path of the file entry
* @param aModTime the modification time of the entry in microseconds
* @param aCompression the compression level, 0 is no compression, 9 is best
* @param aStream the input stream to get the data from
* @param aQueue adds the operation to the background queue. Will be
* performed when processQueue is called.
*
* @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
*/
void addEntryStream(in AUTF8String aZipEntry, in PRTime aModTime,
in int32_t aCompression, in nsIInputStream aStream,
in boolean aQueue);
/**
* Removes an existing entry from the zip file.
*
* @param aZipEntry the path of the entry to be removed
* @param aQueue adds the operation to the background queue. Will be
* performed when processQueue is called.
*
* @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 <other-error> on failure to update the zip file
*/
void removeEntry(in AUTF8String aZipEntry, in boolean aQueue);
/**
* 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
*/
void processQueue(in nsIRequestObserver aObserver, in nsISupports aContext);
/**
* 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 <other-error> on failure to complete the zip file
*/
void close();
/**
* Make all stored(uncompressed) files align to given alignment size.
*
* @param aAlignSize is the alignment size, valid values from 2 to 32768, and
must be power of 2.
*
* @throws NS_ERROR_INVALID_ARG if aAlignSize is invalid
* @throws <other-error> on failure to update the zip file
*/
void alignStoredFiles(in uint16_t aAlignSize);
};
|
