HOWTO · JavaScript

Décoder les entités HTML en utilisant JavaScript

Dans cet article, nous verrons comment décoder des entités HTML à l'aide de JavaScript.

Sur cette page

Pour décoder des entités HTML dans une chaîne, utilisez un élément textarea du navigateur si votre code s’exécute dans un navigateur, ou le paquet he dans un projet Node.js. Ces deux méthodes convertissent des références de caractères telles que &nbsp;, &#39; et &amp; en caractères correspondants. La chaîne d’exemple contient aussi les balises littérales <h2> et <br> : le décodage des entités ne supprime pas ces balises.

Décoder les entités HTML avec JavaScript natif

Un textarea dans le navigateur peut décoder les références de caractères, mais son affectation à innerHTML analyse la syntaxe HTML. Avant d’affecter une entrée non fiable, échappez les signes inférieur littéraux afin qu’une chaîne comme </textarea><img src=x onerror=alert(1)> ne puisse pas fermer le contexte d’analyse ni créer un élément. Les références de caractères sont tout de même décodées, tandis que le texte des balises littérales reste du texte. Cette méthode nécessite document : elle s’exécute dans un navigateur, et non directement dans Node.js.

Voici une page complète pour le navigateur. Remplacez la chaîne d’exemple par la valeur que vous souhaitez décoder. La fonction échappe les caractères < littéraux avant l’analyse, puis la page affiche la valeur renvoyée avec textContent.

<!doctype html>
<meta charset="utf-8">
<textarea id="source"></textarea>
<pre id="result"></pre>
<script>
function decodeEntities(input) {
  const textarea = document.createElement('textarea');
  textarea.innerHTML = input.replace(/</g, '&lt;');
  return textarea.value;
}

const input = "Give&nbsp;us some&#39;<h2>time</h2>&#39; &amp; space <br> Please";
document.querySelector('#source').value = input;
document.querySelector('#result').textContent = decodeEntities(input);
</script>

Échapper chaque caractère < littéral empêche l’entrée de fournir au parseur une balise de fermeture de textarea ou le balisage d’un autre élément. Les références encodées telles que &lt; sont toujours décodées, mais le < obtenu reste du texte dans la valeur du textarea ; il n’est pas analysé une seconde fois comme du balisage. L’affectation à textContent affiche également les caractères <h2> et <br> décodés comme du texte. Si vous souhaitez ensuite afficher les données décodées comme du HTML, appliquez une politique de nettoyage HTML adaptée à cette étape distincte.

Pour un petit exemple Node.js qui traite les références numériques décimales terminées par un point-virgule, String.fromCodePoint() peut convertir chaque valeur correspondante acceptée par JavaScript. Cet utilitaire n’applique pas les règles HTML relatives aux références numériques : &#0; devient U+0000 et &#55296; devient le substitut isolé U+D800, alors qu’un parseur HTML remplace les deux par U+FFFD. L’utilitaire ne valide pas non plus les références mal formées ou hors limites ; une valeur hors limites peut provoquer une RangeError dans String.fromCodePoint(). Les références sans point-virgule restent inchangées. Il s’agit d’un exemple limité, et non d’un décodeur complet d’entités HTML ; pour une syntaxe d’entités plus étendue, utilisez la méthode du navigateur ci-dessus ou le paquet he ci-dessous.

Exécutez cet exemple. Le bloc de sortie conservé à l’identique affiche la chaîne renvoyée ; son libellé reste en anglais.

function decodeDecimalReferences(input) {
  return input.replace(/&#(\d+);/g, (_, digits) =>
    String.fromCodePoint(Number(digits))
  );
}

console.log(decodeDecimalReferences("Give&#39; us time"));
Give' us time

Décoder les entités HTML avec la bibliothèque he

Dans Node.js, installez le paquet he avec npm install he, puis chargez-le avec const he = require('he'); et décodez une chaîne avec he.decode(input). he prend en charge les références de caractères HTML nommées et numériques ; il convient donc mieux qu’une liste de remplacement écrite à la main lorsque l’entrée peut contenir des entités variées. Vérifiez que les exigences actuelles du paquet concernant la version de Node.js sont compatibles avec celle de votre projet, au lieu de supposer que toutes les versions sont prises en charge.

La fonction decode() reçoit la chaîne HTML comme premier argument obligatoire. Son deuxième argument facultatif est un objet d’options ; des propriétés comme isAttributeValue et strict sont des paramètres booléens de cet objet, et non des arguments distincts à lui transmettre. Pour du texte ordinaire, appelez he.decode(input) sans option. Avec la chaîne d’exemple ci-dessus, la chaîne décodée est Give us some'<h2>time</h2>' & space <br> Please (l’espace après « Give » est une espace insécable).

Choisissez la méthode avec textarea pour du code qui s’exécute déjà dans un navigateur, et he pour Node.js ou si vous avez besoin d’un décodeur autonome prenant en charge un large éventail d’entités. Le décodage convertit les références de caractères ; il ne supprime pas les balises littérales de l’exemple. Traitez séparément le décodage et l’affichage sécurisé.