EntityRef: expecting ';' – znak & a < v XML

Znění hlášky v jednotlivých parserech

Pro & hlásí libxml2 (PHP, xmllint) EntityRef: expecting ';' nebo xmlParseEntityRef: no name, Java The reference to entity "…" must end with the ';' delimiter, Python not well-formed (invalid token), .NET An error occurred while parsing EntityName:

Která hláška se objeví, záleží na tom, co za & následuje. Za &barva= parser přečte název entity barva a chybí mu středník. Za & s mezerou nenajde žádný název.

Příčiny a opravy

<?xml version="1.0" encoding="UTF-8"?>
<produkt>
  <url>https://example.cz/detail?id=42&barva=cerna</url>
</produkt>

<?xml version="1.0" encoding="UTF-8"?>
<produkt>
  <url>https://example.cz/detail?id=42&amp;barva=cerna</url>
</produkt>

<?xml version="1.0" encoding="UTF-8"?>
<firma>Novák & syn s.r.o.</firma>

<?xml version="1.0" encoding="UTF-8"?>
<firma>Novák &amp; syn s.r.o.</firma>

<?xml version="1.0" encoding="UTF-8"?>
<podminka>cena < 1000</podminka>

<?xml version="1.0" encoding="UTF-8"?>
<podminka>cena &lt; 1000</podminka>

<?xml version="1.0" encoding="UTF-8"?>
<cena>1&nbsp;290&nbsp;Kč</cena>

<?xml version="1.0" encoding="UTF-8"?>
<cena>1&#160;290&#160;Kč</cena>

Které znaky se musí escapovat

Jak chybu najít

• Hledej v souboru regulárním výrazem &(?!(amp|lt|gt|quot|apos|#[0-9]+|#x[0-9a-fA-F]+);). Najde každý &, který nezačíná platnou entitu.
• Validátor neescapovaný znak nejen najde, ale nabídne i opravu na &.
• Opravuj zdroj, ne výsledný soubor: pokud feed vzniká ze šablony, chyba se vrátí při dalším exportu.

Oprava v kódu

Nejjistější je XML vůbec neskládat spojováním řetězců. Knihovna, která dokument sestaví ze stromu, escapuje text i atributy sama. Když řetězec skládat musíš, použij escapovací funkci pro XML, ne pro HTML ani URL:

from xml.sax.saxutils import escape
escape("cena < 1000 & více")   # 'cena &lt; 1000 &amp; více'

# Lepší je nechat escapování na knihovně, která XML sestavuje:
import xml.etree.ElementTree as ET
url = ET.Element("url")
url.text = "https://example.cz/detail?id=42&barva=cerna"
ET.tostring(url, encoding="unicode")
# '<url>https://example.cz/detail?id=42&amp;barva=cerna</url>'

echo htmlspecialchars($text, ENT_XML1 | ENT_QUOTES, 'UTF-8');

$dom = new DOMDocument('1.0', 'UTF-8');
$url = $dom->createElement('url');
$url->appendChild($dom->createTextNode($text)); // escapuje sám
$dom->appendChild($url);

Element url = doc.createElement("url");
url.setTextContent("https://example.cz/detail?id=42&barva=cerna");
// Transformer při zápisu vypíše &

var url = new XElement("url", "https://example.cz/detail?id=42&barva=cerna");
// <url>https://example.cz/detail?id=42&amp;barva=cerna</url>

SecurityElement.Escape("cena < 1000 & více"); // cena &lt; 1000 &amp; více

const doc = document.implementation.createDocument(null, 'produkt', null);
const url = doc.createElement('url');
url.textContent = 'https://example.cz/detail?id=42&barva=cerna';
doc.documentElement.appendChild(url);
new XMLSerializer().serializeToString(doc);

Pozor na dvojí escapování: když text už obsahuje & a projde escapováním znovu, vznikne & a čtenář uvidí doslova &.

Související

• Kódování znaků a entity v kapitole Jak funguje XML.
• XML feed pro Heureku a Zboží — URL s parametry ve feedu.
• DTD — jak deklarovat vlastní entity.
• Přehled všech chybových hlášek.