Skip to content

gh-75989: TarFile.extractall and TarFile.extract now overwrite symlinks when extracting hardlinks #137316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Lib/tarfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -2723,6 +2723,9 @@ def makelink_with_filter(self, tarinfo, targetpath,
return
else:
if os.path.exists(tarinfo._link_target):
if os.path.lexists(targetpath):
# Avoid FileExistsError on following os.link.
os.unlink(targetpath)
os.link(tarinfo._link_target, targetpath)
return
except symlink_exception:
Expand Down
51 changes: 51 additions & 0 deletions Lib/test/test_tarfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,57 @@ def test_next_on_empty_tarfile(self):
with tarfile.open(fileobj=fd, mode="r") as tf:
self.assertEqual(tf.next(), None)

def _setup_symlink_to_target(self, temp_dirpath):
target_filepath = os.path.join(temp_dirpath, "target")
ustar_dirpath = os.path.join(temp_dirpath, "ustar")
hardlink_filepath = os.path.join(ustar_dirpath, "lnktype")
with open(target_filepath, "wb") as f:
f.write(b"target")
os.makedirs(ustar_dirpath)
os.symlink(target_filepath, hardlink_filepath)
return target_filepath, hardlink_filepath

def _assert_on_file_content(self, filepath, digest):
with open(filepath, "rb") as f:
data = f.read()
self.assertEqual(sha256sum(data), digest)

@unittest.skipUnless(
hasattr(os, "link"), "Missing hardlink implementation"
)
@os_helper.skip_unless_symlink
def test_extract_hardlink_on_symlink(self):
"""
This test verifies that extracting a hardlink will not follow an
existing symlink after a FileExistsError on os.link.
"""
with os_helper.temp_dir() as DIR:
target_filepath, hardlink_filepath = self._setup_symlink_to_target(DIR)
with tarfile.open(tarname, encoding="iso8859-1") as tar:
tar.extract("ustar/regtype", DIR, filter="data")
tar.extract("ustar/lnktype", DIR, filter="data")
self._assert_on_file_content(target_filepath, sha256sum(b"target"))
self._assert_on_file_content(hardlink_filepath, sha256_regtype)

@unittest.skipUnless(
hasattr(os, "link"), "Missing hardlink implementation"
)
@os_helper.skip_unless_symlink
def test_extractall_hardlink_on_symlink(self):
"""
This test verifies that extracting a hardlink will not follow an
existing symlink after a FileExistsError on os.link.
"""
with os_helper.temp_dir() as DIR:
target_filepath, hardlink_filepath = self._setup_symlink_to_target(DIR)
with tarfile.open(tarname, encoding="iso8859-1") as tar:
tar.extractall(
DIR, members=["ustar/regtype", "ustar/lnktype"], filter="data",
)
self._assert_on_file_content(target_filepath, sha256sum(b"target"))
self._assert_on_file_content(hardlink_filepath, sha256_regtype)


class MiscReadTest(MiscReadTestBase, unittest.TestCase):
test_fail_comp = None

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:func:`tarfile.TarFile.extractall` and :func:`tarfile.TarFile.extract` now
overwrite symlinks when extracting hardlinks.
(Contributed by Alexander Enrique Urieles Nieto in :gh:`75989`.)
Loading