Erweiterung:Scribunto

This page is a translated version of the page Extension:Scribunto and the translation is 41% complete.
Outdated translations are marked like this.
Diese Erweiterung ist in MediaWiki 1.34 und darüber enthalten. Daher muss sie nicht erneut heruntergeladen werden. Allerdings müssen die folgenden Anweisungen trotzdem beachtet werden.
Diese Erweiterung läuft über eine ausführbare Datei. Sie müssen die Berechtigung haben, ausführbare Dateien auf Ihrem Host auszuführen, damit diese Erweiterung funktioniert.
MediaWiki-Erweiterungen
Scribunto
Freigabestatus: stabil
Einbindung Parser-Erweiterung
Beschreibung Versorgt ein Framework zum Einbetten von Skriptsprachen in MediaWiki-Seiten
Autor(en)
  • Victor Vasiliev
  • Tim Starling
und andere
Letzte Version Kontinuierliche Aktualisierungen
Kompatibilitätspolitik Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel.
MediaWiki >= 1.43
PHP 5.5+
Lizenz GPL-2.0-or-later AND MIT
Herunterladen
Module (ns:828), Talk_Module (ns:829)
  • $wgScribuntoDefaultEngine
  • $wgScribuntoSlowFunctionThreshold
  • $wgScribuntoGatherFunctionStats
  • $wgScribuntoUseGeSHi
  • $wgScribuntoUseCodeEditor
  • $wgScribuntoEngineConf
Quarterly downloads 443 (Ranked 7th)
Public wikis using 8,789 (Ranked 30th)
Übersetze die Scribunto-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Vagrant-Rolle scribunto
Probleme Offene Aufgaben · Einen Fehler melden

Die Erweiterung Scribunto (Latein: „sie sollen schreiben/schreiben lassen (in der Zukunft)“) ermöglicht das Einbetten von Skriptsprachen in MediaWiki.

Aktuell wird nur die Skriptsprache Lua unterstützt. Scribunto-Lua-Skripte werden in dem Namensraum Module abgelegt. Module laufen auf Wiki-Seiten unter Verwendung der #invoke Parser-Funktionen. Jedes Modul hat eine Sammlung an Funktionen, die mittels Wiki-Syntax aufgerufen werden können, wie:

{{#invoke: Module_name | function_name | arg1 | arg2 | arg3 ... }}

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens Scribunto im Ordner extensions/ ablegen.
    Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Scribunto
  • Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
    wfLoadExtension( 'Scribunto' );
    $wgScribuntoDefaultEngine = 'luastandalone';
    
  •   Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.


Vagrant-Installation:

  • Wird Vagrant benutzt, ist mit vagrant roles enable scribunto --provision zu installieren

Voraussetzungen

PCRE-Version Kompatibilität

PCRE 8.33+ ist empfohlen. PCRE 8.33 wurde im Mai 2013 veröffentlicht. Die durch PHP verwendete Version von PCRE ist anzusehen, indem eine phpinfo()-Webseite aufgerufen wird, oder über die Befehlszeile mit dem folgenden Befehl:

php -r 'echo "pcre: " . ( extension_loaded( "pcre" ) ? PCRE_VERSION : "no" ) . "\n";'
  • Scribunto wird nicht mit Versionen von PCRE älter als 8.10 funktionieren.
  • PCRE 8.32 hat einen Fehler, der dazu führt, dass es bestimmte Codepoints ohne Zeichen ablehnt, was zu Fehlern im mw.html-Modul führt.

CentOS 6 und RHEL 6 arbeiten mit PCRE 7 und müssen aufgerüstet werden.

Die Aktualisierung auf 8.33, auf einem Server mit einer älteren Version, kann relativ kompliziert sein. Für Details siehe Zu PCRE 8.33 oder höher aktualisieren (auf Englisch).

<span id="PHP_pcntl_(LTS )">

PHP pcntl (LTS)

MediaWiki Versions:
1.25 – 1.28

Die Scribunto-Versionen für MediaWiki 1.25 bis 1.28 benötigten die PHP-Erweiterung pcntl, die nur auf Unix/Linux-Plattformen verfügbar ist, wenn Sie "LuaStandalone" verwenden wollen (d. h. in einem separaten Kindprozess laufen lassen). Diese Voraussetzung wurde in Scribunto für MediaWiki-Version 1.29 entfernt.

Sie können überprüfen, ob die pcntl-Unterstützung aktiviert ist, indem Sie sich die phpinfo()-Webseite ansehen oder von der Befehlszeile aus den folgenden Befehl eingeben:

php -r 'echo "pcntl: " . ( extension_loaded( "pcntl" ) ? "yes" : "no" ) . "\n";'

PHP mbstring extension

PHP needs to have the mbstring extension enabled.

You can check whether mbstring support is enabled by viewing a phpinfo() web page, or from the command line with the following command:

php -r 'echo "mbstring: " . ( extension_loaded( "mbstring" ) ? "yes" : "no" ) . "\n";'

Lua binary (Binärcode)

Bundled Binaries

Scribunto kommt mit Lua-Binärcodepaketen für Linux (x86 und x86-64), Mac OS X Lion und Windows (32- and 64-bit).

Scribunto sollte "out of the box" laufen, wenn:

  1. Dein Web-Server auf einer der oben genannten Plattformen läuft.
  2. Die Funktion proc_open von PHP nicht eingeschränkt wurde.[1]
  3. proc_terminate and shell_exec are not disabled in PHP.
  4. Dein Web-Server ist so konfiguriert, dass er die Ausführung von Binärcode-Dateien im MediaWiki Verzeichnisbaum zulässt.
  Hinweis: Execute permissions may need to be set; for example, in Linux use:
chmod 755 /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua
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:
chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua

P.S. Check your version of the extension to see if the name of the engines folder is capitalised or fully lowercase.[2]

Additional binaries

Additional Lua binary distributions, which may be needed for your web server if its operating system is not in the list above, can be obtained from http://luabinaries.sourceforge.net/ or from your Linux distribution.

Only binary files for Lua 5.1.x are supported.

Once you've installed the appropriate binary file on your web server, configure the location of the file with:

# Where Lua is the name of the binary file
# e.g. SourceForge LuaBinaries 5.1.5 - Release 2 name the binary file lua5.1
$wgScribuntoEngineConf['luastandalone']['luaPath'] = '/path/to/binaries/lua5.1';

Note that you should not add the above line unless you've confirmed that Scribunto's built-in binaries don't work for you.

LuaJIT, although theoretically compatible, is not supported.

The support was removed due to Spectre and bitrot concerns (phab:T184156).

Optional installation

Integrating extensions

For a more pleasant user interface, with syntax highlighting and a code editor with autoindent, install the following extensions:

MediaWiki Version:
1.30

Then in your LocalSettings.php after all the extension registrations, add:

$wgScribuntoUseGeSHi = true;
$wgScribuntoUseCodeEditor = true;

These settings are not necessary in MediaWiki versions after 1.30, where the code editor and syntax hightlighting should be used in the appropriate places automatically once the extensions are loaded. However, other settings may be desired. See the documentation for each extension.

LuaSandbox

Wir haben eine in C geschriebene PHP-Erweiterung entwickelt, die LuaSandbox heißt. Sie kann als Alternative zum unabhängigen Binärprogramm verwendet werden und bietet eine verbesserte Leistung. Siehe LuaSandbox für Details und die Installationsanleitung.

Wenn Sie die Erweiterung ursprünglich installiert haben, um die eigenständige Lua-Binärdatei zu verwenden, stellen Sie sicher, dass Sie LocalSettings.php mit der folgenden Konfigurationseinstellung aktualisieren:

$wgScribuntoDefaultEngine = 'luasandbox';

Konfiguration

Die folgenden Konfigurationsvariablen sind verfügbar:

$wgScribuntoDefaultEngine
Wählen Sie die Engine aus. Gültige Werte sind die Schlüssel in $wgScribuntoEngineConf, welche standardmäßig 'luasandbox' oder 'luastandalone' sind.
$wgScribuntoUseGeSHi
Wenn Erweiterung:SyntaxHighlight installiert ist, setzen Sie diesen Wert auf true, um ihn bei der Anzeige von Modulseiten zu verwenden. (MediaWiki 1.30 oder früher.)
$wgScribuntoUseCodeEditor
Wenn Erweiterung:CodeEditor installiert ist, setzen Sie diesen Wert auf true, um ihn beim Bearbeiten von Modulseiten zu verwenden. (MediaWiki 1.30 oder früher.)
$wgScribuntoEngineConf
Ein assoziatives Array zur Engine-Konfiguration. Als Schlüssel werden die gültigen Werte für $wgScribuntoDefaultEngine bezeichnet und als Werte assoziative Arrays von Konfigurationsdaten. Jedes Konfigurations-Array muss einen Schlüssel 'class' enthalten, der die Unterklasse ScribuntoEngineBase benennt, welche benutzt werden soll.

LuaStandalone

Die folgenden Schlüssel werden in $wgScribuntoEngineConf für Scribunto_LuaStandaloneEngine angewendet. Normalerweise sollten Sie in etwa die folgenden Einstellungen vornehmen:

$wgScribuntoEngineConf['luastandalone']['key'] = 'value';
luaPath
Bestimmen Sie den Pfad zu einem Lua-Interpreter.
errorFile
Geben Sie den Pfad zu einer Datei an, die vom Web-Server-User beschreibbar ist und in der die Fehler- und Debugging-Ausgaben des Standalone-Interpreters protokolliert werden sollen.
Vom Standalone-Interpreter erzeugte Fehlermeldungen werden standardmäßig nicht protokolliert. Die Protokollierung wird konfiguriert mit:
$wgScribuntoEngineConf['luastandalone']['errorFile'] = '/path/to/file.log';
memoryLimit
Geben Sie das Speicherlimit in Bytes für den Standalone-Interpreter unter Linux an (wird mittels ulimit erzwungen).
cpuLimit
Geben Sie das CPU-Zeitlimit in Sekunden für den Standalone-Interpreter unter Linux an (wird mittels ulimit erzwungen).
allowEnvFuncs
Set true to allow use of setfenv and getfenv in modules.

LuaSandbox

The following keys are used in $wgScribuntoEngineConf for Scribunto_LuaSandboxEngine. Generally you'd set these as something like

$wgScribuntoEngineConf['luasandbox']['Schlüssel'] = 'Wert';
memoryLimit
Specify the memory limit in bytes. Default 52428800 (50MB)
cpuLimit
Specify the CPU time limit in seconds.
profilerPeriod
Specify the time between polls in sections for the Lua profiler.
allowEnvFuncs
Set true to allow use of setfenv and getfenv in modules.

Benutzung

Scripts go in a new namespace called Module. Each module has a collection of functions, which can be called using wikitext syntax such as:

{{#invoke: Module_name | function_name | arg1 | arg2 | arg3 ... }}

Lua

Lua lernen

Lua ist eine einfache Programmiersprache, zugänglich für Einsteiger. For a quick crash-course on Lua, try Learn Lua in 15 Minutes.

The best comprehensive introduction to Lua is the book Programming in Lua. The first edition (for Lua 5.0) is available online and is mostly relevant to Lua 5.1, the version used by Scribunto:

Das Referenz-Handbuch ist ebenfalls nützlich:

Lua-Umgebung (environment)

In Lua wird die Gesamtheit aller globalen Variablen und Funktionen als Umgebung (environment) bezeichnet.

Jeder {{#invoke:}}-Aufruf läuft in einer separaten Umgebung. Variablen, die in einem {{#invoke:}} definiert sind, sind in keinem anderen verfügbar. Diese Einschränkung war notwendig, um Flexibilität bei der Wikitext-Parser-Einbindung zu erhalten.

Die Umgebung, in der die Skripte laufen, ist nicht vollkommen gleich wie in Standard-Lua. Die Unterschiede sind in Extension:Scribunto/Lua reference manual festgehalten.

Debugkonsole

 
Debug console usage example
Siehe auch: Extension:Scribunto/Debug console

When editing a Lua module a so-called "debug console" can be found underneath the edit form. In this debug console Lua code can be executed without having to save or even create the Lua module in question.

Fehlerbehebung

 
Troubleshooting using the clickable "Script error" link.

Note that red Skriptfehler messages are clickable and will provide more detailed information.

Cannot execute extensions/Scribunto/includes/Engines/LuaStandalone/binaries

Make sure execute permissions are set for the Lua binaries bundled with this extension:[2]

chmod a+x /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/$YOUR_OS/lua

Set type to httpd_sys_script_exec_t if SELinux is enforced:[2]

chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/yourOS/lua

Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 1.

When using the LuaStandalone engine (this is the default), errors along the lines of "Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 1." may be generated if the standalone Lua interpreter cannot be executed or runs into various runtime errors. To obtain more information, assign a file path to $wgScribuntoEngineConf['luastandalone']['errorFile']. The interpreter's error output will be logged to the specified file, which should prove more helpful in tracking down the issue. The information in the debug log includes debugging information, which is why there is so much of it. You should be able to ignore any line beginning with "TX" or "RX".

If you're setting up Scribunto and are using IIS/Windows, this appears to be solved by commenting out a particular line.

Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 2.

When using the LuaStandalone engine (this is the default), status 2 suggests memory allocation errors, probably caused by settings that allocate inadequate memory space for PHP or Lua, or both. Assigning a file path to $wgScribuntoEngineConf['luastandalone']['errorFile'] and examining that output can be valuable in diagnosing memory allocation errors.

Increase PHP allocation in your PHP configuration; add the line memory_limit = 200M. This allocation of 200MB is often sufficient (as of MediaWiki 1.24) but can be increased as required. Set Scribunto's memory allocation in LocalSettings.php as a line:

$wgScribuntoEngineConf['luastandalone']['memoryLimit'] = 209715200; # Bytes

Finally, depending on the server configuration, some installations may be helped by adding another LocalSettings.php line

$wgMaxShellMemory = 204800; # in KB

Note that all 3 memory limits are given in different units.

Lua error: Internal error: 2. on ARM architecture

If you're using an ARM architecture processor like on a RaspberryPi you'll face the error Lua error: Internal error: The interpreter exited with status 2. due to wrong delivered binary format of the Lua interpreter.

Check your Lua interpreter in:

/path/to/webdir/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_32_generic

Check the interpreter by using:

file lua 

The result should look like :

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

The installed default Lua interpreter shows:

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,

look at the "Intel 80386" part what definitely is not correct.

Check in /usr/bin what version of Lua is installed on your system. If you have lua5.1 installed, you can either copy the interpreter to your lua5_1_5_linux_32_generic directory or set in your LocalSettings.php:

$wgScribuntoEngineConf['luastandalone']['luaPath'] = '/usr/bin/lua5.1';

At present don't set wgScribuntoEngineConf to /usr/bin/lua5.3, it'll lead to the "Internal error 1".

Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 24.

When using the LuaStandalone engine (this is the default), status 24 suggests CPU time limit errors, although those should be generating a "The time allocated for running scripts has expired" message instead. It would be useful to file a task in Phabricator and participate in determining why the XCPU signal isn't being caught.

Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 126.

When using the LuaStandalone engine (this is the default), errors along the lines of "Interner Lua-Fehler: Der Interpreter beendet sich mit dem Status 126." may be generated if the standalone Lua interpreter cannot be executed. This generally arises from either of two causes:

  • The Lua executable file's permissions do not include Execute.

Set permissions as described under #Installation.

  • The server does not allow execution of files from the place where the executable is installed, e.g. the filesystem is mounted with the 'noexec' flag.

This often occurs with shared hosted servers. Remedies include adjusting $wgScribuntoEngineConf['luastandalone']['luaPath'] to point to a Lua 5.1 binary installed in an executable location, or adjusting or convincing the shared host to adjust the setting preventing execution.

Error condition such as: Fatal exception of type MWException

Check the MediaWiki, PHP, or webserver logs for more details on the exception, or temporarily set $wgShowExceptionDetails to true.

version 'GLIBC_2.11' not found

If the above gives you errors such as "version 'GLIBC_2.11' not found", it means the version of the standard C library on your system is too old for the binaries provided with Scribunto. You should upgrade your C library, or use a version of Lua 5.1 compiled for the C library you do have installed. To upgrade your C library, your best option is usually to follow your distribution's instructions for upgrading packages (or for upgrading to a new release of the distribution, if applicable).

If you copy the lua binaries from Scribunto master (or from gerrit:77905), that should suffice, if you can't or don't want to upgrade your C library. The distributed binaries were recently recompiled against an older version of glibc, so the minimum is now 2.3 rather than 2.11.

Lua errors in Scribunto files

Errors here include:

  • attempt to index field 'text' (a nil value)
  • Lua error in mw.html.lua at line 253: Invalid class given:

If you are getting errors such these when attempting to use modules imported from WMF wikis, most likely your version of Scribunto is out of date.

Upgrade if possible; for advanced users, you might also try to identify the needed newer commits and cherry-pick them into your local installation.

preg_replace_callback(): Compilation failed: unknown property name after \P or \p at offset 7

preg_replace_callback(): Compilation failed: unknown property name after \P or \p at offset 7

  • this usually indicates an incompatible version of PCRE; you'll need to update to >= 8.10
  • @todo: link to instructions on how to upgrade

Lua error

If you copy templates from Wikipedia and then get big red "Lua error: x" messages where the Scribunto invocation (e.g. the template that uses {{#invoke:}}) should be, that probably means that you didn't import everything you needed. Make sure that you tick the "Include templates" box at w:Special:Export when you export.

When importing pages from another wiki, it is also possible for templates or modules in the imported data to overwrite existing templates or modules with the same title, which may break existing pages, templates, and modules that depend on the overwritten versions.

Blank screen

Make sure your extension version is applicable to your MediaWiki version.

Lizenz

Die Erweiterung enthält Kodes die unter GNU General Public License v2.0 oder neuer (GPL-2.0+) lizenziert sind, sowie Kodes die unter MIT License (MIT) lizenziert sind.

Design documents

Andere Seiten

Siehe auch

Allgemein
  • Lua Wikibase client - Funktionalität für die Scribunto-Erweiterung.
  • Commons:Lua - there may be specific notes for using Lua modules on Wikimedia Commons, including additional Lua extensions installed (e.g. for local support of internationalization and for parsing or playing medias). Some general purpose modules may be reused in other wikis in various languages (except specific tunings for policies, namespaces or project/maintenance pages with dedicated names). If possible, modules that could be widely reused across wikis should be tested and internationalized on Wikimedia Commons.
  • w:Help:Lua - there may be specific notes for using Lua modules on Wikipedia, including additional Lua extensions installed (including for integrating Wikidata and Wikimedia Commons contents, generating complex infoboxes and navigation boxes, or to facilitate the general administration/maintenance of the wiki contents under applicable policies). Some other localized Wikipedia editions (or other projects such Wiktionnary, Wikisource or Wikinews) may also have their own needs and Lua modules.
  • d:Help:Lua - there may be specific notes for using Lua modules on Wikidata, including additional Lua extensions installed (e.g. for local support of internationalization and for database queries)
Erweiterungen

Anmerkungen

  1. Z.B. wird Scribunto nicht laufen, wenn proc_open im Bereich disable_functions der Serverdatei "php.ini" gelistet ist. Ist dies der Fall, erscheint möglicherweise eine Fehlermeldung wie proc_open(): open_basedir restriction in effect. File(/dev/null) is not within the allowed path(s):. Wenn du Plesk verwendest und ausreichende Berechtigungen erteilt sind, sollte es möglich sein, open_basedir in den PHP-Einstellungen für deine Domain oder Sub-Domain zu setzen. Versuche, {WEBSPACEROOT}{/}{:}{TMP}{/} in {WEBSPACEROOT}{/}{:}{TMP}{/}{:}/dev/null{:}/bin/bash zu ändern.
  2. 2.0 2.1 2.2 The name of the engines folder changed from lowercase to capitalised in 2022.