glpi-python-client 0.6.4__tar.gz → 0.6.5__tar.gz

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project are documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## 0.6.5 — 2026-10-14
+
+A patch release that lets a caller find the Document behind an image GLPI left
+as a raw `data:` URI. GLPI may keep a large pasted image in the stored body as
+`<img id="..." src="data:image/png;base64,...">` instead of rewriting it into
+a document link, while still creating its Document, whose tag equals the
+image's `id`. Existing methods are unchanged.
+
+### Added
+
+- **`Link.image_id`**, a new last field of the `Link` the `rewrite_link`
+  callback receives: for an `<img>`, the value of its `id` attribute (trimmed;
+  `None` when absent or blank); always `None` for a link.
+- **`GlpiContentConverter.data_image_ids(html)`** returns, in document order
+  and without duplicates, the `id` of every `<img>` whose `src` is a `data:`
+  URI, so a caller can tell whether it needs to read any Document at all. It
+  does not decode the base64, and leaves out an image inside `<pre>`, `<code>`,
+  `<kbd>` or `<samp>`, which the reader never offers to `rewrite_link`.
+- **`GetDocument.tag`**, a read-only property: the Document's tag from
+  `extra_payload`, or `None` when absent or not a non-empty string. GLPI sets a
+  tag on the Documents it creates from an upload or an editor paste, images or
+  not.
+
 ## 0.6.4 — 2026-10-12
 
 A patch release that reads the documents GLPI links to a followup. GLPI's

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: glpi-python-client
-Version: 0.6.4
+Version: 0.6.5
 Summary: A typed Python client for GLPI ITSM APIs.
 Project-URL: Homepage, https://github.com/baraline/glpi_python_client
 Project-URL: Documentation, https://glpi-python-client.readthedocs.io/en/latest/

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/docs/user_guide.rst

@@ -2007,6 +2007,25 @@ other type raises ``TypeError``. It is not called for a value passed through
 as Markdown (``plain_text_is_markdown=True``), nor for a body read as its text.
 ``easyvista-python-client`` 0.4.3 carries the same hook.
 
+GLPI does not always rewrite a pasted image into a document link. A large one
+can stay in the stored body as ``<img id="tag-1" src="data:image/png;base64,...">``
+while GLPI still creates its Document, whose tag is the image's ``id``. For
+such an image ``Link.image_id`` is that ``id`` and ``href`` is the data URI;
+``GlpiContentConverter.data_image_ids(html)`` lists those ids without
+converting, so a caller reads Documents only when a body needs it. A
+:class:`~glpi_python_client.models.GetDocument` exposes its tag as ``tag``:
+
+.. code-block:: python
+
+    ids = GlpiContentConverter.data_image_ids(body)
+    if ids:
+        by_tag = {d.tag: d for d in documents if d.tag}
+        matched = [by_tag[i] for i in ids if i in by_tag]
+
+The ``id`` is body text, and anyone who can write the body can forge it. Match
+it only against Documents the caller already trusts, such as the same
+ticket's own, never against every Document the instance holds.
+
 It is not a sanitiser
 ^^^^^^^^^^^^^^^^^^^^^
 

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/glpi_python_client/__init__.py

@@ -133,7 +133,7 @@ from glpi_python_client.rsql import (
     date_window,
 )
 
-__version__ = "0.6.4"
+__version__ = "0.6.5"
 
 __all__ = [
     "AsyncGlpiClient",

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/glpi_python_client/content/conversion.py

@@ -179,6 +179,30 @@ def _plain_text_html(text: str) -> str:
     return "<p>" + "<br>".join(lines) + "</p>"
 
 
+#: What a browser strips from the front of a URL, and drops from inside one.
+_URL_LEADING = "".join(chr(c) for c in range(0x21))
+_URL_INNER = str.maketrans("", "", "\t\r\n")
+
+#: The elements inside which the reader writes no image, so offers none.
+_UNFORMATTED = ("pre", "code", "kbd", "samp")
+
+
+def _is_data_uri(src: str) -> bool:
+    """Whether a browser reads ``src`` as a ``data:`` URI.
+
+    The scheme is case-insensitive, leading C0 controls and spaces are
+    stripped, and tabs and line breaks are dropped wherever they are.
+    """
+
+    return src.lstrip(_URL_LEADING).translate(_URL_INNER).casefold().startswith("data:")
+
+
+def _image_id(el: Tag) -> str | None:
+    """The trimmed ``id`` of an element, or ``None`` when it has none."""
+
+    return str(el.get("id") or "").strip() or None
+
+
 def _soup(html: str) -> BeautifulSoup:
     """Parse ``html`` and drop what a browser does not display."""
 
@@ -402,6 +426,12 @@ class Link:
     enclosing_href : str or None
         For an ``<img>`` inside a link, that link's ``href``; ``None``
         otherwise. The image is read before the link around it.
+    image_id : str or None
+        For an ``<img>``, the value of its ``id`` attribute, trimmed, or
+        ``None`` when it has none or the element is a link. GLPI sets it to
+        the tag of the Document it created for an image it has not rewritten
+        into a document link, and that Document carries the same value as its
+        tag, so a caller can find it.
     """
 
     href: str
@@ -410,6 +440,7 @@ class Link:
     image: bool = False
     document_id: int | None = None
     enclosing_href: str | None = None
+    image_id: str | None = None
 
 
 #: A ``rewrite_link`` callback: called with each link and image a read meets,
@@ -664,6 +695,7 @@ class _Converter(MarkdownConverter):
                     enclosing_href=(
                         None if around is None else str(around.get("href") or "")
                     ),
+                    image_id=_image_id(el),
                 )
             )
             if isinstance(answer, str):
@@ -1021,6 +1053,33 @@ class GlpiContentConverter:
         document_id = int(values[0])
         return document_id if document_id > 0 else None
 
+    @staticmethod
+    def data_image_ids(html: str) -> tuple[str, ...]:
+        """Return the ``id`` of every image a body keeps as a ``data:`` URI.
+
+        Each ``<img>`` whose ``src`` a browser reads as a ``data:`` URI and
+        that has a non-empty ``id`` contributes it, in document order and
+        without repeats. The base64 is not decoded. An image inside ``<pre>``,
+        ``<code>``, ``<kbd>`` or ``<samp>`` is left out: the reader shows it
+        as no image, so it never offers it to ``rewrite_link`` either.
+
+        GLPI sets a tag on the Documents it creates from an upload or an
+        editor paste, images or not. For an image it has not rewritten into a
+        document link, that tag is the ``id`` of the ``<img>``
+        (:attr:`Link.image_id`, :attr:`GetDocument.tag`). A caller calls this
+        first, to decide whether it needs to read any Document at all.
+        """
+
+        if "<" not in html:
+            return ()
+        ids = (
+            _image_id(img)
+            for img in _soup(html).find_all("img")
+            if _is_data_uri(str(img.get("src") or ""))
+            and img.find_parent(_UNFORMATTED) is None
+        )
+        return tuple(dict.fromkeys(i for i in ids if i is not None))
+
     @staticmethod
     def document_image(
         document_id: int,

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/glpi_python_client/models/api_schema/management/_document.py

@@ -61,6 +61,20 @@ class GetDocument(GlpiModel):
     mime: str | None = None
     sha1sum: str | None = None
 
+    @property
+    def tag(self) -> str | None:
+        """The tag GLPI gave the Document, or ``None``.
+
+        GLPI sets a tag on the Documents it creates from an upload or an
+        editor paste, images or not. For an image it has not rewritten into
+        a document link, it is the ``id`` of the ``<img>`` left in the body
+        (see ``GlpiContentConverter.data_image_ids``). Read from
+        ``extra_payload``; ``None`` when absent, empty or not a string.
+        """
+
+        value = self.extra_payload.get("tag")
+        return value if isinstance(value, str) and value else None
+
 
 class PostDocument(GlpiModel):
     """Request body for ``POST /Management/Document``.

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/pyproject.toml

@@ -35,7 +35,7 @@ exclude = [
 
 [project]
 name = "glpi-python-client"
-version = "0.6.4"
+version = "0.6.5"
 description = "A typed Python client for GLPI ITSM APIs."
 readme = "README.md"
 requires-python = ">=3.11"

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-asset-workflow/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials allowed to read or write assets."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Asset Workflow

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-client-setup/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to a GLPI v2 API, and valid GLPI credentials."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Client Setup

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-contract-workflow/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials allowed to read or write contracts."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Contract Workflow

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-document-workflow/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and v1 credentials configured on the client for binary uploads."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Document Workflow

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-knowledge-base/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and — for category writes only — a legacy v1 session (v1_base_url + v1_user_token)."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Knowledge Base

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-plugin-fields/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, the GLPI Fields plugin installed server-side, and a legacy v1 session (v1_base_url + v1_user_token) — every method in this family goes over the v1 API."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Plugin Fields

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-reporting-and-context/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials allowed to read tickets, tasks, users, entities, and timeline records."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Reporting And Context

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-team-members/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials allowed to manage ticket teams."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Team Members

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-ticket-timeline/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, and network access to the GLPI v2 API."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Ticket Timeline

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-ticket-workflow/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials accepted by GlpiClient."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI Ticket Workflow

{glpi_python_client-0.6.4 → glpi_python_client-0.6.5}/skills/glpi-user-location-provisioning/SKILL.md

@@ -5,7 +5,7 @@ license: MIT
 compatibility: "Requires Python 3.11+, glpi-python-client, network access to the GLPI v2 API, and credentials allowed to read or write users, locations, and entities."
 metadata:
   package: glpi-python-client
-  version: "0.6.4"
+  version: "0.6.5"
 ---
 
 # GLPI User, Location, And Entity Provisioning