Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1 | """ |
| 2 | Read and write ZIP files. |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 3 | |
| 4 | XXX references to utf-8 need further investigation. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 5 | """ |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 6 | import binascii |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 7 | import importlib.util |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 8 | import io |
shireenrao | a4e2991 | 2019-08-24 11:26:41 -0400 | [diff] [blame] | 9 | import itertools |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 10 | import os |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 11 | import posixpath |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 12 | import shutil |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 13 | import stat |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 14 | import struct |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 15 | import sys |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 16 | import threading |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 17 | import time |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 18 | import contextlib |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 19 | import pathlib |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 20 | |
| 21 | try: |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 22 | import zlib # We may need its compression method |
Christian Heimes | d5e2b6f | 2008-03-19 21:50:51 +0000 | [diff] [blame] | 23 | crc32 = zlib.crc32 |
Brett Cannon | 260fbe8 | 2013-07-04 18:16:15 -0400 | [diff] [blame] | 24 | except ImportError: |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 25 | zlib = None |
Christian Heimes | d5e2b6f | 2008-03-19 21:50:51 +0000 | [diff] [blame] | 26 | crc32 = binascii.crc32 |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 27 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 28 | try: |
| 29 | import bz2 # We may need its compression method |
Brett Cannon | 260fbe8 | 2013-07-04 18:16:15 -0400 | [diff] [blame] | 30 | except ImportError: |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 31 | bz2 = None |
| 32 | |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 33 | try: |
| 34 | import lzma # We may need its compression method |
Brett Cannon | 260fbe8 | 2013-07-04 18:16:15 -0400 | [diff] [blame] | 35 | except ImportError: |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 36 | lzma = None |
| 37 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 38 | __all__ = ["BadZipFile", "BadZipfile", "error", |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 39 | "ZIP_STORED", "ZIP_DEFLATED", "ZIP_BZIP2", "ZIP_LZMA", |
Zackery Spytz | 9a81ab1 | 2020-03-23 07:29:36 -0600 | [diff] [blame] | 40 | "is_zipfile", "ZipInfo", "ZipFile", "PyZipFile", "LargeZipFile", |
| 41 | "Path"] |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 42 | |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 43 | class BadZipFile(Exception): |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 44 | pass |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 45 | |
| 46 | |
| 47 | class LargeZipFile(Exception): |
| 48 | """ |
| 49 | Raised when writing a zipfile, the zipfile requires ZIP64 extensions |
| 50 | and those extensions are disabled. |
| 51 | """ |
| 52 | |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 53 | error = BadZipfile = BadZipFile # Pre-3.2 compatibility names |
| 54 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 55 | |
Amaury Forgeot d'Arc | 0c3f8a4 | 2009-01-17 16:42:26 +0000 | [diff] [blame] | 56 | ZIP64_LIMIT = (1 << 31) - 1 |
Serhiy Storchaka | cfbb394 | 2014-09-23 21:34:24 +0300 | [diff] [blame] | 57 | ZIP_FILECOUNT_LIMIT = (1 << 16) - 1 |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 58 | ZIP_MAX_COMMENT = (1 << 16) - 1 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 59 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 60 | # constants for Zip file compression methods |
| 61 | ZIP_STORED = 0 |
| 62 | ZIP_DEFLATED = 8 |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 63 | ZIP_BZIP2 = 12 |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 64 | ZIP_LZMA = 14 |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 65 | # Other ZIP compression methods not supported |
| 66 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 67 | DEFAULT_VERSION = 20 |
| 68 | ZIP64_VERSION = 45 |
| 69 | BZIP2_VERSION = 46 |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 70 | LZMA_VERSION = 63 |
Martin v. Löwis | d099b56 | 2012-05-01 14:08:22 +0200 | [diff] [blame] | 71 | # we recognize (but not necessarily support) all features up to that version |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 72 | MAX_EXTRACT_VERSION = 63 |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 73 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 74 | # Below are some formats and associated data for reading/writing headers using |
| 75 | # the struct module. The names and structures of headers/records are those used |
| 76 | # in the PKWARE description of the ZIP file format: |
| 77 | # http://www.pkware.com/documents/casestudies/APPNOTE.TXT |
| 78 | # (URL valid as of January 2008) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 79 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 80 | # The "end of central directory" structure, magic number, size, and indices |
| 81 | # (section V.I in the format document) |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 82 | structEndArchive = b"<4s4H2LH" |
| 83 | stringEndArchive = b"PK\005\006" |
| 84 | sizeEndCentDir = struct.calcsize(structEndArchive) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 85 | |
| 86 | _ECD_SIGNATURE = 0 |
| 87 | _ECD_DISK_NUMBER = 1 |
| 88 | _ECD_DISK_START = 2 |
| 89 | _ECD_ENTRIES_THIS_DISK = 3 |
| 90 | _ECD_ENTRIES_TOTAL = 4 |
| 91 | _ECD_SIZE = 5 |
| 92 | _ECD_OFFSET = 6 |
| 93 | _ECD_COMMENT_SIZE = 7 |
| 94 | # These last two indices are not part of the structure as defined in the |
| 95 | # spec, but they are used internally by this module as a convenience |
| 96 | _ECD_COMMENT = 8 |
| 97 | _ECD_LOCATION = 9 |
| 98 | |
| 99 | # The "central directory" structure, magic number, size, and indices |
| 100 | # of entries in the structure (section V.F in the format document) |
| 101 | structCentralDir = "<4s4B4HL2L5H2L" |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 102 | stringCentralDir = b"PK\001\002" |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 103 | sizeCentralDir = struct.calcsize(structCentralDir) |
| 104 | |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 105 | # indexes of entries in the central directory structure |
| 106 | _CD_SIGNATURE = 0 |
| 107 | _CD_CREATE_VERSION = 1 |
| 108 | _CD_CREATE_SYSTEM = 2 |
| 109 | _CD_EXTRACT_VERSION = 3 |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 110 | _CD_EXTRACT_SYSTEM = 4 |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 111 | _CD_FLAG_BITS = 5 |
| 112 | _CD_COMPRESS_TYPE = 6 |
| 113 | _CD_TIME = 7 |
| 114 | _CD_DATE = 8 |
| 115 | _CD_CRC = 9 |
| 116 | _CD_COMPRESSED_SIZE = 10 |
| 117 | _CD_UNCOMPRESSED_SIZE = 11 |
| 118 | _CD_FILENAME_LENGTH = 12 |
| 119 | _CD_EXTRA_FIELD_LENGTH = 13 |
| 120 | _CD_COMMENT_LENGTH = 14 |
| 121 | _CD_DISK_NUMBER_START = 15 |
| 122 | _CD_INTERNAL_FILE_ATTRIBUTES = 16 |
| 123 | _CD_EXTERNAL_FILE_ATTRIBUTES = 17 |
| 124 | _CD_LOCAL_HEADER_OFFSET = 18 |
| 125 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 126 | # The "local file header" structure, magic number, size, and indices |
| 127 | # (section V.A in the format document) |
| 128 | structFileHeader = "<4s2B4HL2L2H" |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 129 | stringFileHeader = b"PK\003\004" |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 130 | sizeFileHeader = struct.calcsize(structFileHeader) |
| 131 | |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 132 | _FH_SIGNATURE = 0 |
| 133 | _FH_EXTRACT_VERSION = 1 |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 134 | _FH_EXTRACT_SYSTEM = 2 |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 135 | _FH_GENERAL_PURPOSE_FLAG_BITS = 3 |
| 136 | _FH_COMPRESSION_METHOD = 4 |
| 137 | _FH_LAST_MOD_TIME = 5 |
| 138 | _FH_LAST_MOD_DATE = 6 |
| 139 | _FH_CRC = 7 |
| 140 | _FH_COMPRESSED_SIZE = 8 |
| 141 | _FH_UNCOMPRESSED_SIZE = 9 |
| 142 | _FH_FILENAME_LENGTH = 10 |
| 143 | _FH_EXTRA_FIELD_LENGTH = 11 |
| 144 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 145 | # The "Zip64 end of central directory locator" structure, magic number, and size |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 146 | structEndArchive64Locator = "<4sLQL" |
| 147 | stringEndArchive64Locator = b"PK\x06\x07" |
| 148 | sizeEndCentDir64Locator = struct.calcsize(structEndArchive64Locator) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 149 | |
| 150 | # The "Zip64 end of central directory" record, magic number, size, and indices |
| 151 | # (section V.G in the format document) |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 152 | structEndArchive64 = "<4sQ2H2L4Q" |
| 153 | stringEndArchive64 = b"PK\x06\x06" |
| 154 | sizeEndCentDir64 = struct.calcsize(structEndArchive64) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 155 | |
| 156 | _CD64_SIGNATURE = 0 |
| 157 | _CD64_DIRECTORY_RECSIZE = 1 |
| 158 | _CD64_CREATE_VERSION = 2 |
| 159 | _CD64_EXTRACT_VERSION = 3 |
| 160 | _CD64_DISK_NUMBER = 4 |
| 161 | _CD64_DISK_NUMBER_START = 5 |
| 162 | _CD64_NUMBER_ENTRIES_THIS_DISK = 6 |
| 163 | _CD64_NUMBER_ENTRIES_TOTAL = 7 |
| 164 | _CD64_DIRECTORY_SIZE = 8 |
| 165 | _CD64_OFFSET_START_CENTDIR = 9 |
| 166 | |
Silas Sewell | 4ba3b50 | 2018-09-18 13:00:05 -0400 | [diff] [blame] | 167 | _DD_SIGNATURE = 0x08074b50 |
| 168 | |
Serhiy Storchaka | 9bdb7be | 2018-09-17 15:36:40 +0300 | [diff] [blame] | 169 | _EXTRA_FIELD_STRUCT = struct.Struct('<HH') |
| 170 | |
| 171 | def _strip_extra(extra, xids): |
| 172 | # Remove Extra Fields with specified IDs. |
| 173 | unpack = _EXTRA_FIELD_STRUCT.unpack |
| 174 | modified = False |
| 175 | buffer = [] |
| 176 | start = i = 0 |
| 177 | while i + 4 <= len(extra): |
| 178 | xid, xlen = unpack(extra[i : i + 4]) |
| 179 | j = i + 4 + xlen |
| 180 | if xid in xids: |
| 181 | if i != start: |
| 182 | buffer.append(extra[start : i]) |
| 183 | start = j |
| 184 | modified = True |
| 185 | i = j |
| 186 | if not modified: |
| 187 | return extra |
| 188 | return b''.join(buffer) |
| 189 | |
Antoine Pitrou | db5fe66 | 2008-12-27 15:50:40 +0000 | [diff] [blame] | 190 | def _check_zipfile(fp): |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 191 | try: |
Antoine Pitrou | db5fe66 | 2008-12-27 15:50:40 +0000 | [diff] [blame] | 192 | if _EndRecData(fp): |
| 193 | return True # file has correct magic number |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 194 | except OSError: |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 195 | pass |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 196 | return False |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 197 | |
Antoine Pitrou | db5fe66 | 2008-12-27 15:50:40 +0000 | [diff] [blame] | 198 | def is_zipfile(filename): |
| 199 | """Quickly see if a file is a ZIP file by checking the magic number. |
| 200 | |
| 201 | The filename argument may be a file or file-like object too. |
| 202 | """ |
| 203 | result = False |
| 204 | try: |
| 205 | if hasattr(filename, "read"): |
| 206 | result = _check_zipfile(fp=filename) |
| 207 | else: |
| 208 | with open(filename, "rb") as fp: |
| 209 | result = _check_zipfile(fp) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 210 | except OSError: |
Antoine Pitrou | db5fe66 | 2008-12-27 15:50:40 +0000 | [diff] [blame] | 211 | pass |
| 212 | return result |
| 213 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 214 | def _EndRecData64(fpin, offset, endrec): |
| 215 | """ |
| 216 | Read the ZIP64 end-of-archive records and use that to update endrec |
| 217 | """ |
Georg Brandl | 268e4d4 | 2010-10-14 06:59:45 +0000 | [diff] [blame] | 218 | try: |
| 219 | fpin.seek(offset - sizeEndCentDir64Locator, 2) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 220 | except OSError: |
Georg Brandl | 268e4d4 | 2010-10-14 06:59:45 +0000 | [diff] [blame] | 221 | # If the seek fails, the file is not large enough to contain a ZIP64 |
| 222 | # end-of-archive record, so just return the end record we were given. |
| 223 | return endrec |
| 224 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 225 | data = fpin.read(sizeEndCentDir64Locator) |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 226 | if len(data) != sizeEndCentDir64Locator: |
| 227 | return endrec |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 228 | sig, diskno, reloff, disks = struct.unpack(structEndArchive64Locator, data) |
| 229 | if sig != stringEndArchive64Locator: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 230 | return endrec |
| 231 | |
Francisco Facioni | ab0716e | 2019-05-29 00:15:11 +0100 | [diff] [blame] | 232 | if diskno != 0 or disks > 1: |
Éric Araujo | ae2d832 | 2010-10-28 13:49:17 +0000 | [diff] [blame] | 233 | raise BadZipFile("zipfiles that span multiple disks are not supported") |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 234 | |
| 235 | # Assume no 'zip64 extensible data' |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 236 | fpin.seek(offset - sizeEndCentDir64Locator - sizeEndCentDir64, 2) |
| 237 | data = fpin.read(sizeEndCentDir64) |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 238 | if len(data) != sizeEndCentDir64: |
| 239 | return endrec |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 240 | sig, sz, create_version, read_version, disk_num, disk_dir, \ |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 241 | dircount, dircount2, dirsize, diroffset = \ |
| 242 | struct.unpack(structEndArchive64, data) |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 243 | if sig != stringEndArchive64: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 244 | return endrec |
| 245 | |
| 246 | # Update the original endrec using data from the ZIP64 record |
Antoine Pitrou | 9e4fdf4 | 2008-09-05 23:43:02 +0000 | [diff] [blame] | 247 | endrec[_ECD_SIGNATURE] = sig |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 248 | endrec[_ECD_DISK_NUMBER] = disk_num |
| 249 | endrec[_ECD_DISK_START] = disk_dir |
| 250 | endrec[_ECD_ENTRIES_THIS_DISK] = dircount |
| 251 | endrec[_ECD_ENTRIES_TOTAL] = dircount2 |
| 252 | endrec[_ECD_SIZE] = dirsize |
| 253 | endrec[_ECD_OFFSET] = diroffset |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 254 | return endrec |
| 255 | |
| 256 | |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 257 | def _EndRecData(fpin): |
| 258 | """Return data from the "End of Central Directory" record, or None. |
| 259 | |
| 260 | The data is a list of the nine items in the ZIP "End of central dir" |
| 261 | record followed by a tenth item, the file seek offset of this record.""" |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 262 | |
| 263 | # Determine file size |
| 264 | fpin.seek(0, 2) |
| 265 | filesize = fpin.tell() |
| 266 | |
| 267 | # Check to see if this is ZIP file with no archive comment (the |
| 268 | # "end of central directory" structure should be the last item in the |
| 269 | # file if this is the case). |
Amaury Forgeot d'Arc | bc34780 | 2009-07-28 22:18:57 +0000 | [diff] [blame] | 270 | try: |
| 271 | fpin.seek(-sizeEndCentDir, 2) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 272 | except OSError: |
Amaury Forgeot d'Arc | bc34780 | 2009-07-28 22:18:57 +0000 | [diff] [blame] | 273 | return None |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 274 | data = fpin.read() |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 275 | if (len(data) == sizeEndCentDir and |
| 276 | data[0:4] == stringEndArchive and |
| 277 | data[-2:] == b"\000\000"): |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 278 | # the signature is correct and there's no comment, unpack structure |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 279 | endrec = struct.unpack(structEndArchive, data) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 280 | endrec=list(endrec) |
| 281 | |
| 282 | # Append a blank comment and record start offset |
| 283 | endrec.append(b"") |
| 284 | endrec.append(filesize - sizeEndCentDir) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 285 | |
Amaury Forgeot d'Arc | d3fb4bb | 2009-01-18 00:29:02 +0000 | [diff] [blame] | 286 | # Try to read the "Zip64 end of central directory" structure |
| 287 | return _EndRecData64(fpin, -sizeEndCentDir, endrec) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 288 | |
| 289 | # Either this is not a ZIP file, or it is a ZIP file with an archive |
| 290 | # comment. Search the end of the file for the "end of central directory" |
| 291 | # record signature. The comment is the last item in the ZIP file and may be |
| 292 | # up to 64K long. It is assumed that the "end of central directory" magic |
| 293 | # number does not appear in the comment. |
| 294 | maxCommentStart = max(filesize - (1 << 16) - sizeEndCentDir, 0) |
| 295 | fpin.seek(maxCommentStart, 0) |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 296 | data = fpin.read() |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 297 | start = data.rfind(stringEndArchive) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 298 | if start >= 0: |
| 299 | # found the magic number; attempt to unpack and interpret |
| 300 | recData = data[start:start+sizeEndCentDir] |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 301 | if len(recData) != sizeEndCentDir: |
| 302 | # Zip file is corrupted. |
| 303 | return None |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 304 | endrec = list(struct.unpack(structEndArchive, recData)) |
R David Murray | 4fbb9db | 2011-06-09 15:50:51 -0400 | [diff] [blame] | 305 | commentSize = endrec[_ECD_COMMENT_SIZE] #as claimed by the zip file |
| 306 | comment = data[start+sizeEndCentDir:start+sizeEndCentDir+commentSize] |
| 307 | endrec.append(comment) |
| 308 | endrec.append(maxCommentStart + start) |
Amaury Forgeot d'Arc | d3fb4bb | 2009-01-18 00:29:02 +0000 | [diff] [blame] | 309 | |
R David Murray | 4fbb9db | 2011-06-09 15:50:51 -0400 | [diff] [blame] | 310 | # Try to read the "Zip64 end of central directory" structure |
| 311 | return _EndRecData64(fpin, maxCommentStart + start - filesize, |
| 312 | endrec) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 313 | |
| 314 | # Unable to find a valid end of central directory structure |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 315 | return None |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 316 | |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 317 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 318 | class ZipInfo (object): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 319 | """Class with attributes describing each file in the ZIP archive.""" |
| 320 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 321 | __slots__ = ( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 322 | 'orig_filename', |
| 323 | 'filename', |
| 324 | 'date_time', |
| 325 | 'compress_type', |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 326 | '_compresslevel', |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 327 | 'comment', |
| 328 | 'extra', |
| 329 | 'create_system', |
| 330 | 'create_version', |
| 331 | 'extract_version', |
| 332 | 'reserved', |
| 333 | 'flag_bits', |
| 334 | 'volume', |
| 335 | 'internal_attr', |
| 336 | 'external_attr', |
| 337 | 'header_offset', |
| 338 | 'CRC', |
| 339 | 'compress_size', |
| 340 | 'file_size', |
| 341 | '_raw_time', |
| 342 | ) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 343 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 344 | def __init__(self, filename="NoName", date_time=(1980,1,1,0,0,0)): |
Greg Ward | 8e36d28 | 2003-06-18 00:53:06 +0000 | [diff] [blame] | 345 | self.orig_filename = filename # Original file name in archive |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 346 | |
| 347 | # Terminate the file name at the first null byte. Null bytes in file |
| 348 | # names are used as tricks by viruses in archives. |
Greg Ward | 8e36d28 | 2003-06-18 00:53:06 +0000 | [diff] [blame] | 349 | null_byte = filename.find(chr(0)) |
| 350 | if null_byte >= 0: |
| 351 | filename = filename[0:null_byte] |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 352 | # This is used to ensure paths in generated ZIP files always use |
| 353 | # forward slashes as the directory separator, as required by the |
| 354 | # ZIP format specification. |
| 355 | if os.sep != "/" and os.sep in filename: |
Greg Ward | 8e36d28 | 2003-06-18 00:53:06 +0000 | [diff] [blame] | 356 | filename = filename.replace(os.sep, "/") |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 357 | |
Greg Ward | 8e36d28 | 2003-06-18 00:53:06 +0000 | [diff] [blame] | 358 | self.filename = filename # Normalized file name |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 359 | self.date_time = date_time # year, month, day, hour, min, sec |
Senthil Kumaran | 29fa9d4 | 2011-10-20 01:46:00 +0800 | [diff] [blame] | 360 | |
| 361 | if date_time[0] < 1980: |
| 362 | raise ValueError('ZIP does not support timestamps before 1980') |
| 363 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 364 | # Standard values: |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 365 | self.compress_type = ZIP_STORED # Type of compression for the file |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 366 | self._compresslevel = None # Level for the compressor |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 367 | self.comment = b"" # Comment for each file |
| 368 | self.extra = b"" # ZIP extra data |
Martin v. Löwis | 0075690 | 2006-02-05 17:09:41 +0000 | [diff] [blame] | 369 | if sys.platform == 'win32': |
| 370 | self.create_system = 0 # System which created ZIP archive |
| 371 | else: |
| 372 | # Assume everything else is unix-y |
| 373 | self.create_system = 3 # System which created ZIP archive |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 374 | self.create_version = DEFAULT_VERSION # Version which created ZIP archive |
| 375 | self.extract_version = DEFAULT_VERSION # Version needed to extract archive |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 376 | self.reserved = 0 # Must be zero |
| 377 | self.flag_bits = 0 # ZIP flag bits |
| 378 | self.volume = 0 # Volume number of file header |
| 379 | self.internal_attr = 0 # Internal attributes |
| 380 | self.external_attr = 0 # External file attributes |
Mickaël Schoentgen | 992347d | 2019-09-09 15:08:54 +0200 | [diff] [blame] | 381 | self.compress_size = 0 # Size of the compressed file |
| 382 | self.file_size = 0 # Size of the uncompressed file |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 383 | # Other attributes are set by class ZipFile: |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 384 | # header_offset Byte offset to the file header |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 385 | # CRC CRC-32 of the uncompressed file |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 386 | |
Serhiy Storchaka | 51a4370 | 2014-10-29 22:42:06 +0200 | [diff] [blame] | 387 | def __repr__(self): |
| 388 | result = ['<%s filename=%r' % (self.__class__.__name__, self.filename)] |
| 389 | if self.compress_type != ZIP_STORED: |
| 390 | result.append(' compress_type=%s' % |
| 391 | compressor_names.get(self.compress_type, |
| 392 | self.compress_type)) |
| 393 | hi = self.external_attr >> 16 |
| 394 | lo = self.external_attr & 0xFFFF |
| 395 | if hi: |
| 396 | result.append(' filemode=%r' % stat.filemode(hi)) |
| 397 | if lo: |
| 398 | result.append(' external_attr=%#x' % lo) |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 399 | isdir = self.is_dir() |
Serhiy Storchaka | 51a4370 | 2014-10-29 22:42:06 +0200 | [diff] [blame] | 400 | if not isdir or self.file_size: |
| 401 | result.append(' file_size=%r' % self.file_size) |
| 402 | if ((not isdir or self.compress_size) and |
| 403 | (self.compress_type != ZIP_STORED or |
| 404 | self.file_size != self.compress_size)): |
| 405 | result.append(' compress_size=%r' % self.compress_size) |
| 406 | result.append('>') |
| 407 | return ''.join(result) |
| 408 | |
Serhiy Storchaka | 182d7cd | 2013-01-15 00:31:39 +0200 | [diff] [blame] | 409 | def FileHeader(self, zip64=None): |
Serhiy Storchaka | 4bb186d | 2018-11-25 09:51:14 +0200 | [diff] [blame] | 410 | """Return the per-file header as a bytes object.""" |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 411 | dt = self.date_time |
| 412 | dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2] |
Tim Peters | 3caca23 | 2001-12-06 06:23:26 +0000 | [diff] [blame] | 413 | dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 414 | if self.flag_bits & 0x08: |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 415 | # Set these to zero because we write them after the file data |
| 416 | CRC = compress_size = file_size = 0 |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 417 | else: |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 418 | CRC = self.CRC |
| 419 | compress_size = self.compress_size |
| 420 | file_size = self.file_size |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 421 | |
| 422 | extra = self.extra |
| 423 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 424 | min_version = 0 |
Serhiy Storchaka | 182d7cd | 2013-01-15 00:31:39 +0200 | [diff] [blame] | 425 | if zip64 is None: |
| 426 | zip64 = file_size > ZIP64_LIMIT or compress_size > ZIP64_LIMIT |
| 427 | if zip64: |
Christian Heimes | d5e2b6f | 2008-03-19 21:50:51 +0000 | [diff] [blame] | 428 | fmt = '<HHQQ' |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 429 | extra = extra + struct.pack(fmt, |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 430 | 1, struct.calcsize(fmt)-4, file_size, compress_size) |
Serhiy Storchaka | 182d7cd | 2013-01-15 00:31:39 +0200 | [diff] [blame] | 431 | if file_size > ZIP64_LIMIT or compress_size > ZIP64_LIMIT: |
| 432 | if not zip64: |
| 433 | raise LargeZipFile("Filesize would require ZIP64 extensions") |
| 434 | # File is larger than what fits into a 4 byte integer, |
| 435 | # fall back to the ZIP64 extension |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 436 | file_size = 0xffffffff |
| 437 | compress_size = 0xffffffff |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 438 | min_version = ZIP64_VERSION |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 439 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 440 | if self.compress_type == ZIP_BZIP2: |
| 441 | min_version = max(BZIP2_VERSION, min_version) |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 442 | elif self.compress_type == ZIP_LZMA: |
| 443 | min_version = max(LZMA_VERSION, min_version) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 444 | |
| 445 | self.extract_version = max(min_version, self.extract_version) |
| 446 | self.create_version = max(min_version, self.create_version) |
Martin v. Löwis | 8570f6a | 2008-05-05 17:44:38 +0000 | [diff] [blame] | 447 | filename, flag_bits = self._encodeFilenameFlags() |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 448 | header = struct.pack(structFileHeader, stringFileHeader, |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 449 | self.extract_version, self.reserved, flag_bits, |
| 450 | self.compress_type, dostime, dosdate, CRC, |
| 451 | compress_size, file_size, |
| 452 | len(filename), len(extra)) |
Martin v. Löwis | 8570f6a | 2008-05-05 17:44:38 +0000 | [diff] [blame] | 453 | return header + filename + extra |
| 454 | |
| 455 | def _encodeFilenameFlags(self): |
| 456 | try: |
| 457 | return self.filename.encode('ascii'), self.flag_bits |
| 458 | except UnicodeEncodeError: |
| 459 | return self.filename.encode('utf-8'), self.flag_bits | 0x800 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 460 | |
| 461 | def _decodeExtra(self): |
| 462 | # Try to decode the extra field. |
| 463 | extra = self.extra |
| 464 | unpack = struct.unpack |
Gregory P. Smith | 0af8a86 | 2014-05-29 23:42:14 -0700 | [diff] [blame] | 465 | while len(extra) >= 4: |
Christian Heimes | d5e2b6f | 2008-03-19 21:50:51 +0000 | [diff] [blame] | 466 | tp, ln = unpack('<HH', extra[:4]) |
Serhiy Storchaka | feccdb2 | 2017-03-09 18:34:03 +0200 | [diff] [blame] | 467 | if ln+4 > len(extra): |
| 468 | raise BadZipFile("Corrupt extra field %04x (size=%d)" % (tp, ln)) |
| 469 | if tp == 0x0001: |
Serhiy Storchaka | e27449d | 2019-11-09 13:13:36 +0200 | [diff] [blame] | 470 | data = extra[4:ln+4] |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 471 | # ZIP64 extension (large files and/or large archives) |
Serhiy Storchaka | e27449d | 2019-11-09 13:13:36 +0200 | [diff] [blame] | 472 | try: |
| 473 | if self.file_size in (0xFFFF_FFFF_FFFF_FFFF, 0xFFFF_FFFF): |
| 474 | field = "File size" |
| 475 | self.file_size, = unpack('<Q', data[:8]) |
| 476 | data = data[8:] |
| 477 | if self.compress_size == 0xFFFF_FFFF: |
| 478 | field = "Compress size" |
| 479 | self.compress_size, = unpack('<Q', data[:8]) |
| 480 | data = data[8:] |
| 481 | if self.header_offset == 0xFFFF_FFFF: |
| 482 | field = "Header offset" |
| 483 | self.header_offset, = unpack('<Q', data[:8]) |
| 484 | except struct.error: |
| 485 | raise BadZipFile(f"Corrupt zip64 extra field. " |
| 486 | f"{field} not found.") from None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 487 | |
| 488 | extra = extra[ln+4:] |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 489 | |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 490 | @classmethod |
Marcel Plch | a2fe1e5 | 2018-08-02 15:04:52 +0200 | [diff] [blame] | 491 | def from_file(cls, filename, arcname=None, *, strict_timestamps=True): |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 492 | """Construct an appropriate ZipInfo for a file on the filesystem. |
| 493 | |
| 494 | filename should be the path to a file or directory on the filesystem. |
| 495 | |
| 496 | arcname is the name which it will have within the archive (by default, |
| 497 | this will be the same as filename, but without a drive letter and with |
| 498 | leading path separators removed). |
| 499 | """ |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 500 | if isinstance(filename, os.PathLike): |
| 501 | filename = os.fspath(filename) |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 502 | st = os.stat(filename) |
| 503 | isdir = stat.S_ISDIR(st.st_mode) |
| 504 | mtime = time.localtime(st.st_mtime) |
| 505 | date_time = mtime[0:6] |
Marcel Plch | a2fe1e5 | 2018-08-02 15:04:52 +0200 | [diff] [blame] | 506 | if not strict_timestamps and date_time[0] < 1980: |
| 507 | date_time = (1980, 1, 1, 0, 0, 0) |
| 508 | elif not strict_timestamps and date_time[0] > 2107: |
| 509 | date_time = (2107, 12, 31, 23, 59, 59) |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 510 | # Create ZipInfo instance to store file information |
| 511 | if arcname is None: |
| 512 | arcname = filename |
| 513 | arcname = os.path.normpath(os.path.splitdrive(arcname)[1]) |
| 514 | while arcname[0] in (os.sep, os.altsep): |
| 515 | arcname = arcname[1:] |
| 516 | if isdir: |
| 517 | arcname += '/' |
| 518 | zinfo = cls(arcname, date_time) |
| 519 | zinfo.external_attr = (st.st_mode & 0xFFFF) << 16 # Unix attributes |
| 520 | if isdir: |
| 521 | zinfo.file_size = 0 |
| 522 | zinfo.external_attr |= 0x10 # MS-DOS directory flag |
| 523 | else: |
| 524 | zinfo.file_size = st.st_size |
| 525 | |
| 526 | return zinfo |
| 527 | |
| 528 | def is_dir(self): |
Serhiy Storchaka | f47fc55 | 2016-05-15 12:27:16 +0300 | [diff] [blame] | 529 | """Return True if this archive member is a directory.""" |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 530 | return self.filename[-1] == '/' |
| 531 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 532 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 533 | # ZIP encryption uses the CRC32 one-byte primitive for scrambling some |
| 534 | # internal keys. We noticed that a direct implementation is faster than |
| 535 | # relying on binascii.crc32(). |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 536 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 537 | _crctable = None |
| 538 | def _gen_crc(crc): |
| 539 | for j in range(8): |
| 540 | if crc & 1: |
| 541 | crc = (crc >> 1) ^ 0xEDB88320 |
| 542 | else: |
| 543 | crc >>= 1 |
| 544 | return crc |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 545 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 546 | # ZIP supports a password-based form of encryption. Even though known |
| 547 | # plaintext attacks have been found against it, it is still useful |
| 548 | # to be able to get data out of such a file. |
| 549 | # |
| 550 | # Usage: |
| 551 | # zd = _ZipDecrypter(mypwd) |
| 552 | # plain_bytes = zd(cypher_bytes) |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 553 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 554 | def _ZipDecrypter(pwd): |
| 555 | key0 = 305419896 |
| 556 | key1 = 591751049 |
| 557 | key2 = 878082192 |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 558 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 559 | global _crctable |
| 560 | if _crctable is None: |
| 561 | _crctable = list(map(_gen_crc, range(256))) |
| 562 | crctable = _crctable |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 563 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 564 | def crc32(ch, crc): |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 565 | """Compute the CRC32 primitive on one byte.""" |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 566 | return (crc >> 8) ^ crctable[(crc ^ ch) & 0xFF] |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 567 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 568 | def update_keys(c): |
| 569 | nonlocal key0, key1, key2 |
| 570 | key0 = crc32(c, key0) |
| 571 | key1 = (key1 + (key0 & 0xFF)) & 0xFFFFFFFF |
| 572 | key1 = (key1 * 134775813 + 1) & 0xFFFFFFFF |
| 573 | key2 = crc32(key1 >> 24, key2) |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 574 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 575 | for p in pwd: |
| 576 | update_keys(p) |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 577 | |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 578 | def decrypter(data): |
| 579 | """Decrypt a bytes object.""" |
| 580 | result = bytearray() |
| 581 | append = result.append |
| 582 | for c in data: |
| 583 | k = key2 | 2 |
| 584 | c ^= ((k * (k^1)) >> 8) & 0xFF |
| 585 | update_keys(c) |
| 586 | append(c) |
| 587 | return bytes(result) |
| 588 | |
| 589 | return decrypter |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 590 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 591 | |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 592 | class LZMACompressor: |
| 593 | |
| 594 | def __init__(self): |
| 595 | self._comp = None |
| 596 | |
| 597 | def _init(self): |
Nadeem Vawda | a425c3d | 2012-06-21 23:36:48 +0200 | [diff] [blame] | 598 | props = lzma._encode_filter_properties({'id': lzma.FILTER_LZMA1}) |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 599 | self._comp = lzma.LZMACompressor(lzma.FORMAT_RAW, filters=[ |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 600 | lzma._decode_filter_properties(lzma.FILTER_LZMA1, props) |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 601 | ]) |
| 602 | return struct.pack('<BBH', 9, 4, len(props)) + props |
| 603 | |
| 604 | def compress(self, data): |
| 605 | if self._comp is None: |
| 606 | return self._init() + self._comp.compress(data) |
| 607 | return self._comp.compress(data) |
| 608 | |
| 609 | def flush(self): |
| 610 | if self._comp is None: |
| 611 | return self._init() + self._comp.flush() |
| 612 | return self._comp.flush() |
| 613 | |
| 614 | |
| 615 | class LZMADecompressor: |
| 616 | |
| 617 | def __init__(self): |
| 618 | self._decomp = None |
| 619 | self._unconsumed = b'' |
| 620 | self.eof = False |
| 621 | |
| 622 | def decompress(self, data): |
| 623 | if self._decomp is None: |
| 624 | self._unconsumed += data |
| 625 | if len(self._unconsumed) <= 4: |
| 626 | return b'' |
| 627 | psize, = struct.unpack('<H', self._unconsumed[2:4]) |
| 628 | if len(self._unconsumed) <= 4 + psize: |
| 629 | return b'' |
| 630 | |
| 631 | self._decomp = lzma.LZMADecompressor(lzma.FORMAT_RAW, filters=[ |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 632 | lzma._decode_filter_properties(lzma.FILTER_LZMA1, |
| 633 | self._unconsumed[4:4 + psize]) |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 634 | ]) |
| 635 | data = self._unconsumed[4 + psize:] |
| 636 | del self._unconsumed |
| 637 | |
| 638 | result = self._decomp.decompress(data) |
| 639 | self.eof = self._decomp.eof |
| 640 | return result |
| 641 | |
| 642 | |
| 643 | compressor_names = { |
| 644 | 0: 'store', |
| 645 | 1: 'shrink', |
| 646 | 2: 'reduce', |
| 647 | 3: 'reduce', |
| 648 | 4: 'reduce', |
| 649 | 5: 'reduce', |
| 650 | 6: 'implode', |
| 651 | 7: 'tokenize', |
| 652 | 8: 'deflate', |
| 653 | 9: 'deflate64', |
| 654 | 10: 'implode', |
| 655 | 12: 'bzip2', |
| 656 | 14: 'lzma', |
| 657 | 18: 'terse', |
| 658 | 19: 'lz77', |
| 659 | 97: 'wavpack', |
| 660 | 98: 'ppmd', |
| 661 | } |
| 662 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 663 | def _check_compression(compression): |
| 664 | if compression == ZIP_STORED: |
| 665 | pass |
| 666 | elif compression == ZIP_DEFLATED: |
| 667 | if not zlib: |
| 668 | raise RuntimeError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 669 | "Compression requires the (missing) zlib module") |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 670 | elif compression == ZIP_BZIP2: |
| 671 | if not bz2: |
| 672 | raise RuntimeError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 673 | "Compression requires the (missing) bz2 module") |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 674 | elif compression == ZIP_LZMA: |
| 675 | if not lzma: |
| 676 | raise RuntimeError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 677 | "Compression requires the (missing) lzma module") |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 678 | else: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 679 | raise NotImplementedError("That compression method is not supported") |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 680 | |
| 681 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 682 | def _get_compressor(compress_type, compresslevel=None): |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 683 | if compress_type == ZIP_DEFLATED: |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 684 | if compresslevel is not None: |
| 685 | return zlib.compressobj(compresslevel, zlib.DEFLATED, -15) |
| 686 | return zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION, zlib.DEFLATED, -15) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 687 | elif compress_type == ZIP_BZIP2: |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 688 | if compresslevel is not None: |
| 689 | return bz2.BZ2Compressor(compresslevel) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 690 | return bz2.BZ2Compressor() |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 691 | # compresslevel is ignored for ZIP_LZMA |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 692 | elif compress_type == ZIP_LZMA: |
| 693 | return LZMACompressor() |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 694 | else: |
| 695 | return None |
| 696 | |
| 697 | |
| 698 | def _get_decompressor(compress_type): |
Berker Peksag | 2f1b857 | 2019-09-12 17:13:44 +0300 | [diff] [blame] | 699 | _check_compression(compress_type) |
Martin v. Löwis | b3260f0 | 2012-05-01 08:38:01 +0200 | [diff] [blame] | 700 | if compress_type == ZIP_STORED: |
| 701 | return None |
| 702 | elif compress_type == ZIP_DEFLATED: |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 703 | return zlib.decompressobj(-15) |
| 704 | elif compress_type == ZIP_BZIP2: |
| 705 | return bz2.BZ2Decompressor() |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 706 | elif compress_type == ZIP_LZMA: |
| 707 | return LZMADecompressor() |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 708 | else: |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 709 | descr = compressor_names.get(compress_type) |
Martin v. Löwis | b3260f0 | 2012-05-01 08:38:01 +0200 | [diff] [blame] | 710 | if descr: |
| 711 | raise NotImplementedError("compression type %d (%s)" % (compress_type, descr)) |
| 712 | else: |
| 713 | raise NotImplementedError("compression type %d" % (compress_type,)) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 714 | |
| 715 | |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 716 | class _SharedFile: |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 717 | def __init__(self, file, pos, close, lock, writing): |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 718 | self._file = file |
| 719 | self._pos = pos |
| 720 | self._close = close |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 721 | self._lock = lock |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 722 | self._writing = writing |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 723 | self.seekable = file.seekable |
| 724 | self.tell = file.tell |
| 725 | |
| 726 | def seek(self, offset, whence=0): |
| 727 | with self._lock: |
Mickaël Schoentgen | 3f8c691 | 2018-07-29 20:26:52 +0200 | [diff] [blame] | 728 | if self._writing(): |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 729 | raise ValueError("Can't reposition in the ZIP file while " |
| 730 | "there is an open writing handle on it. " |
| 731 | "Close the writing handle before trying to read.") |
Mickaël Schoentgen | 3f8c691 | 2018-07-29 20:26:52 +0200 | [diff] [blame] | 732 | self._file.seek(offset, whence) |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 733 | self._pos = self._file.tell() |
| 734 | return self._pos |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 735 | |
| 736 | def read(self, n=-1): |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 737 | with self._lock: |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 738 | if self._writing(): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 739 | raise ValueError("Can't read from the ZIP file while there " |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 740 | "is an open writing handle on it. " |
| 741 | "Close the writing handle before trying to read.") |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 742 | self._file.seek(self._pos) |
| 743 | data = self._file.read(n) |
| 744 | self._pos = self._file.tell() |
| 745 | return data |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 746 | |
| 747 | def close(self): |
| 748 | if self._file is not None: |
| 749 | fileobj = self._file |
| 750 | self._file = None |
| 751 | self._close(fileobj) |
| 752 | |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 753 | # Provide the tell method for unseekable stream |
| 754 | class _Tellable: |
| 755 | def __init__(self, fp): |
| 756 | self.fp = fp |
| 757 | self.offset = 0 |
| 758 | |
| 759 | def write(self, data): |
| 760 | n = self.fp.write(data) |
| 761 | self.offset += n |
| 762 | return n |
| 763 | |
| 764 | def tell(self): |
| 765 | return self.offset |
| 766 | |
| 767 | def flush(self): |
| 768 | self.fp.flush() |
| 769 | |
| 770 | def close(self): |
| 771 | self.fp.close() |
| 772 | |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 773 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 774 | class ZipExtFile(io.BufferedIOBase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 775 | """File-like object for reading an archive member. |
| 776 | Is returned by ZipFile.open(). |
| 777 | """ |
| 778 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 779 | # Max size supported by decompressor. |
| 780 | MAX_N = 1 << 31 - 1 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 781 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 782 | # Read from compressed files in 4k blocks. |
| 783 | MIN_READ_SIZE = 4096 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 784 | |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 785 | # Chunk size to read during seek |
| 786 | MAX_SEEK_READ = 1 << 24 |
| 787 | |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 788 | def __init__(self, fileobj, mode, zipinfo, pwd=None, |
Łukasz Langa | e94980a | 2010-11-22 23:31:26 +0000 | [diff] [blame] | 789 | close_fileobj=False): |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 790 | self._fileobj = fileobj |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 791 | self._pwd = pwd |
Łukasz Langa | e94980a | 2010-11-22 23:31:26 +0000 | [diff] [blame] | 792 | self._close_fileobj = close_fileobj |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 793 | |
Ezio Melotti | 92b4743 | 2010-01-28 01:44:41 +0000 | [diff] [blame] | 794 | self._compress_type = zipinfo.compress_type |
Ezio Melotti | 92b4743 | 2010-01-28 01:44:41 +0000 | [diff] [blame] | 795 | self._compress_left = zipinfo.compress_size |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 796 | self._left = zipinfo.file_size |
Ezio Melotti | 92b4743 | 2010-01-28 01:44:41 +0000 | [diff] [blame] | 797 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 798 | self._decompressor = _get_decompressor(self._compress_type) |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 799 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 800 | self._eof = False |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 801 | self._readbuffer = b'' |
| 802 | self._offset = 0 |
| 803 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 804 | self.newlines = None |
| 805 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 806 | self.mode = mode |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 807 | self.name = zipinfo.filename |
| 808 | |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 809 | if hasattr(zipinfo, 'CRC'): |
| 810 | self._expected_crc = zipinfo.CRC |
Martin Panter | b82032f | 2015-12-11 05:19:29 +0000 | [diff] [blame] | 811 | self._running_crc = crc32(b'') |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 812 | else: |
| 813 | self._expected_crc = None |
| 814 | |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 815 | self._seekable = False |
| 816 | try: |
| 817 | if fileobj.seekable(): |
| 818 | self._orig_compress_start = fileobj.tell() |
| 819 | self._orig_compress_size = zipinfo.compress_size |
| 820 | self._orig_file_size = zipinfo.file_size |
| 821 | self._orig_start_crc = self._running_crc |
| 822 | self._seekable = True |
| 823 | except AttributeError: |
| 824 | pass |
| 825 | |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 826 | self._decrypter = None |
| 827 | if pwd: |
| 828 | if zipinfo.flag_bits & 0x8: |
| 829 | # compare against the file type from extended local headers |
| 830 | check_byte = (zipinfo._raw_time >> 8) & 0xff |
| 831 | else: |
| 832 | # compare against the CRC otherwise |
| 833 | check_byte = (zipinfo.CRC >> 24) & 0xff |
| 834 | h = self._init_decrypter() |
| 835 | if h != check_byte: |
| 836 | raise RuntimeError("Bad password for file %r" % zipinfo.orig_filename) |
| 837 | |
| 838 | |
| 839 | def _init_decrypter(self): |
| 840 | self._decrypter = _ZipDecrypter(self._pwd) |
| 841 | # The first 12 bytes in the cypher stream is an encryption header |
| 842 | # used to strengthen the algorithm. The first 11 bytes are |
| 843 | # completely random, while the 12th contains the MSB of the CRC, |
| 844 | # or the MSB of the file time depending on the header type |
| 845 | # and is used to check the correctness of the password. |
| 846 | header = self._fileobj.read(12) |
| 847 | self._compress_left -= 12 |
| 848 | return self._decrypter(header)[11] |
| 849 | |
Serhiy Storchaka | 51a4370 | 2014-10-29 22:42:06 +0200 | [diff] [blame] | 850 | def __repr__(self): |
| 851 | result = ['<%s.%s' % (self.__class__.__module__, |
| 852 | self.__class__.__qualname__)] |
| 853 | if not self.closed: |
| 854 | result.append(' name=%r mode=%r' % (self.name, self.mode)) |
| 855 | if self._compress_type != ZIP_STORED: |
| 856 | result.append(' compress_type=%s' % |
| 857 | compressor_names.get(self._compress_type, |
| 858 | self._compress_type)) |
| 859 | else: |
| 860 | result.append(' [closed]') |
| 861 | result.append('>') |
| 862 | return ''.join(result) |
| 863 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 864 | def readline(self, limit=-1): |
| 865 | """Read and return a line from the stream. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 866 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 867 | If limit is specified, at most limit bytes will be read. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 868 | """ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 869 | |
Serhiy Storchaka | e670be2 | 2016-06-11 19:32:44 +0300 | [diff] [blame] | 870 | if limit < 0: |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 871 | # Shortcut common case - newline found in buffer. |
| 872 | i = self._readbuffer.find(b'\n', self._offset) + 1 |
| 873 | if i > 0: |
| 874 | line = self._readbuffer[self._offset: i] |
| 875 | self._offset = i |
| 876 | return line |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 877 | |
Serhiy Storchaka | e670be2 | 2016-06-11 19:32:44 +0300 | [diff] [blame] | 878 | return io.BufferedIOBase.readline(self, limit) |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 879 | |
| 880 | def peek(self, n=1): |
| 881 | """Returns buffered bytes without advancing the position.""" |
| 882 | if n > len(self._readbuffer) - self._offset: |
| 883 | chunk = self.read(n) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 884 | if len(chunk) > self._offset: |
| 885 | self._readbuffer = chunk + self._readbuffer[self._offset:] |
| 886 | self._offset = 0 |
| 887 | else: |
| 888 | self._offset -= len(chunk) |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 889 | |
| 890 | # Return up to 512 bytes to reduce allocation overhead for tight loops. |
| 891 | return self._readbuffer[self._offset: self._offset + 512] |
| 892 | |
| 893 | def readable(self): |
Daniel Hillier | 8d62df6 | 2019-11-30 19:30:47 +1100 | [diff] [blame] | 894 | if self.closed: |
| 895 | raise ValueError("I/O operation on closed file.") |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 896 | return True |
| 897 | |
| 898 | def read(self, n=-1): |
| 899 | """Read and return up to n bytes. |
nick sung | 53c2935 | 2019-03-15 03:26:25 +0800 | [diff] [blame] | 900 | If the argument is omitted, None, or negative, data is read and returned until EOF is reached. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 901 | """ |
Daniel Hillier | 8d62df6 | 2019-11-30 19:30:47 +1100 | [diff] [blame] | 902 | if self.closed: |
| 903 | raise ValueError("read from closed file.") |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 904 | if n is None or n < 0: |
| 905 | buf = self._readbuffer[self._offset:] |
| 906 | self._readbuffer = b'' |
| 907 | self._offset = 0 |
| 908 | while not self._eof: |
| 909 | buf += self._read1(self.MAX_N) |
| 910 | return buf |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 911 | |
Antoine Pitrou | 78157b3 | 2012-06-23 16:44:48 +0200 | [diff] [blame] | 912 | end = n + self._offset |
| 913 | if end < len(self._readbuffer): |
| 914 | buf = self._readbuffer[self._offset:end] |
| 915 | self._offset = end |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 916 | return buf |
| 917 | |
Antoine Pitrou | 78157b3 | 2012-06-23 16:44:48 +0200 | [diff] [blame] | 918 | n = end - len(self._readbuffer) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 919 | buf = self._readbuffer[self._offset:] |
| 920 | self._readbuffer = b'' |
| 921 | self._offset = 0 |
| 922 | while n > 0 and not self._eof: |
| 923 | data = self._read1(n) |
| 924 | if n < len(data): |
| 925 | self._readbuffer = data |
| 926 | self._offset = n |
| 927 | buf += data[:n] |
| 928 | break |
| 929 | buf += data |
| 930 | n -= len(data) |
| 931 | return buf |
| 932 | |
| 933 | def _update_crc(self, newdata): |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 934 | # Update the CRC using the given data. |
| 935 | if self._expected_crc is None: |
| 936 | # No need to compute the CRC if we don't have a reference value |
| 937 | return |
Martin Panter | b82032f | 2015-12-11 05:19:29 +0000 | [diff] [blame] | 938 | self._running_crc = crc32(newdata, self._running_crc) |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 939 | # Check the CRC if we're at the end of the file |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 940 | if self._eof and self._running_crc != self._expected_crc: |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 941 | raise BadZipFile("Bad CRC-32 for file %r" % self.name) |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 942 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 943 | def read1(self, n): |
| 944 | """Read up to n bytes with at most one read() system call.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 945 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 946 | if n is None or n < 0: |
| 947 | buf = self._readbuffer[self._offset:] |
| 948 | self._readbuffer = b'' |
| 949 | self._offset = 0 |
Serhiy Storchaka | d2c07a5 | 2013-09-27 22:11:57 +0300 | [diff] [blame] | 950 | while not self._eof: |
| 951 | data = self._read1(self.MAX_N) |
| 952 | if data: |
| 953 | buf += data |
| 954 | break |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 955 | return buf |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 956 | |
Antoine Pitrou | 78157b3 | 2012-06-23 16:44:48 +0200 | [diff] [blame] | 957 | end = n + self._offset |
| 958 | if end < len(self._readbuffer): |
| 959 | buf = self._readbuffer[self._offset:end] |
| 960 | self._offset = end |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 961 | return buf |
| 962 | |
Antoine Pitrou | 78157b3 | 2012-06-23 16:44:48 +0200 | [diff] [blame] | 963 | n = end - len(self._readbuffer) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 964 | buf = self._readbuffer[self._offset:] |
| 965 | self._readbuffer = b'' |
| 966 | self._offset = 0 |
| 967 | if n > 0: |
Serhiy Storchaka | d2c07a5 | 2013-09-27 22:11:57 +0300 | [diff] [blame] | 968 | while not self._eof: |
| 969 | data = self._read1(n) |
| 970 | if n < len(data): |
| 971 | self._readbuffer = data |
| 972 | self._offset = n |
| 973 | buf += data[:n] |
| 974 | break |
| 975 | if data: |
| 976 | buf += data |
| 977 | break |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 978 | return buf |
| 979 | |
| 980 | def _read1(self, n): |
| 981 | # Read up to n compressed bytes with at most one read() system call, |
| 982 | # decrypt and decompress them. |
| 983 | if self._eof or n <= 0: |
| 984 | return b'' |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 985 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 986 | # Read from file. |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 987 | if self._compress_type == ZIP_DEFLATED: |
| 988 | ## Handle unconsumed data. |
| 989 | data = self._decompressor.unconsumed_tail |
| 990 | if n > len(data): |
| 991 | data += self._read2(n - len(data)) |
| 992 | else: |
| 993 | data = self._read2(n) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 994 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 995 | if self._compress_type == ZIP_STORED: |
| 996 | self._eof = self._compress_left <= 0 |
| 997 | elif self._compress_type == ZIP_DEFLATED: |
| 998 | n = max(n, self.MIN_READ_SIZE) |
| 999 | data = self._decompressor.decompress(data, n) |
| 1000 | self._eof = (self._decompressor.eof or |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1001 | self._compress_left <= 0 and |
| 1002 | not self._decompressor.unconsumed_tail) |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1003 | if self._eof: |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 1004 | data += self._decompressor.flush() |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1005 | else: |
| 1006 | data = self._decompressor.decompress(data) |
| 1007 | self._eof = self._decompressor.eof or self._compress_left <= 0 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1008 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1009 | data = data[:self._left] |
| 1010 | self._left -= len(data) |
| 1011 | if self._left <= 0: |
| 1012 | self._eof = True |
| 1013 | self._update_crc(data) |
| 1014 | return data |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 1015 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1016 | def _read2(self, n): |
| 1017 | if self._compress_left <= 0: |
| 1018 | return b'' |
| 1019 | |
| 1020 | n = max(n, self.MIN_READ_SIZE) |
| 1021 | n = min(n, self._compress_left) |
| 1022 | |
| 1023 | data = self._fileobj.read(n) |
| 1024 | self._compress_left -= len(data) |
Serhiy Storchaka | 5ce3f10 | 2014-01-09 14:50:20 +0200 | [diff] [blame] | 1025 | if not data: |
| 1026 | raise EOFError |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1027 | |
| 1028 | if self._decrypter is not None: |
Serhiy Storchaka | 06e5225 | 2017-03-30 19:09:08 +0300 | [diff] [blame] | 1029 | data = self._decrypter(data) |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1030 | return data |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1031 | |
Łukasz Langa | e94980a | 2010-11-22 23:31:26 +0000 | [diff] [blame] | 1032 | def close(self): |
| 1033 | try: |
| 1034 | if self._close_fileobj: |
| 1035 | self._fileobj.close() |
| 1036 | finally: |
| 1037 | super().close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1038 | |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1039 | def seekable(self): |
Daniel Hillier | 8d62df6 | 2019-11-30 19:30:47 +1100 | [diff] [blame] | 1040 | if self.closed: |
| 1041 | raise ValueError("I/O operation on closed file.") |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1042 | return self._seekable |
| 1043 | |
| 1044 | def seek(self, offset, whence=0): |
Daniel Hillier | 8d62df6 | 2019-11-30 19:30:47 +1100 | [diff] [blame] | 1045 | if self.closed: |
| 1046 | raise ValueError("seek on closed file.") |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1047 | if not self._seekable: |
| 1048 | raise io.UnsupportedOperation("underlying stream is not seekable") |
| 1049 | curr_pos = self.tell() |
| 1050 | if whence == 0: # Seek from start of file |
| 1051 | new_pos = offset |
| 1052 | elif whence == 1: # Seek from current position |
| 1053 | new_pos = curr_pos + offset |
| 1054 | elif whence == 2: # Seek from EOF |
| 1055 | new_pos = self._orig_file_size + offset |
| 1056 | else: |
| 1057 | raise ValueError("whence must be os.SEEK_SET (0), " |
| 1058 | "os.SEEK_CUR (1), or os.SEEK_END (2)") |
| 1059 | |
| 1060 | if new_pos > self._orig_file_size: |
| 1061 | new_pos = self._orig_file_size |
| 1062 | |
| 1063 | if new_pos < 0: |
| 1064 | new_pos = 0 |
| 1065 | |
| 1066 | read_offset = new_pos - curr_pos |
| 1067 | buff_offset = read_offset + self._offset |
| 1068 | |
| 1069 | if buff_offset >= 0 and buff_offset < len(self._readbuffer): |
| 1070 | # Just move the _offset index if the new position is in the _readbuffer |
| 1071 | self._offset = buff_offset |
| 1072 | read_offset = 0 |
| 1073 | elif read_offset < 0: |
| 1074 | # Position is before the current position. Reset the ZipExtFile |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1075 | self._fileobj.seek(self._orig_compress_start) |
| 1076 | self._running_crc = self._orig_start_crc |
| 1077 | self._compress_left = self._orig_compress_size |
| 1078 | self._left = self._orig_file_size |
| 1079 | self._readbuffer = b'' |
| 1080 | self._offset = 0 |
Mickaël Schoentgen | 3f8c691 | 2018-07-29 20:26:52 +0200 | [diff] [blame] | 1081 | self._decompressor = _get_decompressor(self._compress_type) |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1082 | self._eof = False |
| 1083 | read_offset = new_pos |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 1084 | if self._decrypter is not None: |
| 1085 | self._init_decrypter() |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1086 | |
| 1087 | while read_offset > 0: |
| 1088 | read_len = min(self.MAX_SEEK_READ, read_offset) |
| 1089 | self.read(read_len) |
| 1090 | read_offset -= read_len |
| 1091 | |
| 1092 | return self.tell() |
| 1093 | |
| 1094 | def tell(self): |
Daniel Hillier | 8d62df6 | 2019-11-30 19:30:47 +1100 | [diff] [blame] | 1095 | if self.closed: |
| 1096 | raise ValueError("tell on closed file.") |
John Jolly | 066df4f | 2018-01-30 01:51:35 -0700 | [diff] [blame] | 1097 | if not self._seekable: |
| 1098 | raise io.UnsupportedOperation("underlying stream is not seekable") |
| 1099 | filepos = self._orig_file_size - self._left - len(self._readbuffer) + self._offset |
| 1100 | return filepos |
| 1101 | |
Antoine Pitrou | a32f9a2 | 2010-01-27 21:18:57 +0000 | [diff] [blame] | 1102 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1103 | class _ZipWriteFile(io.BufferedIOBase): |
| 1104 | def __init__(self, zf, zinfo, zip64): |
| 1105 | self._zinfo = zinfo |
| 1106 | self._zip64 = zip64 |
| 1107 | self._zipfile = zf |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1108 | self._compressor = _get_compressor(zinfo.compress_type, |
| 1109 | zinfo._compresslevel) |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1110 | self._file_size = 0 |
| 1111 | self._compress_size = 0 |
| 1112 | self._crc = 0 |
| 1113 | |
| 1114 | @property |
| 1115 | def _fileobj(self): |
| 1116 | return self._zipfile.fp |
| 1117 | |
| 1118 | def writable(self): |
| 1119 | return True |
| 1120 | |
| 1121 | def write(self, data): |
Serhiy Storchaka | 4c0d9ea | 2017-04-12 16:03:23 +0300 | [diff] [blame] | 1122 | if self.closed: |
| 1123 | raise ValueError('I/O operation on closed file.') |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1124 | nbytes = len(data) |
| 1125 | self._file_size += nbytes |
| 1126 | self._crc = crc32(data, self._crc) |
| 1127 | if self._compressor: |
| 1128 | data = self._compressor.compress(data) |
| 1129 | self._compress_size += len(data) |
| 1130 | self._fileobj.write(data) |
| 1131 | return nbytes |
| 1132 | |
| 1133 | def close(self): |
Serhiy Storchaka | 4c0d9ea | 2017-04-12 16:03:23 +0300 | [diff] [blame] | 1134 | if self.closed: |
| 1135 | return |
Serhiy Storchaka | 2524fde | 2019-03-30 08:25:19 +0200 | [diff] [blame] | 1136 | try: |
| 1137 | super().close() |
| 1138 | # Flush any data from the compressor, and update header info |
| 1139 | if self._compressor: |
| 1140 | buf = self._compressor.flush() |
| 1141 | self._compress_size += len(buf) |
| 1142 | self._fileobj.write(buf) |
| 1143 | self._zinfo.compress_size = self._compress_size |
| 1144 | else: |
| 1145 | self._zinfo.compress_size = self._file_size |
| 1146 | self._zinfo.CRC = self._crc |
| 1147 | self._zinfo.file_size = self._file_size |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1148 | |
Serhiy Storchaka | 2524fde | 2019-03-30 08:25:19 +0200 | [diff] [blame] | 1149 | # Write updated header info |
| 1150 | if self._zinfo.flag_bits & 0x08: |
| 1151 | # Write CRC and file sizes after the file data |
| 1152 | fmt = '<LLQQ' if self._zip64 else '<LLLL' |
| 1153 | self._fileobj.write(struct.pack(fmt, _DD_SIGNATURE, self._zinfo.CRC, |
| 1154 | self._zinfo.compress_size, self._zinfo.file_size)) |
| 1155 | self._zipfile.start_dir = self._fileobj.tell() |
| 1156 | else: |
| 1157 | if not self._zip64: |
| 1158 | if self._file_size > ZIP64_LIMIT: |
| 1159 | raise RuntimeError( |
| 1160 | 'File size unexpectedly exceeded ZIP64 limit') |
| 1161 | if self._compress_size > ZIP64_LIMIT: |
| 1162 | raise RuntimeError( |
| 1163 | 'Compressed size unexpectedly exceeded ZIP64 limit') |
| 1164 | # Seek backwards and write file header (which will now include |
| 1165 | # correct CRC and file sizes) |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1166 | |
Serhiy Storchaka | 2524fde | 2019-03-30 08:25:19 +0200 | [diff] [blame] | 1167 | # Preserve current position in file |
| 1168 | self._zipfile.start_dir = self._fileobj.tell() |
| 1169 | self._fileobj.seek(self._zinfo.header_offset) |
| 1170 | self._fileobj.write(self._zinfo.FileHeader(self._zip64)) |
| 1171 | self._fileobj.seek(self._zipfile.start_dir) |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1172 | |
Serhiy Storchaka | 2524fde | 2019-03-30 08:25:19 +0200 | [diff] [blame] | 1173 | # Successfully written: Add file to our caches |
| 1174 | self._zipfile.filelist.append(self._zinfo) |
| 1175 | self._zipfile.NameToInfo[self._zinfo.filename] = self._zinfo |
| 1176 | finally: |
| 1177 | self._zipfile._writing = False |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1178 | |
Serhiy Storchaka | 2524fde | 2019-03-30 08:25:19 +0200 | [diff] [blame] | 1179 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1180 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1181 | class ZipFile: |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 1182 | """ Class with methods to open, read, write, close, list zip files. |
| 1183 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1184 | z = ZipFile(file, mode="r", compression=ZIP_STORED, allowZip64=True, |
| 1185 | compresslevel=None) |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 1186 | |
Fred Drake | 3d9091e | 2001-03-26 15:49:24 +0000 | [diff] [blame] | 1187 | file: Either the path to the file, or a file-like object. |
| 1188 | If it is a path, the file will be opened and closed by ZipFile. |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1189 | mode: The mode can be either read 'r', write 'w', exclusive create 'x', |
| 1190 | or append 'a'. |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 1191 | compression: ZIP_STORED (no compression), ZIP_DEFLATED (requires zlib), |
| 1192 | ZIP_BZIP2 (requires bz2) or ZIP_LZMA (requires lzma). |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1193 | allowZip64: if True ZipFile will create files with ZIP64 extensions when |
| 1194 | needed, otherwise it will raise an exception when this would |
| 1195 | be necessary. |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1196 | compresslevel: None (default for the given compression type) or an integer |
| 1197 | specifying the level to pass to the compressor. |
| 1198 | When using ZIP_STORED or ZIP_LZMA this keyword has no effect. |
| 1199 | When using ZIP_DEFLATED integers 0 through 9 are accepted. |
| 1200 | When using ZIP_BZIP2 integers 1 through 9 are accepted. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1201 | |
Fred Drake | 3d9091e | 2001-03-26 15:49:24 +0000 | [diff] [blame] | 1202 | """ |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1203 | |
Fred Drake | 90eac28 | 2001-02-28 05:29:34 +0000 | [diff] [blame] | 1204 | fp = None # Set here since __del__ checks it |
Gregory P. Smith | 09aa752 | 2013-02-03 00:36:32 -0800 | [diff] [blame] | 1205 | _windows_illegal_name_trans_table = None |
Fred Drake | 90eac28 | 2001-02-28 05:29:34 +0000 | [diff] [blame] | 1206 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1207 | def __init__(self, file, mode="r", compression=ZIP_STORED, allowZip64=True, |
Marcel Plch | 77b112c | 2018-08-31 16:43:31 +0200 | [diff] [blame] | 1208 | compresslevel=None, *, strict_timestamps=True): |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1209 | """Open the ZIP file with mode read 'r', write 'w', exclusive create 'x', |
| 1210 | or append 'a'.""" |
| 1211 | if mode not in ('r', 'w', 'x', 'a'): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1212 | raise ValueError("ZipFile requires mode 'r', 'w', 'x', or 'a'") |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1213 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1214 | _check_compression(compression) |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1215 | |
| 1216 | self._allowZip64 = allowZip64 |
| 1217 | self._didModify = False |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 1218 | self.debug = 0 # Level of printing: 0 through 3 |
| 1219 | self.NameToInfo = {} # Find file info given name |
| 1220 | self.filelist = [] # List of ZipInfo instances for archive |
| 1221 | self.compression = compression # Method of compression |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1222 | self.compresslevel = compresslevel |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1223 | self.mode = mode |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 1224 | self.pwd = None |
R David Murray | f50b38a | 2012-04-12 18:44:58 -0400 | [diff] [blame] | 1225 | self._comment = b'' |
Marcel Plch | 77b112c | 2018-08-31 16:43:31 +0200 | [diff] [blame] | 1226 | self._strict_timestamps = strict_timestamps |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 1227 | |
Fred Drake | 3d9091e | 2001-03-26 15:49:24 +0000 | [diff] [blame] | 1228 | # Check if we were passed a file-like object |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1229 | if isinstance(file, os.PathLike): |
| 1230 | file = os.fspath(file) |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 1231 | if isinstance(file, str): |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1232 | # No, it's a filename |
Fred Drake | 3d9091e | 2001-03-26 15:49:24 +0000 | [diff] [blame] | 1233 | self._filePassed = 0 |
| 1234 | self.filename = file |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1235 | modeDict = {'r' : 'rb', 'w': 'w+b', 'x': 'x+b', 'a' : 'r+b', |
| 1236 | 'r+b': 'w+b', 'w+b': 'wb', 'x+b': 'xb'} |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1237 | filemode = modeDict[mode] |
| 1238 | while True: |
| 1239 | try: |
| 1240 | self.fp = io.open(file, filemode) |
| 1241 | except OSError: |
| 1242 | if filemode in modeDict: |
| 1243 | filemode = modeDict[filemode] |
| 1244 | continue |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 1245 | raise |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1246 | break |
Fred Drake | 3d9091e | 2001-03-26 15:49:24 +0000 | [diff] [blame] | 1247 | else: |
| 1248 | self._filePassed = 1 |
| 1249 | self.fp = file |
| 1250 | self.filename = getattr(file, 'name', None) |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1251 | self._fileRefCnt = 1 |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1252 | self._lock = threading.RLock() |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1253 | self._seekable = True |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1254 | self._writing = False |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 1255 | |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1256 | try: |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1257 | if mode == 'r': |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 1258 | self._RealGetContents() |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1259 | elif mode in ('w', 'x'): |
Georg Brandl | 268e4d4 | 2010-10-14 06:59:45 +0000 | [diff] [blame] | 1260 | # set the modified flag so central directory gets written |
| 1261 | # even if no files are added to the archive |
| 1262 | self._didModify = True |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1263 | try: |
Serhiy Storchaka | 34cba33 | 2017-01-01 19:00:30 +0200 | [diff] [blame] | 1264 | self.start_dir = self.fp.tell() |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1265 | except (AttributeError, OSError): |
| 1266 | self.fp = _Tellable(self.fp) |
Serhiy Storchaka | 34cba33 | 2017-01-01 19:00:30 +0200 | [diff] [blame] | 1267 | self.start_dir = 0 |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1268 | self._seekable = False |
| 1269 | else: |
| 1270 | # Some file-like objects can provide tell() but not seek() |
| 1271 | try: |
| 1272 | self.fp.seek(self.start_dir) |
| 1273 | except (AttributeError, OSError): |
| 1274 | self._seekable = False |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1275 | elif mode == 'a': |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1276 | try: |
| 1277 | # See if file is a zip file |
| 1278 | self._RealGetContents() |
| 1279 | # seek to start of directory and overwrite |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1280 | self.fp.seek(self.start_dir) |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1281 | except BadZipFile: |
| 1282 | # file is not a zip file, just append |
| 1283 | self.fp.seek(0, 2) |
| 1284 | |
| 1285 | # set the modified flag so central directory gets written |
| 1286 | # even if no files are added to the archive |
| 1287 | self._didModify = True |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1288 | self.start_dir = self.fp.tell() |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1289 | else: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1290 | raise ValueError("Mode must be 'r', 'w', 'x', or 'a'") |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1291 | except: |
| 1292 | fp = self.fp |
| 1293 | self.fp = None |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1294 | self._fpclose(fp) |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1295 | raise |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1296 | |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 1297 | def __enter__(self): |
| 1298 | return self |
| 1299 | |
| 1300 | def __exit__(self, type, value, traceback): |
| 1301 | self.close() |
| 1302 | |
Serhiy Storchaka | 51a4370 | 2014-10-29 22:42:06 +0200 | [diff] [blame] | 1303 | def __repr__(self): |
| 1304 | result = ['<%s.%s' % (self.__class__.__module__, |
| 1305 | self.__class__.__qualname__)] |
| 1306 | if self.fp is not None: |
| 1307 | if self._filePassed: |
| 1308 | result.append(' file=%r' % self.fp) |
| 1309 | elif self.filename is not None: |
| 1310 | result.append(' filename=%r' % self.filename) |
| 1311 | result.append(' mode=%r' % self.mode) |
| 1312 | else: |
| 1313 | result.append(' [closed]') |
| 1314 | result.append('>') |
| 1315 | return ''.join(result) |
| 1316 | |
Tim Peters | 7d3bad6 | 2001-04-04 18:56:49 +0000 | [diff] [blame] | 1317 | def _RealGetContents(self): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1318 | """Read in the table of contents for the ZIP file.""" |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1319 | fp = self.fp |
Georg Brandl | 268e4d4 | 2010-10-14 06:59:45 +0000 | [diff] [blame] | 1320 | try: |
| 1321 | endrec = _EndRecData(fp) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1322 | except OSError: |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 1323 | raise BadZipFile("File is not a zip file") |
Martin v. Löwis | 6f6873b | 2002-10-13 13:54:50 +0000 | [diff] [blame] | 1324 | if not endrec: |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 1325 | raise BadZipFile("File is not a zip file") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1326 | if self.debug > 1: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1327 | print(endrec) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 1328 | size_cd = endrec[_ECD_SIZE] # bytes in central directory |
| 1329 | offset_cd = endrec[_ECD_OFFSET] # offset of central directory |
R David Murray | f50b38a | 2012-04-12 18:44:58 -0400 | [diff] [blame] | 1330 | self._comment = endrec[_ECD_COMMENT] # archive comment |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 1331 | |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1332 | # "concat" is zero, unless zip was concatenated to another file |
| 1333 | concat = endrec[_ECD_LOCATION] - size_cd - offset_cd |
Antoine Pitrou | 9e4fdf4 | 2008-09-05 23:43:02 +0000 | [diff] [blame] | 1334 | if endrec[_ECD_SIGNATURE] == stringEndArchive64: |
| 1335 | # If Zip64 extension structures are present, account for them |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1336 | concat -= (sizeEndCentDir64 + sizeEndCentDir64Locator) |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 1337 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1338 | if self.debug > 2: |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1339 | inferred = concat + offset_cd |
| 1340 | print("given, inferred, offset", offset_cd, inferred, concat) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1341 | # self.start_dir: Position of start of central directory |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1342 | self.start_dir = offset_cd + concat |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1343 | fp.seek(self.start_dir, 0) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1344 | data = fp.read(size_cd) |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1345 | fp = io.BytesIO(data) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1346 | total = 0 |
| 1347 | while total < size_cd: |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 1348 | centdir = fp.read(sizeCentralDir) |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 1349 | if len(centdir) != sizeCentralDir: |
| 1350 | raise BadZipFile("Truncated central directory") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1351 | centdir = struct.unpack(structCentralDir, centdir) |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 1352 | if centdir[_CD_SIGNATURE] != stringCentralDir: |
| 1353 | raise BadZipFile("Bad magic number for central directory") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1354 | if self.debug > 2: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1355 | print(centdir) |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 1356 | filename = fp.read(centdir[_CD_FILENAME_LENGTH]) |
Martin v. Löwis | 8570f6a | 2008-05-05 17:44:38 +0000 | [diff] [blame] | 1357 | flags = centdir[5] |
| 1358 | if flags & 0x800: |
| 1359 | # UTF-8 file names extension |
| 1360 | filename = filename.decode('utf-8') |
| 1361 | else: |
| 1362 | # Historical ZIP filename encoding |
| 1363 | filename = filename.decode('cp437') |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1364 | # Create ZipInfo instance to store file information |
Martin v. Löwis | 8570f6a | 2008-05-05 17:44:38 +0000 | [diff] [blame] | 1365 | x = ZipInfo(filename) |
Fred Drake | 3e038e5 | 2001-02-28 17:56:26 +0000 | [diff] [blame] | 1366 | x.extra = fp.read(centdir[_CD_EXTRA_FIELD_LENGTH]) |
| 1367 | x.comment = fp.read(centdir[_CD_COMMENT_LENGTH]) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1368 | x.header_offset = centdir[_CD_LOCAL_HEADER_OFFSET] |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1369 | (x.create_version, x.create_system, x.extract_version, x.reserved, |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1370 | x.flag_bits, x.compress_type, t, d, |
| 1371 | x.CRC, x.compress_size, x.file_size) = centdir[1:12] |
Martin v. Löwis | d099b56 | 2012-05-01 14:08:22 +0200 | [diff] [blame] | 1372 | if x.extract_version > MAX_EXTRACT_VERSION: |
| 1373 | raise NotImplementedError("zip file version %.1f" % |
| 1374 | (x.extract_version / 10)) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1375 | x.volume, x.internal_attr, x.external_attr = centdir[15:18] |
| 1376 | # Convert date/time code to (year, month, day, hour, min, sec) |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 1377 | x._raw_time = t |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1378 | x.date_time = ( (d>>9)+1980, (d>>5)&0xF, d&0x1F, |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1379 | t>>11, (t>>5)&0x3F, (t&0x1F) * 2 ) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1380 | |
| 1381 | x._decodeExtra() |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1382 | x.header_offset = x.header_offset + concat |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1383 | self.filelist.append(x) |
| 1384 | self.NameToInfo[x.filename] = x |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 1385 | |
| 1386 | # update total bytes read from central directory |
| 1387 | total = (total + sizeCentralDir + centdir[_CD_FILENAME_LENGTH] |
| 1388 | + centdir[_CD_EXTRA_FIELD_LENGTH] |
| 1389 | + centdir[_CD_COMMENT_LENGTH]) |
| 1390 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1391 | if self.debug > 2: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1392 | print("total", total) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1393 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1394 | |
| 1395 | def namelist(self): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1396 | """Return a list of file names in the archive.""" |
Ezio Melotti | 006917e | 2012-04-16 21:34:24 -0600 | [diff] [blame] | 1397 | return [data.filename for data in self.filelist] |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1398 | |
| 1399 | def infolist(self): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1400 | """Return a list of class ZipInfo instances for files in the |
| 1401 | archive.""" |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1402 | return self.filelist |
| 1403 | |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1404 | def printdir(self, file=None): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1405 | """Print a table of contents for the zip file.""" |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1406 | print("%-46s %19s %12s" % ("File Name", "Modified ", "Size"), |
| 1407 | file=file) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1408 | for zinfo in self.filelist: |
Guido van Rossum | 7736b5b | 2008-01-15 21:44:53 +0000 | [diff] [blame] | 1409 | date = "%d-%02d-%02d %02d:%02d:%02d" % zinfo.date_time[:6] |
Guido van Rossum | d6ca546 | 2007-05-22 01:29:33 +0000 | [diff] [blame] | 1410 | print("%-46s %s %12d" % (zinfo.filename, date, zinfo.file_size), |
| 1411 | file=file) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1412 | |
| 1413 | def testzip(self): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1414 | """Read all the files and check the CRC.""" |
Benjamin Peterson | 4cd6a95 | 2008-08-17 20:23:46 +0000 | [diff] [blame] | 1415 | chunk_size = 2 ** 20 |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1416 | for zinfo in self.filelist: |
| 1417 | try: |
Benjamin Peterson | 4cd6a95 | 2008-08-17 20:23:46 +0000 | [diff] [blame] | 1418 | # Read by chunks, to avoid an OverflowError or a |
| 1419 | # MemoryError with very large embedded files. |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1420 | with self.open(zinfo.filename, "r") as f: |
| 1421 | while f.read(chunk_size): # Check CRC-32 |
| 1422 | pass |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 1423 | except BadZipFile: |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1424 | return zinfo.filename |
| 1425 | |
| 1426 | def getinfo(self, name): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1427 | """Return the instance of ZipInfo given 'name'.""" |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1428 | info = self.NameToInfo.get(name) |
| 1429 | if info is None: |
| 1430 | raise KeyError( |
| 1431 | 'There is no item named %r in the archive' % name) |
| 1432 | |
| 1433 | return info |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1434 | |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 1435 | def setpassword(self, pwd): |
| 1436 | """Set default password for encrypted files.""" |
R. David Murray | 8d855d8 | 2010-12-21 21:53:37 +0000 | [diff] [blame] | 1437 | if pwd and not isinstance(pwd, bytes): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1438 | raise TypeError("pwd: expected bytes, got %s" % type(pwd).__name__) |
R. David Murray | 8d855d8 | 2010-12-21 21:53:37 +0000 | [diff] [blame] | 1439 | if pwd: |
| 1440 | self.pwd = pwd |
| 1441 | else: |
| 1442 | self.pwd = None |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 1443 | |
R David Murray | f50b38a | 2012-04-12 18:44:58 -0400 | [diff] [blame] | 1444 | @property |
| 1445 | def comment(self): |
| 1446 | """The comment text associated with the ZIP file.""" |
| 1447 | return self._comment |
| 1448 | |
| 1449 | @comment.setter |
| 1450 | def comment(self, comment): |
| 1451 | if not isinstance(comment, bytes): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1452 | raise TypeError("comment: expected bytes, got %s" % type(comment).__name__) |
R David Murray | f50b38a | 2012-04-12 18:44:58 -0400 | [diff] [blame] | 1453 | # check for valid comment length |
Serhiy Storchaka | 9b7a1a1 | 2014-01-20 21:57:40 +0200 | [diff] [blame] | 1454 | if len(comment) > ZIP_MAX_COMMENT: |
| 1455 | import warnings |
| 1456 | warnings.warn('Archive comment is too long; truncating to %d bytes' |
| 1457 | % ZIP_MAX_COMMENT, stacklevel=2) |
R David Murray | f50b38a | 2012-04-12 18:44:58 -0400 | [diff] [blame] | 1458 | comment = comment[:ZIP_MAX_COMMENT] |
| 1459 | self._comment = comment |
| 1460 | self._didModify = True |
| 1461 | |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 1462 | def read(self, name, pwd=None): |
Serhiy Storchaka | 4bb186d | 2018-11-25 09:51:14 +0200 | [diff] [blame] | 1463 | """Return file bytes for name.""" |
Benjamin Peterson | d285bdb | 2010-10-31 17:57:22 +0000 | [diff] [blame] | 1464 | with self.open(name, "r", pwd) as fp: |
| 1465 | return fp.read() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1466 | |
Serhiy Storchaka | f47fc55 | 2016-05-15 12:27:16 +0300 | [diff] [blame] | 1467 | def open(self, name, mode="r", pwd=None, *, force_zip64=False): |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1468 | """Return file-like object for 'name'. |
| 1469 | |
| 1470 | name is a string for the file name within the ZIP file, or a ZipInfo |
| 1471 | object. |
| 1472 | |
| 1473 | mode should be 'r' to read a file already in the ZIP file, or 'w' to |
| 1474 | write to a file newly added to the archive. |
| 1475 | |
| 1476 | pwd is the password to decrypt files (only used for reading). |
| 1477 | |
| 1478 | When writing, if the file size is not known in advance but may exceed |
| 1479 | 2 GiB, pass force_zip64 to use the ZIP64 format, which can handle large |
| 1480 | files. If the size is known in advance, it is best to pass a ZipInfo |
| 1481 | instance for name, with zinfo.file_size set. |
| 1482 | """ |
Serhiy Storchaka | e670be2 | 2016-06-11 19:32:44 +0300 | [diff] [blame] | 1483 | if mode not in {"r", "w"}: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1484 | raise ValueError('open() requires mode "r" or "w"') |
R. David Murray | 8d855d8 | 2010-12-21 21:53:37 +0000 | [diff] [blame] | 1485 | if pwd and not isinstance(pwd, bytes): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1486 | raise TypeError("pwd: expected bytes, got %s" % type(pwd).__name__) |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1487 | if pwd and (mode == "w"): |
| 1488 | raise ValueError("pwd is only supported for reading files") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1489 | if not self.fp: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1490 | raise ValueError( |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1491 | "Attempt to use ZIP archive that was already closed") |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1492 | |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1493 | # Make sure we have an info object |
| 1494 | if isinstance(name, ZipInfo): |
| 1495 | # 'name' is already an info object |
| 1496 | zinfo = name |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1497 | elif mode == 'w': |
| 1498 | zinfo = ZipInfo(name) |
| 1499 | zinfo.compress_type = self.compression |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1500 | zinfo._compresslevel = self.compresslevel |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1501 | else: |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1502 | # Get info object for name |
| 1503 | zinfo = self.getinfo(name) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1504 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1505 | if mode == 'w': |
| 1506 | return self._open_to_write(zinfo, force_zip64=force_zip64) |
| 1507 | |
| 1508 | if self._writing: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1509 | raise ValueError("Can't read from the ZIP file while there " |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1510 | "is an open writing handle on it. " |
| 1511 | "Close the writing handle before trying to read.") |
| 1512 | |
| 1513 | # Open for reading: |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1514 | self._fileRefCnt += 1 |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1515 | zef_file = _SharedFile(self.fp, zinfo.header_offset, |
| 1516 | self._fpclose, self._lock, lambda: self._writing) |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1517 | try: |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1518 | # Skip the file header: |
| 1519 | fheader = zef_file.read(sizeFileHeader) |
Serhiy Storchaka | d2b1527 | 2013-01-31 15:27:07 +0200 | [diff] [blame] | 1520 | if len(fheader) != sizeFileHeader: |
| 1521 | raise BadZipFile("Truncated file header") |
| 1522 | fheader = struct.unpack(structFileHeader, fheader) |
| 1523 | if fheader[_FH_SIGNATURE] != stringFileHeader: |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1524 | raise BadZipFile("Bad magic number for file header") |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1525 | |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1526 | fname = zef_file.read(fheader[_FH_FILENAME_LENGTH]) |
| 1527 | if fheader[_FH_EXTRA_FIELD_LENGTH]: |
| 1528 | zef_file.read(fheader[_FH_EXTRA_FIELD_LENGTH]) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1529 | |
Antoine Pitrou | 8572da5 | 2012-11-17 23:52:05 +0100 | [diff] [blame] | 1530 | if zinfo.flag_bits & 0x20: |
| 1531 | # Zip 2.7: compressed patched data |
| 1532 | raise NotImplementedError("compressed patched data (flag bit 5)") |
Martin v. Löwis | 2a2ce32 | 2012-05-01 08:44:08 +0200 | [diff] [blame] | 1533 | |
Antoine Pitrou | 8572da5 | 2012-11-17 23:52:05 +0100 | [diff] [blame] | 1534 | if zinfo.flag_bits & 0x40: |
| 1535 | # strong encryption |
| 1536 | raise NotImplementedError("strong encryption (flag bit 6)") |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 1537 | |
Serhiy Storchaka | 36ff513 | 2020-06-22 11:24:11 +0300 | [diff] [blame] | 1538 | if fheader[_FH_GENERAL_PURPOSE_FLAG_BITS] & 0x800: |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1539 | # UTF-8 filename |
| 1540 | fname_str = fname.decode("utf-8") |
| 1541 | else: |
| 1542 | fname_str = fname.decode("cp437") |
Georg Brandl | 5ba11de | 2011-01-01 10:09:32 +0000 | [diff] [blame] | 1543 | |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1544 | if fname_str != zinfo.orig_filename: |
| 1545 | raise BadZipFile( |
| 1546 | 'File name in directory %r and header %r differ.' |
| 1547 | % (zinfo.orig_filename, fname)) |
| 1548 | |
| 1549 | # check for encrypted flag & handle password |
| 1550 | is_encrypted = zinfo.flag_bits & 0x1 |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1551 | if is_encrypted: |
| 1552 | if not pwd: |
| 1553 | pwd = self.pwd |
| 1554 | if not pwd: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1555 | raise RuntimeError("File %r is encrypted, password " |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1556 | "required for extraction" % name) |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 1557 | else: |
| 1558 | pwd = None |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1559 | |
Serhiy Storchaka | 5c32af7 | 2019-10-27 10:22:14 +0200 | [diff] [blame] | 1560 | return ZipExtFile(zef_file, mode, zinfo, pwd, True) |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1561 | except: |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1562 | zef_file.close() |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1563 | raise |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1564 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1565 | def _open_to_write(self, zinfo, force_zip64=False): |
| 1566 | if force_zip64 and not self._allowZip64: |
| 1567 | raise ValueError( |
| 1568 | "force_zip64 is True, but allowZip64 was False when opening " |
| 1569 | "the ZIP file." |
| 1570 | ) |
| 1571 | if self._writing: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1572 | raise ValueError("Can't write to the ZIP file while there is " |
| 1573 | "another write handle open on it. " |
| 1574 | "Close the first handle before opening another.") |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1575 | |
Mickaël Schoentgen | 992347d | 2019-09-09 15:08:54 +0200 | [diff] [blame] | 1576 | # Size and CRC are overwritten with correct data after processing the file |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1577 | zinfo.compress_size = 0 |
| 1578 | zinfo.CRC = 0 |
| 1579 | |
| 1580 | zinfo.flag_bits = 0x00 |
| 1581 | if zinfo.compress_type == ZIP_LZMA: |
| 1582 | # Compressed data includes an end-of-stream (EOS) marker |
| 1583 | zinfo.flag_bits |= 0x02 |
| 1584 | if not self._seekable: |
| 1585 | zinfo.flag_bits |= 0x08 |
| 1586 | |
| 1587 | if not zinfo.external_attr: |
| 1588 | zinfo.external_attr = 0o600 << 16 # permissions: ?rw------- |
| 1589 | |
| 1590 | # Compressed size can be larger than uncompressed size |
| 1591 | zip64 = self._allowZip64 and \ |
| 1592 | (force_zip64 or zinfo.file_size * 1.05 > ZIP64_LIMIT) |
| 1593 | |
| 1594 | if self._seekable: |
| 1595 | self.fp.seek(self.start_dir) |
| 1596 | zinfo.header_offset = self.fp.tell() |
| 1597 | |
| 1598 | self._writecheck(zinfo) |
| 1599 | self._didModify = True |
| 1600 | |
| 1601 | self.fp.write(zinfo.FileHeader(zip64)) |
| 1602 | |
| 1603 | self._writing = True |
| 1604 | return _ZipWriteFile(self, zinfo, zip64) |
| 1605 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1606 | def extract(self, member, path=None, pwd=None): |
| 1607 | """Extract a member from the archive to the current working directory, |
| 1608 | using its full name. Its file information is extracted as accurately |
| 1609 | as possible. `member' may be a filename or a ZipInfo object. You can |
| 1610 | specify a different directory using `path'. |
| 1611 | """ |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1612 | if path is None: |
| 1613 | path = os.getcwd() |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1614 | else: |
| 1615 | path = os.fspath(path) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1616 | |
| 1617 | return self._extract_member(member, path, pwd) |
| 1618 | |
| 1619 | def extractall(self, path=None, members=None, pwd=None): |
| 1620 | """Extract all members from the archive to the current working |
| 1621 | directory. `path' specifies a different directory to extract to. |
| 1622 | `members' is optional and must be a subset of the list returned |
| 1623 | by namelist(). |
| 1624 | """ |
| 1625 | if members is None: |
| 1626 | members = self.namelist() |
| 1627 | |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1628 | if path is None: |
| 1629 | path = os.getcwd() |
| 1630 | else: |
| 1631 | path = os.fspath(path) |
| 1632 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1633 | for zipinfo in members: |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1634 | self._extract_member(zipinfo, path, pwd) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1635 | |
Gregory P. Smith | 09aa752 | 2013-02-03 00:36:32 -0800 | [diff] [blame] | 1636 | @classmethod |
| 1637 | def _sanitize_windows_name(cls, arcname, pathsep): |
| 1638 | """Replace bad characters and remove trailing dots from parts.""" |
| 1639 | table = cls._windows_illegal_name_trans_table |
| 1640 | if not table: |
| 1641 | illegal = ':<>|"?*' |
| 1642 | table = str.maketrans(illegal, '_' * len(illegal)) |
| 1643 | cls._windows_illegal_name_trans_table = table |
| 1644 | arcname = arcname.translate(table) |
| 1645 | # remove trailing dots |
| 1646 | arcname = (x.rstrip('.') for x in arcname.split(pathsep)) |
| 1647 | # rejoin, removing empty parts. |
| 1648 | arcname = pathsep.join(x for x in arcname if x) |
| 1649 | return arcname |
| 1650 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1651 | def _extract_member(self, member, targetpath, pwd): |
| 1652 | """Extract the ZipInfo object 'member' to a physical |
| 1653 | file on the path targetpath. |
| 1654 | """ |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1655 | if not isinstance(member, ZipInfo): |
| 1656 | member = self.getinfo(member) |
| 1657 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1658 | # build the destination pathname, replacing |
| 1659 | # forward slashes to platform specific separators. |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 1660 | arcname = member.filename.replace('/', os.path.sep) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1661 | |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 1662 | if os.path.altsep: |
| 1663 | arcname = arcname.replace(os.path.altsep, os.path.sep) |
| 1664 | # interpret absolute pathname as relative, remove drive letter or |
| 1665 | # UNC path, redundant separators, "." and ".." components. |
| 1666 | arcname = os.path.splitdrive(arcname)[1] |
Gregory P. Smith | 09aa752 | 2013-02-03 00:36:32 -0800 | [diff] [blame] | 1667 | invalid_path_parts = ('', os.path.curdir, os.path.pardir) |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 1668 | arcname = os.path.sep.join(x for x in arcname.split(os.path.sep) |
Gregory P. Smith | 09aa752 | 2013-02-03 00:36:32 -0800 | [diff] [blame] | 1669 | if x not in invalid_path_parts) |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 1670 | if os.path.sep == '\\': |
Serhiy Storchaka | e5e6444 | 2013-02-02 19:50:59 +0200 | [diff] [blame] | 1671 | # filter illegal characters on Windows |
Gregory P. Smith | 09aa752 | 2013-02-03 00:36:32 -0800 | [diff] [blame] | 1672 | arcname = self._sanitize_windows_name(arcname, os.path.sep) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1673 | |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 1674 | targetpath = os.path.join(targetpath, arcname) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1675 | targetpath = os.path.normpath(targetpath) |
| 1676 | |
| 1677 | # Create all upper directories if necessary. |
| 1678 | upperdirs = os.path.dirname(targetpath) |
| 1679 | if upperdirs and not os.path.exists(upperdirs): |
| 1680 | os.makedirs(upperdirs) |
| 1681 | |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 1682 | if member.is_dir(): |
Martin v. Löwis | 70ccd16 | 2009-05-24 19:47:22 +0000 | [diff] [blame] | 1683 | if not os.path.isdir(targetpath): |
| 1684 | os.mkdir(targetpath) |
Martin v. Löwis | 59e4779 | 2009-01-24 14:10:07 +0000 | [diff] [blame] | 1685 | return targetpath |
| 1686 | |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1687 | with self.open(member, pwd=pwd) as source, \ |
| 1688 | open(targetpath, "wb") as target: |
| 1689 | shutil.copyfileobj(source, target) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1690 | |
| 1691 | return targetpath |
| 1692 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1693 | def _writecheck(self, zinfo): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1694 | """Check for errors before writing a file to the archive.""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1695 | if zinfo.filename in self.NameToInfo: |
Serhiy Storchaka | 9b7a1a1 | 2014-01-20 21:57:40 +0200 | [diff] [blame] | 1696 | import warnings |
| 1697 | warnings.warn('Duplicate name: %r' % zinfo.filename, stacklevel=3) |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1698 | if self.mode not in ('w', 'x', 'a'): |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1699 | raise ValueError("write() requires mode 'w', 'x', or 'a'") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1700 | if not self.fp: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1701 | raise ValueError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1702 | "Attempt to write ZIP archive that was already closed") |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 1703 | _check_compression(zinfo.compress_type) |
Serhiy Storchaka | cfbb394 | 2014-09-23 21:34:24 +0300 | [diff] [blame] | 1704 | if not self._allowZip64: |
| 1705 | requires_zip64 = None |
| 1706 | if len(self.filelist) >= ZIP_FILECOUNT_LIMIT: |
| 1707 | requires_zip64 = "Files count" |
| 1708 | elif zinfo.file_size > ZIP64_LIMIT: |
| 1709 | requires_zip64 = "Filesize" |
| 1710 | elif zinfo.header_offset > ZIP64_LIMIT: |
| 1711 | requires_zip64 = "Zipfile size" |
| 1712 | if requires_zip64: |
| 1713 | raise LargeZipFile(requires_zip64 + |
| 1714 | " would require ZIP64 extensions") |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1715 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1716 | def write(self, filename, arcname=None, |
Marcel Plch | 77b112c | 2018-08-31 16:43:31 +0200 | [diff] [blame] | 1717 | compress_type=None, compresslevel=None): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1718 | """Put the bytes from filename into the archive under the name |
| 1719 | arcname.""" |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1720 | if not self.fp: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1721 | raise ValueError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1722 | "Attempt to write to ZIP archive that was already closed") |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1723 | if self._writing: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1724 | raise ValueError( |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1725 | "Can't write to ZIP archive while an open writing handle exists" |
| 1726 | ) |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1727 | |
Marcel Plch | a2fe1e5 | 2018-08-02 15:04:52 +0200 | [diff] [blame] | 1728 | zinfo = ZipInfo.from_file(filename, arcname, |
Marcel Plch | 77b112c | 2018-08-31 16:43:31 +0200 | [diff] [blame] | 1729 | strict_timestamps=self._strict_timestamps) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1730 | |
Serhiy Storchaka | 503f908 | 2016-02-08 00:02:25 +0200 | [diff] [blame] | 1731 | if zinfo.is_dir(): |
| 1732 | zinfo.compress_size = 0 |
| 1733 | zinfo.CRC = 0 |
| 1734 | else: |
| 1735 | if compress_type is not None: |
| 1736 | zinfo.compress_type = compress_type |
| 1737 | else: |
| 1738 | zinfo.compress_type = self.compression |
| 1739 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1740 | if compresslevel is not None: |
| 1741 | zinfo._compresslevel = compresslevel |
| 1742 | else: |
| 1743 | zinfo._compresslevel = self.compresslevel |
| 1744 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1745 | if zinfo.is_dir(): |
| 1746 | with self._lock: |
| 1747 | if self._seekable: |
| 1748 | self.fp.seek(self.start_dir) |
| 1749 | zinfo.header_offset = self.fp.tell() # Start of header bytes |
| 1750 | if zinfo.compress_type == ZIP_LZMA: |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1751 | # Compressed data includes an end-of-stream (EOS) marker |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1752 | zinfo.flag_bits |= 0x02 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1753 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1754 | self._writecheck(zinfo) |
| 1755 | self._didModify = True |
Martin v. Löwis | 59e4779 | 2009-01-24 14:10:07 +0000 | [diff] [blame] | 1756 | |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1757 | self.filelist.append(zinfo) |
| 1758 | self.NameToInfo[zinfo.filename] = zinfo |
| 1759 | self.fp.write(zinfo.FileHeader(False)) |
| 1760 | self.start_dir = self.fp.tell() |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1761 | else: |
| 1762 | with open(filename, "rb") as src, self.open(zinfo, 'w') as dest: |
| 1763 | shutil.copyfileobj(src, dest, 1024*8) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1764 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1765 | def writestr(self, zinfo_or_arcname, data, |
| 1766 | compress_type=None, compresslevel=None): |
Guido van Rossum | 85825dc | 2007-08-27 17:03:28 +0000 | [diff] [blame] | 1767 | """Write a file into the archive. The contents is 'data', which |
| 1768 | may be either a 'str' or a 'bytes' instance; if it is a 'str', |
| 1769 | it is encoded as UTF-8 first. |
| 1770 | 'zinfo_or_arcname' is either a ZipInfo instance or |
Just van Rossum | b083cb3 | 2002-12-12 12:23:32 +0000 | [diff] [blame] | 1771 | the name of the file in the archive.""" |
Guido van Rossum | 85825dc | 2007-08-27 17:03:28 +0000 | [diff] [blame] | 1772 | if isinstance(data, str): |
| 1773 | data = data.encode("utf-8") |
Just van Rossum | b083cb3 | 2002-12-12 12:23:32 +0000 | [diff] [blame] | 1774 | if not isinstance(zinfo_or_arcname, ZipInfo): |
| 1775 | zinfo = ZipInfo(filename=zinfo_or_arcname, |
Guido van Rossum | 7736b5b | 2008-01-15 21:44:53 +0000 | [diff] [blame] | 1776 | date_time=time.localtime(time.time())[:6]) |
Just van Rossum | b083cb3 | 2002-12-12 12:23:32 +0000 | [diff] [blame] | 1777 | zinfo.compress_type = self.compression |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1778 | zinfo._compresslevel = self.compresslevel |
Serhiy Storchaka | 46a3492 | 2014-09-23 22:40:23 +0300 | [diff] [blame] | 1779 | if zinfo.filename[-1] == '/': |
| 1780 | zinfo.external_attr = 0o40775 << 16 # drwxrwxr-x |
| 1781 | zinfo.external_attr |= 0x10 # MS-DOS directory flag |
| 1782 | else: |
| 1783 | zinfo.external_attr = 0o600 << 16 # ?rw------- |
Just van Rossum | b083cb3 | 2002-12-12 12:23:32 +0000 | [diff] [blame] | 1784 | else: |
| 1785 | zinfo = zinfo_or_arcname |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1786 | |
| 1787 | if not self.fp: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1788 | raise ValueError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1789 | "Attempt to write to ZIP archive that was already closed") |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1790 | if self._writing: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1791 | raise ValueError( |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1792 | "Can't write to ZIP archive while an open writing handle exists." |
| 1793 | ) |
| 1794 | |
| 1795 | if compress_type is not None: |
| 1796 | zinfo.compress_type = compress_type |
Guido van Rossum | b5a755e | 2007-07-18 18:15:48 +0000 | [diff] [blame] | 1797 | |
Bo Bayles | ce237c7 | 2018-01-29 23:54:07 -0600 | [diff] [blame] | 1798 | if compresslevel is not None: |
| 1799 | zinfo._compresslevel = compresslevel |
| 1800 | |
Guido van Rossum | 85825dc | 2007-08-27 17:03:28 +0000 | [diff] [blame] | 1801 | zinfo.file_size = len(data) # Uncompressed size |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1802 | with self._lock: |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1803 | with self.open(zinfo, mode='w') as dest: |
| 1804 | dest.write(data) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1805 | |
| 1806 | def __del__(self): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1807 | """Call the "close()" method in case the user forgot.""" |
Tim Peters | d15f8bb | 2001-11-28 23:16:40 +0000 | [diff] [blame] | 1808 | self.close() |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1809 | |
| 1810 | def close(self): |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1811 | """Close the file, and for mode 'w', 'x' and 'a' write the ending |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1812 | records.""" |
Tim Peters | d15f8bb | 2001-11-28 23:16:40 +0000 | [diff] [blame] | 1813 | if self.fp is None: |
| 1814 | return |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1815 | |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1816 | if self._writing: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1817 | raise ValueError("Can't close the ZIP file while there is " |
| 1818 | "an open writing handle on it. " |
| 1819 | "Close the writing handle before closing the zip.") |
Serhiy Storchaka | 18ee29d | 2016-05-13 13:52:49 +0300 | [diff] [blame] | 1820 | |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1821 | try: |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 1822 | if self.mode in ('w', 'x', 'a') and self._didModify: # write ending records |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1823 | with self._lock: |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 1824 | if self._seekable: |
Serhiy Storchaka | a14f7d2 | 2015-01-26 14:01:27 +0200 | [diff] [blame] | 1825 | self.fp.seek(self.start_dir) |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1826 | self._write_end_record() |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 1827 | finally: |
| 1828 | fp = self.fp |
| 1829 | self.fp = None |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1830 | self._fpclose(fp) |
| 1831 | |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1832 | def _write_end_record(self): |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1833 | for zinfo in self.filelist: # write central directory |
| 1834 | dt = zinfo.date_time |
| 1835 | dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2] |
| 1836 | dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2) |
| 1837 | extra = [] |
| 1838 | if zinfo.file_size > ZIP64_LIMIT \ |
| 1839 | or zinfo.compress_size > ZIP64_LIMIT: |
| 1840 | extra.append(zinfo.file_size) |
| 1841 | extra.append(zinfo.compress_size) |
| 1842 | file_size = 0xffffffff |
| 1843 | compress_size = 0xffffffff |
| 1844 | else: |
| 1845 | file_size = zinfo.file_size |
| 1846 | compress_size = zinfo.compress_size |
| 1847 | |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1848 | if zinfo.header_offset > ZIP64_LIMIT: |
| 1849 | extra.append(zinfo.header_offset) |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1850 | header_offset = 0xffffffff |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1851 | else: |
| 1852 | header_offset = zinfo.header_offset |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1853 | |
| 1854 | extra_data = zinfo.extra |
| 1855 | min_version = 0 |
| 1856 | if extra: |
| 1857 | # Append a ZIP64 field to the extra's |
Serhiy Storchaka | 9bdb7be | 2018-09-17 15:36:40 +0300 | [diff] [blame] | 1858 | extra_data = _strip_extra(extra_data, (1,)) |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1859 | extra_data = struct.pack( |
| 1860 | '<HH' + 'Q'*len(extra), |
| 1861 | 1, 8*len(extra), *extra) + extra_data |
| 1862 | |
| 1863 | min_version = ZIP64_VERSION |
| 1864 | |
| 1865 | if zinfo.compress_type == ZIP_BZIP2: |
| 1866 | min_version = max(BZIP2_VERSION, min_version) |
| 1867 | elif zinfo.compress_type == ZIP_LZMA: |
| 1868 | min_version = max(LZMA_VERSION, min_version) |
| 1869 | |
| 1870 | extract_version = max(min_version, zinfo.extract_version) |
| 1871 | create_version = max(min_version, zinfo.create_version) |
Victor Stinner | 1d3b0aa | 2020-01-17 15:17:48 +0100 | [diff] [blame] | 1872 | filename, flag_bits = zinfo._encodeFilenameFlags() |
| 1873 | centdir = struct.pack(structCentralDir, |
| 1874 | stringCentralDir, create_version, |
| 1875 | zinfo.create_system, extract_version, zinfo.reserved, |
| 1876 | flag_bits, zinfo.compress_type, dostime, dosdate, |
| 1877 | zinfo.CRC, compress_size, file_size, |
| 1878 | len(filename), len(extra_data), len(zinfo.comment), |
| 1879 | 0, zinfo.internal_attr, zinfo.external_attr, |
| 1880 | header_offset) |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1881 | self.fp.write(centdir) |
| 1882 | self.fp.write(filename) |
| 1883 | self.fp.write(extra_data) |
| 1884 | self.fp.write(zinfo.comment) |
| 1885 | |
| 1886 | pos2 = self.fp.tell() |
| 1887 | # Write end-of-zip-archive record |
| 1888 | centDirCount = len(self.filelist) |
| 1889 | centDirSize = pos2 - self.start_dir |
Serhiy Storchaka | 3763ea8 | 2017-05-06 14:46:01 +0300 | [diff] [blame] | 1890 | centDirOffset = self.start_dir |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1891 | requires_zip64 = None |
| 1892 | if centDirCount > ZIP_FILECOUNT_LIMIT: |
| 1893 | requires_zip64 = "Files count" |
| 1894 | elif centDirOffset > ZIP64_LIMIT: |
| 1895 | requires_zip64 = "Central directory offset" |
| 1896 | elif centDirSize > ZIP64_LIMIT: |
| 1897 | requires_zip64 = "Central directory size" |
| 1898 | if requires_zip64: |
| 1899 | # Need to write the ZIP64 end-of-archive records |
| 1900 | if not self._allowZip64: |
| 1901 | raise LargeZipFile(requires_zip64 + |
| 1902 | " would require ZIP64 extensions") |
| 1903 | zip64endrec = struct.pack( |
| 1904 | structEndArchive64, stringEndArchive64, |
| 1905 | 44, 45, 45, 0, 0, centDirCount, centDirCount, |
| 1906 | centDirSize, centDirOffset) |
| 1907 | self.fp.write(zip64endrec) |
| 1908 | |
| 1909 | zip64locrec = struct.pack( |
| 1910 | structEndArchive64Locator, |
| 1911 | stringEndArchive64Locator, 0, pos2, 1) |
| 1912 | self.fp.write(zip64locrec) |
| 1913 | centDirCount = min(centDirCount, 0xFFFF) |
| 1914 | centDirSize = min(centDirSize, 0xFFFFFFFF) |
| 1915 | centDirOffset = min(centDirOffset, 0xFFFFFFFF) |
| 1916 | |
| 1917 | endrec = struct.pack(structEndArchive, stringEndArchive, |
| 1918 | 0, 0, centDirCount, centDirCount, |
| 1919 | centDirSize, centDirOffset, len(self._comment)) |
| 1920 | self.fp.write(endrec) |
| 1921 | self.fp.write(self._comment) |
Jan Mazur | ff9147d | 2020-09-28 20:53:33 +0200 | [diff] [blame] | 1922 | if self.mode == "a": |
| 1923 | self.fp.truncate() |
Serhiy Storchaka | f15e524 | 2015-01-26 13:53:38 +0200 | [diff] [blame] | 1924 | self.fp.flush() |
| 1925 | |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 1926 | def _fpclose(self, fp): |
| 1927 | assert self._fileRefCnt > 0 |
| 1928 | self._fileRefCnt -= 1 |
| 1929 | if not self._fileRefCnt and not self._filePassed: |
| 1930 | fp.close() |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1931 | |
| 1932 | |
| 1933 | class PyZipFile(ZipFile): |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1934 | """Class to create ZIP archives with Python library files and packages.""" |
| 1935 | |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 1936 | def __init__(self, file, mode="r", compression=ZIP_STORED, |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 1937 | allowZip64=True, optimize=-1): |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 1938 | ZipFile.__init__(self, file, mode=mode, compression=compression, |
| 1939 | allowZip64=allowZip64) |
| 1940 | self._optimize = optimize |
| 1941 | |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1942 | def writepy(self, pathname, basename="", filterfunc=None): |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1943 | """Add all files from "pathname" to the ZIP archive. |
| 1944 | |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1945 | If pathname is a package directory, search the directory and |
| 1946 | all package subdirectories recursively for all *.py and enter |
| 1947 | the modules into the archive. If pathname is a plain |
| 1948 | directory, listdir *.py and enter all modules. Else, pathname |
| 1949 | must be a Python *.py file and the module will be put into the |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 1950 | archive. Added modules are always module.pyc. |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1951 | This method will compile the module.py into module.pyc if |
| 1952 | necessary. |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1953 | If filterfunc(pathname) is given, it is called with every argument. |
| 1954 | When it is False, the file or directory is skipped. |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 1955 | """ |
Serhiy Storchaka | 8606e95 | 2017-03-08 14:37:51 +0200 | [diff] [blame] | 1956 | pathname = os.fspath(pathname) |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1957 | if filterfunc and not filterfunc(pathname): |
| 1958 | if self.debug: |
Christian Tismer | 410d931 | 2013-10-22 04:09:28 +0200 | [diff] [blame] | 1959 | label = 'path' if os.path.isdir(pathname) else 'file' |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1960 | print('%s %r skipped by filterfunc' % (label, pathname)) |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1961 | return |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1962 | dir, name = os.path.split(pathname) |
| 1963 | if os.path.isdir(pathname): |
| 1964 | initname = os.path.join(pathname, "__init__.py") |
| 1965 | if os.path.isfile(initname): |
| 1966 | # This is a package directory, add it |
| 1967 | if basename: |
| 1968 | basename = "%s/%s" % (basename, name) |
| 1969 | else: |
| 1970 | basename = name |
| 1971 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1972 | print("Adding package in", pathname, "as", basename) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1973 | fname, arcname = self._get_codename(initname[0:-3], basename) |
| 1974 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1975 | print("Adding", arcname) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1976 | self.write(fname, arcname) |
Bernhard M. Wiedemann | 8452104 | 2018-01-31 11:17:10 +0100 | [diff] [blame] | 1977 | dirlist = sorted(os.listdir(pathname)) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1978 | dirlist.remove("__init__.py") |
| 1979 | # Add all *.py files and package subdirectories |
| 1980 | for filename in dirlist: |
| 1981 | path = os.path.join(pathname, filename) |
| 1982 | root, ext = os.path.splitext(filename) |
| 1983 | if os.path.isdir(path): |
| 1984 | if os.path.isfile(os.path.join(path, "__init__.py")): |
| 1985 | # This is a package directory, add it |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1986 | self.writepy(path, basename, |
| 1987 | filterfunc=filterfunc) # Recursive call |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1988 | elif ext == ".py": |
Christian Tismer | 410d931 | 2013-10-22 04:09:28 +0200 | [diff] [blame] | 1989 | if filterfunc and not filterfunc(path): |
| 1990 | if self.debug: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 1991 | print('file %r skipped by filterfunc' % path) |
Christian Tismer | 410d931 | 2013-10-22 04:09:28 +0200 | [diff] [blame] | 1992 | continue |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1993 | fname, arcname = self._get_codename(path[0:-3], |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 1994 | basename) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1995 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1996 | print("Adding", arcname) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 1997 | self.write(fname, arcname) |
| 1998 | else: |
| 1999 | # This is NOT a package directory, add its files at top level |
| 2000 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2001 | print("Adding files from directory", pathname) |
Bernhard M. Wiedemann | 8452104 | 2018-01-31 11:17:10 +0100 | [diff] [blame] | 2002 | for filename in sorted(os.listdir(pathname)): |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2003 | path = os.path.join(pathname, filename) |
| 2004 | root, ext = os.path.splitext(filename) |
| 2005 | if ext == ".py": |
Christian Tismer | 410d931 | 2013-10-22 04:09:28 +0200 | [diff] [blame] | 2006 | if filterfunc and not filterfunc(path): |
| 2007 | if self.debug: |
Serhiy Storchaka | b0d497c | 2016-09-10 21:28:07 +0300 | [diff] [blame] | 2008 | print('file %r skipped by filterfunc' % path) |
Christian Tismer | 410d931 | 2013-10-22 04:09:28 +0200 | [diff] [blame] | 2009 | continue |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2010 | fname, arcname = self._get_codename(path[0:-3], |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 2011 | basename) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2012 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2013 | print("Adding", arcname) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2014 | self.write(fname, arcname) |
| 2015 | else: |
| 2016 | if pathname[-3:] != ".py": |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 2017 | raise RuntimeError( |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 2018 | 'Files added with writepy() must end with ".py"') |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2019 | fname, arcname = self._get_codename(pathname[0:-3], basename) |
| 2020 | if self.debug: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2021 | print("Adding file", arcname) |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2022 | self.write(fname, arcname) |
| 2023 | |
| 2024 | def _get_codename(self, pathname, basename): |
| 2025 | """Return (filename, archivename) for the path. |
| 2026 | |
Fred Drake | 484d735 | 2000-10-02 21:14:52 +0000 | [diff] [blame] | 2027 | Given a module name path, return the correct file path and |
| 2028 | archive name, compiling if necessary. For example, given |
| 2029 | /python/lib/string, return (/python/lib/string.pyc, string). |
| 2030 | """ |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2031 | def _compile(file, optimize=-1): |
| 2032 | import py_compile |
| 2033 | if self.debug: |
| 2034 | print("Compiling", file) |
| 2035 | try: |
| 2036 | py_compile.compile(file, doraise=True, optimize=optimize) |
Serhiy Storchaka | 45c4375 | 2013-01-29 20:10:28 +0200 | [diff] [blame] | 2037 | except py_compile.PyCompileError as err: |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2038 | print(err.msg) |
| 2039 | return False |
| 2040 | return True |
| 2041 | |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2042 | file_py = pathname + ".py" |
| 2043 | file_pyc = pathname + ".pyc" |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2044 | pycache_opt0 = importlib.util.cache_from_source(file_py, optimization='') |
| 2045 | pycache_opt1 = importlib.util.cache_from_source(file_py, optimization=1) |
| 2046 | pycache_opt2 = importlib.util.cache_from_source(file_py, optimization=2) |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2047 | if self._optimize == -1: |
| 2048 | # legacy mode: use whatever file is present |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2049 | if (os.path.isfile(file_pyc) and |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2050 | os.stat(file_pyc).st_mtime >= os.stat(file_py).st_mtime): |
| 2051 | # Use .pyc file. |
| 2052 | arcname = fname = file_pyc |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2053 | elif (os.path.isfile(pycache_opt0) and |
| 2054 | os.stat(pycache_opt0).st_mtime >= os.stat(file_py).st_mtime): |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2055 | # Use the __pycache__/*.pyc file, but write it to the legacy pyc |
| 2056 | # file name in the archive. |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2057 | fname = pycache_opt0 |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2058 | arcname = file_pyc |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2059 | elif (os.path.isfile(pycache_opt1) and |
| 2060 | os.stat(pycache_opt1).st_mtime >= os.stat(file_py).st_mtime): |
| 2061 | # Use the __pycache__/*.pyc file, but write it to the legacy pyc |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2062 | # file name in the archive. |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2063 | fname = pycache_opt1 |
| 2064 | arcname = file_pyc |
| 2065 | elif (os.path.isfile(pycache_opt2) and |
| 2066 | os.stat(pycache_opt2).st_mtime >= os.stat(file_py).st_mtime): |
| 2067 | # Use the __pycache__/*.pyc file, but write it to the legacy pyc |
| 2068 | # file name in the archive. |
| 2069 | fname = pycache_opt2 |
| 2070 | arcname = file_pyc |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 2071 | else: |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2072 | # Compile py into PEP 3147 pyc file. |
| 2073 | if _compile(file_py): |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2074 | if sys.flags.optimize == 0: |
| 2075 | fname = pycache_opt0 |
| 2076 | elif sys.flags.optimize == 1: |
| 2077 | fname = pycache_opt1 |
| 2078 | else: |
| 2079 | fname = pycache_opt2 |
| 2080 | arcname = file_pyc |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2081 | else: |
| 2082 | fname = arcname = file_py |
| 2083 | else: |
| 2084 | # new mode: use given optimization level |
| 2085 | if self._optimize == 0: |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2086 | fname = pycache_opt0 |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2087 | arcname = file_pyc |
| 2088 | else: |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 2089 | arcname = file_pyc |
| 2090 | if self._optimize == 1: |
| 2091 | fname = pycache_opt1 |
| 2092 | elif self._optimize == 2: |
| 2093 | fname = pycache_opt2 |
| 2094 | else: |
| 2095 | msg = "invalid value for 'optimize': {!r}".format(self._optimize) |
| 2096 | raise ValueError(msg) |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 2097 | if not (os.path.isfile(fname) and |
| 2098 | os.stat(fname).st_mtime >= os.stat(file_py).st_mtime): |
| 2099 | if not _compile(file_py, optimize=self._optimize): |
| 2100 | fname = arcname = file_py |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 2101 | archivename = os.path.split(arcname)[1] |
Guido van Rossum | 32abe6f | 2000-03-31 17:30:02 +0000 | [diff] [blame] | 2102 | if basename: |
| 2103 | archivename = "%s/%s" % (basename, archivename) |
| 2104 | return (fname, archivename) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2105 | |
| 2106 | |
shireenrao | a4e2991 | 2019-08-24 11:26:41 -0400 | [diff] [blame] | 2107 | def _parents(path): |
| 2108 | """ |
| 2109 | Given a path with elements separated by |
| 2110 | posixpath.sep, generate all parents of that path. |
| 2111 | |
| 2112 | >>> list(_parents('b/d')) |
| 2113 | ['b'] |
| 2114 | >>> list(_parents('/b/d/')) |
| 2115 | ['/b'] |
| 2116 | >>> list(_parents('b/d/f/')) |
| 2117 | ['b/d', 'b'] |
| 2118 | >>> list(_parents('b')) |
| 2119 | [] |
| 2120 | >>> list(_parents('')) |
| 2121 | [] |
| 2122 | """ |
| 2123 | return itertools.islice(_ancestry(path), 1, None) |
| 2124 | |
| 2125 | |
| 2126 | def _ancestry(path): |
| 2127 | """ |
| 2128 | Given a path with elements separated by |
| 2129 | posixpath.sep, generate all elements of that path |
| 2130 | |
| 2131 | >>> list(_ancestry('b/d')) |
| 2132 | ['b/d', 'b'] |
| 2133 | >>> list(_ancestry('/b/d/')) |
| 2134 | ['/b/d', '/b'] |
| 2135 | >>> list(_ancestry('b/d/f/')) |
| 2136 | ['b/d/f', 'b/d', 'b'] |
| 2137 | >>> list(_ancestry('b')) |
| 2138 | ['b'] |
| 2139 | >>> list(_ancestry('')) |
| 2140 | [] |
| 2141 | """ |
| 2142 | path = path.rstrip(posixpath.sep) |
| 2143 | while path and path != posixpath.sep: |
| 2144 | yield path |
| 2145 | path, tail = posixpath.split(path) |
| 2146 | |
| 2147 | |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2148 | _dedupe = dict.fromkeys |
| 2149 | """Deduplicate an iterable in original order""" |
| 2150 | |
| 2151 | |
| 2152 | def _difference(minuend, subtrahend): |
| 2153 | """ |
| 2154 | Return items in minuend not in subtrahend, retaining order |
| 2155 | with O(1) lookup. |
| 2156 | """ |
| 2157 | return itertools.filterfalse(set(subtrahend).__contains__, minuend) |
| 2158 | |
| 2159 | |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2160 | class CompleteDirs(ZipFile): |
| 2161 | """ |
| 2162 | A ZipFile subclass that ensures that implied directories |
| 2163 | are always included in the namelist. |
| 2164 | """ |
| 2165 | |
| 2166 | @staticmethod |
| 2167 | def _implied_dirs(names): |
| 2168 | parents = itertools.chain.from_iterable(map(_parents, names)) |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2169 | as_dirs = (p + posixpath.sep for p in parents) |
| 2170 | return _dedupe(_difference(as_dirs, names)) |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2171 | |
| 2172 | def namelist(self): |
| 2173 | names = super(CompleteDirs, self).namelist() |
| 2174 | return names + list(self._implied_dirs(names)) |
| 2175 | |
| 2176 | def _name_set(self): |
| 2177 | return set(self.namelist()) |
| 2178 | |
| 2179 | def resolve_dir(self, name): |
| 2180 | """ |
| 2181 | If the name represents a directory, return that name |
| 2182 | as a directory (with the trailing slash). |
| 2183 | """ |
| 2184 | names = self._name_set() |
| 2185 | dirname = name + '/' |
| 2186 | dir_match = name not in names and dirname in names |
| 2187 | return dirname if dir_match else name |
| 2188 | |
| 2189 | @classmethod |
| 2190 | def make(cls, source): |
| 2191 | """ |
| 2192 | Given a source (filename or zipfile), return an |
| 2193 | appropriate CompleteDirs subclass. |
| 2194 | """ |
| 2195 | if isinstance(source, CompleteDirs): |
| 2196 | return source |
| 2197 | |
| 2198 | if not isinstance(source, ZipFile): |
| 2199 | return cls(source) |
| 2200 | |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2201 | # Only allow for FastLookup when supplied zipfile is read-only |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2202 | if 'r' not in source.mode: |
| 2203 | cls = CompleteDirs |
| 2204 | |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2205 | source.__class__ = cls |
| 2206 | return source |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2207 | |
| 2208 | |
| 2209 | class FastLookup(CompleteDirs): |
| 2210 | """ |
| 2211 | ZipFile subclass to ensure implicit |
| 2212 | dirs exist and are resolved rapidly. |
| 2213 | """ |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2214 | |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2215 | def namelist(self): |
| 2216 | with contextlib.suppress(AttributeError): |
| 2217 | return self.__names |
| 2218 | self.__names = super(FastLookup, self).namelist() |
| 2219 | return self.__names |
| 2220 | |
| 2221 | def _name_set(self): |
| 2222 | with contextlib.suppress(AttributeError): |
| 2223 | return self.__lookup |
| 2224 | self.__lookup = super(FastLookup, self)._name_set() |
| 2225 | return self.__lookup |
| 2226 | |
| 2227 | |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2228 | class Path: |
| 2229 | """ |
| 2230 | A pathlib-compatible interface for zip files. |
| 2231 | |
| 2232 | Consider a zip file with this structure:: |
| 2233 | |
| 2234 | . |
| 2235 | ├── a.txt |
| 2236 | └── b |
| 2237 | ├── c.txt |
| 2238 | └── d |
| 2239 | └── e.txt |
| 2240 | |
| 2241 | >>> data = io.BytesIO() |
| 2242 | >>> zf = ZipFile(data, 'w') |
| 2243 | >>> zf.writestr('a.txt', 'content of a') |
| 2244 | >>> zf.writestr('b/c.txt', 'content of c') |
| 2245 | >>> zf.writestr('b/d/e.txt', 'content of e') |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2246 | >>> zf.filename = 'mem/abcde.zip' |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2247 | |
| 2248 | Path accepts the zipfile object itself or a filename |
| 2249 | |
| 2250 | >>> root = Path(zf) |
| 2251 | |
| 2252 | From there, several path operations are available. |
| 2253 | |
| 2254 | Directory iteration (including the zip file itself): |
| 2255 | |
| 2256 | >>> a, b = root.iterdir() |
| 2257 | >>> a |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2258 | Path('mem/abcde.zip', 'a.txt') |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2259 | >>> b |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2260 | Path('mem/abcde.zip', 'b/') |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2261 | |
| 2262 | name property: |
| 2263 | |
| 2264 | >>> b.name |
| 2265 | 'b' |
| 2266 | |
| 2267 | join with divide operator: |
| 2268 | |
| 2269 | >>> c = b / 'c.txt' |
| 2270 | >>> c |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2271 | Path('mem/abcde.zip', 'b/c.txt') |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2272 | >>> c.name |
| 2273 | 'c.txt' |
| 2274 | |
| 2275 | Read text: |
| 2276 | |
| 2277 | >>> c.read_text() |
| 2278 | 'content of c' |
| 2279 | |
| 2280 | existence: |
| 2281 | |
| 2282 | >>> c.exists() |
| 2283 | True |
| 2284 | >>> (b / 'missing.txt').exists() |
| 2285 | False |
| 2286 | |
Xtreak | 0d70227 | 2019-06-03 04:42:33 +0530 | [diff] [blame] | 2287 | Coercion to string: |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2288 | |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2289 | >>> import os |
| 2290 | >>> str(c).replace(os.sep, posixpath.sep) |
| 2291 | 'mem/abcde.zip/b/c.txt' |
| 2292 | |
| 2293 | At the root, ``name``, ``filename``, and ``parent`` |
| 2294 | resolve to the zipfile. Note these attributes are not |
| 2295 | valid and will raise a ``ValueError`` if the zipfile |
| 2296 | has no filename. |
| 2297 | |
| 2298 | >>> root.name |
| 2299 | 'abcde.zip' |
| 2300 | >>> str(root.filename).replace(os.sep, posixpath.sep) |
| 2301 | 'mem/abcde.zip' |
| 2302 | >>> str(root.parent) |
| 2303 | 'mem' |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2304 | """ |
| 2305 | |
| 2306 | __repr = "{self.__class__.__name__}({self.root.filename!r}, {self.at!r})" |
| 2307 | |
| 2308 | def __init__(self, root, at=""): |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2309 | """ |
| 2310 | Construct a Path from a ZipFile or filename. |
| 2311 | |
| 2312 | Note: When the source is an existing ZipFile object, |
| 2313 | its type (__class__) will be mutated to a |
| 2314 | specialized type. If the caller wishes to retain the |
| 2315 | original type, the caller should either create a |
| 2316 | separate ZipFile object or pass a filename. |
| 2317 | """ |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2318 | self.root = FastLookup.make(root) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2319 | self.at = at |
| 2320 | |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2321 | def open(self, mode='r', *args, pwd=None, **kwargs): |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2322 | """ |
| 2323 | Open this entry as text or binary following the semantics |
| 2324 | of ``pathlib.Path.open()`` by passing arguments through |
| 2325 | to io.TextIOWrapper(). |
| 2326 | """ |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2327 | if self.is_dir(): |
| 2328 | raise IsADirectoryError(self) |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2329 | zip_mode = mode[0] |
Jason R. Coombs | ebbe803 | 2020-10-03 10:58:39 -0400 | [diff] [blame] | 2330 | if not self.exists() and zip_mode == 'r': |
| 2331 | raise FileNotFoundError(self) |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2332 | stream = self.root.open(self.at, zip_mode, pwd=pwd) |
| 2333 | if 'b' in mode: |
| 2334 | if args or kwargs: |
| 2335 | raise ValueError("encoding args invalid for binary operation") |
| 2336 | return stream |
| 2337 | return io.TextIOWrapper(stream, *args, **kwargs) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2338 | |
| 2339 | @property |
| 2340 | def name(self): |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2341 | return pathlib.Path(self.at).name or self.filename.name |
| 2342 | |
| 2343 | @property |
| 2344 | def filename(self): |
| 2345 | return pathlib.Path(self.root.filename).joinpath(self.at) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2346 | |
| 2347 | def read_text(self, *args, **kwargs): |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2348 | with self.open('r', *args, **kwargs) as strm: |
| 2349 | return strm.read() |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2350 | |
| 2351 | def read_bytes(self): |
Jason R. Coombs | 0aeab5c | 2020-02-29 10:34:11 -0600 | [diff] [blame] | 2352 | with self.open('rb') as strm: |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2353 | return strm.read() |
| 2354 | |
| 2355 | def _is_child(self, path): |
| 2356 | return posixpath.dirname(path.at.rstrip("/")) == self.at.rstrip("/") |
| 2357 | |
| 2358 | def _next(self, at): |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2359 | return self.__class__(self.root, at) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2360 | |
| 2361 | def is_dir(self): |
| 2362 | return not self.at or self.at.endswith("/") |
| 2363 | |
| 2364 | def is_file(self): |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2365 | return self.exists() and not self.is_dir() |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2366 | |
| 2367 | def exists(self): |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2368 | return self.at in self.root._name_set() |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2369 | |
| 2370 | def iterdir(self): |
| 2371 | if not self.is_dir(): |
| 2372 | raise ValueError("Can't listdir a file") |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2373 | subs = map(self._next, self.root.namelist()) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2374 | return filter(self._is_child, subs) |
| 2375 | |
| 2376 | def __str__(self): |
| 2377 | return posixpath.join(self.root.filename, self.at) |
| 2378 | |
| 2379 | def __repr__(self): |
| 2380 | return self.__repr.format(self=self) |
| 2381 | |
Jason R. Coombs | 928dbfc | 2020-12-15 21:12:54 -0500 | [diff] [blame] | 2382 | def joinpath(self, *other): |
| 2383 | next = posixpath.join(self.at, *other) |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2384 | return self._next(self.root.resolve_dir(next)) |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2385 | |
Jason R. Coombs | 33e067d | 2019-05-09 11:34:36 -0400 | [diff] [blame] | 2386 | __truediv__ = joinpath |
| 2387 | |
Jason R. Coombs | 33e067d | 2019-05-09 11:34:36 -0400 | [diff] [blame] | 2388 | @property |
| 2389 | def parent(self): |
Jason R. Coombs | d1a0a96 | 2020-10-25 14:45:05 -0400 | [diff] [blame] | 2390 | if not self.at: |
| 2391 | return self.filename.parent |
Jason R. Coombs | 38f44b4 | 2019-07-07 17:37:50 -0400 | [diff] [blame] | 2392 | parent_at = posixpath.dirname(self.at.rstrip('/')) |
Jason R. Coombs | 33e067d | 2019-05-09 11:34:36 -0400 | [diff] [blame] | 2393 | if parent_at: |
| 2394 | parent_at += '/' |
| 2395 | return self._next(parent_at) |
| 2396 | |
Jason R. Coombs | b2758ff | 2019-05-08 09:45:06 -0400 | [diff] [blame] | 2397 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2398 | def main(args=None): |
| 2399 | import argparse |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2400 | |
Serhiy Storchaka | 150cd19 | 2017-04-07 18:56:12 +0300 | [diff] [blame] | 2401 | description = 'A simple command-line interface for zipfile module.' |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2402 | parser = argparse.ArgumentParser(description=description) |
Serhiy Storchaka | 150cd19 | 2017-04-07 18:56:12 +0300 | [diff] [blame] | 2403 | group = parser.add_mutually_exclusive_group(required=True) |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2404 | group.add_argument('-l', '--list', metavar='<zipfile>', |
| 2405 | help='Show listing of a zipfile') |
| 2406 | group.add_argument('-e', '--extract', nargs=2, |
| 2407 | metavar=('<zipfile>', '<output_dir>'), |
| 2408 | help='Extract zipfile into target dir') |
| 2409 | group.add_argument('-c', '--create', nargs='+', |
| 2410 | metavar=('<name>', '<file>'), |
| 2411 | help='Create zipfile from sources') |
| 2412 | group.add_argument('-t', '--test', metavar='<zipfile>', |
| 2413 | help='Test if a zipfile is valid') |
| 2414 | args = parser.parse_args(args) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2415 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2416 | if args.test is not None: |
| 2417 | src = args.test |
| 2418 | with ZipFile(src, 'r') as zf: |
Antoine Pitrou | 17babc5 | 2012-11-17 23:50:08 +0100 | [diff] [blame] | 2419 | badfile = zf.testzip() |
Antoine Pitrou | 7c8bcb6 | 2010-08-12 15:11:50 +0000 | [diff] [blame] | 2420 | if badfile: |
| 2421 | print("The following enclosed file is corrupted: {!r}".format(badfile)) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2422 | print("Done testing") |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2423 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2424 | elif args.list is not None: |
| 2425 | src = args.list |
| 2426 | with ZipFile(src, 'r') as zf: |
| 2427 | zf.printdir() |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2428 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2429 | elif args.extract is not None: |
| 2430 | src, curdir = args.extract |
| 2431 | with ZipFile(src, 'r') as zf: |
| 2432 | zf.extractall(curdir) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2433 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2434 | elif args.create is not None: |
| 2435 | zip_name = args.create.pop(0) |
| 2436 | files = args.create |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2437 | |
| 2438 | def addToZip(zf, path, zippath): |
| 2439 | if os.path.isfile(path): |
| 2440 | zf.write(path, zippath, ZIP_DEFLATED) |
| 2441 | elif os.path.isdir(path): |
Serhiy Storchaka | 518e71b | 2014-10-04 13:39:34 +0300 | [diff] [blame] | 2442 | if zippath: |
| 2443 | zf.write(path, zippath) |
Bernhard M. Wiedemann | 8452104 | 2018-01-31 11:17:10 +0100 | [diff] [blame] | 2444 | for nm in sorted(os.listdir(path)): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2445 | addToZip(zf, |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 2446 | os.path.join(path, nm), os.path.join(zippath, nm)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2447 | # else: ignore |
| 2448 | |
Serhiy Storchaka | 8c93310 | 2016-10-23 13:32:12 +0300 | [diff] [blame] | 2449 | with ZipFile(zip_name, 'w') as zf: |
| 2450 | for path in files: |
Serhiy Storchaka | 518e71b | 2014-10-04 13:39:34 +0300 | [diff] [blame] | 2451 | zippath = os.path.basename(path) |
| 2452 | if not zippath: |
| 2453 | zippath = os.path.basename(os.path.dirname(path)) |
| 2454 | if zippath in ('', os.curdir, os.pardir): |
| 2455 | zippath = '' |
| 2456 | addToZip(zf, path, zippath) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2457 | |
Jason R. Coombs | e5bd736 | 2020-02-11 21:58:47 -0500 | [diff] [blame] | 2458 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 2459 | if __name__ == "__main__": |
| 2460 | main() |