Расширение Scribunto (лат.: «пусть они напишут») позволяет встраивать в страницы MediaWiki модули, написанные на сценарных языках программирования.
На данный момент единственный поддерживаемый язык программирования — Lua.
Скрипты Scribunto размещаются в пространстве имён «Модуль».
Модули запускаются на обычных страницах вики с использованием функции #invokeparser function, и каждый модуль имеет набор функций, которые можно вызывать с помощью синтаксиса викитекста, например.
Скачайте и распакуйте файл(ы) в папку с названием Scribunto в вашей папке extensions/. Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:
Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Установка Vagrant:
Если вы используете Vagrant, установите с помощью vagrant roles enable scribunto --provision
Требования
Совместимость с версиями PCRE
Рекомендуется версия PCRE 8.33+.
PCRE 8.33 была выпущена в мае 2013 года.
Вы можете просмотреть используемую PHP версию PCRE на веб-странице phpinfo(), или из командной строки, выполнив следующую команду:
Операционные системы CentOS 6 и RHEL 6 ограничены версией PCRE 7 и должны быть обновлены для работы со Scribunto.
Обновление до версии 8.33 на сервере, использующем более старую версию, может быть проблематично.
См. Updating to PCRE 8.33 or Higher для более детальной информации.
Если на вашем сервере используется SELinux в режиме «Enforcing», вам может потребоваться установить правильный контекст для двоичных файлов. Пример для RHEL/CentOS 7:
P.S. Проверьте свою версию расширения, чтобы увидеть, написано ли имя папки engine заглавными буквами или полностью строчными.[2]
Additional binaries
Дополнительные двоичные дистрибутивы Lua, которые могут потребоваться для вашего веб-сервера, если его операционная система отсутствует в списке выше, можно получить за http://luabinaries.sourceforge.net/ или из вашего дистрибутива Linux.
Only binary files for Lua 5.1.x are supported.
После установки соответствующего двоичного файла на веб-сервере настройте местоположение файла с помощью:
# Где Lua — имя двоичного файла# например, SourceForge LuaBinaries 5.1.5 - Выпуск 2 назовите двоичный файл lua5.1$wgScribuntoEngineConf['luastandalone']['luaPath']='/path/to/binaries/lua5.1';
Обратите внимание, что вам не следует добавлять указанную выше строку, если вы не уверены, что встроенные двоичные файлы Scribunto у вас не работают.
LuaJIT, хотя теоретически совместим, не поддерживается.
Дополнительные параметры конфигурации см. в документации по каждому расширению.
LuaSandbox
Мы разработали написанное на C расширение для PHP под названием LuaSandbox.
Это расширение может быть использовано как альтернатива отдельному исполняемому файлу и обеспечивает более высокую производительность.
См. LuaSandbox для подробностей об этом расширении и инструкции по его установке.
Если вы изначально устанавливали Scribunto для работы с отдельным двоичным файлом Lua, обязательно обновите LocalSettings.php со следующей настройкой конфигурации:
$wgScribuntoDefaultEngine='luasandbox';
Настройка
Доступны следующие переменные конфигурации:
$wgScribuntoDefaultEngine
Выбирает тип движка. Допустимые значения — ключи массива $wgScribuntoEngineConf, по умолчанию это 'luasandbox' и 'luastandalone'.
$wgScribuntoEngineConf
Ассоциативный массив для настройки движков. Ключи — допустимые значения переменной $wgScribuntoDefaultEngine, а значения — ассоциативные массивы с параметрами конфигурации. Каждый массив конфигурации должен содержать ключ 'class', называющий используемый подкласс класса ScribuntoEngineBase.
luastandalone
В $wgScribuntoEngineConf для Scribunto_LuaStandaloneEngine используются нижеперечисленные ключи.
Обычно их задают примерно таким способом:
Указывает путь к файлу, к которому учётная запись веб-сервера имеет доступ на запись. В этот файл будут записываться ошибки и отладочный вывод самостоятельного интерпретатора.
По умолчанию не ведётся запись ошибок, выводимых самостоятельным интерпретатором. Вы можете настроить эту запись как в следующей строке:
Указывает время между опросами в секциях для профилировщика Lua.
allowEnvFuncs
false
Задайте как true, чтобы разрешить использование в модулях функций setfenv и getfenv.
Использование
Скрипты размещаются в новом пространстве имён Модуль.
Каждый модуль содержит набор функций, которые могут быть вызваны из вики-текста с помощью синтаксиса:
Lua — простой язык программирования, который должен быть доступен для новичков.
Для быстрого введения в язык, попробуйте Learn Lua in 15 Minutes.
Лучшим комплексным введением в Lua служит книга Programming in Lua.
Её первое издание (для Lua 5.0) доступно в сети и в целом подходит для версии 5.1, используемой Scribunto:
Окружением в Lua называется набор глобальных переменных и функций.
Каждый вызов {{#invoke:}} производится в отдельном окружении.
Переменные, определённые в одном {{#invoke:}}, не будут доступны из прочих.
Это ограничение было необходимо для поддержки гибкости в реализации парсера вики-текста.
Окружение, в котором работают скрипты, не совсем то же, что в стандартном Lua. Их различия описаны на странице Extension:Scribunto/Справочник Lua.
При редактировании модуля на Lua под окном редактирования располагается так называемая отладочная консоль.
В ней может исполняться код на Lua без необходимости сохранения и даже создания редактируемого модуля.
Поиск и устранение неисправностей
Поиск ошибок с помощью клика по ссылке Ошибка скрипта.
Обратите внимание, что красные сообщения Ошибка скрипта кликабельны и могут предоставить детальную информацию.
Невозможно выполнить extensions/Scribunto/includes/Engines/LuaStandalone/binaries
Убедитесь, что для двоичных файлов Lua, входящих в комплект этого расширения, установлены разрешения на выполнение:[2]
Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 1.
При использовании движка LuaStandalone (он используется по умолчанию) могут возникать ошибки типа "Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 1.", если автономный интерпретатор Lua не может быть запущен или возникают различные ошибки времени выполнения.
Чтобы получить больше информации, присвойте путь к файлу параметру $wgScribuntoEngineConf['luastandalone']['errorFile'].
Ошибки интерпретатора будут логгироваться в указанный файл, что должно помогать в отслеживании проблемы.
Информация в журнале отладки включает в себя отладочную информацию, поэтому ее так много.
Вы можете игнорировать любую строку, начинающуюся с «TX» или «RX».
Если вы настраиваете Scribunto и используете IIS/Windows, то эта проблема, по-видимому, решается путем комментирования строки 132 в $wiki/extensions/Scribunto/includes/engines/LuaStandalone/LuaStandaloneInterpreter.php.
Другими словами, поменяйте $cmd = '"' . $cmd . '"'; на // $cmd = '"' . $cmd . '"';.
Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 2.
При использовании движка LuaStandalone (это значение по умолчанию) статус 2 указывает на ошибки выделения памяти, вероятно, вызванные настройками, которые выделяют недостаточно места в памяти для PHP или Lua, или для обоих.
Назначение пути к файлу $wgScribuntoEngineConf['luastandalone']['errorFile'] и изучение этого вывода может оказаться полезным при диагностике ошибок распределения памяти.
Увеличьте выделение PHP в вашей конфигурации PHP; добавьте строку memory_limit = 200M.
Выделение 200 МБ часто бывает достаточным (начиная с MediaWiki 1.24), но при необходимости его можно увеличить.
Установите выделение памяти Scribunto в LocalSettings.php в виде строки:
$wgScribuntoEngineConf['luastandalone']['memoryLimit']=209715200;# в байтах
Наконец, в зависимости от конфигурации сервера, некоторые установки могут быть улучшены путем добавления еще одной строки LocalSettings.php.
$wgMaxShellMemory=204800;# в КБ
Обратите внимание, что лимита памяти задаются в разных единицах.
Ошибка Lua: Внутренняя ошибка: 2. на архитектуре ARM
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.
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
Установленный по умолчанию интерпретатор Lua показывает:
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,
посмотрите на часть «Intel 80386», это определенно не так.
Проверьте в /usr/bin, какая версия Lua установлена в вашей системе. Если у вас установлен lua5.1, вы можете либо скопировать интерпретатор в каталог lua5_1_5_linux_32_generic, либо установить его в каталоге LocalSettings.php:
В настоящее время не устанавливайте wgScribuntoEngineConf на /usr/bin/lua5.3, это приведет к «Внутренней ошибке 1».
Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 24.
При использовании движка LuaStandalone (это значение по умолчанию) статус 24 указывает на ошибки ограничения времени ЦП, хотя они должны генерировать сообщение «Время, выделенное для выполнения скриптов, истекло».
It would be useful to file a task in Фабрикатор and participate in determining why the XCPU signal isn't being caught.
Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 126.
При использовании движка LuaStandalone (по умолчанию), могут генерироваться ошибки наподобие "Ошибка Lua: Внутренняя ошибка: Интерпретатор завершил работу со статусом 126.", если интерпретатор Lua не может быть запущен.
В большинстве случаев это происходит в двух случаях:
У исполняемого файла lua не задано разрешение на исполнение (x). Установите разрешения как указано в разделе #Установка.
Сервер не позволяет запуск файлов из места установки файла, например, файловая система смонтирована с флагом 'noexec'. Чаще всего это происходит с серверами с общим хостингом. К средствам устранения этой проблемы относятся настройка $wgScribuntoEngineConf['luastandalone']['luaPath'] так, чтобы он указывал на двоичный файл Lua 5.1, установленный в исполняемом каталоге, или настройка или убеждение общего хоста изменить настройку, предотвращающую выполнение.
На процессоре на базе ARM вам, возможно, придется установить Lua 5.1 для ARM (в Debian/Ubuntu запустите sudo apt install lua5.1) и добавить в файл LocalSettings.php $wgScribuntoEngineConf['luastandalone']['luaPath'] = '/usr/bin/lua5.1';
Ошибки вроде: Fatal exception of type MWException
Проверьте журналы MediaWiki, PHP или веб-сервера для получения более подробной информации об исключении или временно установите $wgShowExceptionDetails на true.
версия 'GLIBC_2.11' не найдена
Если вышеприведенные действия приводят к ошибкам типа «версия 'GLIBC_2.11' не найдена», это означает, что версия стандартной библиотеки C в вашей системе слишком устарела для двоичных файлов, поставляемых с Scribunto.
Вам следует обновить библиотеку C или использовать версию Lua 5.1, скомпилированную для установленной у вас библиотеки C.
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).
Если вы скопируете двоичные файлы lua из Scribunto master (или из gerrit:77905), этого должно быть достаточно, если вы не можете или не хотите обновлять свою библиотеку C.
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.
Лицензия
Это расширение содержит код, распространяемый по лицензии GNU General Public License v2.0 или более поздней версии (GPL-2.0+), а также код, распространяемый по лицензии MIT License (MIT).
Lua scripting - Wikimedia activity page describing deployment plan to Wikimedia sites.
Расширение:Scribunto/Справочник Lua - The reference about the Lua language, as well as its standard libraries and common Scribunto modules supported on Wikimedia sites.
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
Capiunto - Provides basic infobox functionality for the Scribunto extension.
↑
то есть Scribunto не будет работать, если proc_open указан в массиве disable_functions в файле "php.ini" вашего сервера. Если это так, вы можете увидеть сообщение об ошибке, например proc_open(): open_basedir restriction in effect. File(/dev/null) is not within the allowed path(s): Если вы используете Plesk и вам предоставлены достаточные разрешения, вы можете установить open_basedir в настройках PHP для своего домена или поддомена. Попробуйте изменить {WEBSPACEROOT}{/}{:}{TMP}{/} на {WEBSPACEROOT}{/}{:}{TMP}{/}{:}/dev/null{:}/bin/bash.
Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki.
Это расширение включено в следующие вики-фермы/хостинги и/или пакеты:
Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения.
Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Заметка: Возможно, потребуется установить разрешения на выполнение; например, в Linux используйте:
