Extension:Scribunto/ru

Расширение Scribunto (лат.: «пусть они напишут») позволяет встраивать в страницы MediaWiki модули, написанные на сценарных языках программирования.

На данный момент единственный поддерживаемый язык программирования — Lua. Скрипты Scribunto размещаются в пространстве имён «Модуль».

Лицензия
Это расширение содержит код, распространяемый по лицензии GNU General Public License v2.0 или более поздней версии (GPL-2.0+), а также код, распространяемый по лицензии MIT License (MIT).

Совместимость с версиями PCRE
Рекомендуется версия PCRE 8.33+. Вы можете просмотреть используемую PHP версию PCRE на веб-странице phpinfo, или из командной строки, выполнив следующую команду:


 * Scribunto не будет работать, если установлена версия PCRE раньше 8.10.
 * В PCRE 8.31 содержится ошибка с JIT-разбором паттернов, которая приводит к неработоспособности некоторых паттернов при использовании HHVM.
 * В PCRE 8.32 есть ошибка, ввиду которой эта библиотека не может принимать некоторые несимвольные позиции Юникода, что приводит к ошибкам в модуле mw.html.

Операционные системы CentOS 6 и RHEL 6 ограничены версией PCRE 7 и должны быть обновлены для работы со Scribunto.

Обновление до версии 8.33 на сервере, использующем более старую версию, может быть проблематично. Смотрите статью обновление на PCRE 8.33 или выше для подробностей о таком обновлении.

Расширение PHP pcntl (LTS)
Версии Scribunto для MediaWiki 1.25 — 1.28 требовали наличия расширения pcntl для PHP, которое доступно только на платформах под управлением ОС Unix/Linux. Это требование действовало только при использовании LuaStandalone (т. е. выполнении Lua в отдельном дочернем процессе). Это расширение сделано необязательным в Scribunto для MediaWiki 1.29.

Вы можете просмотреть, включена ли поддержка pcntl, на веб-странице phpinfo, или из командной строки, выполнив следующую команду:

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
Мы разработали написанное на C расширение для PHP под названием LuaSandbox. Это расширение может быть использовано как альтернатива отдельному исполняемому файлу и обеспечивает более высокую производительность. См. для подробностей об этом расширении и инструкции по его установке.

Если вы изначально устанавливали Scribunto для работы с отдельным двоичным файлом Lua, вам потребуется добавить в LocalSettings.php строку $2.

Настройка
Доступны следующие переменные конфигурации:
 * $wgScribuntoDefaultEngine : Выбирает тип движка. Допустимые значения — ключи массива $wgScribuntoEngineConf, по умолчанию это 'luasandbox' и 'luastandalone'.
 * $wgScribuntoUseGeSHi : Если установлено, задайте эту переменную как true, чтобы это расширение использовалось при отображении модулей. (MediaWiki 1.30 или ранее.)
 * $wgScribuntoUseCodeEditor : Если установлено, задайте эту переменную как true, чтобы это расширение использовалось при редактировании модулей. (MediaWiki 1.30 или ранее.)
 * $wgScribuntoEngineConf : Ассоциативный массив для настройки движков. Ключи — допустимые значения переменной $wgScribuntoDefaultEngine, а значения — ассоциативные массивы с параметрами конфигурации. Каждый массив конфигурации должен содержать ключ 'class', называющий используемый подкласс класса ScribuntoEngineBase.

LuaStandalone
В $wgScribuntoEngineConf для Scribunto_LuaStandaloneEngine используются нижеперечисленные ключи. Обычно их задают примерно таким способом:


 * luaPath: Указывает путь к интерпретатору Lua.
 * errorFile:
 * Указывает путь к файлу, к которому учётная запись веб-сервера имеет доступ на запись. В этот файл будут записываться ошибки и отладочный вывод самостоятельного интерпретатора.
 * По умолчанию не ведётся запись ошибок, выводимых самостоятельным интерпретатором. Вы можете настроить эту запись как в следующей строке:


 * memoryLimit: Указывает ограничение памяти в байтах, применяемое к процессу самостоятельного интерпретатора на Linux (осуществляется средствами ulimit).
 * cpuLimit: Указывает ограничение времени ЦП в секундах, применяемое к процессу самостоятельного интерпретатора на Linux (осуществляется средствами ulimit).
 * allowEnvFuncs: Задайте как true, чтобы разрешить использование в модулях функций setfenv и getfenv.

LuaSandbox
В $wgScribuntoEngineConf для Scribunto_LuaSandboxEngine используются нижеперечисленные ключи. Обычно их задают примерно таким способом:


 * memoryLimit : Указывает лимит памяти в байтайх.
 * cpuLimit : Указывает лимит процессорного времени в секундах.
 * profilerPeriod : Указывает время между опросами в секциях для профилировщика Lua.
 * allowEnvFuncs : Задайте как true, чтобы разрешить использование в модулях функций setfenv и getfenv.

Использование
Скрипты размещаются в новом пространстве имён Модуль. Каждый модуль содержит набор функций, которые могут быть вызваны из вики-текста с помощью синтаксиса:

Изучение Lua
Lua — простой язык программирования, который должен быть доступен для новичков. Для быстрого введения в язык, попробуйте Learn Lua in 15 Minutes.

Лучшим комплексным введением в Lua служит книга Programming in Lua. Её первое издание (для Lua 5.0) доступно в сети и в целом подходит для версии 5.1, используемой Scribunto:


 * Programming in Lua (пролистайте ниже рекламы книг, чтобы найти текст)

Также полезен справочник:

Окружение Lua
Окружением в Lua называется набор глобальных переменных и функций.

Каждый вызов производится в отдельном окружении. Переменные, определённые в одном, не будут доступны из прочих. Это ограничение было необходимо для поддержки гибкости в реализации парсера вики-текста.

Отладочная консоль



 * См. также: 

При редактировании модуля на Lua под окном редактирования располагается так называемая отладочная консоль. В ней может исполняться код на Lua без необходимости сохранения и даже создания редактируемого модуля.

Поиск и устранение неисправностей


Обратите внимание, что красные сообщения кликабельны и могут предоставить детальную информацию.

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. Чтобы получить больше информации, присвойте путь к файлу параметру. Ошибки интерпретатора будут логгироваться в указанный файл, что должно помогать в отслеживании проблемы. 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.

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

Обратите внимание, что лимита памяти задаются в разных единицах.

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.

При использовании движка LuaStandalone (по умолчанию), могут генерироваться ошибки наподобие "", если интерпретатор Lua не может быть запущен. В большинстве случаев это происходит в двух случаях:


 * У исполняемого файла lua не задано разрешение на исполнение . Установите разрешения как указано в разделе #Установка.
 * Сервер не позволяет запуск файлов из места установки файла, например, файловая система смонтирована с флагом . Чаще всего это происходит с серверами с общим хостингом. 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.

Ошибки вроде: 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.]]

Другие страницы

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

Смотрите также

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