Jump to content

Розширення:JsonConfig

Issue tracker: #JsonConfig
From mediawiki.org
This page is a translated version of the page Extension:JsonConfig and the translation is 45% complete.
Languages:
Довідка про розширення MediaWiki
JsonConfig
Статус релізу: стабільний
Реалізація ContentHandler , MyWiki
Опис Забезпечує систему конфігурації JSON на основі вікі
Автор(и) Yuri Astrakhan (yurikобговорення)
Найновіша версія 1.1.1
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.38+
Зміни в БД Ні
Ліцензія GNU General Public License 2.0 or later
Завантажити
Download extension
Git [?]:

RFC
Параметри

  • $wgJsonConfigs
  • $wgJsonConfigModels
Використані hook'и
Quarterly downloads 268 (Ranked 21st)
Public wikis using 897 (Ranked 264th)
Translate the JsonConfig extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

Розширення JsonConfig дозволяє іншим розширенням зберігати свої конфігураційні дані як JSON на вікі-сторінці.

Доступні риси та патерни використання

Приклад візуалізації JSON засобами розширення JsonConfig
  • You may use JsonConfig to store data in a number of ways:
    • in a single configuration page, e.g. a number of settings for your extension in Config:MyExtSettings (Config is the default namespace associated with the JsonConfig extension);
    • in a set of pages with similar structure residing in their own namespace, e.g. IP addresses of known proxies or event log schemas named "Proxy:Opera", or schemas named Schema:AccountCreation
    • using it only for pages whose titles match a regex pattern, e.g. Config:Proxy:Opera or Config:Opera.proxy. This avoids filling a wiki with lots of namespaces, one for each content model.
  • You may provide a content class to do data validation (beyond valid JSON) and normalization.
  • You may provide a view class to customize HTML display.
  • You can store data:
    • "one-per-wiki", "one-per-cluster", or even one per some "family" (different structure of the caching key for shared memcached);
    • in a public or private wiki and accessed with credentials;
    • in a separate cluster, and do remote notification when changed.

Вікіпедійне використання

Поточне

  • Спільні табличні набори даних
  • Спільні набори даних мап
  • Конфігурації панелі приладів Dashiki
  • Інше?

Минуле

Встановлення

  • Завантажте і розмістіть файли в каталозі з назвою JsonConfig у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/JsonConfig
  • Додайте такий код унизу вашого файлу LocalSettings.php : 
    wfLoadExtension( 'JsonConfig' );
  • Налаштуйте як вимагається.
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Конфігурація

$wgJsonConfigs

Ця змінна визначає профілі для кожного типу конфігураційних сторінок. $wgJsonConfigs — асоціативний масив масивів, де кожний підмасив має нуль або більше наступних параметрів. Усталено, JsonConfig використовує струнний ключ як ID моделі, що подає цей профіль, але у випадку перевикористання одного й того ж ID моделі в понад одному профілі, можна перекрити його параметром model.

параметр тип усталення опис
model string (ключ у $wgJsonConfigs) ID моделі для використання під час створення нової сторінки. If none is given, the array key of this profile becomes the model ID. Якщо це значення встановлене в null, то використовуватиметься вбудований ID модуля JsonConfig. ID моделі також повинен бути перелічений у $wgJsonConfigModels, крім null або 'JsonConfig'.
namespace int NS_CONFIG (482) Простір імен, в якому перебуватимуть ці конфігурації, або усталено «Config:»
nsName string/false Для неусталених (і NS_CONFIG ≠ 482) просторів імен, присвоює канонічному (англійському) імені. Якщо понад один масив $wgJsonConfigs використовує той самий простір імен, то вкажіть ім'я лише раз. If not found, a warning will be given, and the namespace will get automatic "ConfigNNN" name. У випадку, якщо ця конфігурація не зберігається локально, використовуватиметься nsName як віддалений простір імен, без локального оголошення.

Якщо бажаєте поділитися простором імен із іншими, не-JsonConfig сторінками вмісту, вкажіть це значення у false.

nsTalk string nsName+_talk Для неусталених просторів імен присвоює їхні сторінки обговорення в канонічне (англійське) ім'я
pattern string (all) Регулярний вираз відповідності назви сторінки в даному просторі імен. Якщо порожньо, то конфігурація застосовуватиметься до всіх сторінок у просторі імен. Для відповідності спадковій поведінці «підпросторів», для isSubspace=true використовуйте патерн ^/^name:./, а для isSubspace=false — /^name$/.
isLocal bool true Якщо true, то конфігурація поширюватиметься не на весь кластер, а на кожну вікі з локальною конфігурацією. Якщо false, то очікується поширення конфігурації на декілька вікі, а задля локального зберігання цієї конкретної вікі, вкажіть поле «store».
This flag affects the caching key, so a config page with the same name would be shared in memcached if this setting is false, but will be unique per wiki if true.
cacheExp int 24*60*60 Час (у секундах) кешування значення в пам'яті
cacheKey string Якщо значення вказане, додайте цю струну до ключа кешування. Use cacheKey to invalidate previous cached values - e.g. when making an incompatible change that would modify cached values, and you worry that you may need to roll back. This key can also be used to allow all language wikis in the same family to share the same cached value, while being stored in the same page but on different wikis. Наприклад, Вікіпедія може використовувати «wp», а Вікіцитати — «wq».
flaggedRevs bool false Якщо true, то отримуватиметься найостанніша патрульована версія, а якщо null, то патрульовані версії перевірятимуться та за доступності використовуватимуться. Якщо false, завжди використовуватиметься найостанніша версія.
remote array Об'єкт із параметрами, що описують доступ до конфігурації з іншої вікі. Повинно бути присутнє, якщо «store» не вказане, а «isLocal» є «false».
  ‑ url string Non-default API endpoint to get config from remote wiki just for this configuration profile. Якщо не зазначено, використовуватиметься значення $wgJsonConfigApiUri.
  ‑ username string Якщо задане, то використовуватиметься для автентифікації у віддалене конфігураційне сховище.
  ‑ password string Див. username.
store array Вкажіть це значення в true або масив, аби поточна вікі дійсно містила ці конфігураційні дані. This value will automatically populate if missing and isLocal is true.
  ‑ cacheNewValue bool true Коли змінюється конфігурація, як повинен змінитися кеш? Якщо false, видаляє кешоване значення, змушуючи інші вікі перезапитувати його. true вказує нове значення в кеш. Найкорисніше, коли вікі-зберігач і вікі-споживач ділять один і той самий кеш. Beware that in case of false, if consumer wiki requests the new value too fast, it might get it from a possibly stale slave DB.
  ‑ notifyUrl string Optionally specify remote API URL that will be called when configuration changes.
  ‑ notifyUsername string Optional username to use with notifyUrl
  ‑ notifyPassword string Опційний пароль для використання з notifyUrl

$wgJsonConfigModels

This variable defines which custom content class will handle which Model ID. More than one Model ID may be handled by the same content class. All content classes must derive from the JCContent class; if the modelID maps to null, then the default JCContent class handles the model ID.

Приклад: 

$wgJsonConfigModels['Config.MyExtSettings'] = 'MyExt\MyContentClass';

If you implement a separate class to do HTML rendering, you can specify your config model as an array with an extra view class: 

$wgJsonConfigModels['Config.MyExtSettings'] = [
    'class' => 'MyExt\MyContentClass',
    'view'  => 'MyExt\MyContentViewClass', // easier to extend JCDefaultObjContentView or JCDefaultContentView
];

Приклади

Before version 1.0.0, JsonConfig used name and isSubspace values to customize which pages belonged to the given content model. Both have been removed in version 1.0.0, and replaced with the pattern parameter that accepts a regular expression. Make sure to surround your patterns with ^ and $ symbols, and add slashes (PHP style)

Привіт, світе

The simplest case is a single configuration page without any validation, stored locally on each wiki. Просто додайте ці налаштування до LocalSettings.php 

// Content model is 'JsonConfig.MySettings'
// Model class is set to NULL to allow non-validated data
$wgJsonConfigModels['JsonConfig.MySettings'] = null;

$wgJsonConfigs['JsonConfig.MySettings'] = array(
  'pattern' => '/^MySettings$/', // Page name in Config namespace
);

The above enables namespace "Config" on the local wiki, but only allows the "Config:MySettings" page to be created, not any other page in that namespace. You can store well-formed JSON data in the page.

Для читання даних MySettings у PHP, використовуйте об'єкт TitleValue для доступу до сторінки, а потім запитуйте її вміст: 

use JsonConfig\JCSingleton;
$tv = new TitleValue( NS_CONFIG, 'MySettings' ); // DB Key
$content = JCSingleton::GetContent( $tv );
if ( $content->isValid() ) {
    $data = $content->getData();
    ...
}

Підтримка шаблонів Вікімедіа

Some templates (e.g. Template:TNT) from Wikimedia projects require JsonConfig to support the Data namespace on commons for mw.ext.data.get. You can use the following config to support that usecase. 

wfLoadExtension( 'JsonConfig' );

$wgJsonConfigEnableLuaSupport = true; // required to use JsonConfig in Lua
$wgJsonConfigModels['Tabular.JsonConfig'] = 'JsonConfig\JCTabularContent';
$wgJsonConfigs['Tabular.JsonConfig'] = [ 
        'namespace' => 486, 
        'nsName' => 'Data',
        // page name must end in ".tab", and contain at least one symbol
        'pattern' => '/.\.tab$/',
        'license' => 'CC0-1.0',
        'isLocal' => false,
];

$wgJsonConfigModels['Map.JsonConfig'] = 'JsonConfig\JCMapDataContent';
$wgJsonConfigs['Map.JsonConfig'] = [ 
        'namespace' => 486,
        'nsName' => 'Data',
        // page name must end in ".map", and contain at least one symbol
        'pattern' => '/.\.map$/',
        'license' => 'CC0-1.0',
        'isLocal' => false,
];
$wgJsonConfigInterwikiPrefix = "commons";

$wgJsonConfigs['Tabular.JsonConfig']['remote'] = [ 
        'url' => 'https://commons.wikimedia.org/w/api.php'
];
$wgJsonConfigs['Map.JsonConfig']['remote'] = [
        'url' => 'https://commons.wikimedia.org/w/api.php'
];

Multiple configs shared in a cluster

Lets say we decide to store the trusted proxies' IPs as "Config:Proxy:SomeName" pages on Meta-Wiki and share this data with the cluster. 

// All wikis must have this configuration:
$wgJsonConfigs['JsonConfig.Proxy'] = [
  'pattern' => '/^Proxy\:./', // require at least one letter after the ':'
  'isLocal' => false,
];

// The LocalSettings.php for all wikis except Meta-Wiki will set this URL to Meta-Wiki's API endpoint:
$wgJsonConfigs['JsonConfig.Proxy']['remote'] = 'http://meta.wikimedia.org/w/api.php';

// LocalSettings.php for Meta-Wiki will indicate that the data should be stored there
$wgJsonConfigs['JsonConfig.Proxy']['store'] = true;

If instead you want to dedicate a separate namespace to proxies, the parameters would change to: 

$wgJsonConfigs['JsonConfig.Proxy'] = [
  'namespace' => NNN, // NNN is the number you would reserve for Proxy namespace
  'nsName' => 'Proxy', // Canonical namespace name
];

Validation

Most of the time one would also want a custom content class with its own validation. JSON pages are handled by the content classes which derive from JCContent. The content class is responsible for parsing and validating raw text. JCContent does not do any validation beyond JSON parsing, but you may choose to derive from it and override JCContent::validate(). Better yet, you may derive from the JCObjContent class which provides a number of validation primitives, and only override JCObjContent::validateContent(). 

// This should be done on all wikis, including Meta-Wiki
$wgJsonConfigModels['JsonConfig.Proxy'] = 'ProxyExt\ProxyContent';

For the sake of this documentation, let's presume that the proxy config page describing Opera Mini servers has this format: 

{
    "enabled": true,
    "comment": "See http://... for updates",
    "ips": [
        '37.228.104.0/21',
        ...
    ]
}

Here is the content class to validate that data. 

use JsonConfig\JCObjContent;
use JsonConfig\JCValidators;

class ProxyContent extends JCObjContent {

    /**
     * Derived classes must implement this method to perform custom validation
     * using the check(...) calls
     */
    public function validateContent() {
        // 'enabled' must be a boolean, true by default.
        // JCValidators::* already handle localized error messages
        $this->testOptional( 'enabled', true, JCValidators::isBool() );
        // an optional field 'comment' of type string
        $this->testOptional( 'comment', '', JCValidators::isString() );
        // 'ips' must be a list of valid CIDR ranges
        // field is not optional when default value would not pass validation
        $this->test( 'ips', self::getIpValidator() );
    }

    private static function getIpValidator() {
        // JCValue $value is a value of the field being checked wrapped with the status information.
        //              $v->getValue() actual value being examined
        //              $v->isMissing() if the value is not present in the data
        //              $v->defaultUsed() if the value did not exist and a default was supplied
        // array $path the location of this field in the hierarchy - each value is either string or an int
        // JCObjContent $self - this object, useful to get access to other fields via $self->getField()
        // You may modify the value stored inside, set additional flags, or report an error
        // using the $v->error( $key, $path, ... ) function
        return function ( JCValue $value, array $path, JCObjContent $self ) {
            $isErr = false;
            $v = $value->getValue();
            if ( is_string( $v ) ) {
                // user supplied a single string, treat as an non-assoc array
                $v = array( $v );
            } else {
                // ensure that $v is an non-assoc array, and all of its values are strings
                $isErr = !JCUtils::isList( $v ) || !JCUtils::allValuesAreStrings( $v );
            }
            if ( !$isErr ) {
                // @todo: do the rest of the IP validation and set $isErr to true on failure
            }
            // Error message might be in this form:
            // "Parameter \"$1\" must be an array of valid non-restricted (no private networks) CIDR IP blocks"
            if ( $isErr ) {
                $value->error( 'my-proxyconfig-err-ips', $path );
            } else {
                $value->setValue( $v );
            }
        };
    }
}

Customizing behavior on the storage wiki

You may also want to customize viewing and page creation on the storage wiki (Meta-Wiki in the above example). There are two ways to do this: inside your JCContent-derived class, or via a separate "view" class that derives from JCContentView. The second approach is preferable as it cleanly separates the architecture and the view class need only exist in the storage wiki (e.g. Meta-Wiki), not on all the wikis that use the data.

To override default value in JCContent-derived class, override the constructor and set the $text value to the new default if it came in as NULL before passing it to the parent constructor. To override the HTML generation, override JCContent::getHtml().

With the recommended way, create a view class that derives from JCContentView or a more feature-rich JCDefaultContentView. For JCContentView, you will need to implement valueToHtml() and getDefault(). By default, the view is implemented by the JCDefaultContentView class, which can also be used as a customizable base if you just need minor adjustments to the way it looks. 

// Changing model definition from the above - should be done on all wikis, including META
$wgJsonConfigModels['JsonConfig.Proxy'] = [ 'class' => 'ProxyExt\ProxyContent' ];

// Add the view class - should only be done on the storage wiki (e.g. META)
$wgJsonConfigModels['JsonConfig.Proxy']['view'] = 'ProxyExt\ProxyView';

class ProxyView extends JsonConfig\JCDefaultObjContentView {
    public function getDefault( $modelId ) {
        return <<<JSON
{
    "comment": "See http://... for updates",
    "ips": [
        "N.N.N.N/NN",...
    ]
}
JSON;
    }
}


Найкращі практики

  • Extensions that use JsonConfig should add their configurations to the $wgJsonConfigs and $wgJsonConfigModels in the main extension file.
  • If you share config data among multiple wikis, document the key name used in $wgJsonConfigs[], and initialize the 'store' / 'remote' section in LocalSettings.php. This is better than introducing a number of global variables that duplicate the config functionality. See for example Wikimedia's configuration of the Graph extension across multiple wikis (although that uses complex multi-wiki setup rather than simple config variables).

Статус

Реалізовані риси

  • JSON parsing converts JSON text into either an array or an object
  • Visualization shows JSON as an easy to view table rather than code, with some extra highlighting. For example if the value is not provided and a default is used, it is shown in gray, or when the value is the same as default, it shows as purple. For example, see this and this.
  • Редактор коду спрощує редагування JSON
  • Custom Validation performs complex checks such as checking that the value is in the proper format or that a user ID exists.
  • MemCached caching stores json blobs in memcached under custom keys and expiration policies, and resets them on save.
  • Flagged Revisions support allows configurations to be marked as "reviewed" before going into production
  • Localization of most basic interface elements has been done in many languages, and it would reduce translation work if most common messages would be done just once in one place.

Unimplemented nice-to-haves

These features would be desirable to more than one type of configs:

  • Schema validator - Validate against JSON Schema, as most extensions might not need complex validation rules, or might want to combine schema plus extra validation.
  • Custom editor - Zero team has been thinking about implementing a more complex editor, possibly based on JSON Schema.
  • API query support - Allow config pages to be returned as regular API results in all formats - json/xml/... instead of text blobs:
    api.php ? action=query & titles=Config:Proxy:Opera & prop=jsonconfig
  • Localization - it would be good to be able to show localized descriptions for each configuration key

Зовнішній доступ

The stored configuration data may frequently be needed by some external agent such as JavaScript, bot, or other programs. JavaScript could use either JSONP to access needed data by calling standard action=query&rvprop=content API, or we could develop a forwarding service if CORS is unavailable. Extension authors may choose to add their own API modules to provide domain-specific information. Lastly, the rvprop=jcddata Query API parameter would return JSON data as part of the API result, not as a text blob that rvprop=content would return. 

// NOT IMPLEMENTED! Use regular action=query API until we decide how to do it right
var req = {
    format: 'json', action: 'query',
    titles: 'Proxy:Opera',
    prop: 'revisions', rvprop: 'jcdcontent', indexpageids: '',
};
$.ajax({
    url: '//meta.wikipedia.org/w/api.php',
    data: req, cache: true, dataType: 'jsonp',
    success: function(result) { /* handle errors and warnings, process content */ }
});

Див. також

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:JsonConfig/uk&oldid=6811150"