Extension:Scribunto/fr

L'extension Scribunto (latin : « ils l'écriront/le laisseront écrire (à l'avenir) ») permet l'intégration des langages de script dans MediaWiki.

Actuellement, le seul langage de script pris en charge est Lua. Les scripts Lua Scribunto sont stockés dans l'espace de noms Module.

Licence
Cette extension comporte du code sous licence GNU General Public License v2.0 ou ultérieure (GPL-2.0+) ainsi que du code sous licence MIT (MIT).

Prérequis


Compatibilité des versions PCRE
PCRE 8.33+ est recommandé. Vous pouvez voir la version de PCRE utilisée par PHP en affichant une page web phpinfo, ou à partir de la ligne de commande avec :


 * Scribunto ne fonctionne pas avec les versions de PCRE inférieures à 8.10.
 * PCRE 8.31 montre des bogues avec l'étude des modèles JIT qui échouent avec des modèles utilisant HHVM.
 * PCRE 8.32 comporte un bogue qui fait que certains points de code qui ne correspondent pas à des caractères sont rejetés, ce qui provoque des erreurs dans le module mw.html

CentOS 6 et RHEL 6 sont associés à PCRE 7 et doivent être mis à jour.

Mettre à jour vers la 8.33 peut s'avérer très compliqué avec un serveur ayant une version plus ancienne. Voir Mise à jour vers PCRE 8.33 ou supérieur pour les détails.

PHP pcntl (LTS)
Les versions de Scribunto pour MediaWiki 1.25 à 1.28 nécessitaient l'extension PHP pcntl, qui n'est disponible que sur les plateformes Unix/Linux, si vous voulez utiliser LuaStandalone (par exemple en exécutant dans un processus fils séparé). Cette contrainte a été supprimée dans Scribunto pour MediaWiki 1.29.

Vous pouvez vérifier si pcntl est pris en charge en affichant une page web phpinfo ou à partir de la ligne de commande en tapant :



Extension mbstring pour PHP
PHP a besoin que l'extension mbstring soit activée.

Vous pouvez vérifier si le support de mbstring est activé en affichant une page web phpinfo, ou à partir de la commande suivante en mode ligne de commande :



Binaire Lua


Binaires dans les archives
Scribunto est livré avec les distributions binaires Lua pour Linux (x86 et x86-64), Mac OS X Lion, et Windows (32 et 64-bit).

Scribunto devrait fonctionner pour vous hors de la boîte si :


 * 1) votre serveur web s'exécute sur l'une des plateforme ci-dessus.
 * 2) La function PHP   n'est pas restreinte.
 * 3) Votre serveur web est configuré pour permettre l'exécution de fichiers binaires dans l'arborescence MediaWiki.
 * Vous devrez éventuellement attribuer le droit d'exécuter; par exemple, sous Linux utilisez :
 * If you are using SELinux in "Enforcing" mode on your server, you might need to set a proper context for the binaries. Example for RHEL/CentOS 7:



Binaires supplémentaires
Les distributions binaires Lua complémentaires, nécessaires à votre serveur web si son système d'exploitation n'est pas dans la liste ci-dessus, peuvent être obtenues de http://luabinaries.sourceforge.net/ ou de votre distribution Linux.

Seuls les fichiers binaires pour Lua 5.1.x sont pris en charge.

Une fois que vous avez installé le fichier binaire approprié sur votre serveur web, configurez l'emplacement du fichier avec :

Notez que vous ne devez pas ajouter la ligne ci-dessus à moins que vous avez confirmé que les binaires construits de Scribunto ne fonctionnent pas chez vous.

LuaJIT n'est pas pris en charge bien qu'il soit théoriquement compatible.

Le support a été supprimé à cause des problèmes Spectre et bitrot (T184156).

Installation


Installation optionnelle


Intégrer les extensions
Pour disposer d'une interface utilisateur plus agréable, avec une mise en valeur de la syntaxe et un éditeur de code réalisant l'indentation automatique, installez les extensions suivantes :

Puis dans votre  après l'enregistrement de toutes les extensions, ajoutez :

LuaSandbox
Nous avons développé une extension PHP écrite en C appelée LuaSandbox. Il peut être utilisé en tant qu'alternative au binaire isolé, en fournira de meilleures performances. Voir pour les détails et les instructions d'installation.

Si vous avez initialement installé l'extension pour qu'elle utilise le binaire Lua séparé, assurez-vous de mettre à jour  avec le paramètre de configuration suivant :

Configuration
Les variables de configuration suivantes sont disponibles :
 * $wgScribuntoDefaultEngine
 * Choisir le moteur Les valeurs valides sont les clés de, qui par défaut sont  ou.


 * $wgScribuntoUseGeSHi
 * Lorsque est installé, mettez ceci à   pour l'utiliser lors de l'affichage des pages de modules. (MediaWiki 1.30 ou version antérieure).


 * $wgScribuntoUseCodeEditor
 * Lorsque est installé, mettez ceci à   pour l'utiliser lors de la modification des pages de module.  (MediaWiki 1.30 ou version antérieure).


 * $wgScribuntoEngineConf
 * Tableau associatif pour la configuration du moteur. Les clés sont les valeurs valides pour, et les valeurs sont les tableaux associatifs des paramètres de configuration. Chaque tableau de configuration doit contenir une clé  qui nomme les sous-classes   à utiliser.

LuaStandalone
Les clés suivantes sont utilisées dans pour. En général, vous les initialiserez d'une manière similaire à :


 * luaPath
 * Spécifier le chemin vers un interpréteur Lua.


 * errorFile
 * Indiquez le chemin vers un fichier, accessible en écriture par l'utilisateur du serveur web, où la sortie des erreurs et des informations de debogage seront journalisées.
 * Les sorties d'erreurs produites par l'interpréteur indépendant ne sont pas journalisées par défaut. Configurez la connexion avec :


 * memoryLimit
 * Indiquez la taille limite de la mémoire en octets pour l'interpréteur indépendant sous Linux (forcé en utilisant ulimit).


 * cpuLimit
 * Indiquez la valeur maximale du temps d'utilisation du CPU en secondes pour l'interpréteur indépendant sous Linux (forcé en utilisant ulimit)


 * allowEnvFuncs
 * Mettre à  pour autoriser l'utilisation de setfenv et getfenv dans les modules.

LuaSandbox
Les clés suivantes sont utilisées dans pour. En général, vous les initialiserez d'une manière similaire à :


 * memoryLimit
 * Indiquez la limite de la mémoire en octets.


 * cpuLimit
 * Indiquez la limite du temps CPU en secondes.


 * profilerPeriod
 * Indiquez le temps entre chaque interrogation en secondes pour le profileur Lua.


 * allowEnvFuncs
 * Mettez à  pour permettre l'utilisation de setfenv et getfenv dans les modules.

Utilisation
Les scripts se placent dans un nouvel espace de noms appelé Module. Chaque module possède un ensemble de fonctions pouvant être appelées avec la syntaxe wikicode telle que :

Lua


Apprendre Lua
Lua est un langage simple de programmation créé dans le but d'être accessible aux débutants. Pour un cours Lua super rapide, essayez Apprendre Lua en 15 minutes.

La meilleure introduction détaillée sur Lua est le livre Programmer en Lua. La première édition (pour Lua 5.0) est disponible en ligne et convient pratiquement pour Lua 5.1 qui est la version utilisée par Scribunto :


 * Programmer en Lua (descendre pour passer les annonces du livre et accéder au texte)

Le manuel de référence est également utile :



Environnement Lua
En Lua, nous appelons environnement l'ensemble des variables et des fonctions globales.

Chaque appel de  s'exécute dansn environnement séparé. Les variables définies dans un  ne seront pas accessibles d'un autre. Cette restriction était nécessaire pour maintenir la flexibilité dans l'implémentation de l'analyseur de wikicode.



Console de débogage



 * Voir aussi : 

Lorsque vous modifiez un module Lua, une fenêtre de debogage apparaît sous le formulaire d'édition. Dans cette fenêtre de débogage, vous pouvez exécuter du code Lua sans avoir à sauvegarder ou même à créer le module Lua en question.

Dépannage


Remarquez que les messages rouges sont cliquables et fourniront des informations plus détaillées.

Si vous utilisez le moteur LuaStandalone (cas par défaut), les erreurs avec les lignes associées de «  » peuvent être générées si l'interpréteur indépendant Lua ne peut pas être exécuté ou s'exécute avec de multiples erreurs de code. Pour obtenir davantage d'informations, définissez un chemin de fichier pour. La sortie d'erreurs de l'interpréteur sera tracée dans le fichier spécifié, ce qui s'avèrera plus utile lors de la recherche de fautes. L'information dans le journal de debogage comprend les informations de debogage, c'est pourquoi il est si long. Vous devriez pouvoir ignorer les lignes commençant par TX ou RX.

Si vous configurez Scribunto et que vous utilisez IIS/Windows, ce cas semble être résolu en commentant une ligne particulière.

En utilisant le moteur LuaStandalone (cas par défaut), l'état 2 suggère des erreurs d'allocation mémoire, probablement causées par les paramètres qui réservent l'espace mémoire non approprié pour PHP ou Lua, ou pour les deux. En fournissant un chemin de fichier à  et en examinant ainsi la sortie vous pourrez diagnostiquer valablement les erreurs d'allocation mémoire.

Augmentez l'allocation PHP dans votre configuration PHP; ajoutez la ligne. Celle allocation de 200 Mo est habituellement suffisante (depuis MediaWiki 1.24) et peut être augmentée si nécessaire. Définissez l'allocation mémoire de Scribunto dans le fichier  avec la ligne suivante : Enfin, en fonction de la configuration du serveur, certaines installations peuvent être facilitées en ajoutant une autre ligne à  :

Notez que les limites des trois mémoires sont données dans des unités différentes.



Erreur Lua : Erreur interne : 2. sur architecture ARM
Si vous utilisez un processeur à architecture ARM tel que sur un RaspberryPi vous rencontrerez l'erreur  à cause du mauvais format binaire de livraison de l'interpréteur Lua.

Vérifez votre interpréteur Lua dans : /path/to/webdir/Scribunto/includes/engines/LuaStandalone/binaries/lua5_1_5_linux_32_generic

Vérifiez l'interpréteur en utilisant : file lua Le résultat devrait être similaire à : lua: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0 L'interpréteur Lua installé par défaut donne : lua: ELF 32-bit LSB pie executable, Intel 80386, version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux.so.2, for GNU/Linux 2.6.9, regardez dans la partie Intel 80386 ce qui définitivement n'est pas correct.

Vérifiez dans  la version de Lua installée sur votre système. Si lua5.1 est installé, vous pouvez soit copier l'interpréteur dans votre répertoire  ou bien le déclarer dans votre LocalSettings.php :

Maintenant n'initialisez pas  à /usr/bin/lua5.3, cela conduira à l' « Erreur interne 1  ».

Lorsque vous utilisez le moteur LuaStandalone (cas par défaut), l'état 24 suggère des erreurs de dépassement du temps d'allocation CPU, bien que celles-ci devraient générer à la place, un message « Le temps alloué à l'exécution des scripts est dépassé ». Il serait utile de créer une tâche dans et d'y participer pour déterminer pourquoi le signal XCPU n'est pas récupéré.

Lorsque vous utilisez le moteur LuaStandalone (cas par défaut), des erreurs avec les lignes associées de «  » peuvent apparaître si l'interpréteur Lua indépendant ne peut pas être exécuté. Ceci est dû généralement à l'une des deux causes suivantes :


 * Le droit d'exécuter sur les fichiers Lua n'incluent pas l'exécution (Execute). Attribuez les droits tel que décrit dans la section Installation.
 * Le serveur n'autorise pas l'exécution des fichiers à partir de l'endroit où les exécutables ont été installés parce que le système de fichiers est monté avec l'attribut . Ceci se produit souvent avec des serveurs hôtes partagés. Une solution possible est de modifier   pour qu'il pointe vers un binaire Lua 5.1 installé à un endroit exécutable ou en l'adaptant, ou encore en convaincant l'hôte partagé de corriger le paramètre qui empêche l'exécution.



Condition d'erreur telle que : exception fatale de type MWException
Voyez les journaux de MediaWiki, PHP, ou du serveur web pour davantage de détails sur l'exception, ou mettez temporairement à.



Version 'GLIBC_2.11' non trouvée
Si ce qui précède génère des erreurs telles que « version 'GLIBC_2.11' non trouvée », cela signifie que la version de la bibliothèque standard C sur votre système, est trop ancienne pour les binaires fournis avec Scribunto. Vous devriez mettre à jour votre bibliothèque C ou utiliser une version de Lua 5.1 compilée pour la bibliothèque C que vous avez installée. Pour mettre à jour votre bibliothèque C, la meilleure façon est habituellement de suivre les instructions de votre distribution relatives à la mise à jour des paquets logiciels (ou pour faire la mise à jour vers une nouvelle version de la distribution, selon le cas).

Si vous copiez les binaires Lua à partir de la branche master de Scribunto (ou de 77905), cela devrait suffire, si vous ne pouvez pas (ou ne voulez pas) mettre à jour votre bibliothèque C. Les binaires distribués ont été récemment recompilés avec une ancienne version de glibc, donc le minimum maintenant est 2.3 au lieu de 2.11.



Erreurs Lua dans les fichiers Scribunto
Les erreurs comprennent ici :
 * essai pour indexer le champ 'text' (une valeur nulle)
 * Erreur Lua dans mw.html.lua en ligne 253 : classe invalide fournie :

Si vous obtenez des erreurs comme celles-ci lorsque vous essayez d'utiliser les modules importés des wikis de la WMF, il est très probable que la version de votre  Scribunto soit obsolète.

Mettez-la à jour si possible; pour les utilisateurs avancés, vous pouvez aussi essayer d'identifier les nouvelles validations (commits) nécessaires et les récupérer (cherry-pick) dans votre installation locale.



preg_replace_callback: échec de compilation : nom de propriété inconnu après \P ou \p à l'offset 7

 * cela indique habituellement une version incompatible de PCRE; vous devrez mettre à jour >= 8.10
 * @todo: lien sur les instructions de mise à jour



Erreur Lua
Si vous copiez les modèles de Wikipedia et qu'ensuite vous voyez de gros messages en rouge « Lua error: x » où Scribunto est appelé (par exemple le modèle qui utilise ), cela signifie probablement que vous n'avez pas importé tous les éléments nécessaires. Assurez-vous d'avoir coché la case « Inclure les modèles » sur w:Special:Export lorsque vous exportez.

Lorsque vous importez des pages à partir d'un autre wiki, il est aussi possible que des modèles ou des modules parmi ces données importées, réécrasent les modèles ou les modules existants qui ont le même titre, ce qui peut casser les pages existantes, les modèles, ou les modules qui dépendent de ces versions réécrasées.

<span id="Blank_screen">

Ecran vide
Vérifiez que la version de votre extension est compatible avec votre version de MediaWiki.

<span id="Design_documents">

Documents de conception

 * Linux.conf.au 2014 - Scribunto presentation.webm sur linux.conf.au en 2014 à propos des motivations, des défis d'implémentation et des résultats du déploiement de Scribunto et Lua.]]

<span id="Other_pages">

Autres pages

 * - Page d'activité Wikimedia décrivant le plan de déploiement des sites Wikimedia.
 * - La référence du langage Lua, ainsi que ses bibliothèques standard et ses modules communs Scribunto pris en charge par les sites Wikimedia.
 * - Liste de modifications connues dans Lua 5.2 qui peuvent faire que le code écrit en 5.1 fonctionne de manière inattendue.
 * - Code d'exemple d'extensions qui étendent la bibliothèque Scribunto.
 * - Liste de modifications connues dans Lua 5.2 qui peuvent faire que le code écrit en 5.1 fonctionne de manière inattendue.
 * - Code d'exemple d'extensions qui étendent la bibliothèque Scribunto.
 * - Code d'exemple d'extensions qui étendent la bibliothèque Scribunto.

<span id="See_also">

Voir aussi

 * General
 * - fonctionnalité pour l'extension Scribunto.
 * Lua (Commons) - vous pourrez trouver des notes spécifiques sur l'utilisation des modules Lua sur Wikimedia Commons, y compris sur les extensions supplémentaires Lua installées (par exemple pour la prise en charge locale des traductions et pour l'analyse ou la restitution des médias). Certains modules à fonctionnement général peuvent être réutilisés sur d'autres wikis et dans des langues différentes (sauf pour l'adaptation spécifique des règles, les espaces de noms ou les pages des projets ou de maintenance ayant des noms dédiés). Les modules réutilisés à grande échelle sur les wikis doivent si possible être testés et traduits sur Wikimedia Commons.
 * w:Help:Lua - il peut contenir des notes spécifiques sur l'utilisation de modules Lua avec Wikipedia, y compris les extensions Lua installées (pour intégrer le contenu de Wikidata et Wikimedia Commons, pour générer des boîtes d'information et de navigation complexes, ou pour faciliter l'administration et la maintenance générale du contenu du wiki en fonction des règles applicables). Certaines autres éditions traduites de Wikipedia (ou d'autres projets comme le Wiktionnaire, Wikisource ou Wikinews) peuvent avoir également leurs propres besoins ainsi que leurs modules Lua.
 * d:Help:Lua - vous pourrez trouver des notes spécifiques sur l'utilisation des modules Lua dans Wikidata, y compris sur les extensions supplémentaires Lua installées (par exemple pour la prise en charge locale des traductions et pour les requêtes dans la base de données).
 * Extensions
 * - Fournit les fonctions de base d'une boîte d'information à l'extension Scribunto.
 * - fournit un support natif pour l'extension Scribunto pour l'utilisation avec
 * - fournit un interface Lua Scribunto pour l'extension Variables
 * - fournit (partie du projet Wikidata)