Extension:Scribunto
Scribunto リリースの状態: 安定 |
|
---|---|
実装 | パーサー拡張機能 |
説明 | MediaWiki ページにスクリプト言語を埋め込むためのフレームワークを提供する |
作者 |
|
最新バージョン | 継続的な更新 |
互換性の方針 | MediaWiki とともにリリースされるスナップショット。 master には後方互換性がありません。 |
PHP | 5.5+ |
ライセンス | GPL-2.0-or-later AND MIT |
ダウンロード | |
Module (ns:828), Talk_Module (ns:829) |
|
|
|
四半期ごとのダウンロード数 | 457 (Ranked 6th) |
使用中の公開ウィキ | 8,789 (Ranked 30th) |
translatewiki.net で翻訳を利用できる場合は、Scribunto 拡張機能の翻訳にご協力ください | |
Vagrant role | scribunto |
問題点 | 未解決のタスク · バグを報告 |
The Scribunto (Latin: "they shall write/let them write (in the future)") extension allows for embedding scripting languages in MediaWiki.
現在、対応しているスクリプト言語は Lua のみです。 Scribunto Lua スクリプトは、Module という名前空間に配置されます。 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 ... }}
インストール
- ダウンロードして、ファイルを
extensions/
フォルダー内のScribunto
という名前のディレクトリ内に配置します。
開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Scribunto - 以下のコードを LocalSettings.php ファイルの末尾に追加します:
wfLoadExtension( 'Scribunto' ); $wgScribuntoDefaultEngine = 'luastandalone';
- 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。
Vagrantでのインストール:
- Vagrant を使用している場合は、
vagrant roles enable scribunto --provision
でインストールしてください。
要件
PCREのバージョン互換性
PCRE 8.33+が推奨されます。 PCRE 8.33 was released in May 2013. PHP で使用されている PCRE のバージョンは、phpinfo() の Web ページを見るか、コマンドラインから以下のコマンドを実行することで確認できます:
php -r 'echo "pcre: " . ( extension_loaded( "pcre" ) ? PCRE_VERSION : "no" ) . "\n";'
- Scribunto は PCRE の 8.10 未満のバージョンでは動作しません。
- PCRE 8.32 has a bug that will cause it to reject certain non-character codepoints, which will cause errors in the mw.html module.
CentOS 6 と RHEL 6 は PCRE 7 で止まっているため、アップグレードする必要があります。
古いバージョンのサーバーで 8.33 に更新するのは、比較的複雑な場合があります。 See Updating to PCRE 8.33 or Higher for details.
PHP の mbstring 拡張機能
PHPはmbstring拡張機能を有効にする必要があります。
mbstring サポートが有効かどうかは、phpinfo() のウェブページを見るか、コマンドラインで以下のコマンドを実行することで確認できます:
php -r 'echo "mbstring: " . ( extension_loaded( "mbstring" ) ? "yes" : "no" ) . "\n";'
Lua バイナリ
バンドルされたバイナリ
Scribuntoは、Linux(x86およびx86-64)、Mac OS X Lion、Windows(32および64ビット)用のLuaバイナリディストリビューションにバンドルされています。
Scribuntoは、次のような場合に、すぐに使えるはずです。
- Webサーバーは、上記のプラットフォームのいずれかで実行されます。
- PHP's
proc_open
function is not restricted.[1] proc_terminate
andshell_exec
are not disabled in PHP.- あなたのウェブサーバーは、MediaWikiツリー内のバイナリファイルの実行を許可するように設定されています。
- 注: 実行権限を設定する必要がある場合があります。例えば、Linuxでは次のように使用します。
- 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:
chmod 755 /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua
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]
追加バイナリ
WebサーバーのOSが上記のリストにない場合、追加のLuaバイナリ・ディストリビューションをhttp://luabinaries.sourceforge.net/またはお使いのLinuxディストリビューションから入手することができます。
Lua 5.1.x用のバイナリファイルのみ対応しています。
ウェブサーバーに適切なバイナリファイルをインストールしたら、そのファイルの場所を
# Luaはバイナリファイルの名前です。
# e.g. SourceForge LuaBinaries 5.1.5 - Release 2 name the binary file lua5.1
$wgScribuntoEngineConf['luastandalone']['luaPath'] = '/path/to/binaries/lua5.1';
Scribuntoのビルトインバイナリが動作しないことが確認されていない限り、上記の行を追加してはいけないことに注意してください。
LuaJITは理論的には互換性がありますが、サポートされていません。
The support was removed due to Spectre and bitrot concerns (phab:T184156).
オプションのインストール
拡張機能の統合
構文強調や自動インデント機能を備えたコード エディターなど、より快適なユーザー インターフェイスを実現するために、以下の拡張機能をインストールしてください:
See the documentation for each extension for additional configuration options.
Luaサンドボックス
LuaSandbox という C 言語で書かれた PHP 拡張機能を開発しました。 スタンドアロンのバイナリの代替として使用でき、パフォーマンスが向上します。 詳細とインストール方法は LuaSandbox を参照してください。
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';
設定
以下の設定変数が利用可能です。
- $wgScribuntoDefaultEngine
- エンジンを選択します。 Valid values are the keys in
$wgScribuntoEngineConf
, which by default are'luasandbox'
or'luastandalone'
. - $wgScribuntoEngineConf
- エンジン構成用の連想配列です。 Keys are the valid values for
$wgScribuntoDefaultEngine
, and values are associative arrays of configuration data. Each configuration array must contain a'class'
key naming theScribuntoEngineBase
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']['キー'] = '値';
- 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.
使用法
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
Luaの学習
Luaはシンプルなプログラミング言語で、初心者でもわかりやすいです。 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の環境
Luaでは、全てのグローバル変数と関数の集合を環境と呼んでいます。
{{#invoke:}}
のコールは別の環境で実行されます。
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 red スクリプトエラー messages are clickable and will provide more detailed information.
Cannot execute extensions/Scribunto/includes/Engines/LuaStandalone/binaries
この拡張機能にバンドルされているLuaバイナリの実行権限を設定します。[2]
chmod a+x /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/$YOUR_OS/lua
Set type to httpd_sys_script_exec_t
if SELinux is enforced:[2]
chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/includes/Engines/LuaStandalone/binaries/yourOS/lua
Lua エラー: 内部エラー: インタープリターは終了コード 1 で終了しました。
LuaStandaloneエンジン(既定)を使用する場合、スタンドアロンLuaインタープリターが実行できないか、さまざまなランタイムエラーが発生すると、"Lua エラー: 内部エラー: インタープリターは終了コード 1 で終了しました。"のようなエラーを生成することがあります。
詳細情報を得るには、$wgScribuntoEngineConf['luastandalone']['errorFile']
にファイルパスを割り当てます。
インタープリターのエラーログは指定されたファイルに出力され、問題の追跡に役立つはずです。
デバッグログにはデバッグ情報が含まれるため、かなり情報量が多くなります。
"TX"または"RX"で始まる行は無視してかまいません。
If you're setting up Scribunto and are using IIS/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 . '"';
.
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; # バイト単位
Finally, depending on the server configuration, some installations may be helped by adding another LocalSettings.php
line
$wgMaxShellMemory = 204800; # 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 Phabricator 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. Cのライブラリを改良するか、インストールされているCライブラリ用にコンパイルされたLua 5.1のバージョンを使用する必要があります。 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.
ライセンス
This extension contains code licensed GNU General Public License v2.0 or later (GPL-2.0+) as well as code licensed MIT License (MIT).
Design documents
- Extension:Scribunto/Parser interface design
- Extension:Scribunto/Victor's API proposal
- Extension:Scribunto/Documentation specification
- Extension:Scribunto/Tim's draft roadmap
その他のページ
- Extension:Scribunto/Deployment priorities
- Extension:Scribunto/Brainstorming
- Lua scripting - Wikimedia activity page describing deployment plan to Wikimedia sites.
- Extension:Scribunto/Lua リファレンス マニュアル - The reference about the Lua language, as well as its standard libraries and common Scribunto modules supported on Wikimedia sites.
- Extension:Scribunto/Lua 5.2 changes - A list of known changes in Lua 5.2 that may cause code written in 5.1 to function unexpectedly.
- Extension:Scribunto/モジュールの例
- Extension:Scribunto/Example extension - Code for example extensions extending the Scribunto library.
- Extension:Scribunto/We use Lua
関連項目
- 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
- Capiunto - Provides basic infobox functionality for the Scribunto extension.
- Semantic Scribunto - provides native support for the Scribunto extension for usage with Semantic MediaWiki
- VariablesLua - provides a Scribunto Lua interface for the Variables extension
- Wikibase Client - provides ウィキベース (part of Wikidata project)
外部リンク
注記
- ↑
i.e. Scribunto will not work if
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
. - ↑ 2.0 2.1 2.2 The name of the engines folder changed from lowercase to capitalised in 2022.
この拡張機能は 1 つ以上のウィキメディアのプロジェクトで使用されています。 これはおそらく、この拡張機能が安定していて高いトラフィックのウェブサイトでも十分に動作することを意味します。 この拡張機能がインストールされている場所を確認するには、ウィキメディアの設定ファイル CommonSettings.php および InitialiseSettings.php 内で、この拡張機能の名前を探してください。 特定のウィキにインストールされている拡張機能の完全な一覧は、そのウィキの Special:Version ページにあります。 |
この拡張機能は以下のウィキ ファーム/ウィキ ホスト/パッケージに含まれています: これは正式な一覧ではありません。 一部のウィキ ファーム/ウィキ ホスト/パッケージは、ここに記載されていなくてもこの拡張機能を含んでいる場合があります。 必ずご利用のウィキ ファーム、ウィキ ホスト、バンドルで確認してください。 |