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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use std::ffi::CStr;
use std::marker::PhantomData;
use std::mem::{zeroed, ManuallyDrop};
use std::os::raw::c_int;
use std::ptr::{null, null_mut, NonNull};

use zipp_sys::*;

use crate::consts::*;
use crate::file::File;
use crate::source::Source;
use crate::*;

/// Zip Archive
#[derive(Debug)]
pub struct Archive {
    inner: NonNull<zip_t>,
}

impl Archive {
    /// Opens the zip archive specified by path
    pub fn open(path: &CStr) -> ZResult<Self> {
        _open(path, ZIP_RDONLY)
    }

    /// Opens a zip archive encapsulated by the Source
    pub fn from_source<T>(source: Source<T>, flag: i32) -> ZResult<Self> {
        let mut error = ZipErrorSys::default();
        let res = unsafe { zip_open_from_source(source.into_raw(), flag, &mut *error) };
        if res.is_null() {
            Err(error.into())
        } else {
            unsafe {
                Ok(Self {
                    inner: NonNull::new_unchecked(res),
                })
            }
        }
    }

    /// Create the zip archive specified by path
    pub fn create(path: &CStr) -> ZResult<Self> {
        _open(path, ZIP_CREATE)
    }

    /// Close zip archive and discard changes
    pub fn discard(self) {
        let me = ManuallyDrop::new(self);
        unsafe {
            zip_discard(me.inner.as_ptr());
        }
    }

    /// Close zip archive and writes any changes made to archive to disk.
    pub fn close(self) -> ZResult<()> {
        let me = ManuallyDrop::new(self);
        let errno = unsafe { zip_close(me.inner.as_ptr()) };
        if errno == -1 {
            zip_err!(me.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Undo changes to file in zip archive
    pub fn unchanged(&self, index: u64) -> ZResult<()> {
        let errno = unsafe { zip_unchange(self.inner.as_ptr(), index) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Undo global changes to zip archive
    pub fn unchanged_archive(&self) -> ZResult<()> {
        let errno = unsafe { zip_unchange_archive(self.inner.as_ptr()) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Undo all changes in a zip archive
    pub fn unchanged_all(&self) -> ZResult<()> {
        let errno = unsafe { zip_unchange_all(self.inner.as_ptr()) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Set default password for encrypted files in zip
    pub fn set_default_password(&self, password: &CStr) -> ZResult<()> {
        let errno = unsafe { zip_set_default_password(self.inner.as_ptr(), password.as_ptr()) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Set compression method for file in zip
    pub fn set_file_compression(&self, index: u64, comp: i32, comp_flag: u32) -> ZResult<()> {
        let errno =
            unsafe { zip_set_file_compression(self.inner.as_ptr(), index, comp, comp_flag) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Set encryption method for file in zip
    pub fn file_set_encryption(&self, index: u64, method: u16, passwd: &CStr) -> ZResult<()> {
        let errno =
            unsafe { zip_file_set_encryption(self.inner.as_ptr(), index, method, passwd.as_ptr()) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Set zip archive comment
    pub fn set_comment(&self, comment: &CStr) -> ZResult<()> {
        let len = comment.to_bytes().len();
        let len = if len > u16::MAX as usize {
            u16::MAX
        } else {
            len as u16
        };
        let errno = unsafe { zip_set_archive_comment(self.inner.as_ptr(), comment.as_ptr(), len) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Get zip archive comment
    pub fn get_comment(&self, flag: u32) -> ZResult<&CStr> {
        let res = unsafe { zip_get_archive_comment(self.inner.as_ptr(), null_mut(), flag) };
        if res.is_null() {
            zip_err!(self.inner.as_ptr())
        } else {
            unsafe { Ok(CStr::from_ptr(res)) }
        }
    }

    /// Open encrypted file in zip archive for reading by name, if passwd is None, it would be
    /// open normal
    pub fn open_file(&self, name: &CStr, flag: u32, passwd: Option<&CStr>) -> ZResult<File> {
        let passwd = if passwd.is_none() {
            null()
        } else {
            passwd.unwrap().as_ptr()
        };
        let res = unsafe { zip_fopen_encrypted(self.inner.as_ptr(), name.as_ptr(), flag, passwd) };
        if res.is_null() {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(File::from_ptr(res))
        }
    }

    /// Open encrypted file in zip archive for reading, if passwd is None, it will open as normal
    /// file
    pub fn open_file_index(&self, index: u64, flag: u32, passwd: Option<&CStr>) -> ZResult<File> {
        let passwd = if passwd.is_none() {
            null()
        } else {
            passwd.unwrap().as_ptr()
        };
        let res = unsafe { zip_fopen_index_encrypted(self.inner.as_ptr(), index, flag, passwd) };
        if res.is_null() {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(File::from_ptr(res))
        }
    }

    /// Rename file in zip archive
    pub fn file_rename(&self, index: u64, name: &CStr, flag: u32) -> ZResult<()> {
        let errno = unsafe { zip_file_rename(self.inner.as_ptr(), index, name.as_ptr(), flag) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Add file to zip archive or replace file in zip archive
    pub fn file_add<T>(&self, name: &CStr, source: Source<T>, flag: u32) -> ZResult<u64> {
        let res =
            unsafe { zip_file_add(self.inner.as_ptr(), name.as_ptr(), source.into_raw(), flag) };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(res as _)
        }
    }

    /// Add file to zip archive or replace file in zip archive
    pub fn file_replace<T>(&self, index: u64, source: Source<T>, flag: u32) -> ZResult<()> {
        let res = unsafe { zip_file_replace(self.inner.as_ptr(), index, source.into_raw(), flag) };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Delete file from zip archive
    pub fn file_delete(&self, index: u64) -> ZResult<()> {
        let errno = unsafe { zip_delete(self.inner.as_ptr(), index) };
        if errno == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(())
        }
    }

    /// Get comment for file in zip
    pub fn file_get_comment(&self, index: u64, flag: u32) -> ZResult<&CStr> {
        let res = unsafe { zip_file_get_comment(self.inner.as_ptr(), index, null_mut(), flag) };
        if res.is_null() {
            zip_err!(self.inner.as_ptr())
        } else {
            unsafe { Ok(CStr::from_ptr(res)) }
        }
    }

    /// Get information about file by name
    pub fn stat_name(&self, name: &CStr, flag: u32) -> ZResult<Stat> {
        let mut stat = unsafe { zeroed() };
        let res = unsafe {
            zip_stat_init(&mut stat);
            zip_stat(self.inner.as_ptr(), name.as_ptr(), flag, &mut stat)
        };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(stat)
        }
    }

    /// Get name of file by index
    pub fn get_name(&self, index: u64, flag: u32) -> &CStr {
        unsafe { CStr::from_ptr(zip_get_name(self.inner.as_ptr(), index, flag)) }
    }

    /// Get index of file by name
    pub fn get_index(&self, name: &CStr, flag: u32) -> ZResult<u64> {
        let res = unsafe { zip_name_locate(self.inner.as_ptr(), name.as_ptr(), flag) };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(res as _)
        }
    }

    /// Get number of files in archive
    pub fn num_entries(&self, flag: u32) -> u64 {
        // Safety: because of self.inner is `NonNull` pointer
        unsafe { zip_get_num_entries(self.inner.as_ptr(), flag) as _ }
    }

    /*
    pub fn source_file(&self, name: &CStr, start: u64, len: i64) -> ZResult<Source<&Self>> {
        let ptr = unsafe { zip_source_file(self.inner.as_ptr(), name.as_ptr(), start, len) };
        if ptr.is_null() {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(Source::from_ptr(ptr))
        }
    }
    */

    /// Add directory to zip archive
    pub fn dir_add(&self, name: &CStr, flag: u32) -> ZResult<u64> {
        let res = unsafe { zip_dir_add(self.inner.as_ptr(), name.as_ptr(), flag) };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(res as _)
        }
    }

    /// Get information about file
    pub fn stat_index(&self, index: u64, flag: u32) -> ZResult<Stat> {
        let mut stat = unsafe { zeroed() };
        let res = unsafe {
            zip_stat_init(&mut stat);
            zip_stat_index(self.inner.as_ptr(), index, flag, &mut stat)
        };
        if res == -1 {
            zip_err!(self.inner.as_ptr())
        } else {
            Ok(stat)
        }
    }

    /// Gets an iterator over the file entries of archive
    pub fn iter_file(&self, flag: u32) -> IterFile {
        IterFile {
            ptr: self.inner.as_ptr(),
            pos: 0,
            flag,
            _phantom_data: PhantomData,
        }
    }

    /// Gets an iterator over the item stat of archive
    pub fn iter_stat(&self, flag: u32) -> IterStat {
        IterStat {
            ptr: self.inner.as_ptr(),
            pos: 0,
            flag,
            _phantom_data: PhantomData,
        }
    }
}

// Using RAII, close and save zip in default.
impl Drop for Archive {
    fn drop(&mut self) {
        let r = unsafe { zip_close(self.inner.as_ptr()) };
        debug_assert!(r == 0);
    }
}

/// File item iterater struct
#[derive(Debug)]
pub struct IterFile<'a> {
    ptr: *mut zip_t,
    pos: u64,
    flag: u32,
    _phantom_data: PhantomData<&'a Archive>,
}

impl<'a> Iterator for IterFile<'a> {
    type Item = File<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        let res = unsafe { zip_fopen_index(self.ptr, self.pos, self.flag) };
        if res.is_null() {
            None
        } else {
            self.pos += 1;
            Some(File::from_ptr(res))
        }
    }
}

/// Stat item iterater struct
#[derive(Debug)]
pub struct IterStat<'a> {
    ptr: *mut zip_t,
    pos: u64,
    flag: u32,
    _phantom_data: PhantomData<&'a Archive>,
}

impl<'a> Iterator for IterStat<'a> {
    type Item = Stat;

    fn next(&mut self) -> Option<Self::Item> {
        unsafe {
            let mut stat = zeroed();
            zip_stat_init(&mut stat);
            let errno = zip_stat_index(self.ptr, self.pos, self.flag, &mut stat);
            if errno == -1 {
                None
            } else {
                self.pos += 1;
                Some(stat)
            }
        }
    }
}

/// Open archive with flags
#[derive(Debug)]
pub struct OpenOptions {
    inner: c_int,
}

impl OpenOptions {
    /// Open archive that edit at default
    pub fn new() -> Self {
        Self { inner: 0 }
    }

    /// Open archive read only
    pub fn rdonly(&mut self, flag: bool) -> &mut Self {
        if flag {
            self.inner |= ZIP_RDONLY;
        }
        self
    }

    /// If archive no exits, it will create a new archive
    pub fn create(&mut self, flag: bool) -> &mut Self {
        if flag {
            self.inner |= ZIP_CREATE;
        }
        self
    }

    /// If archive exits, it will return Error
    pub fn excl(&mut self, flag: bool) -> &mut Self {
        if flag {
            self.inner |= ZIP_EXCL;
        }
        self
    }

    /// Clear an exits archive
    pub fn truncate(&mut self, flag: bool) -> &mut Self {
        if flag {
            self.inner |= ZIP_TRUNCATE;
        }
        self
    }

    /// Consume the flag to open archive
    pub fn open(&self, path: &CStr) -> ZResult<Archive> {
        _open(path, self.inner)
    }
}

#[inline]
fn _open(path: &CStr, flag: c_int) -> ZResult<Archive> {
    unsafe {
        let mut errno = 0;
        let res = zip_open(path.as_ptr(), flag, &mut errno);
        if res.is_null() {
            Err(ZipErrorSys::from(errno).into())
        } else {
            Ok(Archive {
                inner: NonNull::new_unchecked(res),
            })
        }
    }
}

#[cfg(test)]
mod tests {
    use std::ffi::CString;

    use super::*;

    #[test]
    fn iter() {
        let name = CString::new("tests/test.zip").unwrap();
        let archive = Archive::open(&name).unwrap();

        let stats: Vec<_> = archive.iter_stat(ZIP_STAT_CRC).collect();

        let files: Vec<_> = archive.iter_file(ZIP_FL_COMPRESSED).collect();

        println!("{:?}", stats);
        println!("{:?}", files);
    }

    #[test]
    fn archive() {
        let name = CString::new("Hello").unwrap();
        let archive = OpenOptions::new().open(&name);
        assert!(archive.is_err());

        let name = CString::new("tests/test.zip").unwrap();
        let archive = OpenOptions::new().open(&name);
        assert!(archive.is_ok());

        let stat = archive.unwrap().stat_index(u64::MAX, ZIP_STAT_SIZE);
        assert!(stat.is_err());
    }
}