blob: e6b19e1f0be556f5404f98bbef9d8353a80ec301 [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright 2006 The Android Open Source Project
3 *
4 * Simple Zip archive support.
5 */
6#ifndef _MINZIP_ZIP
7#define _MINZIP_ZIP
8
9#include "inline_magic.h"
10
11#include <stdlib.h>
12#include <utime.h>
13
14#include "Hash.h"
15#include "SysUtil.h"
16
Doug Zongker28ce47c2011-10-28 10:33:05 -070017#ifdef __cplusplus
18extern "C" {
19#endif
20
Stephen Smalley779701d2012-02-09 14:13:23 -050021#include <selinux/selinux.h>
22#include <selinux/label.h>
Stephen Smalley779701d2012-02-09 14:13:23 -050023
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080024/*
25 * One entry in the Zip archive. Treat this as opaque -- use accessors below.
26 *
27 * TODO: we're now keeping the pages mapped so we don't have to copy the
28 * filename. We can change the accessors to retrieve the various pieces
29 * directly from the source file instead of copying them out, for a very
30 * slight speed hit and a modest reduction in memory usage.
31 */
32typedef struct ZipEntry {
33 unsigned int fileNameLen;
34 const char* fileName; // not null-terminated
caozhiyuan2584f9c2016-03-11 15:18:29 +080035 uint32_t offset;
36 uint32_t compLen;
37 uint32_t uncompLen;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080038 int compression;
39 long modTime;
40 long crc32;
41 int versionMadeBy;
42 long externalFileAttributes;
43} ZipEntry;
44
45/*
46 * One Zip archive. Treat as opaque.
47 */
48typedef struct ZipArchive {
Doug Zongker99916f02014-01-13 14:16:58 -080049 unsigned int numEntries;
50 ZipEntry* pEntries;
51 HashTable* pHash; // maps file name to ZipEntry
52 unsigned char* addr;
53 size_t length;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080054} ZipArchive;
55
56/*
57 * Represents a non-NUL-terminated string,
58 * which is how entry names are stored.
59 */
60typedef struct {
61 const char *str;
62 size_t len;
63} UnterminatedString;
64
65/*
66 * Open a Zip archive.
67 *
68 * On success, returns 0 and populates "pArchive". Returns nonzero errno
69 * value on failure.
70 */
Doug Zongker99916f02014-01-13 14:16:58 -080071int mzOpenZipArchive(unsigned char* addr, size_t length, ZipArchive* pArchive);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080072
73/*
74 * Close archive, releasing resources associated with it.
75 *
76 * Depending on the implementation this could unmap pages used by classes
77 * stored in a Jar. This should only be done after unloading classes.
78 */
79void mzCloseZipArchive(ZipArchive* pArchive);
80
81
82/*
83 * Find an entry in the Zip archive, by name.
84 */
85const ZipEntry* mzFindZipEntry(const ZipArchive* pArchive,
86 const char* entryName);
87
caozhiyuan2584f9c2016-03-11 15:18:29 +080088INLINE uint32_t mzGetZipEntryOffset(const ZipEntry* pEntry) {
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080089 return pEntry->offset;
90}
caozhiyuan2584f9c2016-03-11 15:18:29 +080091INLINE uint32_t mzGetZipEntryUncompLen(const ZipEntry* pEntry) {
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080092 return pEntry->uncompLen;
93}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080094
95/*
96 * Type definition for the callback function used by
97 * mzProcessZipEntryContents().
98 */
99typedef bool (*ProcessZipEntryContentsFunction)(const unsigned char *data,
100 int dataLen, void *cookie);
101
102/*
103 * Stream the uncompressed data through the supplied function,
104 * passing cookie to it each time it gets called. processFunction
105 * may be called more than once.
106 *
107 * If processFunction returns false, the operation is abandoned and
108 * mzProcessZipEntryContents() immediately returns false.
109 *
110 * This is useful for calculating the hash of an entry's uncompressed contents.
111 */
112bool mzProcessZipEntryContents(const ZipArchive *pArchive,
113 const ZipEntry *pEntry, ProcessZipEntryContentsFunction processFunction,
114 void *cookie);
115
116/*
117 * Read an entry into a buffer allocated by the caller.
118 */
119bool mzReadZipEntry(const ZipArchive* pArchive, const ZipEntry* pEntry,
120 char* buf, int bufLen);
121
122/*
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800123 * Inflate and write an entry to a file.
124 */
125bool mzExtractZipEntryToFile(const ZipArchive *pArchive,
Doug Zongker1c4ceae2009-05-08 09:43:28 -0700126 const ZipEntry *pEntry, int fd);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800127
128/*
Doug Zongker6aece332010-02-01 14:40:12 -0800129 * Inflate and write an entry to a memory buffer, which must be long
130 * enough to hold mzGetZipEntryUncomplen(pEntry) bytes.
131 */
132bool mzExtractZipEntryToBuffer(const ZipArchive *pArchive,
133 const ZipEntry *pEntry, unsigned char* buffer);
134
135/*
Narayan Kamath9c0f5d62015-02-23 14:09:31 +0000136 * Inflate all files under zipDir to the directory specified by
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800137 * targetDir, which must exist and be a writable directory.
138 *
Narayan Kamath9c0f5d62015-02-23 14:09:31 +0000139 * Directory entries and symlinks are not extracted.
140 *
141 *
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800142 * The immediate children of zipDir will become the immediate
143 * children of targetDir; e.g., if the archive contains the entries
144 *
145 * a/b/c/one
146 * a/b/c/two
147 * a/b/c/d/three
148 *
149 * and mzExtractRecursive(a, "a/b/c", "/tmp", ...) is called, the resulting
150 * files will be
151 *
152 * /tmp/one
153 * /tmp/two
154 * /tmp/d/three
155 *
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800156 * If timestamp is non-NULL, file timestamps will be set accordingly.
157 *
158 * If callback is non-NULL, it will be invoked with each unpacked file.
159 *
160 * Returns true on success, false on failure.
161 */
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800162bool mzExtractRecursive(const ZipArchive *pArchive,
163 const char *zipDir, const char *targetDir,
Narayan Kamath9c0f5d62015-02-23 14:09:31 +0000164 const struct utimbuf *timestamp,
Stephen Smalley779701d2012-02-09 14:13:23 -0500165 void (*callback)(const char *fn, void*), void *cookie,
166 struct selabel_handle *sehnd);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800167
Doug Zongker28ce47c2011-10-28 10:33:05 -0700168#ifdef __cplusplus
169}
170#endif
171
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800172#endif /*_MINZIP_ZIP*/