File size: 62,846 Bytes
d3de7c1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 | #!/usr/bin/python -u
#
# p7zr library
#
# Copyright (c) 2019-2024 Hiroshi Miura <miurahr@linux.com>
# Copyright (c) 2004-2015 by Joachim Bauch, mail@joachim-bauch.de
# 7-Zip Copyright (C) 1999-2010 Igor Pavlov
# LZMA SDK Copyright (C) 1999-2010 Igor Pavlov
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
"""Read 7zip format archives."""
from __future__ import annotations
import collections.abc
import contextlib
import datetime
import errno
import functools
import io
import os
import pathlib
import queue
import re
import stat
import sys
import time
from collections.abc import Collection
from dataclasses import dataclass
from multiprocessing import Process
from shutil import ReadError
from threading import Thread
from typing import IO, TYPE_CHECKING, Any, BinaryIO, Protocol, TypedDict
import multivolumefile
from py7zr.archiveinfo import Folder, Header, SignatureHeader
from py7zr.callbacks import ExtractCallback
from py7zr.compressor import SupportedMethods, get_methods_names
from py7zr.exceptions import (
AbsolutePathError,
Bad7zFile,
CrcError,
DecompressionError,
InternalError,
UnsupportedCompressionMethodError,
)
from py7zr.helpers import (
ArchiveTimestamp,
calculate_crc32,
check_archive_path,
filetime_to_dt,
get_sanitized_output_path,
is_path_valid,
readlink,
remove_trailing_slash,
)
from py7zr.io import MemIO, NullIO, WriterFactory
from py7zr.member import FILE_ATTRIBUTE_UNIX_EXTENSION, MemberType
from py7zr.properties import DEFAULT_FILTERS, FILTER_DEFLATE64, MAGIC_7Z, get_default_blocksize, get_memory_limit
if TYPE_CHECKING:
from typing_extensions import NotRequired
if sys.platform.startswith("win"):
import _winapi
class SupportsReadAndSeek(Protocol):
def read(self, n: int = -1) -> bytes: ...
def seek(self, offset: int, whence: int = 0) -> int: ...
class FileInfoDict(TypedDict):
"""
File information dictionary structure for archive members.
Contains filesystem metadata, timestamps, and platform-specific attributes.
"""
# Core fields (always present)
origin: pathlib.Path | None
filename: str
creationtime: ArchiveTimestamp
lastwritetime: ArchiveTimestamp
lastaccesstime: ArchiveTimestamp
# Optional fields
emptystream: NotRequired[bool]
attributes: NotRequired[int]
uncompressed: NotRequired[int]
data: NotRequired[IO[Any]]
readonly: NotRequired[bool]
posix_mode: NotRequired[int | None]
archivable: NotRequired[bool]
is_directory: NotRequired[bool]
class ArchiveFile:
"""Represent each files metadata inside archive file.
It holds file properties; filename, permissions, and type whether
it is directory, link or normal file.
Instances of the :class:`ArchiveFile` class are returned by iterating :attr:`files_list` of
:class:`SevenZipFile` objects.
Each object stores information about a single member of the 7z archive. Most of users use :meth:`extractall()`.
The class also hold an archive parameter where file is exist in
archive file folder(container)."""
def __init__(self, id: int, file_info: FileInfoDict) -> None:
self.id = id
self._file_info = file_info
def file_properties(self) -> FileInfoDict:
"""Return file properties as a hash object. Following keys are included: 'readonly', 'is_directory',
'posix_mode', 'archivable', 'emptystream', 'filename', 'creationtime', 'lastaccesstime',
'lastwritetime', 'attributes'
"""
properties = self._file_info
if properties is not None:
properties["readonly"] = self.readonly
properties["posix_mode"] = self.posix_mode
properties["archivable"] = self.archivable
properties["is_directory"] = self.is_directory
return properties
def _get_property(self, key: str) -> Any:
return self._file_info.get(key)
@property
def origin(self) -> pathlib.Path:
return self._get_property("origin")
@property
def folder(self) -> Folder:
return self._get_property("folder")
@property
def filename(self) -> str:
"""return filename of archive file."""
return self._get_property("filename")
@property
def emptystream(self) -> bool:
"""True if file is empty(0-byte file), otherwise False"""
return self._get_property("emptystream")
@property
def uncompressed(self) -> int:
return self._get_property("uncompressed")
@property
def compressed(self) -> int | None:
"""Compressed size"""
return self._get_property("compressed")
@property
def crc32(self) -> int | None:
"""CRC of archived file(optional)"""
return self._get_property("digest")
def _test_attribute(self, target_bit: int) -> bool:
attributes = self._get_property("attributes")
if attributes is None:
return False
return attributes & target_bit == target_bit
@property
def archivable(self) -> bool:
"""File has a Windows `archive` flag."""
if hasattr(stat, "FILE_ATTRIBUTE_ARCHIVE"):
return self._test_attribute(getattr(stat, "FILE_ATTRIBUTE_ARCHIVE"))
return False
@property
def is_directory(self) -> bool:
"""True if file is a directory, otherwise False."""
if hasattr(stat, "FILE_ATTRIBUTE_DIRECTORY"):
return self._test_attribute(getattr(stat, "FILE_ATTRIBUTE_DIRECTORY"))
return False
@property
def is_file(self) -> bool:
e = self._get_unix_extension()
if e is not None:
return stat.S_ISREG(e)
return not (self.is_directory or self.is_symlink or self.is_junction or self.is_socket)
@property
def readonly(self) -> bool:
"""True if file is readonly, otherwise False."""
if hasattr(stat, "FILE_ATTRIBUTE_READONLY"):
return self._test_attribute(getattr(stat, "FILE_ATTRIBUTE_READONLY"))
return False
def _get_unix_extension(self) -> int | None:
attributes = self._get_property("attributes")
if self._test_attribute(FILE_ATTRIBUTE_UNIX_EXTENSION):
return attributes >> 16
return None
def data(self) -> BinaryIO | None:
return self._get_property("data")
def has_strdata(self) -> bool:
"""True if file content is set by writestr() method otherwise False."""
return "data" in self._file_info
@property
def is_symlink(self) -> bool:
"""True if file is a symbolic link, otherwise False."""
e = self._get_unix_extension()
if e is not None:
return stat.S_ISLNK(e)
if hasattr(stat, "FILE_ATTRIBUTE_REPARSE_POINT"):
return self._test_attribute(getattr(stat, "FILE_ATTRIBUTE_REPARSE_POINT"))
return False
@property
def is_junction(self) -> bool:
"""True if file is a junction/reparse point on windows, otherwise False."""
if hasattr(stat, "FILE_ATTRIBUTE_REPARSE_POINT"):
return self._test_attribute(
getattr(stat, "FILE_ATTRIBUTE_REPARSE_POINT") | getattr(stat, "FILE_ATTRIBUTE_DIRECTORY")
)
return False
@property
def is_socket(self) -> bool:
"""True if file is a socket, otherwise False."""
e = self._get_unix_extension()
if e is not None:
return stat.S_ISSOCK(e)
return False
@property
def lastwritetime(self) -> ArchiveTimestamp | None:
"""Return last written timestamp of a file."""
return self._get_property("lastwritetime")
@property
def posix_mode(self) -> int | None:
"""
posix mode when a member has a unix extension property, or None
:return: Return file stat mode can be set by os.chmod()
"""
e = self._get_unix_extension()
if e is not None:
return stat.S_IMODE(e)
return None
@property
def st_fmt(self) -> int | None:
"""
:return: Return the portion of the file mode that describes the file type
"""
e = self._get_unix_extension()
if e is not None:
return stat.S_IFMT(e)
return None
class ArchiveFileList(collections.abc.Iterable[ArchiveFile]):
"""Iterable container of ArchiveFile."""
def __init__(self, offset: int = 0):
self.files_list: list[FileInfoDict] = []
self.index = 0
self.offset = offset
def append(self, file_info: FileInfoDict) -> None:
self.files_list.append(file_info)
def __len__(self) -> int:
return len(self.files_list)
def __iter__(self) -> ArchiveFileListIterator:
return ArchiveFileListIterator(self)
def __getitem__(self, index: int) -> ArchiveFile:
if index > len(self.files_list):
raise IndexError
if index < 0:
raise IndexError
res = ArchiveFile(index + self.offset, self.files_list[index])
return res
class ArchiveFileListIterator(collections.abc.Iterator[ArchiveFile]):
def __init__(self, archive_file_list: ArchiveFileList):
self._archive_file_list = archive_file_list
self._index = 0
def __next__(self) -> ArchiveFile:
if self._index == len(self._archive_file_list):
raise StopIteration
res = self._archive_file_list[self._index]
self._index += 1
return res
# ------------------
# Exported Classes
# ------------------
@dataclass
class ArchiveInfo:
"""Hold archive information"""
filename: str
stat: os.stat_result
header_size: int
method_names: list[str]
solid: bool
blocks: int
uncompressed: int
@dataclass
class FileInfo:
"""Hold archived file information."""
filename: str
compressed: int | None
uncompressed: int
archivable: bool
is_directory: bool
is_file: bool
is_symlink: bool
creationtime: datetime.datetime | None
crc32: int | None
def __post_init__(self) -> None:
# Prevent ambiguous file type states.
# A file can't simultaneously be a directory, a regular file, or a symlink,
# but it’s allowed to be none of these (e.g., a junction or a socket).
flags = self.is_directory + self.is_file + self.is_symlink
if flags > 1:
raise ValueError(
f"At most one of is_directory, is_file, or is_symlink can be True; "
f"got is_directory={self.is_directory}, is_file={self.is_file}, is_symlink={self.is_symlink}"
)
class SevenZipFile(contextlib.AbstractContextManager):
"""The SevenZipFile Class provides an interface to 7z archives."""
def __init__(
self,
file: IO[bytes] | str | pathlib.Path,
mode: str = "r",
*,
filters: list[dict[str, int]] | None = None,
dereference=False,
password: str | None = None,
header_encryption: bool = False,
blocksize: int | None = None,
mp: bool = False,
) -> None:
# check invalid mode.
if mode not in ("r", "w", "x", "a"):
raise ValueError("SevenZipFile requires mode 'r', 'w', 'x', or 'a'")
self.fp: IO[bytes]
self.mp = mp
self.password_protected = password is not None
if blocksize:
self._block_size = blocksize
else:
self._block_size = get_default_blocksize()
# https://github.com/python/cpython/blob/b5e142ba7c2063efe9bb8065c3b0bad33e2a9afa/Lib/zipfile/__init__.py#L1350
# Check if we were passed a file-like object or not
if isinstance(file, os.PathLike):
file = os.fspath(file)
if isinstance(file, str):
# No, it's a filename
self._filePassed = False
self.filename: str | None = file
modeDict = {
"r": "rb",
"w": "w+b",
"x": "x+b",
"a": "r+b",
"r+b": "w+b",
"w+b": "wb",
"x+b": "xb",
}
filemode = modeDict[mode]
while True:
try:
self.fp = open(file, filemode)
except OSError:
if filemode in modeDict:
filemode = modeDict[filemode]
continue
raise
break
self.mode = mode
elif isinstance(file, multivolumefile.MultiVolume):
self._filePassed = True
self.fp = file
self.filename = None
self.mode = mode # noqa
elif isinstance(file, io.IOBase):
self._filePassed = True
self.fp = file
self.filename = getattr(file, "name", None)
self.mode = mode # noqa
else:
raise TypeError(f"invalid file: {type(file)}")
self.encoded_header_mode = True
self.header_encryption = header_encryption
try:
if mode == "r":
self._real_get_contents(password)
self.fp.seek(self.afterheader) # seek into start of payload and prepare worker to extract
self.worker = Worker(self.files, self.afterheader, self.header, self.mp)
elif mode == "w":
self._prepare_write(filters, password)
elif mode == "x":
self._prepare_write(filters, password)
elif mode == "a":
try:
# Append if it's an existing 7zip file
self._real_get_contents(password)
self._prepare_append(filters, password)
except Bad7zFile:
# Not an existing 7zip file, write instead
self._prepare_write(filters, password)
else:
raise ValueError("Mode must be 'r', 'w', 'x', or 'a'") # never come here
except Exception as e:
self._fpclose()
raise e
self.dereference = dereference
self.reporterd: Thread | None = None
self.q: queue.Queue[Any] = queue.Queue()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def _fpclose(self) -> None:
if not self._filePassed:
self.fp.close()
def _real_get_contents(self, password) -> None:
if not self._check_7zfile(self.fp):
raise Bad7zFile("not a 7z file")
self.sig_header = SignatureHeader.retrieve(self.fp) # type: ignore[arg-type]
self.afterheader: int = self.fp.tell()
self.fp.seek(self.sig_header.nextheaderofs, os.SEEK_CUR)
buffer = io.BytesIO(self.fp.read(self.sig_header.nextheadersize))
if self.sig_header.nextheadercrc != calculate_crc32(buffer.getvalue()):
raise Bad7zFile("invalid header data")
header = Header.retrieve(self.fp, buffer, self.afterheader, password) # type: ignore[arg-type]
if header is None:
return
header.size += 32 + self.sig_header.nextheadersize
self.header = header
buffer.close()
self.files = ArchiveFileList()
if getattr(self.header, "files_info", None) is None:
return
# Initialize references for convenience
if hasattr(self.header, "main_streams") and self.header.main_streams is not None:
folders = self.header.main_streams.unpackinfo.folders
for folder in folders:
folder.password = password
packinfo = self.header.main_streams.packinfo
packsizes = packinfo.packsizes
subinfo = self.header.main_streams.substreamsinfo
if subinfo is not None and subinfo.unpacksizes is not None:
unpacksizes = subinfo.unpacksizes
else:
unpacksizes = [x.unpacksizes[-1] for x in folders]
else:
subinfo = None
folders = None
packinfo = None
packsizes = []
unpacksizes = [0]
pstat = self.ParseStatus()
pstat.src_pos = self.afterheader
file_in_solid = 0
for file_id, file_info in enumerate(self.header.files_info.files):
if not file_info["emptystream"] and folders is not None:
folder = folders[pstat.folder]
numinstreams = max([coder.get("numinstreams", 1) for coder in folder.coders])
(maxsize, compressed, uncompressed, packsize, solid) = self._get_fileinfo_sizes(
pstat, subinfo, packinfo, folder, packsizes, unpacksizes, file_in_solid, numinstreams
)
pstat.input += 1
folder.solid = solid
file_info["folder"] = folder
file_info["maxsize"] = maxsize
file_info["compressed"] = compressed
file_info["uncompressed"] = uncompressed
file_info["packsizes"] = packsize
if subinfo.digestsdefined[pstat.outstreams]:
file_info["digest"] = subinfo.digests[pstat.outstreams]
if folder is None:
pstat.src_pos += file_info["compressed"]
else:
if folder.solid:
file_in_solid += 1
pstat.outstreams += 1
if folder.files is None:
folder.files = ArchiveFileList(offset=file_id)
folder.files.append(file_info)
if pstat.input >= subinfo.num_unpackstreams_folders[pstat.folder]:
file_in_solid = 0
pstat.src_pos += sum(packinfo.packsizes[pstat.stream : pstat.stream + numinstreams])
pstat.folder += 1
pstat.stream += numinstreams
pstat.input = 0
else:
file_info["folder"] = None
file_info["maxsize"] = 0
file_info["compressed"] = 0
file_info["uncompressed"] = 0
file_info["packsizes"] = [0]
if "filename" not in file_info:
# compressed file is stored without a name, generate one
try:
basefilename = self.filename
except AttributeError:
# 7z archive file doesn't have a name
file_info["filename"] = "contents"
else:
if basefilename is not None:
fn, ext = os.path.splitext(os.path.basename(basefilename))
file_info["filename"] = fn
else:
file_info["filename"] = "contents"
self.files.append(file_info)
if not self.password_protected and self.header.main_streams is not None:
# Check specified coders have a crypt method or not.
self.password_protected = any(
[SupportedMethods.needs_password(folder.coders) for folder in self.header.main_streams.unpackinfo.folders]
)
def _extract(
self,
path: Any | None = None,
targets: Collection[str] | None = None,
callback: ExtractCallback | None = None,
recursive: bool | None = False,
writer_factory: WriterFactory | None = None,
) -> None:
if callback is None:
pass
elif isinstance(callback, ExtractCallback):
self.reporterd = Thread(target=self.reporter, args=(callback,), daemon=True)
self.reporterd.start()
else:
raise ValueError("Callback specified is not an instance of subclass of py7zr.callbacks.ExtractCallback class")
target_files: list[tuple[pathlib.Path, FileInfoDict]] = []
target_dirs: list[pathlib.Path] = []
if path is not None:
if isinstance(path, str):
path = pathlib.Path(path)
try:
if not path.exists():
path.mkdir(parents=True)
else:
pass
except OSError as e:
if e.errno == errno.EEXIST and path.is_dir():
pass
else:
raise e
if targets is not None:
# faster lookups
targets = set(targets)
fnames: dict[str, int] = {} # check duplicated filename in one archive?
self.q.put(("pre", None, None))
for f in self.files:
if targets is not None and recursive is False:
if f.filename not in targets:
self.worker.register_filelike(f.id, None)
continue
elif targets is not None and recursive is True:
if f.filename not in targets and not any([f.filename.startswith(target) for target in targets]):
self.worker.register_filelike(f.id, None)
continue
# When archive has a multiple files which have same name
# To guarantee order of archive, multi-thread decompression becomes off.
# Currently always overwrite by latter archives.
# TODO: provide option to select overwrite or skip.
if f.filename not in fnames:
outname = f.filename
fnames[f.filename] = 0
else:
outname = f"{f.filename}_{fnames[f.filename]}"
fnames[f.filename] += 1
if path is None or path.is_absolute():
outfilename = get_sanitized_output_path(outname, path)
else:
outfilename = get_sanitized_output_path(outname, pathlib.Path(os.getcwd()).joinpath(path))
if writer_factory is not None:
if f.is_directory or f.is_socket:
# ignore special files and directories
pass
else:
fname = outfilename.as_posix()
self.worker.register_filelike(f.id, MemIO(fname, writer_factory))
elif f.is_directory:
if not outfilename.exists():
target_dirs.append(outfilename)
target_files.append((outfilename, f.file_properties()))
else:
pass
elif f.is_socket:
pass # TODO: implement me.
elif f.is_symlink or f.is_junction:
self.worker.register_filelike(f.id, outfilename)
else:
self.worker.register_filelike(f.id, outfilename)
target_files.append((outfilename, f.file_properties()))
for target_dir in sorted(target_dirs):
try:
target_dir.mkdir(parents=True)
except FileExistsError:
if target_dir.is_dir():
pass
elif target_dir.is_file():
raise DecompressionError(f"Directory {target_dir} is existed as a normal file.")
else:
raise DecompressionError(f"Directory {target_dir} making fails on unknown condition.")
if callback is not None:
self.worker.extract(
self.fp,
path,
parallel=(not self.password_protected and not self._filePassed),
q=self.q,
)
else:
self.worker.extract(
self.fp,
path,
parallel=(not self.password_protected and not self._filePassed),
)
self.q.put(("post", None, None))
# early return when dict specified
if writer_factory is not None:
return
# set file properties
for outfilename, properties in target_files:
# mtime
lastmodified = None
try:
lastmodified = ArchiveTimestamp(properties["lastwritetime"]).totimestamp()
except KeyError:
pass
if lastmodified is not None:
os.utime(str(outfilename), times=(lastmodified, lastmodified))
if os.name == "posix":
st_mode = properties["posix_mode"]
if st_mode is not None:
outfilename.chmod(st_mode)
continue
# fallback: only set readonly if specified
if properties["readonly"] and not properties["is_directory"]:
ro_mask = 0o777 ^ (stat.S_IWRITE | stat.S_IWGRP | stat.S_IWOTH)
outfilename.chmod(outfilename.stat().st_mode & ro_mask)
return None
def _prepare_append(self, filters, password):
if password is not None and filters is None:
filters = DEFAULT_FILTERS.ENCRYPTED_ARCHIVE_FILTER
elif filters is None:
filters = DEFAULT_FILTERS.ARCHIVE_FILTER
else:
for f in filters:
if f["id"] == FILTER_DEFLATE64:
raise UnsupportedCompressionMethodError(filters, "Compression with deflate64 is not supported.")
self.header.filters = filters
self.header.password = password
if self.header.main_streams is not None:
pos = self.afterheader + self.header.main_streams.packinfo.packpositions[-1]
else:
pos = self.afterheader
self.fp.seek(pos)
self.worker = Worker(self.files, pos, self.header, self.mp)
def _prepare_write(self, filters, password):
if password is not None and filters is None:
filters = DEFAULT_FILTERS.ENCRYPTED_ARCHIVE_FILTER
elif filters is None:
filters = DEFAULT_FILTERS.ARCHIVE_FILTER
self.files = ArchiveFileList()
self.sig_header = SignatureHeader()
self.sig_header._write_skeleton(self.fp)
self.afterheader = self.fp.tell()
self.header = Header.build_header(filters, password)
self.fp.seek(self.afterheader)
self.worker = Worker(self.files, self.afterheader, self.header, self.mp)
def _write_flush(self):
if self.header is not None:
if self.header._initialized:
folder = self.header.main_streams.unpackinfo.folders[-1]
self.worker.flush_archive(self.fp, folder)
self._write_header()
def _write_header(self):
"""Write header and update signature header."""
(header_pos, header_len, header_crc) = self.header.write(
self.fp,
self.afterheader,
encoded=self.encoded_header_mode,
encrypted=self.header_encryption,
)
self.sig_header.nextheaderofs = header_pos - self.afterheader
self.sig_header.calccrc(header_len, header_crc)
self.sig_header.write(self.fp)
def _writeall(self, path, arcname):
try:
if path.is_symlink() and not self.dereference:
self.write(path, arcname)
elif path.is_file():
self.write(path, arcname)
elif path.is_dir():
if not path.samefile("."):
self.write(path, arcname)
for nm in sorted(os.listdir(str(path))):
arc = os.path.join(arcname, nm) if arcname is not None else None
self._writeall(path.joinpath(nm), arc)
else:
return # pathlib ignores ELOOP and return False for is_*().
except OSError as ose:
if self.dereference and ose.errno in [errno.ELOOP]:
return # ignore ELOOP here, this resulted to stop looped symlink reference.
elif self.dereference and sys.platform == "win32" and ose.errno in [errno.ENOENT]:
return # ignore ENOENT which is happened when a case of ELOOP on windows.
else:
raise
class ParseStatus:
def __init__(self, src_pos=0):
self.src_pos = src_pos
self.folder = 0 # 7zip folder where target stored
self.outstreams = 0 # output stream count
self.input = 0 # unpack stream count in each folder
self.stream = 0 # target input stream position
def _get_fileinfo_sizes(
self,
pstat,
subinfo,
packinfo,
folder,
packsizes,
unpacksizes,
file_in_solid,
numinstreams,
):
if pstat.input == 0:
folder.solid = subinfo.num_unpackstreams_folders[pstat.folder] > 1
maxsize = (folder.solid and packinfo.packsizes[pstat.stream]) or None
uncompressed = unpacksizes[pstat.outstreams]
if file_in_solid > 0:
compressed = None
elif pstat.stream < len(packsizes): # file is compressed
compressed = packsizes[pstat.stream]
else: # file is not compressed
compressed = uncompressed
packsize = packsizes[pstat.stream : pstat.stream + numinstreams]
return maxsize, compressed, uncompressed, packsize, folder.solid
def set_encoded_header_mode(self, mode: bool) -> None:
if mode:
self.encoded_header_mode = True
else:
self.encoded_header_mode = False
self.header_encryption = False
def set_encrypted_header(self, mode: bool) -> None:
if mode:
self.encoded_header_mode = True
self.header_encryption = True
else:
self.header_encryption = False
@staticmethod
def _check_7zfile(fp: SupportsReadAndSeek) -> bool:
try:
magic_len = len(MAGIC_7Z)
result = MAGIC_7Z == fp.read(magic_len)[:magic_len]
fp.seek(-magic_len, 1)
return result
except OSError:
# A new empty file raises OSError
return False
def _get_method_names(self) -> list[str]:
try:
return get_methods_names([folder.coders for folder in self.header.main_streams.unpackinfo.folders])
except KeyError:
raise UnsupportedCompressionMethodError(self.header.main_streams.unpackinfo.folders, "Unknown method")
def _read_digest(self, pos: int, size: int) -> int:
self.fp.seek(pos)
remaining_size = size
digest = 0
while remaining_size > 0:
block = min(self._block_size, remaining_size)
digest = calculate_crc32(self.fp.read(block), digest)
remaining_size -= block
return digest
def _is_solid(self):
for f in self.header.main_streams.substreamsinfo.num_unpackstreams_folders:
if f > 1:
return True
return False
def _var_release(self):
self._dict = {}
self.worker.close()
del self.worker
del self.files
del self.header
del self.sig_header
@staticmethod
def _make_file_info( # noqa
target: pathlib.Path, arcname: str | None = None, dereference: bool = False
) -> FileInfoDict:
origin = target
filename = pathlib.Path(arcname).as_posix() if arcname else target.as_posix()
target = target.resolve() if dereference else target
fstat = target.lstat()
f = FileInfoDict(
origin=origin,
filename=filename,
creationtime=ArchiveTimestamp.from_datetime(fstat.st_ctime),
lastwritetime=ArchiveTimestamp.from_datetime(fstat.st_mtime),
lastaccesstime=ArchiveTimestamp.from_datetime(fstat.st_atime),
)
if target.is_symlink():
f["emptystream"] = False
f["attributes"] = MemberType.SYMLINK.attributes(fstat)
# TODO: handle junctions
elif target.is_dir():
f["emptystream"] = True
f["attributes"] = MemberType.DIRECTORY.attributes(fstat)
elif target.is_file():
f["emptystream"] = False
f["uncompressed"] = fstat.st_size
f["attributes"] = MemberType.FILE.attributes(fstat)
return f
@staticmethod
def _make_file_info_from_name(bio: IO[Any], size: int, arcname: str) -> FileInfoDict:
return FileInfoDict(
origin=None,
data=bio,
filename=pathlib.Path(arcname).as_posix(),
uncompressed=size,
emptystream=False,
attributes=MemberType.FILE.attributes(),
creationtime=ArchiveTimestamp.from_now(),
lastwritetime=ArchiveTimestamp.from_now(),
lastaccesstime=ArchiveTimestamp.from_now(),
)
@staticmethod
def _sanitize_archive_arcname(arcname):
if isinstance(arcname, str):
path = arcname
else:
path = str(arcname)
# Strip leading / (tar's directory separator) from filenames.
# Include os.sep (target OS directory separator) as well.
if path.startswith(("/", os.sep)):
path = path.lstrip("/" + os.sep)
if re.match("^[a-zA-Z]:", path):
path = path[2:]
# strip again
if path.startswith(("/", os.sep)):
path = path.lstrip("/" + os.sep)
if os.path.isabs(path) or re.match("^[a-zA-Z]:", path):
# Path is absolute even after stripping.
raise AbsolutePathError(arcname)
return path
@staticmethod
def _is_none_or_collection(t):
if t is None:
return True
if isinstance(t, str):
return False
if isinstance(t, tuple):
return False
if isinstance(t, list) or isinstance(t, set):
return True
return False
# --------------------------------------------------------------------------
# The public methods which SevenZipFile provides:
def getnames(self) -> list[str]:
"""Return the members of the archive as a list of their names. It has
the same order as the list returned by getmembers().
"""
return self.namelist()
def namelist(self) -> list[str]:
"""Return a list of archive members by name."""
return list(x.filename for x in self.files)
def getinfo(self, name: str) -> FileInfo:
"""Return a :class:`FileInfo` object with information about the archive member *name*.
Calling :meth:`getinfo()` for a name not currently contained in the archive will raise a :exc:`KeyError`."""
# For interoperability with ZipFile
name = remove_trailing_slash(name)
try:
sevenzipinfo = next(member for member in self.list() if member.filename == name)
except StopIteration:
# ZipFile and TarFile raise KeyError if the named member is not found
# So for consistency, we'll also raise KeyError here
raise KeyError(f"'{name}' not found in archive.") from None
return sevenzipinfo
def archiveinfo(self) -> ArchiveInfo:
total_uncompressed = functools.reduce(lambda x, y: x + y, [f.uncompressed for f in self.files])
if isinstance(self.fp, multivolumefile.MultiVolume):
fname = self.fp.name
fstat = self.fp.stat()
else:
fname = self.filename
assert fname is not None
fstat = os.stat(fname)
return ArchiveInfo(
fname,
fstat,
self.header.size,
self._get_method_names(),
self._is_solid(),
len(self.header.main_streams.unpackinfo.folders),
total_uncompressed,
)
def needs_password(self) -> bool:
return self.password_protected
def list(self) -> list[FileInfo]:
"""Returns contents information"""
alist: list[FileInfo] = []
lastmodified: datetime.datetime | None = None
for f in self.files:
if f.lastwritetime is not None:
lastmodified = filetime_to_dt(f.lastwritetime)
alist.append(
FileInfo(
filename=f.filename,
compressed=f.compressed,
uncompressed=f.uncompressed,
archivable=f.archivable,
is_file=f.is_file,
is_directory=f.is_directory,
is_symlink=f.is_symlink,
creationtime=lastmodified,
crc32=f.crc32,
)
)
return alist
def extractall(
self,
path: Any | None = None,
*,
callback: ExtractCallback | None = None,
factory: WriterFactory | None = None,
) -> None:
"""Extract all members from the archive to the current working
directory and set owner, modification time and permissions on
directories afterward. ``path`` specifies a different directory
to extract to.
"""
self._extract(path=path, callback=callback, writer_factory=factory)
def extract(
self,
path: Any | None = None,
targets: Collection[str] | None = None,
recursive: bool | None = False,
*,
callback: ExtractCallback | None = None,
factory: WriterFactory | None = None,
) -> None:
if not self._is_none_or_collection(targets):
raise TypeError("Wrong argument type given.")
# For interoperability with ZipFile, we strip any trailing slashes
# This also matches the behavior of TarFile
if targets is not None:
targets = [remove_trailing_slash(target) for target in targets]
self._extract(path, targets, recursive=recursive, callback=callback, writer_factory=factory)
def reporter(self, callback: ExtractCallback) -> None:
while True:
try:
item: tuple[str, str, str] | None = self.q.get(timeout=1)
except queue.Empty:
pass
else:
if item is None:
break
elif item[0] == "s":
callback.report_start(item[1], item[2])
elif item[0] == "u":
callback.report_update(item[2])
elif item[0] == "e":
callback.report_end(item[1], item[2])
elif item[0] == "pre":
callback.report_start_preparation()
elif item[0] == "post":
callback.report_postprocess()
elif item[0] == "w":
callback.report_warning(item[1])
else:
pass
self.q.task_done()
def writeall(
self,
path: pathlib.Path | str,
arcname: str | None = None,
) -> None:
"""Write files in target path into archive."""
if isinstance(path, str):
path = pathlib.Path(path)
if not path.exists():
raise ValueError("specified path does not exist.")
if path.is_dir() or path.is_file():
self._writeall(path, arcname)
else:
raise ValueError("specified path is not a directory or a file")
def write(
self,
file: pathlib.Path | str,
arcname: str | None = None,
) -> None:
"""Write single target file into archive."""
if not isinstance(file, str) and not isinstance(file, pathlib.Path):
raise ValueError("Unsupported file type.")
if arcname is None:
arcname = self._sanitize_archive_arcname(file)
else:
arcname = self._sanitize_archive_arcname(arcname)
if isinstance(file, str):
path = pathlib.Path(file)
else:
path = file
folder = self.header.initialize()
file_info = self._make_file_info(path, arcname, self.dereference)
self.header.files_info.files.append(file_info)
self.header.files_info.emptyfiles.append(file_info["emptystream"])
self.files.append(file_info)
self.worker.archive(self.fp, self.files, folder, deref=self.dereference)
def writef(self, bio: IO[Any], arcname: str) -> None:
if not check_archive_path(arcname):
raise ValueError(f"Specified path is bad: {arcname}")
return self._writef(bio, arcname)
def _writef(self, bio: IO[Any], arcname: str) -> None:
if isinstance(bio, io.BytesIO):
size = bio.getbuffer().nbytes
elif isinstance(bio, io.TextIOBase):
# First check whether is it Text?
raise ValueError("Unsupported file object type: please open file with Binary mode.")
elif isinstance(bio, io.BufferedIOBase):
# come here when subtype of io.BufferedIOBase that don't have __sizeof__ (eg. pypy)
# alternative for `size = bio.__sizeof__()`
current = bio.tell()
bio.seek(0, os.SEEK_END)
last = bio.tell()
bio.seek(current, os.SEEK_SET)
size = last - current
elif isinstance(bio, MemIO):
size = bio.__sizeof__()
else:
raise ValueError("Wrong argument passed for argument bio.")
if size >= 0:
folder = self.header.initialize()
file_info = self._make_file_info_from_name(bio, size, arcname)
self.header.files_info.files.append(file_info)
self.header.files_info.emptyfiles.append(file_info["emptystream"])
self.files.append(file_info)
self.worker.archive(self.fp, self.files, folder, deref=False)
else:
file_info = self._make_file_info_from_name(bio, size, arcname)
self.header.files_info.files.append(file_info)
self.header.files_info.emptyfiles.append(file_info["emptystream"])
self.files.append(file_info)
def writestr(
self,
data: str | bytes | bytearray | memoryview,
arcname: str,
) -> None:
if not check_archive_path(arcname):
raise ValueError(f"Specified path is bad: {arcname}")
return self._writestr(data, arcname)
def _writestr(
self,
data: str | bytes | bytearray | memoryview,
arcname: str,
) -> None:
if not isinstance(arcname, str):
raise ValueError("Unsupported arcname")
if isinstance(data, str):
self._writef(io.BytesIO(data.encode("UTF-8")), arcname)
elif isinstance(data, bytes) or isinstance(data, bytearray) or isinstance(data, memoryview):
self._writef(io.BytesIO(bytes(data)), arcname)
else:
raise ValueError("Unsupported data type.")
def close(self) -> None:
"""Flush all the data into archive and close it.
When close py7zr start reading target and writing actual archive file.
"""
if "r" in self.mode:
if self.reporterd is not None:
self.q.put_nowait(None)
self.reporterd.join(1)
if self.reporterd.is_alive():
raise InternalError("Progress report thread terminate error.")
self.reporterd = None
else: # "w" | "x" | "a" in self.mode
self._write_flush()
self._fpclose()
self._var_release()
def reset(self) -> None:
"""
When read mode, it reset file pointer, decompress worker and decompressor
"""
if self.mode == "r":
self.fp.seek(self.afterheader)
self.worker = Worker(self.files, self.afterheader, self.header, self.mp)
if self.header.main_streams is not None and self.header.main_streams.unpackinfo.numfolders > 0:
for i, folder in enumerate(self.header.main_streams.unpackinfo.folders):
folder.decompressor = None
def test(self) -> bool | None:
self.fp.seek(self.afterheader)
self.worker = Worker(self.files, self.afterheader, self.header, self.mp)
crcs: list[int] | None = self.header.main_streams.packinfo.crcs
if crcs is None or len(crcs) == 0:
return None
packpos = self.afterheader + self.header.main_streams.packinfo.packpos
packsizes = self.header.main_streams.packinfo.packsizes
digestdefined = self.header.main_streams.packinfo.digestdefined
j = 0
for i, d in enumerate(digestdefined):
if d:
if self._read_digest(packpos, packsizes[i]) != crcs[j]:
return False
j += 1
packpos += packsizes[i]
return True
def testzip(self) -> str | None:
self.fp.seek(self.afterheader)
self.worker = Worker(self.files, self.afterheader, self.header, self.mp)
for f in self.files:
self.worker.register_filelike(f.id, None)
try:
self.worker.extract(
self.fp, None, parallel=(not self.password_protected), skip_notarget=False
) # TODO: print progress
except CrcError as crce:
return crce.args[2]
else:
return None
# --------------------
# exported functions
# --------------------
def is_7zfile(file: SupportsReadAndSeek | IO[bytes] | str | os.PathLike[str]) -> bool:
"""Quickly see if a file is a 7Z file by checking the magic number.
The file argument may be a filename or file-like object too.
"""
if hasattr(file, "read") and hasattr(file, "seek"):
return SevenZipFile._check_7zfile(file) # type: ignore
try:
if isinstance(file, str):
with open(file, mode="rb") as fp:
return SevenZipFile._check_7zfile(fp)
if isinstance(file, os.PathLike):
with open(os.fspath(file), mode="rb") as fp:
return SevenZipFile._check_7zfile(fp)
except FileNotFoundError:
return False
msg = (
f"Invalid 'file' argument: Expected a path-like object " f"or a binary file-like object; got {type(file).__name__}."
)
raise TypeError(msg)
def unpack_7zarchive(archive, path, extra=None):
"""
Function for registering with shutil.register_unpack_format().
"""
if not is_7zfile(archive):
raise ReadError(f"{archive} is not a 7zip file.")
with SevenZipFile(archive) as arc:
arc.extractall(path)
def pack_7zarchive(base_name, base_dir, owner=None, group=None, dry_run=None, logger=None):
"""
Function for registering with shutil.register_archive_format().
"""
target_name = f"{base_name}.7z"
with SevenZipFile(target_name, mode="w") as archive:
archive.writeall(path=base_dir)
return target_name
class Worker:
"""
Extract worker class to invoke handler.
"""
def __init__(self, files, src_start: int, header, mp=False) -> None:
self.target_filepath: dict[int, MemIO | pathlib.Path | None] = {}
self.files = files
self.src_start = src_start
self.header = header
self.current_file_index = len(self.files)
self.last_file_index = len(self.files) - 1
if mp:
self.concurrent: type[Thread] | type[Process] = Process
else:
self.concurrent = Thread
def extract(
self,
fp: IO[bytes],
path: pathlib.Path | None,
parallel: bool,
skip_notarget=True,
q=None,
) -> None:
"""Extract worker method to handle 7zip folder and decompress each files."""
if hasattr(self.header, "main_streams") and self.header.main_streams is not None:
src_end = self.src_start + self.header.main_streams.packinfo.packpositions[-1]
numfolders = self.header.main_streams.unpackinfo.numfolders
if numfolders == 1:
self.extract_single(
fp,
self.files,
path,
self.src_start,
src_end,
q,
skip_notarget=skip_notarget,
)
else:
folders = self.header.main_streams.unpackinfo.folders
positions = self.header.main_streams.packinfo.packpositions
empty_files = [f for f in self.files if f.emptystream]
if not parallel:
self.extract_single(fp, empty_files, path, 0, 0, q)
for i in range(numfolders):
if skip_notarget:
if not any([self.target_filepath.get(f.id, None) for f in folders[i].files]):
continue
self.extract_single(
fp,
folders[i].files,
path,
self.src_start + positions[i],
self.src_start + positions[i + 1],
q,
skip_notarget=skip_notarget,
)
else:
if getattr(fp, "name", None) is None:
raise InternalError("Caught unknown variable status error")
filename: str = getattr(fp, "name", "") # do not become "" but it is for type check.
self.extract_single(open(filename, "rb"), empty_files, path, 0, 0, q)
concurrent_tasks = []
exc_q: queue.Queue = queue.Queue()
for i in range(numfolders):
if skip_notarget:
if not any([self.target_filepath.get(f.id, None) for f in folders[i].files]):
continue
p = self.concurrent(
target=self.extract_single,
args=(
filename,
folders[i].files,
path,
self.src_start + positions[i],
self.src_start + positions[i + 1],
q,
exc_q,
skip_notarget,
),
)
p.start()
concurrent_tasks.append(p)
for p in concurrent_tasks:
p.join()
if exc_q.empty():
pass
else:
exc_info = exc_q.get()
raise exc_info[1].with_traceback(exc_info[2])
else:
empty_files = [f for f in self.files if f.emptystream]
self.extract_single(fp, empty_files, path, 0, 0, q)
def extract_single(
self,
fp: IO[bytes] | str,
files,
path,
src_start: int,
src_end: int,
q: queue.Queue | None,
exc_q: queue.Queue | None = None,
skip_notarget=True,
) -> None:
"""
Single thread extractor that takes file lists in single 7zip folder.
"""
if files is None:
return
try:
if isinstance(fp, str):
fp = open(fp, "rb")
fp.seek(src_start)
self._extract_single(fp, files, path, src_end, q, skip_notarget)
except Exception as e:
if exc_q is None:
raise e
else:
exc_tuple = sys.exc_info()
exc_q.put(exc_tuple)
def _extract_single(
self,
fp: IO[bytes],
files,
path,
src_end: int,
q: queue.Queue | None,
skip_notarget=True,
) -> None:
"""
Single thread extractor that takes file lists in single 7zip folder.
this may raise exception.
"""
just_check: list[ArchiveFile] = []
for f in files:
if q is not None:
q.put(
(
"s",
str(f.filename),
str(f.compressed) if f.compressed is not None else "0",
)
)
fileish = self.target_filepath.get(f.id, None)
if fileish is None:
if not f.emptystream:
just_check.append(f)
else:
# delayed execution of crc check.
self._check(fp, just_check, src_end)
just_check = []
if not isinstance(fileish, MemIO):
fileish.parent.mkdir(parents=True, exist_ok=True)
if not f.emptystream:
if f.is_junction and not isinstance(fileish, MemIO) and sys.platform == "win32":
with io.BytesIO() as ofp:
self.decompress(fp, f.folder, ofp, f.uncompressed, f.compressed, src_end, q)
dst: str = ofp.read().decode("utf-8")
if is_path_valid(fileish.parent.joinpath(dst), path):
# fileish.unlink(missing_ok=True) > py3.7
if fileish.exists():
fileish.unlink()
if sys.platform == "win32": # hint for mypy
_winapi.CreateJunction(str(fileish), dst) # noqa
else:
raise Bad7zFile("Junction point out of target directory.")
elif f.is_symlink and not isinstance(fileish, MemIO):
with io.BytesIO() as omfp:
self.decompress(fp, f.folder, omfp, f.uncompressed, f.compressed, src_end, q)
omfp.seek(0)
dst = omfp.read().decode("utf-8")
# check sym_target points inside an archive target?
if is_path_valid(fileish.parent.joinpath(dst), path):
sym_target = pathlib.Path(dst)
# fileish.unlink(missing_ok=True) > py3.7
if fileish.exists():
fileish.unlink()
fileish.symlink_to(sym_target)
else:
raise Bad7zFile("Symlink point out of target directory.")
else:
with fileish.open(mode="wb") as obfp:
crc32 = self.decompress(fp, f.folder, obfp, f.uncompressed, f.compressed, src_end, q)
obfp.seek(0)
if f.crc32 is not None and crc32 != f.crc32:
raise CrcError(crc32, f.crc32, f.filename)
else:
# just create empty file
if not isinstance(fileish, MemIO):
fileish.touch()
else:
with fileish.open() as ofp:
pass
if q is not None:
q.put(("e", str(f.filename), str(f.uncompressed)))
if not skip_notarget:
# delayed execution of crc check.
self._check(fp, just_check, src_end)
def _check(self, fp, check_target, src_end):
"""
delayed execution of crc check.
"""
for f in check_target:
with NullIO() as ofp:
crc32 = self.decompress(fp, f.folder, ofp, f.uncompressed, f.compressed, src_end)
if f.crc32 is not None and crc32 != f.crc32:
raise CrcError(crc32, f.crc32, f.filename)
def decompress(
self,
fp: IO[bytes],
folder,
fq: IO[Any],
size: int,
compressed_size: int | None,
src_end: int,
q: queue.Queue | None = None,
) -> int:
"""
decompressor wrapper called from extract method.
:parameter fp: archive source file pointer
:parameter folder: Folder object that have decompressor object.
:parameter fq: output file pathlib.Path
:parameter size: uncompressed size of target file.
:parameter compressed_size: compressed size of target file.
:parameter src_end: end position of the folder
:parameter q: the queue for the reporter
:returns None
"""
assert folder is not None
out_remaining = size
max_block_size = get_memory_limit()
crc32 = 0
decompressor = folder.get_decompressor(compressed_size)
previous_update_at = time.time()
decompressed_bytes = 0
while out_remaining > 0:
tmp = decompressor.decompress(fp, min(out_remaining, max_block_size))
if len(tmp) > 0:
out_remaining -= len(tmp)
fq.write(tmp)
crc32 = calculate_crc32(tmp, crc32)
if q is not None:
time_delta = time.time() - previous_update_at
decompressed_bytes += len(tmp)
if out_remaining <= 0 or time_delta >= 1:
q.put(("u", None, str(decompressed_bytes)))
previous_update_at += time_delta
decompressed_bytes = 0
if out_remaining <= 0:
break
if fp.tell() >= src_end:
if decompressor.crc is not None and not decompressor.check_crc():
raise CrcError(decompressor.crc, decompressor.digest, None)
return crc32
def _find_link_target(self, target):
"""
Find the target member of a symlink or hardlink member in the archive.
"""
targetname: str = target.as_posix()
linkname: str | pathlib.Path = readlink(targetname)
# Check windows full path symlinks
if str(linkname).startswith("\\\\?\\"):
linkname = str(linkname)[4:]
# normalize as posix style
linkname = pathlib.Path(linkname).as_posix()
member = None
for j in range(len(self.files)):
if linkname == self.files[j].origin.as_posix():
# FIXME: when API user specify arcname, it will break
member = os.path.relpath(linkname, os.path.dirname(targetname))
break
if member is None:
member = linkname
return member
def _after_write(self, insize, foutsize, crc):
self.header.main_streams.substreamsinfo.digestsdefined.append(True)
self.header.main_streams.substreamsinfo.digests.append(crc)
if self.header.main_streams.substreamsinfo.unpacksizes is None:
self.header.main_streams.substreamsinfo.unpacksizes = [insize]
else:
self.header.main_streams.substreamsinfo.unpacksizes.append(insize)
if self.header.main_streams.substreamsinfo.num_unpackstreams_folders is None:
self.header.main_streams.substreamsinfo.num_unpackstreams_folders = [1]
else:
self.header.main_streams.substreamsinfo.num_unpackstreams_folders[-1] += 1
return foutsize, crc
def write(self, fp: IO[bytes], f, assym, folder):
compressor = folder.get_compressor()
if assym:
link_target: str = self._find_link_target(f.origin)
tgt: bytes = link_target.encode("utf-8")
fd = io.BytesIO(tgt)
insize, foutsize, crc = compressor.compress(fd, fp)
fd.close()
else:
with f.origin.open(mode="rb") as fd:
insize, foutsize, crc = compressor.compress(fd, fp)
return self._after_write(insize, foutsize, crc)
def writestr(self, fp: IO[bytes], f, folder):
compressor = folder.get_compressor()
insize, foutsize, crc = compressor.compress(f.data(), fp)
return self._after_write(insize, foutsize, crc)
def flush_archive(self, fp, folder):
compressor = folder.get_compressor()
foutsize = compressor.flush(fp)
if len(self.files) > 0:
if "maxsize" in self.header.files_info.files[self.last_file_index]:
self.header.files_info.files[self.last_file_index]["maxsize"] += foutsize
else:
self.header.files_info.files[self.last_file_index]["maxsize"] = foutsize
# Update size data in header
self.header.main_streams.packinfo.numstreams += 1
if self.header.main_streams.packinfo.enable_digests:
self.header.main_streams.packinfo.crcs.append(compressor.digest)
self.header.main_streams.packinfo.digestdefined.append(True)
self.header.main_streams.packinfo.packsizes.append(compressor.packsize)
folder.unpacksizes = compressor.unpacksizes
def archive(self, fp: IO[bytes], files, folder, deref=False):
"""Run archive task for specified 7zip folder."""
f = files[self.current_file_index]
if f.has_strdata():
foutsize, crc = self.writestr(fp, f, folder)
self.header.files_info.files[self.current_file_index]["maxsize"] = foutsize
self.header.files_info.files[self.current_file_index]["digest"] = crc
self.last_file_index = self.current_file_index
elif (f.is_symlink and not deref) or not f.emptystream:
foutsize, crc = self.write(fp, f, (f.is_symlink and not deref), folder)
self.header.files_info.files[self.current_file_index]["maxsize"] = foutsize
self.header.files_info.files[self.current_file_index]["digest"] = crc
self.last_file_index = self.current_file_index
self.current_file_index += 1
def register_filelike(self, id: int, fileish: MemIO | pathlib.Path | None) -> None:
"""register file-ish to worker."""
self.target_filepath[id] = fileish
def close(self):
del self.header
del self.files
del self.concurrent
|