Fixed inconsistent inclusion of padding files in tdef (#8479)

Author: qstokkink

src/tribler/core/libtorrent/torrentdef.py

@@ -638,8 +638,12 @@ def _get_all_files_as_unicode_with_length(self) -> Generator[tuple[Path, int], N
             metainfo_v1 = cast(InfoDict, self.metainfo[b"info"])
             # Multi-file v1 torrent
             files = cast(FileDict, metainfo_v1[b"files"])
+            storage = cast(lt.torrent_info, self.torrent_info).files()  # If we have metainfo, we have torrent_info
 
-            for file_dict in files:
+            for index, file_dict in enumerate(files):
+                # Ignore padding files, to align with v2 metainfo
+                if storage.file_flags(index) != 0:
+                    continue
                 if b"path.utf-8" in file_dict:
                     # This file has an utf-8 encoded list of elements.
                     # We assume that it is correctly encoded and use it normally.

src/tribler/test_unit/core/libtorrent/download_manager/test_download_state.py

@@ -155,11 +155,11 @@ def test_get_files_completion_zero_length_file(self) -> None:
         """
         download = Download(TorrentDef.load_from_memory(TORRENT_WITH_DIRS_CONTENT), self.dlmngr,
                             checkpoint_disabled=True, config=DownloadConfig(ConfigObj(StringIO(SPEC_CONTENT))))
-        for file_spec in download.tdef.metainfo[b"info"][b"files"]:
-            file_spec[b"length"] = 0
-        download.handle = Mock(is_valid=Mock(return_value=True), file_progress=Mock(return_value=[]))
+        download.tdef.metainfo[b"info"][b"files"][0][b"length"] = 0  # Other five files have length of 6
+        download.handle = Mock(is_valid=Mock(return_value=True), file_progress=Mock(return_value=[0, 6, 6, 6, 6, 6]))
         download_state = DownloadState(download, Mock(), None)
 
+        self.assertEqual(6, len(download_state.get_files_completion()))
         for _, progress in download_state.get_files_completion():
             self.assertEqual(1.0, progress)
 

src/tribler/test_unit/core/libtorrent/test_torrentdef.py

@@ -397,7 +397,8 @@ def test_get_files_with_length(self) -> None:
         name_bytes = b"\xe8\xaf\xad\xe8\xa8\x80\xe5\xa4\x84\xe7\x90\x86"
         name_unicode = name_bytes.decode()
         tdef = TorrentDef(metainfo={b"info": {b"files": [{b"path.utf-8": [name_bytes], b"length": 123},
-                                                         {b"path.utf-8": [b"file.txt"], b"length": 456}]}})
+                                                         {b"path.utf-8": [b"file.txt"], b"length": 456}],
+                                              b"name": b"", b"piece length": 128, b"pieces": b"\x00" * 100}})
 
         self.assertEqual([(Path(name_unicode), 123), (Path('file.txt'), 456)], tdef.get_files_with_length())
 
@@ -408,7 +409,8 @@ def test_get_files_with_length_valid_path_utf8(self) -> None:
         name_bytes = b"\xe8\xaf\xad\xe8\xa8\x80\xe5\xa4\x84\xe7\x90\x86"
         name_unicode = name_bytes.decode()
         tdef = TorrentDef(metainfo={b"info": {b"files": [{b"path": [name_bytes], b"length": 123},
-                                                         {b"path": [b"file.txt"], b"length": 456}]}})
+                                                         {b"path": [b"file.txt"], b"length": 456}],
+                                              b"name": b"", b"piece length": 128, b"pieces": b"\x00" * 100}})
 
         self.assertEqual([(Path(name_unicode), 123), (Path('file.txt'), 456)], tdef.get_files_with_length())
 
@@ -418,7 +420,8 @@ def test_get_files_with_length_illegal_path(self) -> None:
         """
         name_bytes = b"\xe8\xaf\xad\xe8\xa8\x80\xe5\xa4\x84\xe7\x90\x86"
         tdef = TorrentDef(metainfo={b"info": {b"files": [{b"path": [b"test\xff" + name_bytes], b"length": 123},
-                                                         {b"path": [b"file.txt"], b"length": 456}]}})
+                                                         {b"path": [b"file.txt"], b"length": 456}],
+                                              b"name": b"", b"piece length": 128, b"pieces": b"\x00" * 100}})
 
         self.assertEqual([(Path("test?????????????"), 123), (Path("file.txt"), 456)], tdef.get_files_with_length())
 
@@ -428,10 +431,27 @@ def test_get_files_with_length_illegal_path_utf8(self) -> None:
         """
         name_bytes = b"\xe8\xaf\xad\xe8\xa8\x80\xe5\xa4\x84\xe7\x90\x86"
         tdef = TorrentDef(metainfo={b"info": {b"files": [{b"path.utf-8": [b"test\xff" + name_bytes], b"length": 123},
-                                                         {b"path": [b"file.txt"], b"length": 456}]}})
+                                                         {b"path": [b"file.txt"], b"length": 456}],
+                                              b"name": b"", b"piece length": 128, b"pieces": b"\x00" * 100}})
 
         self.assertEqual([(Path("file.txt"), 456)], tdef.get_files_with_length())
 
+    def test_get_files_with_length_ignore_padding(self) -> None:
+        """
+        Test if get_files_with_length ignores padding files.
+        """
+        tdef = TorrentDef(metainfo={
+            b"info": {
+                b"name": b"torrent name",
+                b"files": [{b"path": [b".pad"], b"length": 123, b"attr": b"p"},
+                           {b"path": [b"file.txt"], b"length": 456}],
+                b"piece length": 128,
+                b"pieces": b"\x00" * 100
+            }
+        })
+
+        self.assertEqual([(Path('file.txt'), 456)], tdef.get_files_with_length())
+
     def test_load_torrent_info(self) -> None:
         """
         Test if load_torrent_info() loads the torrent info.