/usr/lib/python3/dist-packages/diffoscope/comparators/utils/libarchive.py is in diffoscope 93ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
#
# diffoscope: in-depth comparison of files, archives, and directories
#
# Copyright © 2015 Jérémy Bobbio <lunar@debian.org>
#
# diffoscope 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.
#
# diffoscope 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 diffoscope. If not, see <https://www.gnu.org/licenses/>.
import time
import os.path
import ctypes
import logging
import libarchive
import collections
from diffoscope.exc import ContainerExtractionError
from diffoscope.excludes import any_excluded
from diffoscope.tempfiles import get_temporary_directory
from ..device import Device
from ..symlink import Symlink
from ..directory import Directory
from .archive import Archive, ArchiveMember
logger = logging.getLogger(__name__)
# Monkeypatch libarchive-c (<< 2.2)
if not hasattr(libarchive.ffi, 'entry_rdevmajor'):
libarchive.ffi.ffi('entry_rdevmajor', [libarchive.ffi.c_archive_entry_p], ctypes.c_uint)
libarchive.ArchiveEntry.rdevmajor = property(lambda self: libarchive.ffi.entry_rdevmajor(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_rdevminor'):
libarchive.ffi.ffi('entry_rdevminor', [libarchive.ffi.c_archive_entry_p], ctypes.c_uint)
libarchive.ArchiveEntry.rdevminor = property(lambda self: libarchive.ffi.entry_rdevminor(self._entry_p))
# Monkeypatch libarchive-c (<< 2.3)
if not hasattr(libarchive.ffi, 'entry_nlink'):
libarchive.ffi.ffi('entry_nlink', [libarchive.ffi.c_archive_entry_p], ctypes.c_uint)
libarchive.ArchiveEntry.nlink = property(lambda self: libarchive.ffi.entry_nlink(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_uid'):
libarchive.ffi.ffi('entry_uid', [libarchive.ffi.c_archive_entry_p], ctypes.c_uint32)
libarchive.ArchiveEntry.uid = property(lambda self: libarchive.ffi.entry_uid(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_gid'):
libarchive.ffi.ffi('entry_gid', [libarchive.ffi.c_archive_entry_p], ctypes.c_uint32)
libarchive.ArchiveEntry.gid = property(lambda self: libarchive.ffi.entry_uid(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_mtime_nsec'):
libarchive.ffi.ffi('entry_mtime_nsec', [libarchive.ffi.c_archive_entry_p], ctypes.c_long)
libarchive.ArchiveEntry.mtime_nsec = property(lambda self: libarchive.ffi.entry_mtime_nsec(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_uname'):
libarchive.ffi.ffi('entry_uname', [libarchive.ffi.c_archive_entry_p], ctypes.c_char_p)
libarchive.ArchiveEntry.uname = property(lambda self: libarchive.ffi.entry_uname(self._entry_p))
if not hasattr(libarchive.ffi, 'entry_gname'):
libarchive.ffi.ffi('entry_gname', [libarchive.ffi.c_archive_entry_p], ctypes.c_char_p)
libarchive.ArchiveEntry.gname = property(lambda self: libarchive.ffi.entry_gname(self._entry_p))
# Monkeypatch libarchive-c so we always get pathname as (Unicode) str
# Otherwise, we'll get sometimes str and sometimes bytes and always pain.
libarchive.ArchiveEntry.pathname = property(lambda self: libarchive.ffi.entry_pathname(self._entry_p).decode('utf-8', errors='surrogateescape'))
def list_libarchive(path):
with libarchive.file_reader(path) as archive:
for entry in archive:
if entry.isblk or entry.ischr:
size_or_dev = '{major:>3},{minor:>3}'.format(major=entry.rdevmajor, minor=entry.rdevminor)
else:
size_or_dev = entry.size
mtime = time.strftime('%Y-%m-%d %H:%M:%S', time.gmtime(entry.mtime)) + '.{:06d}'.format(entry.mtime_nsec // 1000)
if entry.issym:
name_and_link = '{entry.name} -> {entry.linkname}'.format(entry=entry)
else:
name_and_link = entry.name
if entry.uname:
user = '{user:<8} {uid:>7}'.format(user=entry.uname.decode('utf-8', errors='surrogateescape'), uid='({})'.format(entry.uid))
else:
user = entry.uid
if entry.gname:
group = '{group:<8} {gid:>7}'.format(group=entry.gname.decode('utf-8', errors='surrogateescape'), gid='({})'.format(entry.gid))
else:
group = entry.gid
yield '{strmode} {entry.nlink:>3} {user:>8} {group:>8} {size_or_dev:>8} {mtime:>8} {name_and_link}\n'.format(strmode=entry.strmode.decode('us-ascii'), entry=entry, user=user, group=group, size_or_dev=size_or_dev, mtime=mtime, name_and_link=name_and_link)
class LibarchiveMember(ArchiveMember):
def __init__(self, archive, entry):
super().__init__(archive, entry.pathname)
def is_directory(self):
return False
def is_symlink(self):
return False
def is_device(self):
return False
class LibarchiveDirectory(Directory, LibarchiveMember):
def __init__(self, archive, entry):
LibarchiveMember.__init__(self, archive, entry)
def compare(self, other, source=None):
return None
def has_same_content_as(self, other):
return False
@property
def path(self):
raise NotImplementedError('LibarchiveDirectory is not meant to be extracted.')
def is_directory(self):
return True
def get_member_names(self):
raise ValueError("archives are compared as a whole.") # noqa
def get_member(self, member_name):
raise ValueError("archives are compared as a whole.") # noqa
class LibarchiveSymlink(Symlink, LibarchiveMember):
def __init__(self, archive, entry):
LibarchiveMember.__init__(self, archive, entry)
self._destination = entry.linkpath
@property
def symlink_destination(self):
return self._destination
def is_symlink(self):
return True
class LibarchiveDevice(Device, LibarchiveMember):
def __init__(self, container, entry):
LibarchiveMember.__init__(self, container, entry)
self._mode = entry.mode
self._major = entry.rdevmajor
self._minor = entry.rdevminor
def get_device(self):
return (self._mode, self._major, self._minor)
def is_device(self):
return True
class LibarchiveContainer(Archive):
def open_archive(self):
# libarchive is very very stream oriented an not for random access
# so we are going to reopen the archive everytime
# not nice, but it'll work
return True
def close_archive(self):
pass
def get_member_names(self):
self.ensure_unpacked()
return self._members.keys()
def get_member(self, member_name):
with libarchive.file_reader(self.source.path) as archive:
for entry in archive:
if entry.pathname == member_name:
return self.get_subclass(entry)
raise KeyError('%s not found in archive', member_name)
def get_filtered_members(self):
with libarchive.file_reader(self.source.path) as archive:
for entry in archive:
if any_excluded(entry.pathname):
continue
yield entry.pathname, self.get_subclass(entry)
def extract(self, member_name, dest_dir):
self.ensure_unpacked()
return self._members[member_name]
def get_subclass(self, entry):
if entry.isdir:
return LibarchiveDirectory(self, entry)
elif entry.issym:
return LibarchiveSymlink(self, entry)
elif entry.isblk or entry.ischr:
return LibarchiveDevice(self, entry)
return LibarchiveMember(self, entry)
def ensure_unpacked(self):
if hasattr(self, '_members'):
return
tmpdir = get_temporary_directory().name
self._members = collections.OrderedDict()
logger.debug("Extracting %s to %s", self.source.path, tmpdir)
with libarchive.file_reader(self.source.path) as archive:
for idx, entry in enumerate(archive):
# Always skip directories
if entry.isdir:
continue
# Save extracting excluded files
if any_excluded(entry.pathname):
continue
# Keep directory sizes small. could be improved but should be
# good enough for "ordinary" large archives.
dst = os.path.join(tmpdir, str(idx // 4096), str(idx % 4096))
root, ext = os.path.splitext(entry.pathname)
dst += ext
# Maintain a mapping of archive path to the extracted path,
# avoiding the need to sanitise filenames.
self._members[entry.pathname] = dst
logger.debug("Extracting %s to %s", entry.pathname, dst)
os.makedirs(os.path.dirname(dst), exist_ok=True)
try:
with open(dst, 'wb') as f:
for block in entry.get_blocks():
f.write(block)
except Exception as exc:
raise ContainerExtractionError(entry.pathname, exc)
logger.debug(
"Extracted %d entries from %s to %s",
len(self._members), self.source.path, tmpdir,
)
def comparisons(self, other):
def hide_trivial_dirs(item):
file1, file2, comment = item
return not (isinstance(file1, Directory) and isinstance(file2, Directory) and comment is None)
return filter(hide_trivial_dirs, super().comparisons(other))
|