 Release status: stable | |
|---|---|
| Implementation | Parser extension |
| Description | Provides a framework for embedding scripting languages into MediaWiki pages |
| Author(s) |
|
| Latest version | Continuous updates |
| Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| PHP | 5.5+ |
| License | GPL-2.0-or-later AND MIT |
| Download | |
Module (ns:828), Talk_Module (ns:829) | |
| |
| |
| Translate the Scribunto extension if it is available at translatewiki.net | |
| Vagrant role | scribunto |
| Issues | Open tasks ·Report a bug |
TheScribunto (Latin: "they shall write!") extension gives framework and allows for embedding ofscripting languages into MediaWiki pages.
Currently the only supported scripting language isLua.Scribunto Lua scripts go in a namespace calledModule.Modules are run on normal wiki pages using the#invokeparser function and each module has a collection offunctions, which can be called using wikitext syntax such as:
{{#invoke:Module_name |function_name |arg1 |arg2 |arg3 ... }}Scribunto folder to yourextensions/ directory.cdextensions/gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/ScribuntowfLoadExtension('Scribunto');$wgScribuntoDefaultEngine='luastandalone';
Done – Navigate toSpecial:Version on your wiki to verify that the extension is successfully installed.
Vagrant installation:
vagrant roles enable scribunto --provisionPCRE 8.33+ is required.You can see the version ofPCRE used by PHP by viewing a phpinfo() web page, or from the command line with the following command:
php-r'echo "pcre: " . ( extension_loaded( "pcre" ) ? PCRE_VERSION : "no" ) . "\n";'PHP needs to have thembstring 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";'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:
proc_open function is not restricted.[1]proc_terminate andshell_exec are not disabled in PHP.
Note: Execute permissions may need to be set; for example, in Linux use:chmod755/path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/luachcon-thttpd_sys_script_exec_t/path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua
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 fromhttp://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 toSpectre and bitrot concerns (phab:T184156).
For a more pleasant user interface, with syntax highlighting and a code editor with autoindent, install the following extensions:
See the documentation for each extension for additional configuration options.
We have developed a PHP extension written in C called LuaSandbox.It can be used as an alternative to the standalone binary, and will provide improved performance.SeeLuaSandbox for details and installation instructions.
If you initially installed the extension to use the Lua standalone binary, be sure to updateLocalSettings.php with the following configuration setting:
$wgScribuntoDefaultEngine='luasandbox';
The following configuration variables are available:
$wgScribuntoEngineConf, which by default are'luasandbox' or'luastandalone'.$wgScribuntoDefaultEngine, and values are associative arrays of configuration data. Each configuration array must contain a'class' key naming theScribuntoEngineBase subclass to use.The following keys are used in$wgScribuntoEngineConf forScribunto_LuaStandaloneEngine.Generally you'd set these as something like
$wgScribuntoEngineConf['luastandalone']['key']='value';
| key | value | description |
|---|---|---|
| luaPath | null | Path to the Lua interpreter. |
| errorFile | null | Path to a file, writable by the web server user, where the error and debugging output from the standalone interpreter will be logged. Error output produced by the standalone interpreter are not logged by default. Configure logging with: $wgScribuntoEngineConf['luastandalone']['errorFile']='/path/to/file.log'; |
| memoryLimit | 52,428,800 (50MB) | Memory limit in bytes (enforced using ulimit). |
| cpuLimit | 7 | CPU time limit in seconds (enforced using ulimit). |
| allowEnvFuncs | false | Settrue to allow use of setfenv and getfenv in modules. |
The following keys are used in$wgScribuntoEngineConf forScribunto_LuaSandboxEngine.Generally you'd set these as something like
$wgScribuntoEngineConf['luasandbox']['key']='value';
| key | value | description |
|---|---|---|
| memoryLimit | 52,428,800 (50MB) | Memory limit in bytes. |
| cpuLimit | 7 | CPU time limit in seconds. |
| profilerPeriod | 0.02 | Time between polls in sections for the Lua profiler. |
| allowEnvFuncs | false | Settrue to allow use of setfenv and getfenv in modules. |
Scripts go in a new namespace calledModule.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 is a simple programming language intended to be accessible to beginners.For a quick crash-course on Lua, tryLearn Lua in 15 Minutes.
The best comprehensive introduction to Lua is the bookProgramming 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:
The reference manual is also useful:
In Lua, the set of all global variables and functions is called an environment.
Each{{#invoke:}} call runs in a separate environment.Variables defined in one{{#invoke:}} will not be available from another.This restriction was necessary to maintain flexibility in the wikitext parser implementation.
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.
Note that redScript error messages are clickable and will provide more detailed information.
Make sure execute permissions are set for the Lua binaries bundled with this extension:[2]
chmoda+x/path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/$YOUR_OS/luaSet type tohttpd_sys_script_exec_t if SELinux is enforced:[2]
chcon-thttpd_sys_script_exec_t/path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/yourOS/lua
When using the LuaStandalone engine (this is the default), errors along the lines of"Lua error: Internal error: The interpreter exited with 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 usingIIS/Windows, this appears to be solved by commenting out line 132 in$wiki/extensions/Scribunto/includes/engines/LuaStandalone/LuaStandaloneInterpreter.php.In other words, change$cmd = '"' . $cmd . '"'; to// $cmd = '"' . $cmd . '"';.
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 linememory_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 inLocalSettings.php as a line:
$wgScribuntoEngineConf['luastandalone']['memoryLimit']=209715200;# bytes
Finally, depending on the server configuration, some installations may be helped by adding anotherLocalSettings.php line
$wgMaxShellMemory=204800;# in KB
Note that all 3 memory limits are given in different units.
If you're using an ARM architecture processor like on a RaspberryPi you'll face the errorLua 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 yourlua5_1_5_linux_32_generic directory or set in your LocalSettings.php:
$wgScribuntoEngineConf['luastandalone']['luaPath']='/usr/bin/lua5.1';
At present don't setwgScribuntoEngineConf 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 inPhabricator 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"Lua error: Internal error: The interpreter exited with status 126." may be generated if the standalone Lua interpreter cannot be executed.This generally arises from either of two causes:
'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.sudo apt install lua5.1) and add to the LocalSettings.php file $wgScribuntoEngineConf['luastandalone']['luaPath'] = '/usr/bin/lua5.1';Check the MediaWiki, PHP, or webserver logs for more details on the exception, or temporarily set$wgShowExceptionDetails totrue.
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 fromgerrit: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.
Errors here include:
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
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 atw: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.
Make sure your extension version is applicable to your MediaWiki version.
This extension contains code licensed GNU General Public License v2.0 or later (GPL-2.0+) as well as code licensed MIT License (MIT).
proc_open is listed in thedisable_functions array in your server's "php.ini" file. If it is, you may see an error message likeproc_open(): open_basedir restriction in effect. File(/dev/null) is not within the allowed path(s):. If you are using Plesk and have been granted sufficient permissions, you may be able to setopen_basedir in the PHP settings for your domain or subdomain. Try changing{WEBSPACEROOT}{/}{:}{TMP}{/} to{WEBSPACEROOT}{/}{:}{TMP}{/}{:}/dev/null{:}/bin/bash. | This extension is being used on one or moreWikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia'sCommonSettings.php andInitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki'sSpecial:Version page. |
 | This extension is included in the following wiki farms/hosts and/or packages:This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |