XML e XPath

O catálogo pode representar cada livro com um elemento livro, um atributo id e os filhos titulo e preco. XML permite definir esse vocabulário; XPath percorre a árvore para selecionar livros ou calcular valores. SVG, XHTML e MathML também usam vocabulários XML, com regras próprias.

Documento bem formado

<?xml version="1.0" encoding="UTF-8"?>
<catalogo>
  <livro id="r1">
    <titulo>Redes</titulo>
    <preco>18</preco>
  </livro>
  <livro id="a1">
    <titulo>Algoritmos</titulo>
    <preco>25</preco>
  </livro>
  <livro id="s1">
    <titulo>SQL</titulo>
    <preco>12</preco>
  </livro>
</catalogo>

Existe um único elemento raiz, catalogo. As etiquetas fecham pela ordem inversa à abertura, os nomes distinguem maiúsculas e os valores de atributos usam aspas. <livro id=r1> não é bem formado; <Titulo>Redes</titulo> também não. Elementos vazios podem usar <aviso/>.

O nó raiz do documento contém o elemento catalogo; não são o mesmo nó. Para o primeiro livro, o percurso até ao texto do título é:

Documento
└── catalogo
    └── livro  [atributo id="r1"]
        ├── titulo
        │   └── texto "Redes"
        └── preco
            └── texto "18"

A árvore omite os outros livros e os nós de texto da indentação. O atributo id pertence ao elemento, mas não é um filho no eixo child de XPath. Por isso usamos @id para o selecionar e titulo/text() para chegar ao texto Redes.

& representa &, e < representa < em texto. Uma secção <![CDATA[...]]> permite texto que não é interpretado como marcação, mas não pode conter o seu próprio terminador ]]>. Comentários não podem conter -- no interior.

Boa formação e validade

Boa formação verifica as regras sintáticas do XML. Validade exige também cumprir um contrato, como DTD, XML Schema ou Relax NG. Um documento com <preco>caro</preco> pode ser bem formado e falhar um esquema que exija número.

Uma DTD possível para o catálogo, sem repetir aqui o documento inteiro:

<!ELEMENT catalogo (livro*)>
<!ELEMENT livro (titulo, preco)>
<!ATTLIST livro id ID #REQUIRED>
<!ELEMENT titulo (#PCDATA)>
<!ELEMENT preco (#PCDATA)>

livro* permite zero ou mais livros. (titulo, preco) exige os dois nessa ordem. O atributo id é obrigatório, com unicidade e formato de ID. #PCDATA admite texto, mas esta DTD não exige que o preço seja numérico. Um XSD pode acrescentar tipos, como xs:decimal, e restrições. Uma DTD não é uma base de dados nem substitui a verificação de regras de negócio.

Ao processar XML não confiável, não atives resolução arbitrária de entidades externas nem carregamento de recursos do cliente. Esses mecanismos podem expor ficheiros ou fazer pedidos do servidor. O formato estar bem formado não o torna seguro.

Caminhos XPath

Vamos usar XPath 1.0, como no DOMXPath de PHP. O contexto é o nó a partir do qual uma expressão é avaliada. Resolve um caminho por etapas: parte da raiz, escolhe os livro filhos de catalogo, filtra os que têm preço abaixo de 20 e só depois escolhe titulo. Cada predicado filtra o passo onde aparece, antes de avançar. A tabela seguinte resume os casos.

/ no início fixa o nó raiz do documento. Entre passos, / liga o eixo de filhos habitual. // abrevia um percurso por descendentes, não apenas filhos diretos. . representa o contexto e .. o pai. @ seleciona atributos; * seleciona elementos com qualquer nome nesse passo.

Predicados e posição

Um predicado entre [] filtra os candidatos do passo em que aparece. [preco < 20] avalia o preço de cada livro candidato. [2] equivale a uma condição sobre a posição, que começa em 1.

/catalogo/livro[2]/titulo
/catalogo/livro[preco < 20][1]/titulo
/catalogo/livro[1][preco < 20]/titulo

A primeira dá Algoritmos. A segunda primeiro filtra baratos e depois escolhe o primeiro, Redes. A terceira escolhe o primeiro livro e só depois verifica o preço. Neste catálogo também dá Redes, mas não daria o mesmo se o primeiro livro custasse 30. A ordem dos filtros faz parte da pergunta.

//livro[1] escolhe livros que são o primeiro livro entre os irmãos em cada grupo relevante. (//livro)[1] escolhe um único primeiro livro do conjunto global. Quando só há um catalogo, podem coincidir; com várias secções, a diferença torna-se visível.

Os eixos explicitam a relação: child:: é o percurso habitual, descendant:: desce vários níveis, ancestor:: sobe e following-sibling:: segue irmãos. //livro abrevia descendant-or-self::node()/child::livro. Podemos combinar condições com and, or e not. contains(titulo, 'Red') procura texto contido; starts-with verifica prefixo; normalize-space remove espaços exteriores e reduz sequências de espaços. last() usa a última posição. | une conjuntos de nós.

Com vários nós, compara existência e ausência com cuidado. Sobre <livro><categoria>redes</categoria><categoria>web</categoria></livro>, categoria = 'web' é verdadeiro, porque existe uma categoria web. Mas categoria != 'web' também é verdadeiro, porque existe uma categoria diferente.

Para pedir “nenhuma categoria é web”, nega a igualdade completa com not(categoria = 'web'). A comparação com vários nós é verdadeira quando algum nó a satisfaz, sem exigir todos.

Executar em PHP

O exemplo completo carrega XML de uma string, consulta e conta:

<?php
$documento = new DOMDocument();
$documento->loadXML('<catalogo><livro id="r1"><titulo>Redes</titulo><preco>18</preco></livro><livro id="a1"><titulo>Algoritmos</titulo><preco>25</preco></livro><livro id="s1"><titulo>SQL</titulo><preco>12</preco></livro></catalogo>', LIBXML_NONET);
$xpath = new DOMXPath($documento);
foreach ($xpath->query('/catalogo/livro[preco < 20]/titulo') as $titulo) {
    echo $titulo->textContent, "
";
}
echo 'Total: ', $xpath->evaluate('count(/catalogo/livro)'), "
";

Obténs Redes, SQL e Total: 3.

loadXML constrói a árvore a partir de texto. query devolve nós; evaluate também serve para resultados escalares, como count. No navegador, document.evaluate avalia XPath com um nó de contexto e um tipo de resultado pedido. Para percorrer nós por ordem do documento, pede XPathResult.ORDERED_NODE_ITERATOR_TYPE e lê-os com iterateNext() até devolver null. Para obter o texto dos elementos escolhidos, usa textContent. Não confundas um conjunto vazio com a string vazia de um elemento existente.

Namespaces

Um namespace distingue vocabulários através de um URI. O prefixo é uma abreviatura local, não a identidade definitiva do nome:

<c:catalogo xmlns:c="urn:biblioteca">
  <c:livro id="r1"><c:titulo>Redes</c:titulo></c:livro>
</c:catalogo>

c:livro pertence ao namespace urn:biblioteca. Outro documento pode usar prefixo b para o mesmo URI, sem mudar esse nome expandido. Declarar xmlns="urn:biblioteca" coloca elementos sem prefixo nesse namespace. A declaração por defeito não coloca automaticamente atributos sem prefixo no namespace.

Em XPath 1.0, um nome sem prefixo procura elementos sem namespace. Para consultar um documento com namespace por defeito, regista um prefixo na consulta:

$xpath->registerNamespace('b', 'urn:biblioteca');
$livros = $xpath->query('/b:catalogo/b:livro');

O prefixo b da consulta não precisa de ser o c do documento. Precisa de apontar para o mesmo URI. O URI identifica o namespace; não implica que o programa deva descarregar algo desse endereço.

Tecnologias relacionadas

XPath seleciona; XSLT transforma XML, por exemplo em HTML ou noutro XML; XQuery consulta e constrói resultados; XSL-FO descreve formatação de documentos, frequentemente para PDF. SVG é um vocabulário XML para gráficos.

Um documento XML não ganha validade, namespaces ou um esquema só por usar etiquetas; é o formato e o processamento escolhidos que dão essas propriedades. JSON também pode ter contratos de validação, por isso a escolha não se reduz a “XML validado, JSON sem regras”.