L'utilitaire xmlstarlet pour Linux

xmlstarlet est un utilitaire puissant pour Linux qui permet de manipuler des données XML depuis la ligne de commande et qui s'intègre dans vos scripts shell. Il est au XML ce que jq est au JSON.

Avec xmlstarlet, vous pouvez embellir une sortie XML mais aussi la filtrer, par exemple pour n'afficher qu'un nœud donné.

Un mur de XML en entrée, un mot en sortie​

Voici le fichier avec lequel nous allons jouer, data.xml, exactement tel qu'une machine l'aurait écrit : tout sur une seule ligne, aucun formatage.

<?xml version="1.0" encoding="UTF-8"?><bookstore><book category="cooking"><title lang="en">Everyday Italian</title><author>Giada De Laurentiis</author><year>2005</year><price>30.00</price></book><book category="children"><title lang="en">Harry Potter</title><author>J K. Rowling</author><year>2005</year><price>29.99</price></book><book category="web"><title lang="en">XQuery Kick Start</title><author>James McGovern</author><author>Per Bothner</author><author>Kurt Cagle</author><author>James Linn</author><author>Vaidyanathan Nagarajan</author><year>2003</year><price>49.99</price></book><book category="web"><title lang="en">Learning XML</title><author>Erik T. Ray</author><year>2003</year><price>39.95</price></book></bookstore>?

Posons-lui maintenant une question : donne-moi le titre du livre classé dans la catégorie children.

$ cat "data.xml" | xmlstarlet sel -t -v "//book[@category='children']/title"
Harry Potter▋

Une commande, une réponse, et pas une seule ligne de code de parsing.

Embellir le fichier​

La deuxième chose que vous utiliserez tous les jours : rendre ce mur lisible, grâce à l'action format.

$ cat "data.xml" | xmlstarlet format --indent-spaces 4▋

<?xml version="1.0" encoding="UTF-8"?>?
<bookstore>
    <book category="cooking">?
        <title lang="en">Everyday Italian</title>?
        <author>Giada De Laurentiis</author>
        <year>2005</year>
        <price>30.00</price>
    </book>
    <book category="children">
        <title lang="en">Harry Potter</title>
        <author>J K. Rowling</author>
        <year>2005</year>
        <price>29.99</price>
    </book>
    <book category="web">
        <title lang="en">XQuery Kick Start</title>
        <author>James McGovern</author>
        <author>Per Bothner</author>
        <author>Kurt Cagle</author>
        <author>James Linn</author>
        <author>Vaidyanathan Nagarajan</author>
        <year>2003</year>
        <price>49.99</price>
    </book>
    <book category="web">
        <title lang="en">Learning XML</title>
        <author>Erik T. Ray</author>
        <year>2003</year>
        <price>39.95</price>
    </book>
</bookstore>

Le voir à l'œuvre avec Docker​

Avant d'installer quoi que ce soit, essayez les deux commandes ci-dessus dans un container jetable — data.xml, exactement le même fichier que celui montré en haut de cet article, vous attend déjà dans le répertoire de travail.

Construisez l'image et lancez-la :

$ docker build -t xmlstarlet-demo .
[+] Building 9.4s (6/6) FINISHED
✔ exporting to image
$ docker run --rm -it xmlstarlet-demo
🐳 root ~/demo # cat data.xml | xmlstarlet sel -t -v "//book[@category='children']/title"
Harry Potter

Même fichier, même filtre, même réponse — pas de mkdir, pas de copier-coller de XML dans un nouveau fichier. Essayez ensuite cat data.xml | xmlstarlet format --indent-spaces 4 pour voir la version embellie, ou modifiez l'expression XPath pour récupérer un autre nœud.

Installer xmlstarlet​

Pour vérifier si xmlstarlet est déjà installé sur votre système, lancez simplement which xmlstarlet. Si vous obtenez xmlstarlet not found comme réponse :

$ sudo apt-get update && sudo apt-get -y install xmlstarlet▋

$ xmlstarlet --version

1.6.1▋

À vous de jouer​

Pour reproduire les deux commandes ci-dessus sur votre machine, ouvrez un shell Linux et lancez mkdir -p /tmp/xmlstarlet && cd $_, puis créez un fichier data.xml avec le contenu affiché en haut de cet article.

Comprendre l'expression XPath​

Une expression XPath n'est qu'un chemin dans l'arbre. Notre nœud racine s'appelle bookstore, ensuite nous avons un ou plusieurs book et chaque livre a un title :

<!-- highlight-next-line -->
<bookstore>
    <!-- highlight-next-line -->
    <book category="cooking">?
        <!-- highlight-next-line -->
        <title lang="en">Everyday Italian</title>?
        [...]
    </book>
    [...]
</bookstore>

Parcourez ce chemin depuis la racine et vous obtenez tous les titres du fichier :

$ cat "data.xml" | xmlstarlet sel -t -v "/bookstore/book/title"

Everyday Italian
Harry Potter
XQuery Kick Start
Learning XML
▋

L'expression utilisée au début de cet article, //book[@category='children']/title, en est la version filtrée : donne-moi chaque book, peu importe où le nœud se trouve (c'est le préfixe //), mais uniquement s'il possède un attribut nommé category dont la valeur est children. Puis, si trouvé, affiche son title.

Conclusion​

Deux actions couvrent l'essentiel des besoins quotidiens : format pour rendre un fichier XML lisible par un humain, et sel -t -v avec une expression XPath pour en extraire exactement le nœud voulu. Les deux s'utilisent dans un pipe, donc les deux s'utilisent dans un script shell.

Consultez la documentation officielle pour en apprendre plus sur xmlstarlet, et si votre prochain fichier est un .json, l'utilitaire jq pour Linux raconte exactement la même histoire avec une syntaxe différente.