-
Notifications
You must be signed in to change notification settings - Fork 457
/
extractor.py
159 lines (140 loc) · 5.73 KB
/
extractor.py
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
# pylint: disable=useless-object-inheritance, keyword-arg-before-vararg
# disabled for python2 compatibility reasons
'''
Extraction of archives
'''
import os
import glob
import shutil
import tempfile
import itertools
import subprocess
from contextlib import contextmanager
from .log import LOGGER
from .util import inpath
class ExtractionFailed(ValueError):
""" Extraction fail """
# pass
class UnknownArchiveType(ValueError):
""" Unknown archive type"""
# pass
@contextmanager
def popen_ctx(*args, **kwargs):
''' Python 2 does not support context manager style Popen.'''
proc = subprocess.Popen(*args, **kwargs)
try:
yield proc
finally:
if 'stdout' in kwargs:
proc.stdout.close()
proc.terminate()
proc.wait()
class BaseExtractor(object):
'''Extracts tar, rpm, etc. files'''
def __init__(self, logger=None):
'''Sets up logger and if we should extract files or just report'''
if logger is None:
logger = LOGGER.getChild(self.__class__.__name__)
self.logger = logger
self.file_extractors = {
self.extract_file_tar: ['.tgz', '.tar.gz', '.tar', '.tar.xz', '.tar.bz2'],
self.extract_file_rpm: ['.rpm'],
self.extract_file_deb: ['.deb', '.ipk'],
self.extract_file_cab: ['.cab'],
self.extract_file_zip: ['.exe', '.zip', '.jar', '.apk'],
}
def can_extract(self, filename):
""" Check if the filename is something we know how to extract """
for extention in itertools.chain(*self.file_extractors.values()):
if filename[::-1].startswith(extention[::-1]):
return True
return False
@classmethod
def extract_file_tar(cls, filename, extraction_path):
""" Extract tar files """
if not inpath('tar'):
print("Error: need 'tar' binary in path")
else:
return subprocess.call(
["tar", "-C", extraction_path, "-axf", filename])
@classmethod
def extract_file_rpm(cls, filename, extraction_path):
""" Extract rpm packages """
if not inpath('rpm2cpio') or not inpath('cpio'):
print("Error: need 'rpm2cpio' or 'cpio' binary in path")
else:
with popen_ctx(["rpm2cpio", filename], stdout=subprocess.PIPE) as proc:
return subprocess.call(["cpio", "-idmv"], stdin=proc.stdout,
cwd=extraction_path)
@classmethod
def extract_file_deb(cls, filename, extraction_path):
""" Extract debian packages """
if not inpath('ar'):
print("Error: need 'ar' binary in path")
else:
result = subprocess.call(["ar", "x", filename], cwd=extraction_path)
if result != 0:
return result
if not inpath('tar'):
print("Error: need 'tar' binary not in path")
else:
datafile = glob.glob(os.path.join(extraction_path, "data.tar.*"))[0]
result = subprocess.call(["tar", "-C", extraction_path, "-axf", datafile])
return result
@classmethod
def extract_file_cab(cls, filename, extraction_path):
""" Extract cab files """
if not inpath('cabextract'):
print("Error: need 'cabextract' binary in path")
else:
return subprocess.call(
["cabextract", "-d", extraction_path, filename])
@classmethod
def extract_file_zip(cls, filename, extraction_path):
""" Extract zip files """
if not inpath('unzip'):
print("Error: need 'unzip' binary in path")
else:
return subprocess.call(
["unzip", "-qq", "-n", "-d", extraction_path, filename])
class TempDirExtractorContext(BaseExtractor):
'''Extracts tar, rpm, etc. files'''
def __init__(self, raise_failure=False, *args, **kwargs):
BaseExtractor.__init__(self, *args, **kwargs)
self.tempdir = None
self.raise_failure = raise_failure
def extract(self, filename):
""" Run the extractor """
# Resolve path in case of cwd change
filename = os.path.abspath(filename)
for extractor in self.file_extractors:
for extention in self.file_extractors[extractor]:
if filename[::-1].startswith(extention[::-1]):
extracted_path = os.path.join(self.tempdir,
os.path.basename(filename) + \
".extracted")
if os.path.exists(extracted_path):
shutil.rmtree(extracted_path)
os.makedirs(extracted_path)
if extractor(filename, extracted_path) != 0:
if self.raise_failure:
raise ExtractionFailed(filename)
else:
self.logger.warning('Failure extracting %r',
filename)
else:
self.logger.debug('Extracted %r to %r', filename,
extracted_path)
return extracted_path
raise UnknownArchiveType(filename)
def __enter__(self):
''' Create a temporary directory to extract files to. '''
self.tempdir = tempfile.mkdtemp()
return self
def __exit__(self, exc_type, exc, exc_tb):
""" Removes all extraction directories that need to be cleaned up."""
shutil.rmtree(self.tempdir)
class Extractor(BaseExtractor):
'''Provides a context which extraction is done in'''
def __call__(self, *args, **kwargs):
return TempDirExtractorContext(*args, **kwargs)