Руководство:Разработка расширений

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Manual:Developing extensions and the translation is 26% complete.

Outdated translations are marked like this.
Other languages:
العربية • ‎български • ‎Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Latina • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎سنڌي • ‎中文
Gnome-preferences-other.svg Расширения:Manual:Extensions РазработкаManual:Developing extensions Теги расширенийManual:Tag extensions Руководство:функции парсераManual:Parser functions ПрерыванияManual:Hooks Служебные страницыManual:Special pages Стили оформления (skins)Manual:Skins Волшебные словаManual:Magic words APIAPI:Extensions
Расширения MediaWiki

Каждое расширение состоит из трех частей:

  1. Установка
  2. Выполнение
  3. Локализация

Минимальное расширение будет состоять из трех файлов, по одному для каждой части:

MyExtension/extension.json
Хранит инструкции установки. Имя файла должно быть extension.json. (До MediaWiki 1.25 инструкции установки были в файле MyExtension/MyExtension.php, (?)с таким же именем как у расширения. Многие расширения имеют прослойки обратной совместимости в этом PHP файле.)
MyExtension/MyExtension_body.php
Хранит код выполнения расширения Имя файла MyExtension_body.php является традиционным, но не обязательным. Если ваше расширение является сложным и включает в себя несколько PHP файлов, вы должны следовать соглашению размещать свой код реализации в подкаталоге с именем MyExtension/includes (хотя расширения Example и BoilerPlate не следуют этому соглашению). Например смотри расширение Semantic MediaWiki.
MyExtension/i18n/*.json
Хранит информацию локализации для расширения.
Изначально, расширениями были отдельные файлы, и вы все еще можете найти некоторые примеры этого устаревшего стиля.

При разработке расширения, замените MyExtension на имя вашего расширения. Используйте имена в стиле UpperCamelCase для директории и PHP файлов; это общее соглашение по именованию файлов.[1]

($git repo - хорошая начальная точка для вашего расширения. Также посмотрите cookiecutter template для расширений MediaWiki на GitHub.)

Три части расширения, установка, выполнение и локализация так же как типы расширений и лицензия и публикация вашего расширения описываются в следующих разделах этой страницы.

Во время разработки, вы можете выключить кэширование настройками $wgMainCacheTypeManual:$wgMainCacheType = CACHE_NONE и $wgCacheDirectoryManual:$wgCacheDirectory = false, иначе системные сообщения и другие изменения могут не появляться.

Установка[edit]

Ваша цель - (?) написать часть установки таким образом, что пользователям, устанавливающим ваше расширение не нужно было делать ничего, кроме как включить файл установки в свой файл LocalSettings.phpManual:LocalSettings.php, вот так:

wfLoadExtension( 'MyExtension' );

Если вы хотите, чтобы ваше расширение было конфигурируемо, необходимо определить и документировать некоторые параметры конфигурации, и настройки ваших пользователей должны выглядеть следующим образом:

wfLoadExtension( 'MyExtension' );
$wgMyExtensionConfigThis = 1;
$wgMyExtensionConfigThat = false;

Для достижения этой простоты, ваш файл установки должен выполнить ряд задач (подробно описано в следующих разделах):

  • зарегистрировать все media handler, функции парсера, special page, тэги расширений, и переменные, используемые вашим расширением.
  • определить и/или проверить все(?any?) переменные конфигурации, которые вы определили для вашего расширения.
  • подготовить классы, используемые вашим расширением, для автозагрузки
  • определить, какие части вашей установки должны быть сделаны немедленно, и что должно быть отложено до тех пор, пока ядро ​​MediaWiki не будет инициализировано и сконфигурировано
  • определить дополнительные прерывания, требующиеся для вашего расширения
  • создать или проверить любые новые таблицы базы данных, необходимые для вашего расширения
  • установить локализацию для расширения

Регистрирующие функции в MediaWiki[edit]

MediaWiki перечисляет все установленные расширения на странице Special:Version. Например, вы можете посмотреть все расширения, установленные на этой вики в Special:Version. Полезно также убедиться, что ваше расширение присутствует на этой странице. Для этого вы должны добавить запись в $wgExtensionCredits для каждого media handler, функции парсера, специальной страницы, custom XML tag, и переменной, используемой вашим расширением. Запись будет выглядеть примерно так:

{
	"name": "Example",
	"author": "John Doe",
	"url": "https://www.mediawiki.org/wiki/Extension:Example",
	"description": "This extension is an example and performs no discernible function",
	"version": "1.5",
	"license-name": "GPL-2.0+",
	"type": "validextensionclass",
	"manifest_version": 1
}

См. Manual:$wgExtensionCreditsManual:$wgExtensionCredits что бы узнать, что эти поля делают. Многие поля опциональные, но все-таки будет хорошо, если вы их заполните. manifest_version ссылается на схему extension.jsonextension.json файла.

Как написано (1.26alpha), поддерживается только 1я версия.

В дополнение к вышеописанной регистрации вы должны подцепить ваши фичи в MediaWiki. То, что описано устанавливает только страницу Special:Version. Способ, которым вы это делаете, зависит от типа вашего расширения. Детали смотри в документации для каждого типа расширения:

Gnome-preferences-other.svg Расширения:Manual:Extensions РазработкаManual:Developing extensions Теги расширенийManual:Tag extensions Руководство:функции парсераManual:Parser functions ПрерыванияManual:Hooks Служебные страницыManual:Special pages Стили оформления (skins)Manual:Skins Волшебные словаManual:Magic words APIAPI:Extensions

Делаем расширение конфигурируемым[edit]

Если вы хотите, чтобы пользователь мог настроить ваше расширение, вы должны предоставить некоторые конфигурационные переменные. А также хорошо бы им дать уникальные имена. Они также должны следовать соглашению по именованию в MediaWiki (например, глобальные переменные должны начинаться с $wg).

For example, if your extension is named "Very silly extension that does nothing", you might want to name all your configuration variables to begin $wgVsetdn or $wgVSETDN. It doesn't really matter what you choose so long as none of the MediaWiki core begins its variables this way and you have done a reasonable job of checking to see that none of the published extensions begin their variables this way. Users won't take kindly to having to choose between your extension and some other extensions because you chose overlapping variable names.

It is also a good idea to include extensive documentation of any configuration variables in your installation notes.

Внимание Внимание: To avoid register_globalsRegister globals vulnerabilities, ALWAYS explicitly set all your extension's configuration variables in extension setup file. Constructs like if ( !isset( $wgMyLeetOption ) ) $wgMyLeetOption = somevalue; do not safeguard against register_globals!

Here is an example boiler plate that can be used to get started:

{
	"name": "BoilerPlate",
	"version": "0.0.0",
	"author": [
		"Your Name"
	],
	"url": "https://www.mediawiki.org/wiki/Extension:BoilerPlate",
	"descriptionmsg": "boilerplate-desc",
	"license-name": "MIT",
	"type": "other",
	"AutoloadClasses": {
		"BoilerPlateHooks": "BoilerPlate.hooks.php",
		"SpecialHelloWorld": "specials/SpecialHelloWorld.php"
	},
	"config": {
		"BoilerPlateEnableFoo": true
	},
	"callback": "BoilerPlateHooks::onExtensionLoad",
	"ExtensionMessagesFiles": {
		"BoilerPlateAlias": "BoilerPlate.i18n.alias.php"
	},
	"Hooks": {
		"NameOfHook": [
			"BoilerPlateHooks::onNameOfHook"
		]
	},
	"MessagesDirs": {
		"BoilerPlate": [
			"i18n"
		]
	},
	"ResourceModules": {
		"ext.boilerPlate.foo": {
			"scripts": [
				"modules/ext.boilerPlate.js",
				"modules/ext.boilerPlate.foo.js"
			],
			"styles": [
				"modules/ext.boilerPlate.foo.css"
			]
		}
	},
	"ResourceFileModulePaths": {
		"localBasePath": "",
		"remoteExtPath": "BoilerPlate"
	},
	"SpecialPages": {
		"HelloWorld": "SpecialHelloWorld"
	},
	"manifest_version": 1
}

Preparing classes for autoloading[edit]

If you choose to use classes to implement your extension, MediaWiki provides a simplified mechanism for helping PHP find the source file where your class is located. In most cases this should eliminate the need to write your own __autoload($classname) method.

To use MediaWiki's autoloading mechanism, you add entries to the AutoloadClassesManual:$wgAutoloadClasses field. The key of each entry is the class name; the value is the file that stores the definition of the class. For a simple one class extension, the class is usually given the same name as the extension, so your autoloading section might look like this (extension is named MyExtension):

{
	"AutoloadClasses": {
		"MyExtension": "MyExtension_body.php"
	}
}

The filename is relative to the directory the extension.json file is in.

Defining additional hooks[edit]

See Manual:HooksManual:Hooks.

Adding database tables[edit]

Внимание Внимание: If your extension is used on any production WMF-hosted wiki please follow the Schema change guide.

If your extension needs to add its own database tables, use the LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates hook. See the manual page for more information on usage.

Set up localisation[edit]

See:


Add logs[edit]

On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. See Manual:Logging to Special:LogManual:Logging to Special:Log for how to do it.

Execution[edit]

The technique for writing the implementation portion depends upon the part of MediaWiki system you wish to extend:

See also Extensions FAQExtensions FAQ, Портал разработчиковDeveloper hub

Localisation[edit]

While developing, you may want to disable both cache by setting $wgMainCacheType = CACHE_NONE and $wgCacheDirectory = false, otherwise your system message changes may not show up.

If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Store messages in <language-key>.json[edit]

Store message definitions in a localisation JSON-file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. An example you can find e.g. in extension MobileFrontend. Here is an example of a minimal JSON file (in this case en.json:

en.json

{
	"myextension-desc": "Adds the MyExtension great functionality.",
	"myextension-action-message": "This is a test message"
}

Store message documentation in qqq.json[edit]

The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json:

{
	"myextension-desc": "The description of MyExtension used in Extension credits.",
	"myextension-action-message": "Adds 'message' after 'action' triggered by user."
}

Define messages[edit]

  • Assign each message a unique, lowercase, no space message id; e.g.uploadwizard-desc
  • For any text string displayed to the user, define a message.
  • MediaWiki supports parameterized messages and that feature should be used when a message is dependent on information generated at runtime. Parameter placeholders are specified with $n, where n represents the index of the placeholder; e.g.
"mwe-upwiz-api-warning-was-deleted": "There was a file by this name, '$1', but it was deleted and you can not reupload the file. If your file is different, try renaming it."

Define message documentation[edit]

Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

"uploadwizard-desc": "Description of extension. It refers to [//blog.wikimedia.org/blog/2009/07/02/ford-foundation-awards-300k-grant-for-wikimedia-commons/ this event], i.e. the development was paid with this $300,000 grant."

Load the localisation file[edit]

In your setup routine, define the location of your messages files (e.g. in directory i18n/):

{
	"MessagesDirs": {
		"MyExtension": [
			"i18n"
		]
	}
}

Use wfMessage in PHP[edit]

In your setup and implementation code, replace each literal use of the message with a call to wfMessage( $msgID, $param1, $param2, ... ). In classes that implement IContextSourceManual:RequestContext (as well as some others such as subclasses of SpecialPage), you can use $this->msg( $msgID, $param1, $param2, ... ) instead. Example:

wfMessage( 'myextension-addition', '1', '2', '3' )->parse()

Use mw.message in JavaScript[edit]

It's possible to use i18n functions in JavaScript too. Look at Manual:Messages APIManual:Messages API for details.

Extension types[edit]

Gnome-preferences-other.svg Расширения:Manual:Extensions РазработкаManual:Developing extensions Теги расширенийManual:Tag extensions Руководство:функции парсераManual:Parser functions ПрерыванияManual:Hooks Служебные страницыManual:Special pages Стили оформления (skins)Manual:Skins Волшебные словаManual:Magic words APIAPI:Extensions

Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:

  • Subclassing: MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
  • HooksManual:Hooks – A technique for injecting custom php code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
  • Tag-function associationsManual:Tag extensionsXML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
  • Волшебные словаManual:Magic words – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see Manual:Волшебные словаManual:Magic words for more information.
  • API modulesAPI:Extensions – you can add custom modules to MediaWiki's "action" web API, that can be invoked by JavaScript, bots or third-party clients.

Support other core versions[edit]

There are two widespread conventions for supporting older versions of MediaWiki core:

  • Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
  • Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki 1.27 need to use the REL1_27 branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Extension maintainers should declare with the compatibility policy parameter of the {{Extension}} template which convention they follow.


License[edit]

MediaWiki is an open-source project and users are encouraged to make any MediaWiki extensions under an Open Source Initiative (OSI) approved license compatible with GPL-2.0+ (Wikimedia's standard software license).

We recommend adopting one of the following compatible licenses for your projects in Gerrit:

For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions. To specify the licence in code and with "license-name" a key should be used to provide it's short name, e.g. "GPL-2.0+" or "MIT" adhering to the list of identifiers at spdx.org.

Publishing[edit]

To autocategorize and standardize the documentation of your existing extension, please see Template:ExtensionTemplate:Extension. To add your new extension to this Wiki:


A developer sharing their code on the MediaWiki wiki or code repository should expect:

Feedback / Criticism / Code reviews
Review and comments by other developers on things like framework use, security, efficiency and usability.
Developer tweaking
Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
Improved access for wiki sysadmins
If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.
Future versions by other developers
New branches of your code being created by other developers as new versions of MediaWiki are released.
Merger of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
Credit
Credit for your work being preserved in future versions — including any merged extensions.
Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host their code directly on the MediaWiki wiki or code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it. You may also add the {{Extension exception}} template to your extension requesting other developers refrain from modifying your code, although no guarantees can be made that an update will be made if deemed important for security or compatibility reasons. You may use the current issues noticeboard if you feel another developer has violated the spirit of these expectations in editing your extension.


Deploying and registering[edit]

Consult Review queueReview queue. If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at database table and field registrationdatabase table and field registration.

Help documentation[edit]

You should provide public-domain help documentation for features provided by your extension. Help:CirrusSearchHelp:CirrusSearch is a good example. You should give users a link to the documentation via the addHelpLink()Manual:Special pages#Help page function.

Providing support / collaboration[edit]

Extension developers should open an account on Wikimedia's PhabricatorPhabricator, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

See also[edit]

References[edit]