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
|
# Copyright (C) 2012-2023 Bastian Kleineidam
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Archive commands for the tarfile Python module."""
from .. import util
import os
import sys
import tarfile
def list_tar(archive, compression, cmd, verbosity, interactive):
"""List a TAR archive with the tarfile Python module."""
try:
with tarfile.open(archive) as tfile:
tfile.list(verbose=verbosity > 1)
except Exception as err:
raise util.PatoolError(f"error listing {archive}") from err
return
test_tar = list_tar
def extract_tar(archive, compression, cmd, verbosity, interactive, outdir):
"""Extract a TAR archive with the tarfile Python module."""
try:
with tarfile.open(archive) as tfile:
if sys.version_info >= (3, 12, 0, "final", 0):
tfile.extractall(path=outdir, filter='data')
else:
safe_extract(tfile, outdir)
except Exception as err:
raise util.PatoolError(f"error extracting {archive}") from err
return
def is_within_directory(directory, target):
"""Check that given target path is a subdirectory inside the directory."""
abs_directory = os.path.abspath(directory)
abs_target = os.path.abspath(target)
prefix = os.path.commonprefix([abs_directory, abs_target])
return prefix == abs_directory
def safe_extract(tfile, path):
"""Helper function to ensure that TAR members will be extracted inside
the given path.
If a member will be extracted outside the path an Exception is raised.
"""
safe_members = []
bad_members = []
for member in tfile.getmembers():
member_path = os.path.join(path, member.name)
if is_within_directory(path, member_path):
safe_members.append(member)
else:
bad_members.append(member)
tfile.extractall(path, safe_members)
if bad_members:
filelist = ", ".join(member.name for member in bad_members)
raise Exception(f"Unsafe tarfile entries: {filelist}.")
def create_tar(archive, compression, cmd, verbosity, interactive, filenames):
"""Create a TAR archive with the tarfile Python module."""
mode = get_tar_mode(compression)
try:
with tarfile.open(archive, mode) as tfile:
for filename in filenames:
tfile.add(filename)
except Exception as err:
raise util.PatoolError(f"error creating {archive}") from err
return
def get_tar_mode(compression):
"""Determine tarfile open mode according to the given compression."""
if compression == 'gzip':
return 'w:gz'
if compression == 'bzip2':
return 'w:bz2'
if compression in ('lzma', 'xz'):
return 'w:xz'
if compression:
msg = f'pytarfile does not support {compression} for tar compression'
raise util.PatoolError(msg)
# no compression
return 'w'
|
