blob: fd89e9b63441c804375d367589290c88cc24700b [file] [log] [blame]
Just van Rossum52e14d62002-12-30 22:08:05 +00001#include "Python.h"
2#include "structmember.h"
3#include "osdefs.h"
4#include "marshal.h"
Just van Rossum52e14d62002-12-30 22:08:05 +00005#include <time.h>
6
7
8#define IS_SOURCE 0x0
9#define IS_BYTECODE 0x1
10#define IS_PACKAGE 0x2
11
12struct st_zip_searchorder {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000013 char suffix[14];
14 int type;
Just van Rossum52e14d62002-12-30 22:08:05 +000015};
16
17/* zip_searchorder defines how we search for a module in the Zip
18 archive: we first search for a package __init__, then for
19 non-package .pyc, .pyo and .py entries. The .pyc and .pyo entries
20 are swapped by initzipimport() if we run in optimized mode. Also,
21 '/' is replaced by SEP there. */
Neal Norwitz29fd2ba2003-03-23 13:21:03 +000022static struct st_zip_searchorder zip_searchorder[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000023 {"/__init__.pyc", IS_PACKAGE | IS_BYTECODE},
24 {"/__init__.pyo", IS_PACKAGE | IS_BYTECODE},
25 {"/__init__.py", IS_PACKAGE | IS_SOURCE},
26 {".pyc", IS_BYTECODE},
27 {".pyo", IS_BYTECODE},
28 {".py", IS_SOURCE},
29 {"", 0}
Just van Rossum52e14d62002-12-30 22:08:05 +000030};
31
32/* zipimporter object definition and support */
33
34typedef struct _zipimporter ZipImporter;
35
36struct _zipimporter {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 PyObject_HEAD
Victor Stinner9e40fad2010-10-18 22:34:46 +000038 PyObject *archive; /* pathname of the Zip archive,
39 decoded from the filesystem encoding */
Victor Stinner72f767e2010-10-18 11:44:21 +000040 PyObject *prefix; /* file prefix: "a/sub/directory/",
41 encoded to the filesystem encoding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000042 PyObject *files; /* dict with file info {path: toc_entry} */
Just van Rossum52e14d62002-12-30 22:08:05 +000043};
44
Just van Rossum52e14d62002-12-30 22:08:05 +000045static PyObject *ZipImportError;
Victor Stinnerc342fca2010-10-18 11:39:05 +000046/* read_directory() cache */
Just van Rossum52e14d62002-12-30 22:08:05 +000047static PyObject *zip_directory_cache = NULL;
48
49/* forward decls */
Victor Stinner2460a432010-08-16 17:54:28 +000050static PyObject *read_directory(PyObject *archive);
Victor Stinner60fe8d92010-08-16 23:48:11 +000051static PyObject *get_data(PyObject *archive, PyObject *toc_entry);
Victor Stinnerf6b563a2011-03-14 20:46:50 -040052static PyObject *get_module_code(ZipImporter *self, PyObject *fullname,
Victor Stinner08654e12010-10-18 12:09:02 +000053 int *p_ispackage, PyObject **p_modpath);
Just van Rossum52e14d62002-12-30 22:08:05 +000054
55
56#define ZipImporter_Check(op) PyObject_TypeCheck(op, &ZipImporter_Type)
57
58
59/* zipimporter.__init__
60 Split the "subdirectory" from the Zip archive path, lookup a matching
61 entry in sys.path_importer_cache, fetch the file directory from there
62 if found, or else read it from the archive. */
63static int
64zipimporter_init(ZipImporter *self, PyObject *args, PyObject *kwds)
65{
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010066 PyObject *path, *files, *tmp;
67 PyObject *filename = NULL;
68 Py_ssize_t len, flen;
69#ifdef ALTSEP
70 _Py_IDENTIFIER(replace);
71#endif
Just van Rossum52e14d62002-12-30 22:08:05 +000072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000073 if (!_PyArg_NoKeywords("zipimporter()", kwds))
74 return -1;
Georg Brandl02c42872005-08-26 06:42:30 +000075
Victor Stinner2b8dab72010-08-14 14:54:10 +000076 if (!PyArg_ParseTuple(args, "O&:zipimporter",
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010077 PyUnicode_FSDecoder, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 return -1;
Just van Rossum52e14d62002-12-30 22:08:05 +000079
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010080 if (PyUnicode_READY(path) == -1)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +020081 return -1;
82
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010083 len = PyUnicode_GET_LENGTH(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000084 if (len == 0) {
85 PyErr_SetString(ZipImportError, "archive path is empty");
Victor Stinner2b8dab72010-08-14 14:54:10 +000086 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 }
Just van Rossum52e14d62002-12-30 22:08:05 +000088
89#ifdef ALTSEP
Martin v. Löwiscfa61292011-10-31 09:01:22 +010090 tmp = _PyObject_CallMethodId(path, &PyId_replace, "CC", ALTSEP, SEP);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010091 if (!tmp)
92 goto error;
93 Py_DECREF(path);
94 path = tmp;
Just van Rossum52e14d62002-12-30 22:08:05 +000095#endif
96
Martin v. Löwisa72e78b2011-10-31 08:33:37 +010097 filename = path;
98 Py_INCREF(filename);
99 flen = len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 for (;;) {
101 struct stat statbuf;
102 int rv;
Just van Rossum52e14d62002-12-30 22:08:05 +0000103
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100104 rv = _Py_stat(filename, &statbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 if (rv == 0) {
106 /* it exists */
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100107 if (!S_ISREG(statbuf.st_mode))
108 /* it's a not file */
109 Py_CLEAR(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 break;
111 }
Victor Stinner2b8dab72010-08-14 14:54:10 +0000112 else if (PyErr_Occurred())
113 goto error;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100114 Py_CLEAR(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 /* back up one path element */
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100116 flen = PyUnicode_FindChar(path, SEP, 0, flen, -1);
117 if (flen == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 break;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100119 filename = PyUnicode_Substring(path, 0, flen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 }
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100121 if (filename == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 PyErr_SetString(ZipImportError, "not a Zip file");
Victor Stinner2b8dab72010-08-14 14:54:10 +0000123 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000125
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100126 if (PyUnicode_READY(filename) < 0)
127 goto error;
128
129 files = PyDict_GetItem(zip_directory_cache, filename);
Victor Stinner2b8dab72010-08-14 14:54:10 +0000130 if (files == NULL) {
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100131 files = read_directory(filename);
Victor Stinner2b8dab72010-08-14 14:54:10 +0000132 if (files == NULL)
133 goto error;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100134 if (PyDict_SetItem(zip_directory_cache, filename, files) != 0)
Victor Stinner2b8dab72010-08-14 14:54:10 +0000135 goto error;
136 }
137 else
138 Py_INCREF(files);
139 self->files = files;
140
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100141 /* Transfer reference */
142 self->archive = filename;
143 filename = NULL;
Victor Stinner2b8dab72010-08-14 14:54:10 +0000144
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100145 /* Check if there is a prefix directory following the filename. */
146 if (flen != len) {
147 tmp = PyUnicode_Substring(path, flen+1,
148 PyUnicode_GET_LENGTH(path));
149 if (tmp == NULL)
150 goto error;
151 self->prefix = tmp;
152 if (PyUnicode_READ_CHAR(path, len-1) != SEP) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 /* add trailing SEP */
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100154 tmp = PyUnicode_FromFormat("%U%c", self->prefix, SEP);
155 if (tmp == NULL)
156 goto error;
157 Py_DECREF(self->prefix);
158 self->prefix = tmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000159 }
160 }
Victor Stinner2b8dab72010-08-14 14:54:10 +0000161 else
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100162 self->prefix = PyUnicode_New(0, 0);
163 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 return 0;
Victor Stinner2b8dab72010-08-14 14:54:10 +0000165
166error:
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100167 Py_DECREF(path);
168 Py_XDECREF(filename);
Victor Stinner2b8dab72010-08-14 14:54:10 +0000169 return -1;
Just van Rossum52e14d62002-12-30 22:08:05 +0000170}
171
172/* GC support. */
173static int
174zipimporter_traverse(PyObject *obj, visitproc visit, void *arg)
175{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 ZipImporter *self = (ZipImporter *)obj;
177 Py_VISIT(self->files);
178 return 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000179}
180
181static void
182zipimporter_dealloc(ZipImporter *self)
183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 PyObject_GC_UnTrack(self);
185 Py_XDECREF(self->archive);
186 Py_XDECREF(self->prefix);
187 Py_XDECREF(self->files);
188 Py_TYPE(self)->tp_free((PyObject *)self);
Just van Rossum52e14d62002-12-30 22:08:05 +0000189}
190
191static PyObject *
192zipimporter_repr(ZipImporter *self)
193{
Victor Stinner028dd972010-08-17 00:04:48 +0000194 if (self->archive == NULL)
195 return PyUnicode_FromString("<zipimporter object \"???\">");
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200196 else if (self->prefix != NULL && PyUnicode_GET_LENGTH(self->prefix) != 0)
Victor Stinner07298a12010-10-18 22:45:54 +0000197 return PyUnicode_FromFormat("<zipimporter object \"%U%c%U\">",
Victor Stinner028dd972010-08-17 00:04:48 +0000198 self->archive, SEP, self->prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 else
Victor Stinner07298a12010-10-18 22:45:54 +0000200 return PyUnicode_FromFormat("<zipimporter object \"%U\">",
Victor Stinner028dd972010-08-17 00:04:48 +0000201 self->archive);
Just van Rossum52e14d62002-12-30 22:08:05 +0000202}
203
204/* return fullname.split(".")[-1] */
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400205static PyObject *
206get_subname(PyObject *fullname)
Just van Rossum52e14d62002-12-30 22:08:05 +0000207{
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100208 Py_ssize_t len, dot;
209 if (PyUnicode_READY(fullname) < 0)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200210 return NULL;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100211 len = PyUnicode_GET_LENGTH(fullname);
212 dot = PyUnicode_FindChar(fullname, '.', 0, len, -1);
213 if (dot == -1) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400214 Py_INCREF(fullname);
215 return fullname;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100216 } else
217 return PyUnicode_Substring(fullname, dot+1, len);
Just van Rossum52e14d62002-12-30 22:08:05 +0000218}
219
220/* Given a (sub)modulename, write the potential file path in the
221 archive (without extension) to the path buffer. Return the
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400222 length of the resulting string.
223
224 return self.prefix + name.replace('.', os.sep) */
225static PyObject*
226make_filename(PyObject *prefix, PyObject *name)
Just van Rossum52e14d62002-12-30 22:08:05 +0000227{
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400228 PyObject *pathobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200229 Py_UCS4 *p, *buf;
230 Py_ssize_t len;
Just van Rossum52e14d62002-12-30 22:08:05 +0000231
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200232 len = PyUnicode_GET_LENGTH(prefix) + PyUnicode_GET_LENGTH(name) + 1;
233 p = buf = PyMem_Malloc(sizeof(Py_UCS4) * len);
234 if (buf == NULL) {
235 PyErr_NoMemory();
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400236 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200237 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000238
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200239 if (!PyUnicode_AsUCS4(prefix, p, len, 0))
240 return NULL;
241 p += PyUnicode_GET_LENGTH(prefix);
242 len -= PyUnicode_GET_LENGTH(prefix);
243 if (!PyUnicode_AsUCS4(name, p, len, 1))
244 return NULL;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400245 for (; *p; p++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 if (*p == '.')
247 *p = SEP;
248 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200249 pathobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
250 buf, p-buf);
251 PyMem_Free(buf);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400252 return pathobj;
Just van Rossum52e14d62002-12-30 22:08:05 +0000253}
254
Raymond Hettinger2c45c9a2004-11-10 13:08:35 +0000255enum zi_module_info {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 MI_ERROR,
257 MI_NOT_FOUND,
258 MI_MODULE,
259 MI_PACKAGE
Just van Rossum52e14d62002-12-30 22:08:05 +0000260};
261
262/* Return some information about a module. */
Raymond Hettinger2c45c9a2004-11-10 13:08:35 +0000263static enum zi_module_info
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400264get_module_info(ZipImporter *self, PyObject *fullname)
Just van Rossum52e14d62002-12-30 22:08:05 +0000265{
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400266 PyObject *subname;
267 PyObject *path, *fullpath, *item;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 struct st_zip_searchorder *zso;
Just van Rossum52e14d62002-12-30 22:08:05 +0000269
Victor Stinner965a8a12010-10-18 21:44:33 +0000270 subname = get_subname(fullname);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400271 if (subname == NULL)
272 return MI_ERROR;
Just van Rossum52e14d62002-12-30 22:08:05 +0000273
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400274 path = make_filename(self->prefix, subname);
275 Py_DECREF(subname);
276 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 return MI_ERROR;
Just van Rossum52e14d62002-12-30 22:08:05 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 for (zso = zip_searchorder; *zso->suffix; zso++) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400280 fullpath = PyUnicode_FromFormat("%U%s", path, zso->suffix);
281 if (fullpath == NULL) {
282 Py_DECREF(path);
283 return MI_ERROR;
284 }
285 item = PyDict_GetItem(self->files, fullpath);
286 Py_DECREF(fullpath);
287 if (item != NULL) {
288 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 if (zso->type & IS_PACKAGE)
290 return MI_PACKAGE;
291 else
292 return MI_MODULE;
293 }
294 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400295 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296 return MI_NOT_FOUND;
Just van Rossum52e14d62002-12-30 22:08:05 +0000297}
298
299/* Check whether we can satisfy the import of the module named by
300 'fullname'. Return self if we can, None if we can't. */
301static PyObject *
302zipimporter_find_module(PyObject *obj, PyObject *args)
303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 ZipImporter *self = (ZipImporter *)obj;
305 PyObject *path = NULL;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400306 PyObject *fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 enum zi_module_info mi;
Just van Rossum52e14d62002-12-30 22:08:05 +0000308
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400309 if (!PyArg_ParseTuple(args, "U|O:zipimporter.find_module",
Victor Stinner965a8a12010-10-18 21:44:33 +0000310 &fullname, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 mi = get_module_info(self, fullname);
314 if (mi == MI_ERROR)
315 return NULL;
316 if (mi == MI_NOT_FOUND) {
317 Py_INCREF(Py_None);
318 return Py_None;
319 }
320 Py_INCREF(self);
321 return (PyObject *)self;
Just van Rossum52e14d62002-12-30 22:08:05 +0000322}
323
324/* Load and return the module named by 'fullname'. */
325static PyObject *
326zipimporter_load_module(PyObject *obj, PyObject *args)
327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 ZipImporter *self = (ZipImporter *)obj;
Victor Stinner26fabe12010-10-18 12:03:25 +0000329 PyObject *code = NULL, *mod, *dict;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400330 PyObject *fullname;
331 PyObject *modpath = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 int ispackage;
Just van Rossum52e14d62002-12-30 22:08:05 +0000333
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400334 if (!PyArg_ParseTuple(args, "U:zipimporter.load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 &fullname))
336 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200337 if (PyUnicode_READY(fullname) == -1)
338 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 code = get_module_code(self, fullname, &ispackage, &modpath);
341 if (code == NULL)
Victor Stinner26fabe12010-10-18 12:03:25 +0000342 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000343
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400344 mod = PyImport_AddModuleObject(fullname);
Victor Stinner26fabe12010-10-18 12:03:25 +0000345 if (mod == NULL)
346 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 dict = PyModule_GetDict(mod);
Just van Rossum52e14d62002-12-30 22:08:05 +0000348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 /* mod.__loader__ = self */
350 if (PyDict_SetItemString(dict, "__loader__", (PyObject *)self) != 0)
351 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 if (ispackage) {
354 /* add __path__ to the module *before* the code gets
355 executed */
356 PyObject *pkgpath, *fullpath;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400357 PyObject *subname = get_subname(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 int err;
Just van Rossum52e14d62002-12-30 22:08:05 +0000359
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400360 fullpath = PyUnicode_FromFormat("%U%c%U%U",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 self->archive, SEP,
362 self->prefix, subname);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400363 Py_DECREF(subname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 if (fullpath == NULL)
365 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000366
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400367 pkgpath = Py_BuildValue("[N]", fullpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 if (pkgpath == NULL)
369 goto error;
370 err = PyDict_SetItemString(dict, "__path__", pkgpath);
371 Py_DECREF(pkgpath);
372 if (err != 0)
373 goto error;
374 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400375 mod = PyImport_ExecCodeModuleObject(fullname, code, modpath, NULL);
Victor Stinner26fabe12010-10-18 12:03:25 +0000376 Py_CLEAR(code);
377 if (mod == NULL)
378 goto error;
379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 if (Py_VerboseFlag)
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400381 PySys_FormatStderr("import %U # loaded from Zip %U\n",
Victor Stinner08654e12010-10-18 12:09:02 +0000382 fullname, modpath);
383 Py_DECREF(modpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 return mod;
Just van Rossum52e14d62002-12-30 22:08:05 +0000385error:
Victor Stinner26fabe12010-10-18 12:03:25 +0000386 Py_XDECREF(code);
Victor Stinner08654e12010-10-18 12:09:02 +0000387 Py_XDECREF(modpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000389}
390
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000391/* Return a string matching __file__ for the named module */
392static PyObject *
393zipimporter_get_filename(PyObject *obj, PyObject *args)
394{
395 ZipImporter *self = (ZipImporter *)obj;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400396 PyObject *fullname, *code, *modpath;
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000397 int ispackage;
398
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400399 if (!PyArg_ParseTuple(args, "U:zipimporter.get_filename",
Victor Stinner9e40fad2010-10-18 22:34:46 +0000400 &fullname))
Victor Stinnerc342fca2010-10-18 11:39:05 +0000401 return NULL;
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000402
403 /* Deciding the filename requires working out where the code
404 would come from if the module was actually loaded */
405 code = get_module_code(self, fullname, &ispackage, &modpath);
406 if (code == NULL)
Victor Stinnerc342fca2010-10-18 11:39:05 +0000407 return NULL;
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000408 Py_DECREF(code); /* Only need the path info */
409
Victor Stinner08654e12010-10-18 12:09:02 +0000410 return modpath;
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000411}
412
Just van Rossum52e14d62002-12-30 22:08:05 +0000413/* Return a bool signifying whether the module is a package or not. */
414static PyObject *
415zipimporter_is_package(PyObject *obj, PyObject *args)
416{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 ZipImporter *self = (ZipImporter *)obj;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400418 PyObject *fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 enum zi_module_info mi;
Just van Rossum52e14d62002-12-30 22:08:05 +0000420
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400421 if (!PyArg_ParseTuple(args, "U:zipimporter.is_package",
Victor Stinner965a8a12010-10-18 21:44:33 +0000422 &fullname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 mi = get_module_info(self, fullname);
426 if (mi == MI_ERROR)
Victor Stinner965a8a12010-10-18 21:44:33 +0000427 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 if (mi == MI_NOT_FOUND) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400429 PyErr_Format(ZipImportError, "can't find module %R", fullname);
Victor Stinner965a8a12010-10-18 21:44:33 +0000430 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 }
432 return PyBool_FromLong(mi == MI_PACKAGE);
Just van Rossum52e14d62002-12-30 22:08:05 +0000433}
434
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200435
Just van Rossum52e14d62002-12-30 22:08:05 +0000436static PyObject *
437zipimporter_get_data(PyObject *obj, PyObject *args)
438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 ZipImporter *self = (ZipImporter *)obj;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100440 PyObject *path, *key;
Just van Rossum52e14d62002-12-30 22:08:05 +0000441#ifdef ALTSEP
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100442 _Py_IDENTIFIER(replace);
Just van Rossum52e14d62002-12-30 22:08:05 +0000443#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 PyObject *toc_entry;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100445 Py_ssize_t path_start, path_len, len;
Just van Rossum52e14d62002-12-30 22:08:05 +0000446
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100447 if (!PyArg_ParseTuple(args, "U:zipimporter.get_data", &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000449
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200450#ifdef ALTSEP
Martin v. Löwiscfa61292011-10-31 09:01:22 +0100451 path = _PyObject_CallMethodId(path, &PyId_replace, "CC", ALTSEP, SEP);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100452 if (!path)
453 return NULL;
454#else
455 Py_INCREF(path);
Just van Rossum52e14d62002-12-30 22:08:05 +0000456#endif
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100457 if (PyUnicode_READY(path) == -1)
458 goto error;
459
460 path_len = PyUnicode_GET_LENGTH(path);
461
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200462 len = PyUnicode_GET_LENGTH(self->archive);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100463 path_start = 0;
464 if (PyUnicode_Tailmatch(path, self->archive, 0, len, -1)
465 && PyUnicode_READ_CHAR(path, len) == SEP) {
466 path_start = len + 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000468
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100469 key = PyUnicode_Substring(path, path_start, path_len);
Victor Stinner60fe8d92010-08-16 23:48:11 +0000470 if (key == NULL)
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100471 goto error;
Victor Stinner60fe8d92010-08-16 23:48:11 +0000472 toc_entry = PyDict_GetItem(self->files, key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 if (toc_entry == NULL) {
Victor Stinner60fe8d92010-08-16 23:48:11 +0000474 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, key);
475 Py_DECREF(key);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100476 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 }
Victor Stinner60fe8d92010-08-16 23:48:11 +0000478 Py_DECREF(key);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100479 Py_DECREF(path);
Victor Stinner60fe8d92010-08-16 23:48:11 +0000480 return get_data(self->archive, toc_entry);
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100481 error:
482 Py_DECREF(path);
483 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000484}
485
486static PyObject *
487zipimporter_get_code(PyObject *obj, PyObject *args)
488{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 ZipImporter *self = (ZipImporter *)obj;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400490 PyObject *fullname;
Just van Rossum52e14d62002-12-30 22:08:05 +0000491
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400492 if (!PyArg_ParseTuple(args, "U:zipimporter.get_code", &fullname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 return get_module_code(self, fullname, NULL, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +0000496}
497
498static PyObject *
499zipimporter_get_source(PyObject *obj, PyObject *args)
500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000501 ZipImporter *self = (ZipImporter *)obj;
502 PyObject *toc_entry;
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400503 PyObject *fullname, *subname, *path, *fullpath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 enum zi_module_info mi;
Just van Rossum52e14d62002-12-30 22:08:05 +0000505
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400506 if (!PyArg_ParseTuple(args, "U:zipimporter.get_source", &fullname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 mi = get_module_info(self, fullname);
Victor Stinner965a8a12010-10-18 21:44:33 +0000510 if (mi == MI_ERROR)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 return NULL;
Victor Stinner04106562010-10-18 20:44:08 +0000512 if (mi == MI_NOT_FOUND) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400513 PyErr_Format(ZipImportError, "can't find module %R", fullname);
Victor Stinner04106562010-10-18 20:44:08 +0000514 return NULL;
515 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400516
Victor Stinner965a8a12010-10-18 21:44:33 +0000517 subname = get_subname(fullname);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400518 if (subname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000520
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400521 path = make_filename(self->prefix, subname);
522 Py_DECREF(subname);
523 if (path == NULL)
524 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000525
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400526 if (mi == MI_PACKAGE)
527 fullpath = PyUnicode_FromFormat("%U%c__init__.py", path, SEP);
528 else
529 fullpath = PyUnicode_FromFormat("%U.py", path);
530 Py_DECREF(path);
531 if (fullpath == NULL)
532 return NULL;
533
534 toc_entry = PyDict_GetItem(self->files, fullpath);
535 Py_DECREF(fullpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 if (toc_entry != NULL) {
Victor Stinner60fe8d92010-08-16 23:48:11 +0000537 PyObject *res, *bytes;
538 bytes = get_data(self->archive, toc_entry);
539 if (bytes == NULL)
540 return NULL;
541 res = PyUnicode_FromStringAndSize(PyBytes_AS_STRING(bytes),
542 PyBytes_GET_SIZE(bytes));
543 Py_DECREF(bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 return res;
545 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 /* we have the module, but no source */
548 Py_INCREF(Py_None);
549 return Py_None;
Just van Rossum52e14d62002-12-30 22:08:05 +0000550}
551
552PyDoc_STRVAR(doc_find_module,
553"find_module(fullname, path=None) -> self or None.\n\
554\n\
555Search for a module specified by 'fullname'. 'fullname' must be the\n\
556fully qualified (dotted) module name. It returns the zipimporter\n\
557instance itself if the module was found, or None if it wasn't.\n\
558The optional 'path' argument is ignored -- it's there for compatibility\n\
559with the importer protocol.");
560
561PyDoc_STRVAR(doc_load_module,
562"load_module(fullname) -> module.\n\
563\n\
564Load the module specified by 'fullname'. 'fullname' must be the\n\
565fully qualified (dotted) module name. It returns the imported\n\
566module, or raises ZipImportError if it wasn't found.");
567
568PyDoc_STRVAR(doc_get_data,
569"get_data(pathname) -> string with file data.\n\
570\n\
571Return the data associated with 'pathname'. Raise IOError if\n\
572the file wasn't found.");
573
574PyDoc_STRVAR(doc_is_package,
575"is_package(fullname) -> bool.\n\
576\n\
577Return True if the module specified by fullname is a package.\n\
Brian Curtin32839732010-07-21 01:44:19 +0000578Raise ZipImportError if the module couldn't be found.");
Just van Rossum52e14d62002-12-30 22:08:05 +0000579
580PyDoc_STRVAR(doc_get_code,
581"get_code(fullname) -> code object.\n\
582\n\
583Return the code object for the specified module. Raise ZipImportError\n\
Brian Curtin32839732010-07-21 01:44:19 +0000584if the module couldn't be found.");
Just van Rossum52e14d62002-12-30 22:08:05 +0000585
586PyDoc_STRVAR(doc_get_source,
587"get_source(fullname) -> source string.\n\
588\n\
589Return the source code for the specified module. Raise ZipImportError\n\
Brian Curtin32839732010-07-21 01:44:19 +0000590if the module couldn't be found, return None if the archive does\n\
Just van Rossum52e14d62002-12-30 22:08:05 +0000591contain the module, but has no source for it.");
592
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000593
594PyDoc_STRVAR(doc_get_filename,
Nick Coghlan9a1d6e32009-02-08 03:37:27 +0000595"get_filename(fullname) -> filename string.\n\
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000596\n\
597Return the filename for the specified module.");
598
Just van Rossum52e14d62002-12-30 22:08:05 +0000599static PyMethodDef zipimporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 {"find_module", zipimporter_find_module, METH_VARARGS,
601 doc_find_module},
602 {"load_module", zipimporter_load_module, METH_VARARGS,
603 doc_load_module},
604 {"get_data", zipimporter_get_data, METH_VARARGS,
605 doc_get_data},
606 {"get_code", zipimporter_get_code, METH_VARARGS,
607 doc_get_code},
608 {"get_source", zipimporter_get_source, METH_VARARGS,
609 doc_get_source},
610 {"get_filename", zipimporter_get_filename, METH_VARARGS,
611 doc_get_filename},
612 {"is_package", zipimporter_is_package, METH_VARARGS,
613 doc_is_package},
614 {NULL, NULL} /* sentinel */
Just van Rossum52e14d62002-12-30 22:08:05 +0000615};
616
617static PyMemberDef zipimporter_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 {"archive", T_OBJECT, offsetof(ZipImporter, archive), READONLY},
619 {"prefix", T_OBJECT, offsetof(ZipImporter, prefix), READONLY},
620 {"_files", T_OBJECT, offsetof(ZipImporter, files), READONLY},
621 {NULL}
Just van Rossum52e14d62002-12-30 22:08:05 +0000622};
623
624PyDoc_STRVAR(zipimporter_doc,
625"zipimporter(archivepath) -> zipimporter object\n\
626\n\
627Create a new zipimporter instance. 'archivepath' must be a path to\n\
Alexandre Vassalotti8ae3e052008-05-16 00:41:41 +0000628a zipfile, or to a specific path inside a zipfile. For example, it can be\n\
629'/tmp/myimport.zip', or '/tmp/myimport.zip/mydirectory', if mydirectory is a\n\
630valid directory inside the archive.\n\
631\n\
632'ZipImportError is raised if 'archivepath' doesn't point to a valid Zip\n\
633archive.\n\
634\n\
635The 'archive' attribute of zipimporter objects contains the name of the\n\
636zipfile targeted.");
Just van Rossum52e14d62002-12-30 22:08:05 +0000637
638#define DEFERRED_ADDRESS(ADDR) 0
639
640static PyTypeObject ZipImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 PyVarObject_HEAD_INIT(DEFERRED_ADDRESS(&PyType_Type), 0)
642 "zipimport.zipimporter",
643 sizeof(ZipImporter),
644 0, /* tp_itemsize */
645 (destructor)zipimporter_dealloc, /* tp_dealloc */
646 0, /* tp_print */
647 0, /* tp_getattr */
648 0, /* tp_setattr */
649 0, /* tp_reserved */
650 (reprfunc)zipimporter_repr, /* tp_repr */
651 0, /* tp_as_number */
652 0, /* tp_as_sequence */
653 0, /* tp_as_mapping */
654 0, /* tp_hash */
655 0, /* tp_call */
656 0, /* tp_str */
657 PyObject_GenericGetAttr, /* tp_getattro */
658 0, /* tp_setattro */
659 0, /* tp_as_buffer */
660 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
661 Py_TPFLAGS_HAVE_GC, /* tp_flags */
662 zipimporter_doc, /* tp_doc */
663 zipimporter_traverse, /* tp_traverse */
664 0, /* tp_clear */
665 0, /* tp_richcompare */
666 0, /* tp_weaklistoffset */
667 0, /* tp_iter */
668 0, /* tp_iternext */
669 zipimporter_methods, /* tp_methods */
670 zipimporter_members, /* tp_members */
671 0, /* tp_getset */
672 0, /* tp_base */
673 0, /* tp_dict */
674 0, /* tp_descr_get */
675 0, /* tp_descr_set */
676 0, /* tp_dictoffset */
677 (initproc)zipimporter_init, /* tp_init */
678 PyType_GenericAlloc, /* tp_alloc */
679 PyType_GenericNew, /* tp_new */
680 PyObject_GC_Del, /* tp_free */
Just van Rossum52e14d62002-12-30 22:08:05 +0000681};
682
683
684/* implementation */
685
Just van Rossum52e14d62002-12-30 22:08:05 +0000686/* Given a buffer, return the long that is represented by the first
687 4 bytes, encoded as little endian. This partially reimplements
688 marshal.c:r_long() */
689static long
690get_long(unsigned char *buf) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 long x;
692 x = buf[0];
693 x |= (long)buf[1] << 8;
694 x |= (long)buf[2] << 16;
695 x |= (long)buf[3] << 24;
Just van Rossum52e14d62002-12-30 22:08:05 +0000696#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 /* Sign extension for 64-bit machines */
698 x |= -(x & 0x80000000L);
Just van Rossum52e14d62002-12-30 22:08:05 +0000699#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 return x;
Just van Rossum52e14d62002-12-30 22:08:05 +0000701}
702
703/*
704 read_directory(archive) -> files dict (new reference)
705
706 Given a path to a Zip archive, build a dict, mapping file names
707 (local to the archive, using SEP as a separator) to toc entries.
708
709 A toc_entry is a tuple:
710
Victor Stinner08654e12010-10-18 12:09:02 +0000711 (__file__, # value to use for __file__, available for all files,
712 # encoded to the filesystem encoding
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 compress, # compression kind; 0 for uncompressed
714 data_size, # size of compressed data on disk
715 file_size, # size of decompressed data
716 file_offset, # offset of file header from start of archive
717 time, # mod time of file (in dos format)
718 date, # mod data of file (in dos format)
719 crc, # crc checksum of the data
Victor Stinnerc342fca2010-10-18 11:39:05 +0000720 )
Just van Rossum52e14d62002-12-30 22:08:05 +0000721
722 Directories can be recognized by the trailing SEP in the name,
723 data_size and file_offset are 0.
724*/
725static PyObject *
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400726read_directory(PyObject *archive)
Just van Rossum52e14d62002-12-30 22:08:05 +0000727{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 PyObject *files = NULL;
729 FILE *fp;
Victor Stinnerd36c8212010-10-18 12:13:46 +0000730 unsigned short flags;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 long compress, crc, data_size, file_size, file_offset, date, time;
732 long header_offset, name_size, header_size, header_position;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200733 long l, count;
734 Py_ssize_t i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 char name[MAXPATHLEN + 5];
Victor Stinner2460a432010-08-16 17:54:28 +0000736 PyObject *nameobj = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 char *p, endof_central_dir[22];
738 long arc_offset; /* offset from beginning of file to start of zip-archive */
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100739 PyObject *path;
Victor Stinnerd36c8212010-10-18 12:13:46 +0000740 const char *charset;
Victor Stinner4ee65a92011-01-22 10:30:29 +0000741 int bootstrap;
Just van Rossum52e14d62002-12-30 22:08:05 +0000742
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400743 fp = _Py_fopen(archive, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 if (fp == NULL) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400745 PyErr_Format(ZipImportError, "can't open Zip file: %R", archive);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 return NULL;
747 }
748 fseek(fp, -22, SEEK_END);
749 header_position = ftell(fp);
750 if (fread(endof_central_dir, 1, 22, fp) != 22) {
751 fclose(fp);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400752 PyErr_Format(ZipImportError, "can't read Zip file: %R", archive);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 return NULL;
754 }
755 if (get_long((unsigned char *)endof_central_dir) != 0x06054B50) {
756 /* Bad: End of Central Dir signature */
757 fclose(fp);
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400758 PyErr_Format(ZipImportError, "not a Zip file: %R", archive);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 return NULL;
760 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 header_size = get_long((unsigned char *)endof_central_dir + 12);
763 header_offset = get_long((unsigned char *)endof_central_dir + 16);
764 arc_offset = header_position - header_offset - header_size;
765 header_offset += arc_offset;
Just van Rossum52e14d62002-12-30 22:08:05 +0000766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 files = PyDict_New();
768 if (files == NULL)
769 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 /* Start of Central Directory */
772 count = 0;
773 for (;;) {
774 PyObject *t;
775 int err;
Just van Rossum52e14d62002-12-30 22:08:05 +0000776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 fseek(fp, header_offset, 0); /* Start of file header */
778 l = PyMarshal_ReadLongFromFile(fp);
779 if (l != 0x02014B50)
780 break; /* Bad: Central Dir File Header */
Victor Stinnerd36c8212010-10-18 12:13:46 +0000781 fseek(fp, header_offset + 8, 0);
782 flags = (unsigned short)PyMarshal_ReadShortFromFile(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 compress = PyMarshal_ReadShortFromFile(fp);
784 time = PyMarshal_ReadShortFromFile(fp);
785 date = PyMarshal_ReadShortFromFile(fp);
786 crc = PyMarshal_ReadLongFromFile(fp);
787 data_size = PyMarshal_ReadLongFromFile(fp);
788 file_size = PyMarshal_ReadLongFromFile(fp);
789 name_size = PyMarshal_ReadShortFromFile(fp);
790 header_size = 46 + name_size +
791 PyMarshal_ReadShortFromFile(fp) +
792 PyMarshal_ReadShortFromFile(fp);
793 fseek(fp, header_offset + 42, 0);
794 file_offset = PyMarshal_ReadLongFromFile(fp) + arc_offset;
795 if (name_size > MAXPATHLEN)
796 name_size = MAXPATHLEN;
Just van Rossum52e14d62002-12-30 22:08:05 +0000797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 p = name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200799 for (i = 0; i < (Py_ssize_t)name_size; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 *p = (char)getc(fp);
801 if (*p == '/')
802 *p = SEP;
803 p++;
804 }
805 *p = 0; /* Add terminating null byte */
806 header_offset += header_size;
Just van Rossum52e14d62002-12-30 22:08:05 +0000807
Victor Stinner4ee65a92011-01-22 10:30:29 +0000808 bootstrap = 0;
Victor Stinnerd36c8212010-10-18 12:13:46 +0000809 if (flags & 0x0800)
810 charset = "utf-8";
Victor Stinner4ee65a92011-01-22 10:30:29 +0000811 else if (!PyThreadState_GET()->interp->codecs_initialized) {
812 /* During bootstrap, we may need to load the encodings
813 package from a ZIP file. But the cp437 encoding is implemented
814 in Python in the encodings package.
815
816 Break out of this dependency by assuming that the path to
817 the encodings module is ASCII-only. */
818 charset = "ascii";
819 bootstrap = 1;
820 }
Victor Stinnerd36c8212010-10-18 12:13:46 +0000821 else
822 charset = "cp437";
823 nameobj = PyUnicode_Decode(name, name_size, charset, NULL);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200824 if (PyUnicode_READY(nameobj) == -1)
825 goto error;
Victor Stinner4ee65a92011-01-22 10:30:29 +0000826 if (nameobj == NULL) {
827 if (bootstrap)
828 PyErr_Format(PyExc_NotImplementedError,
829 "bootstrap issue: python%i%i.zip contains non-ASCII "
830 "filenames without the unicode flag",
831 PY_MAJOR_VERSION, PY_MINOR_VERSION);
Victor Stinner2460a432010-08-16 17:54:28 +0000832 goto error;
Victor Stinner4ee65a92011-01-22 10:30:29 +0000833 }
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100834 path = PyUnicode_FromFormat("%U%c%U", archive, SEP, nameobj);
835 if (path == NULL)
Victor Stinner2460a432010-08-16 17:54:28 +0000836 goto error;
Martin v. Löwisa72e78b2011-10-31 08:33:37 +0100837 t = Py_BuildValue("Niiiiiii", path, compress, data_size,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 file_size, file_offset, time, date, crc);
839 if (t == NULL)
840 goto error;
Victor Stinner2460a432010-08-16 17:54:28 +0000841 err = PyDict_SetItem(files, nameobj, t);
842 Py_CLEAR(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 Py_DECREF(t);
844 if (err != 0)
845 goto error;
846 count++;
847 }
848 fclose(fp);
849 if (Py_VerboseFlag)
Victor Stinnerf6b563a2011-03-14 20:46:50 -0400850 PySys_FormatStderr("# zipimport: found %ld names in %R\n",
851 count, archive);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 return files;
Just van Rossum52e14d62002-12-30 22:08:05 +0000853error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 fclose(fp);
855 Py_XDECREF(files);
Victor Stinner2460a432010-08-16 17:54:28 +0000856 Py_XDECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000858}
859
860/* Return the zlib.decompress function object, or NULL if zlib couldn't
861 be imported. The function is cached when found, so subsequent calls
Victor Stinner4925cde2011-05-20 00:16:09 +0200862 don't import zlib again. */
Just van Rossum52e14d62002-12-30 22:08:05 +0000863static PyObject *
864get_decompress_func(void)
865{
Victor Stinner4925cde2011-05-20 00:16:09 +0200866 static int importing_zlib = 0;
867 PyObject *zlib;
868 PyObject *decompress;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200869 _Py_IDENTIFIER(decompress);
Just van Rossum52e14d62002-12-30 22:08:05 +0000870
Victor Stinner4925cde2011-05-20 00:16:09 +0200871 if (importing_zlib != 0)
872 /* Someone has a zlib.py[co] in their Zip file;
873 let's avoid a stack overflow. */
874 return NULL;
875 importing_zlib = 1;
876 zlib = PyImport_ImportModuleNoBlock("zlib");
877 importing_zlib = 0;
878 if (zlib != NULL) {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200879 decompress = _PyObject_GetAttrId(zlib,
880 &PyId_decompress);
Victor Stinner4925cde2011-05-20 00:16:09 +0200881 Py_DECREF(zlib);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 }
Victor Stinner4925cde2011-05-20 00:16:09 +0200883 else {
884 PyErr_Clear();
885 decompress = NULL;
886 }
887 if (Py_VerboseFlag)
888 PySys_WriteStderr("# zipimport: zlib %s\n",
889 zlib != NULL ? "available": "UNAVAILABLE");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 return decompress;
Just van Rossum52e14d62002-12-30 22:08:05 +0000891}
892
893/* Given a path to a Zip file and a toc_entry, return the (uncompressed)
894 data as a new reference. */
895static PyObject *
Victor Stinner60fe8d92010-08-16 23:48:11 +0000896get_data(PyObject *archive, PyObject *toc_entry)
Just van Rossum52e14d62002-12-30 22:08:05 +0000897{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 PyObject *raw_data, *data = NULL, *decompress;
899 char *buf;
900 FILE *fp;
901 int err;
902 Py_ssize_t bytes_read = 0;
903 long l;
Victor Stinner60fe8d92010-08-16 23:48:11 +0000904 PyObject *datapath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 long compress, data_size, file_size, file_offset, bytes_size;
906 long time, date, crc;
Just van Rossum52e14d62002-12-30 22:08:05 +0000907
Victor Stinner60fe8d92010-08-16 23:48:11 +0000908 if (!PyArg_ParseTuple(toc_entry, "Olllllll", &datapath, &compress,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 &data_size, &file_size, &file_offset, &time,
910 &date, &crc)) {
911 return NULL;
912 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000913
Victor Stinner60fe8d92010-08-16 23:48:11 +0000914 fp = _Py_fopen(archive, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 if (!fp) {
916 PyErr_Format(PyExc_IOError,
Victor Stinner60fe8d92010-08-16 23:48:11 +0000917 "zipimport: can not open file %U", archive);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 return NULL;
919 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 /* Check to make sure the local file header is correct */
922 fseek(fp, file_offset, 0);
923 l = PyMarshal_ReadLongFromFile(fp);
924 if (l != 0x04034B50) {
925 /* Bad: Local File Header */
926 PyErr_Format(ZipImportError,
Victor Stinner60fe8d92010-08-16 23:48:11 +0000927 "bad local file header in %U",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 archive);
929 fclose(fp);
930 return NULL;
931 }
932 fseek(fp, file_offset + 26, 0);
933 l = 30 + PyMarshal_ReadShortFromFile(fp) +
934 PyMarshal_ReadShortFromFile(fp); /* local header size */
935 file_offset += l; /* Start of file data */
Just van Rossum52e14d62002-12-30 22:08:05 +0000936
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 bytes_size = compress == 0 ? data_size : data_size + 1;
938 if (bytes_size == 0)
939 bytes_size++;
940 raw_data = PyBytes_FromStringAndSize((char *)NULL, bytes_size);
Just van Rossum52e14d62002-12-30 22:08:05 +0000941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 if (raw_data == NULL) {
943 fclose(fp);
944 return NULL;
945 }
946 buf = PyBytes_AsString(raw_data);
Just van Rossum52e14d62002-12-30 22:08:05 +0000947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 err = fseek(fp, file_offset, 0);
949 if (err == 0)
950 bytes_read = fread(buf, 1, data_size, fp);
951 fclose(fp);
952 if (err || bytes_read != data_size) {
953 PyErr_SetString(PyExc_IOError,
954 "zipimport: can't read data");
955 Py_DECREF(raw_data);
956 return NULL;
957 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 if (compress != 0) {
960 buf[data_size] = 'Z'; /* saw this in zipfile.py */
961 data_size++;
962 }
963 buf[data_size] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 if (compress == 0) { /* data is not compressed */
966 data = PyBytes_FromStringAndSize(buf, data_size);
967 Py_DECREF(raw_data);
968 return data;
969 }
970
971 /* Decompress with zlib */
972 decompress = get_decompress_func();
973 if (decompress == NULL) {
974 PyErr_SetString(ZipImportError,
975 "can't decompress data; "
976 "zlib not available");
977 goto error;
978 }
979 data = PyObject_CallFunction(decompress, "Oi", raw_data, -15);
Victor Stinner4925cde2011-05-20 00:16:09 +0200980 Py_DECREF(decompress);
Just van Rossum52e14d62002-12-30 22:08:05 +0000981error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 Py_DECREF(raw_data);
983 return data;
Just van Rossum52e14d62002-12-30 22:08:05 +0000984}
985
986/* Lenient date/time comparison function. The precision of the mtime
987 in the archive is lower than the mtime stored in a .pyc: we
988 must allow a difference of at most one second. */
989static int
990eq_mtime(time_t t1, time_t t2)
991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 time_t d = t1 - t2;
993 if (d < 0)
994 d = -d;
995 /* dostime only stores even seconds, so be lenient */
996 return d <= 1;
Just van Rossum52e14d62002-12-30 22:08:05 +0000997}
998
999/* Given the contents of a .py[co] file in a buffer, unmarshal the data
1000 and return the code object. Return None if it the magic word doesn't
1001 match (we do this instead of raising an exception as we fall back
1002 to .py if available and we don't want to mask other errors).
1003 Returns a new reference. */
1004static PyObject *
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001005unmarshal_code(PyObject *pathname, PyObject *data, time_t mtime)
Just van Rossum52e14d62002-12-30 22:08:05 +00001006{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 PyObject *code;
1008 char *buf = PyBytes_AsString(data);
1009 Py_ssize_t size = PyBytes_Size(data);
Just van Rossum52e14d62002-12-30 22:08:05 +00001010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 if (size <= 9) {
1012 PyErr_SetString(ZipImportError,
1013 "bad pyc data");
1014 return NULL;
1015 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 if (get_long((unsigned char *)buf) != PyImport_GetMagicNumber()) {
1018 if (Py_VerboseFlag)
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001019 PySys_FormatStderr("# %R has bad magic\n",
1020 pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021 Py_INCREF(Py_None);
1022 return Py_None; /* signal caller to try alternative */
1023 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 if (mtime != 0 && !eq_mtime(get_long((unsigned char *)buf + 4),
1026 mtime)) {
1027 if (Py_VerboseFlag)
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001028 PySys_FormatStderr("# %R has bad mtime\n",
1029 pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 Py_INCREF(Py_None);
1031 return Py_None; /* signal caller to try alternative */
1032 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 code = PyMarshal_ReadObjectFromString(buf + 8, size - 8);
1035 if (code == NULL)
1036 return NULL;
1037 if (!PyCode_Check(code)) {
1038 Py_DECREF(code);
1039 PyErr_Format(PyExc_TypeError,
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001040 "compiled module %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 pathname);
1042 return NULL;
1043 }
1044 return code;
Just van Rossum52e14d62002-12-30 22:08:05 +00001045}
1046
1047/* Replace any occurances of "\r\n?" in the input string with "\n".
1048 This converts DOS and Mac line endings to Unix line endings.
1049 Also append a trailing "\n" to be compatible with
1050 PyParser_SimpleParseFile(). Returns a new reference. */
1051static PyObject *
1052normalize_line_endings(PyObject *source)
1053{
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001054 char *buf, *q, *p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 PyObject *fixed_source;
1056 int len = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +00001057
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001058 p = PyBytes_AsString(source);
1059 if (p == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 return PyBytes_FromStringAndSize("\n\0", 2);
1061 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 /* one char extra for trailing \n and one for terminating \0 */
1064 buf = (char *)PyMem_Malloc(PyBytes_Size(source) + 2);
1065 if (buf == NULL) {
1066 PyErr_SetString(PyExc_MemoryError,
1067 "zipimport: no memory to allocate "
1068 "source buffer");
1069 return NULL;
1070 }
1071 /* replace "\r\n?" by "\n" */
1072 for (q = buf; *p != '\0'; p++) {
1073 if (*p == '\r') {
1074 *q++ = '\n';
1075 if (*(p + 1) == '\n')
1076 p++;
1077 }
1078 else
1079 *q++ = *p;
1080 len++;
1081 }
1082 *q++ = '\n'; /* add trailing \n */
1083 *q = '\0';
1084 fixed_source = PyBytes_FromStringAndSize(buf, len + 2);
1085 PyMem_Free(buf);
1086 return fixed_source;
Just van Rossum52e14d62002-12-30 22:08:05 +00001087}
1088
1089/* Given a string buffer containing Python source code, compile it
1090 return and return a code object as a new reference. */
1091static PyObject *
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001092compile_source(PyObject *pathname, PyObject *source)
Just van Rossum52e14d62002-12-30 22:08:05 +00001093{
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001094 PyObject *code, *fixed_source, *pathbytes;
Just van Rossum52e14d62002-12-30 22:08:05 +00001095
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001096 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1097 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001099
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001100 fixed_source = normalize_line_endings(source);
1101 if (fixed_source == NULL) {
1102 Py_DECREF(pathbytes);
1103 return NULL;
1104 }
1105
1106 code = Py_CompileString(PyBytes_AsString(fixed_source),
1107 PyBytes_AsString(pathbytes),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 Py_file_input);
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001109 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 Py_DECREF(fixed_source);
1111 return code;
Just van Rossum52e14d62002-12-30 22:08:05 +00001112}
1113
1114/* Convert the date/time values found in the Zip archive to a value
1115 that's compatible with the time stamp stored in .pyc files. */
Neal Norwitz29fd2ba2003-03-23 13:21:03 +00001116static time_t
1117parse_dostime(int dostime, int dosdate)
Just van Rossum52e14d62002-12-30 22:08:05 +00001118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 struct tm stm;
Just van Rossum52e14d62002-12-30 22:08:05 +00001120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 memset((void *) &stm, '\0', sizeof(stm));
Christian Heimes679db4a2008-01-18 09:56:22 +00001122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 stm.tm_sec = (dostime & 0x1f) * 2;
1124 stm.tm_min = (dostime >> 5) & 0x3f;
1125 stm.tm_hour = (dostime >> 11) & 0x1f;
1126 stm.tm_mday = dosdate & 0x1f;
1127 stm.tm_mon = ((dosdate >> 5) & 0x0f) - 1;
1128 stm.tm_year = ((dosdate >> 9) & 0x7f) + 80;
1129 stm.tm_isdst = -1; /* wday/yday is ignored */
Just van Rossum52e14d62002-12-30 22:08:05 +00001130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 return mktime(&stm);
Just van Rossum52e14d62002-12-30 22:08:05 +00001132}
1133
1134/* Given a path to a .pyc or .pyo file in the archive, return the
Ezio Melotti13925002011-03-16 11:05:33 +02001135 modification time of the matching .py file, or 0 if no source
Just van Rossum52e14d62002-12-30 22:08:05 +00001136 is available. */
1137static time_t
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001138get_mtime_of_source(ZipImporter *self, PyObject *path)
Just van Rossum52e14d62002-12-30 22:08:05 +00001139{
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001140 PyObject *toc_entry, *stripped;
1141 time_t mtime;
1142
1143 /* strip 'c' or 'o' from *.py[co] */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001144 if (PyUnicode_READY(path) == -1)
1145 return (time_t)-1;
1146 stripped = PyUnicode_FromKindAndData(PyUnicode_KIND(path),
1147 PyUnicode_DATA(path),
1148 PyUnicode_GET_LENGTH(path) - 1);
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001149 if (stripped == NULL)
1150 return (time_t)-1;
1151
1152 toc_entry = PyDict_GetItem(self->files, stripped);
1153 Py_DECREF(stripped);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 if (toc_entry != NULL && PyTuple_Check(toc_entry) &&
1155 PyTuple_Size(toc_entry) == 8) {
1156 /* fetch the time stamp of the .py file for comparison
1157 with an embedded pyc time stamp */
1158 int time, date;
1159 time = PyLong_AsLong(PyTuple_GetItem(toc_entry, 5));
1160 date = PyLong_AsLong(PyTuple_GetItem(toc_entry, 6));
1161 mtime = parse_dostime(time, date);
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001162 } else
1163 mtime = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 return mtime;
Just van Rossum52e14d62002-12-30 22:08:05 +00001165}
1166
1167/* Return the code object for the module named by 'fullname' from the
1168 Zip archive as a new reference. */
1169static PyObject *
1170get_code_from_data(ZipImporter *self, int ispackage, int isbytecode,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001171 time_t mtime, PyObject *toc_entry)
Just van Rossum52e14d62002-12-30 22:08:05 +00001172{
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001173 PyObject *data, *modpath, *code;
Just van Rossum52e14d62002-12-30 22:08:05 +00001174
Victor Stinner60fe8d92010-08-16 23:48:11 +00001175 data = get_data(self->archive, toc_entry);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 if (data == NULL)
1177 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001178
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001179 modpath = PyTuple_GetItem(toc_entry, 0);
Victor Stinner2a94f4c2010-10-18 12:15:34 +00001180 if (isbytecode)
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001181 code = unmarshal_code(modpath, data, mtime);
Victor Stinner2a94f4c2010-10-18 12:15:34 +00001182 else
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001183 code = compile_source(modpath, data);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 Py_DECREF(data);
1185 return code;
Just van Rossum52e14d62002-12-30 22:08:05 +00001186}
1187
Ezio Melotti42da6632011-03-15 05:18:48 +02001188/* Get the code object associated with the module specified by
Just van Rossum52e14d62002-12-30 22:08:05 +00001189 'fullname'. */
1190static PyObject *
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001191get_module_code(ZipImporter *self, PyObject *fullname,
Victor Stinner08654e12010-10-18 12:09:02 +00001192 int *p_ispackage, PyObject **p_modpath)
Just van Rossum52e14d62002-12-30 22:08:05 +00001193{
Gregory P. Smith95c7c462011-05-21 05:19:42 -07001194 PyObject *code = NULL, *toc_entry, *subname;
Victor Stinner9a2261a2011-05-26 13:59:41 +02001195 PyObject *path, *fullpath = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 struct st_zip_searchorder *zso;
Just van Rossum52e14d62002-12-30 22:08:05 +00001197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 subname = get_subname(fullname);
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001199 if (subname == NULL)
1200 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001201
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001202 path = make_filename(self->prefix, subname);
1203 Py_DECREF(subname);
1204 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001207 for (zso = zip_searchorder; *zso->suffix; zso++) {
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001208 code = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001209
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001210 fullpath = PyUnicode_FromFormat("%U%s", path, zso->suffix);
1211 if (fullpath == NULL)
1212 goto exit;
1213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 if (Py_VerboseFlag > 1)
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001215 PySys_FormatStderr("# trying %U%c%U\n",
1216 self->archive, (int)SEP, fullpath);
1217 toc_entry = PyDict_GetItem(self->files, fullpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 if (toc_entry != NULL) {
1219 time_t mtime = 0;
1220 int ispackage = zso->type & IS_PACKAGE;
1221 int isbytecode = zso->type & IS_BYTECODE;
Just van Rossum52e14d62002-12-30 22:08:05 +00001222
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001223 if (isbytecode) {
1224 mtime = get_mtime_of_source(self, fullpath);
1225 if (mtime == (time_t)-1 && PyErr_Occurred()) {
1226 goto exit;
1227 }
1228 }
1229 Py_CLEAR(fullpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 if (p_ispackage != NULL)
1231 *p_ispackage = ispackage;
1232 code = get_code_from_data(self, ispackage,
1233 isbytecode, mtime,
1234 toc_entry);
1235 if (code == Py_None) {
1236 /* bad magic number or non-matching mtime
1237 in byte code, try next */
1238 Py_DECREF(code);
1239 continue;
1240 }
Victor Stinner08654e12010-10-18 12:09:02 +00001241 if (code != NULL && p_modpath != NULL) {
1242 *p_modpath = PyTuple_GetItem(toc_entry, 0);
1243 Py_INCREF(*p_modpath);
1244 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001245 goto exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001247 else
1248 Py_CLEAR(fullpath);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 }
Victor Stinnerf6b563a2011-03-14 20:46:50 -04001250 PyErr_Format(ZipImportError, "can't find module %R", fullname);
1251exit:
1252 Py_DECREF(path);
1253 Py_XDECREF(fullpath);
1254 return code;
Just van Rossum52e14d62002-12-30 22:08:05 +00001255}
1256
1257
1258/* Module init */
1259
1260PyDoc_STRVAR(zipimport_doc,
1261"zipimport provides support for importing Python modules from Zip archives.\n\
1262\n\
1263This module exports three objects:\n\
1264- zipimporter: a class; its constructor takes a path to a Zip archive.\n\
Fredrik Lundhb84b35f2006-01-15 15:00:40 +00001265- ZipImportError: exception raised by zipimporter objects. It's a\n\
Just van Rossum52e14d62002-12-30 22:08:05 +00001266 subclass of ImportError, so it can be caught as ImportError, too.\n\
1267- _zip_directory_cache: a dict, mapping archive paths to zip directory\n\
1268 info dicts, as used in zipimporter._files.\n\
1269\n\
1270It is usually not needed to use the zipimport module explicitly; it is\n\
1271used by the builtin import mechanism for sys.path items that are paths\n\
1272to Zip archives.");
1273
Martin v. Löwis1a214512008-06-11 05:26:20 +00001274static struct PyModuleDef zipimportmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 PyModuleDef_HEAD_INIT,
1276 "zipimport",
1277 zipimport_doc,
1278 -1,
1279 NULL,
1280 NULL,
1281 NULL,
1282 NULL,
1283 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001284};
1285
Just van Rossum52e14d62002-12-30 22:08:05 +00001286PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001287PyInit_zipimport(void)
Just van Rossum52e14d62002-12-30 22:08:05 +00001288{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 PyObject *mod;
Just van Rossum52e14d62002-12-30 22:08:05 +00001290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 if (PyType_Ready(&ZipImporter_Type) < 0)
1292 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 /* Correct directory separator */
1295 zip_searchorder[0].suffix[0] = SEP;
1296 zip_searchorder[1].suffix[0] = SEP;
1297 zip_searchorder[2].suffix[0] = SEP;
1298 if (Py_OptimizeFlag) {
1299 /* Reverse *.pyc and *.pyo */
1300 struct st_zip_searchorder tmp;
1301 tmp = zip_searchorder[0];
1302 zip_searchorder[0] = zip_searchorder[1];
1303 zip_searchorder[1] = tmp;
1304 tmp = zip_searchorder[3];
1305 zip_searchorder[3] = zip_searchorder[4];
1306 zip_searchorder[4] = tmp;
1307 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 mod = PyModule_Create(&zipimportmodule);
1310 if (mod == NULL)
1311 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 ZipImportError = PyErr_NewException("zipimport.ZipImportError",
1314 PyExc_ImportError, NULL);
1315 if (ZipImportError == NULL)
1316 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 Py_INCREF(ZipImportError);
1319 if (PyModule_AddObject(mod, "ZipImportError",
1320 ZipImportError) < 0)
1321 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 Py_INCREF(&ZipImporter_Type);
1324 if (PyModule_AddObject(mod, "zipimporter",
1325 (PyObject *)&ZipImporter_Type) < 0)
1326 return NULL;
Just van Rossumf8b6de12002-12-31 09:51:59 +00001327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 zip_directory_cache = PyDict_New();
1329 if (zip_directory_cache == NULL)
1330 return NULL;
1331 Py_INCREF(zip_directory_cache);
1332 if (PyModule_AddObject(mod, "_zip_directory_cache",
1333 zip_directory_cache) < 0)
1334 return NULL;
1335 return mod;
Just van Rossum52e14d62002-12-30 22:08:05 +00001336}