pypdf/tests/generic/test_link.py at 59f6a25ca3fc3a545679635049b88d14519ee7ba · py-pdf/pypdf · GitHub

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
"""Test the pypdf.generic._link module."""
from io import BytesIO

import pytest

from pypdf import PageObject, PdfReader, PdfWriter
from pypdf.generic import (
    ArrayObject,
    DictionaryObject,
    DirectReferenceLink,
    NameObject,
    NullObject,
    NumberObject,
    extract_links,
)
from tests import get_data_from_url


@pytest.mark.enable_socket
def test_extract_links__null_object_in_old_page() -> None:
    url = "https://github.com/user-attachments/files/25507697/sample.pdf"
    name = "issue3656.pdf"
    reader = PdfReader(BytesIO(get_data_from_url(url=url, name=name)))

    writer = PdfWriter()
    writer.append(reader)


def test_extract_links(caplog: pytest.LogCaptureFixture) -> None:
    page1 = PageObject()
    page2 = PageObject()

    # No annotations.
    assert extract_links(page1, page2) == []
    assert caplog.messages == []

    # Only old annotations.
    page1[NameObject("/Annots")] = NullObject()
    assert extract_links(page1, page2) == []
    assert caplog.messages == []
    caplog.clear()

    page1[NameObject("/Annots")] = ArrayObject([NullObject()])
    assert extract_links(page1, page2) == []
    assert caplog.messages == []
    caplog.clear()

    # Both old and new annotations.
    page2[NameObject("/Annots")] = ArrayObject([NullObject()])
    assert extract_links(page1, page2) == []
    assert caplog.messages == []  # Same size.
    caplog.clear()

    page2[NameObject("/Annots")] = NullObject()
    assert extract_links(page1, page2) == []
    assert caplog.messages == []
    caplog.clear()

    # Only new annotations.
    del page1[NameObject("/Annots")]
    page2[NameObject("/Annots")] = ArrayObject([NullObject()])
    assert extract_links(page1, page2) == []
    assert caplog.messages == []


def test_extract_links_ignores_non_link_annotation_offsets() -> None:
    old_page = PageObject()
    new_page = PageObject()

    old_link = DictionaryObject(
        {
            NameObject("/Subtype"): NameObject("/Link"),
            NameObject("/Dest"): ArrayObject([NumberObject(7)]),
        }
    )
    new_link = DictionaryObject(
        {
            NameObject("/Subtype"): NameObject("/Link"),
            NameObject("/Dest"): ArrayObject([NumberObject(11)]),
        }
    )

    old_page[NameObject("/Annots")] = ArrayObject([NullObject(), old_link])
    new_page[NameObject("/Annots")] = ArrayObject([new_link])

    links = extract_links(new_page, old_page)
    assert len(links) == 1
    assert isinstance(links[0][0], DirectReferenceLink)
    assert isinstance(links[0][1], DirectReferenceLink)


def test_extract_links_ignores_uri_annotation_offsets(caplog: pytest.LogCaptureFixture) -> None:
    old_page = PageObject()
    new_page = PageObject()

    goto_link = DictionaryObject(
        {
            NameObject("/Subtype"): NameObject("/Link"),
            NameObject("/Dest"): ArrayObject([NumberObject(7)]),
        }
    )
    uri_link = DictionaryObject(
        {
            NameObject("/Subtype"): NameObject("/Link"),
            NameObject("/A"): DictionaryObject(
                {
                    NameObject("/S"): NameObject("/URI"),
                    NameObject("/URI"): NameObject("https://example.com"),
                }
            ),
        }
    )

    old_page[NameObject("/Annots")] = ArrayObject([goto_link])
    new_page[NameObject("/Annots")] = ArrayObject([uri_link, goto_link])

    links = extract_links(new_page, old_page)

    assert len(links) == 1
    assert isinstance(links[0][0], DirectReferenceLink)
    assert isinstance(links[0][1], DirectReferenceLink)
    assert caplog.messages == []


def test_direct_reference_link_empty_reference() -> None:
    # An empty destination array has no target page to resolve.
    assert DirectReferenceLink(ArrayObject([])).find_referenced_page() is None
    # A populated array still resolves to its first element.
    assert DirectReferenceLink(ArrayObject([NumberObject(7)])).find_referenced_page() == 7