Jump to content

확장기능:Scribunto

From mediawiki.org
This page is a translated version of the page Extension:Scribunto and the translation is 4% complete.
This extension comes with MediaWiki 1.34 and above. 따라서 다시 다운로드하지 않아도 됩니다. 하지만 여전히 제공되는 별개의 지침을 따라야 합니다.
이 확장기능은 상단에 작성하여 실행할 수 있습니다. 이 확장 프로그램이 작동하기 위해서는 호스트에서 프로그램을 실행할 수 있는 권한이 있어야 합니다.
미디어위키 확장 기능 설명서
Scribunto
출시 상태: 안정
구현 파서 확장 기능
설명 미디어 위키 페이지에 스크립트 언어를 삽입하는 프레임워크를 제공합니다.
만든 이
  • Victor Vasiliev
  • Tim Starling
, 그 외 다른 개발자
최신 버전 지속적으로 업데이트 되고 있습니다.
호환성 정책 스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible.
MediaWiki >= 1.43
PHP 5.5+
라이선스 GPL-2.0-or-later AND MIT
다운로드
Module (ns:828), Talk_Module (ns:829)
  • $wgScribuntoDefaultEngine
  • $wgScribuntoSlowFunctionThreshold
  • $wgScribuntoGatherFunctionStats
  • $wgScribuntoUseGeSHi
  • $wgScribuntoUseCodeEditor
  • $wgScribuntoEngineConf
Quarterly downloads 429 (Ranked 7th)
Public wikis using 8,789 (Ranked 30th)
Scribunto 확장 기능 번역 (translatewiki.net에서 가능한 경우)
Vagrant 역할 scribunto
이슈 미해결 작업 · 버그 보고

Scribunto(라틴어로 적도록 도와주다라는 의미의 낱말)란 미디어위키 내에서 구문을 (위키내에 내장된 컴퓨터로 작동시킨다는 의미의) 임베딩을 가능하도록 도와주는 확장기능입니다.

현재는 Lua라는 프로그래밍 언어로만 지원하고 있습니다. Scribunto가 적용되었다는 건, Lua를 모듈이라는 이름공간안에서 작성하는 것이 가능하다는 의미입니다. Modules are run on normal wiki pages using the #invoke parser function and each module has a collection of functions, which can be called using wikitext syntax such as:

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

License

This extension contains code licensed GNU General Public License v2.0 or later (GPL-2.0+) as well as code licensed MIT License (MIT).

Requirements

PCRE version compatibility

PCRE 8.33+ is recommended. PCRE 8.33 was released in May 2013. You can see the version of PCRE 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";'
  • Scribunto will not work with versions of PCRE lower than 8.10.

CentOS 6 and RHEL 6 are stuck on PCRE 7 and need to be upgraded.

Updating to 8.33 on a server with an older version may be relatively complicated. See Updating to PCRE 8.33 or Higher for details.


PHP pcntl (LTS)

미디어위키 버전:
1.25 – 1.28

Scribunto versions for MediaWiki 1.25 to 1.28 required PHP's pcntl extension, which is only available on Unix/Linux platforms, if you want to use "LuaStandalone" (i.e. running in a separate child process). This requirement was removed in Scribunto for MediaWiki 1.29.

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

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

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 proc_open function is not restricted.[1]
  3. proc_terminate and shell_exec are not disabled in PHP.
  4. 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:
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).

Installation

  • 파일을 다운로드하고 Scribunto 폴더를 extensions/ 디렉토리에 넣어 주세요.
    개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Scribunto
  • 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
    wfLoadExtension( 'Scribunto' );
    $wgScribuntoDefaultEngine = 'luastandalone';
    
  • Set execute permissions for the Lua binaries bundled with this extension:
chmod a+x /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/yourOS/lua

[2]

  • Set type to httpd_sys_script_exec_t if SELinux is enforced:
chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/yourOS/lua

[2]

  • Yes 완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.


Vagrant 설치:

  • Vagrant 를 사용하고 있는 경우에는, vagrant roles enable scribunto --provision로 설치해주세요


Optional installation

Integrating extensions

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

미디어위키 버전:
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

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. See LuaSandbox for details and installation instructions.

If you initially installed the extension to use the Lua standalone binary, be sure to update LocalSettings.php with the following configuration setting:

$wgScribuntoDefaultEngine = 'luasandbox';

Configuration

The following configuration variables are available:

$wgScribuntoDefaultEngine
Select the engine. Valid values are the keys in $wgScribuntoEngineConf, which by default are 'luasandbox' or 'luastandalone'.
$wgScribuntoUseGeSHi
When 확장 기능:SyntaxHighlight is installed, set this true to use it when displaying Module pages. (MediaWiki 1.30 or earlier.)
$wgScribuntoUseCodeEditor
When 확장기능:코드 편집기 is installed, set this true to use it when editing Module pages. (MediaWiki 1.30 or earlier.)
$wgScribuntoEngineConf
An associative array for engine configuration. Keys are the valid values for $wgScribuntoDefaultEngine, and values are associative arrays of configuration data. Each configuration array must contain a 'class' key naming the ScribuntoEngineBase subclass to use.

LuaStandalone

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

$wgScribuntoEngineConf['luastandalone']['key'] = 'value';
luaPath
Specify the path to a Lua interpreter.
errorFile
Specify the 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
Specify the memory limit in bytes. Default 52428800 (50MB) (enforced using ulimit).
cpuLimit
Specify the CPU time limit in seconds (enforced using ulimit).
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']['key'] = 'value';
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.

Usage

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

Learning Lua

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:

The reference manual is also useful:

Lua environment

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.

The environment which scripts run in is not quite the same as in standard Lua. These differences are noted in Extension:Scribunto/Lua reference manual.

Debug console

Debug console usage example
See also: 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.

Troubleshooting

Troubleshooting using the clickable "Script error" link.

Note that red 스크립트 오류 messages are clickable and will provide more detailed information.

Lua 오류: 내부 오류: 인터프리터가 1 상태로 종료했습니다.

When using the LuaStandalone engine (this is the default), errors along the lines of "Lua 오류: 내부 오류: 인터프리터가 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.

Lua 오류: 내부 오류: 인터프리터가 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".

Lua 오류: 내부 오류: 인터프리터가 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 파브리케이터 and participate in determining why the XCPU signal isn't being caught.

Lua 오류: 내부 오류: 인터프리터가 126 상태로 종료했습니다.

When using the LuaStandalone engine (this is the default), errors along the lines of "Lua 오류: 내부 오류: 인터프리터가 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.

Design documents

Other pages

See also

General
  • Lua Wikibase client - functionality for the Scribunto extension.
  • 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)
Extensions

Notes

  1. i.e. Scribunto will not work if proc_open is listed in the disable_functions array in your server's "php.ini" file. If it is, you may see an error message like proc_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 set open_basedir in the PHP settings for your domain or subdomain. Try changing {WEBSPACEROOT}{/}{:}{TMP}{/} to {WEBSPACEROOT}{/}{:}{TMP}{/}{:}/dev/null{:}/bin/bash.
  2. 2.0 2.1 2.2 The name of the engines folder changed from lowercase to capitalised in 2022.