Extension:Scribunto/de

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.

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.

PCRE-Version Kompatibilität
PCRE 8.33+ ist empfohlen. Die durch PHP verwendete Version von PCRE ist anzusehen, indem eine phpinfo-Webseite aufgerufen wird, oder über die Befehlszeile mit dem folgenden Befehl:


 * Scribunto wird nicht funktionieren mit Versionen von PCRE die unter Version 8.10 sind.
 * PCRE 8.31 hat Fehler mit JIT-Muster-Untersuchung, das verschiedene Muster unterbricht, wenn sie mit HHVM genutzt werden.
 * 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. Siehe (auf Englisch) Updating to PCRE 8.33 or Higher für Details.

PHP pcntl (LTS)
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 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:

Bundled binaries
Scribunto comes bundled with Lua binary distributions for Linux (x86 and x86-64), Mac OS X Lion, and Windows (32- and 64-bit).

Scribunto should work for you out of the box if:


 * 1) Your web server is run on one of the above platforms.
 * 2) PHP's   function is not restricted.
 * 3) Your web server is configured to allow the execution of binary files in the MediaWiki tree.
 * Execute permissions may need to be set; for example, in Linux use
 * 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:

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:

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 (T184156).

Integrating extensions
For a more pleasant user interface, with syntax highlighting and a code editor with autoindent, install the following extensions:
 * Extension:WikiEditor
 * Extension:SyntaxHighlight
 * Extension:CodeEditor

(MediaWiki 1.30 or earlier)Then in your LocalSettings.php after all the extension registrations, add:

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 für Details und die Installationsanleitung.

Wenn Sie die Erweiterung zuerst installiert haben, um die eigenständige Lua-Binärdatei zu verwenden, stellen Sie sicher, dass Sie LocalSettings.php mit  aktualisieren.

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 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 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:


 * 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:


 * 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


 * memoryLimit : Specify the memory limit in bytes.
 * 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:

Lua lernen
Lua is a simple programming language intended to be accessible to beginners. 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:


 * Programming in Lua (scroll down past the book ads to find the text)

The reference manual is also useful:

Lua environment
In Lua, the set of all global variables and functions is called an environment.

Each call runs in a separate environment. Variables defined in one will not be available from another. This restriction was necessary to maintain flexibility in the wikitext parser implementation.

Debugkonsole



 * Siehe auch: 

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


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

When using the LuaStandalone engine (this is the default), errors along the lines of "" 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. 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".

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  and examining that output can be valuable in diagnosing memory allocation errors.

Increase PHP allocation in your PHP configuration; add the line. 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: Finally, depending on the server configuration, some installations may be helped by adding another LocalSettings.php line

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  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  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 you LocalSettings.php the

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

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.

When using the LuaStandalone engine (this is the default), errors along the lines of "" may be generated if the standalone Lua interpreter cannot be executed. This generally arises from either of two causes:

Set permissions as described under #Installation. This often occurs with shared hosted servers. Remedies include adjusting  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.
 * The lua executable file's permissions do not include Execute.
 * 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.

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 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 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

 * 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 ) 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.

Design documents

 * Linux.conf.au 2014 - Scribunto presentation.webm's presentation at linux.conf.au 2014 discussing the motivations, implementation challenges and results of deploying Scribunto and Lua.]]

Other pages

 * - Wikimedia activity page describing deployment plan to Wikimedia sites
 * - The reference about the Lua language, as well as its standard libraries and common Scribunto modules supported on Wikimedia sites
 * - A list of known changes in Lua 5.2 that may cause code written in 5.1 to function unexpectedly
 * - Code for example extensions extending the Scribunto library.
 * - A list of known changes in Lua 5.2 that may cause code written in 5.1 to function unexpectedly
 * - Code for example extensions extending the Scribunto library.
 * - Code for example extensions extending the Scribunto library.

Siehe auch

 * General
 * - functionality for the Scribunto extension.
 * commons: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 Commons.
 * wikipedia:Help:Lua - there may be specific notes for using Lua modules on (English) 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.
 * wikidata: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)
 * Extensions
 * - Provides basic Infobox functionality for the Scribunto extension.
 * - provides native support for the Scribunto extension for usage with
 * - provides a Scribunto Lua interface for the Variables extension
 * - Provides Wikibase (part of Wikidata project)