RandomSec/extensions/wikidata/module/scripts/dialogs/wikibase-dialog.js
Lu Liu 7d4e182c75
Extend Wikidata extension to support arbitrary Wikibase instances (#2810)
Closes #1640. All Wikibase-dependent parameters, which were previously hard-coded for Wikidata, are now described in a JSON manifest. The manifest is currently constructed by hand, but, in the future, will hopefully be published by each Wikibase instance at a standard location.

* setup the manifest framework

* add dependency mechanism to scrutinizers & update tests

* add json creators to constraint entities

* adapt the backend (units tests are to be updated)

* remove the call to prepareDependencies() in the constructor

* update code according to review feedback

* update scrutinizers tests

* fix typo & update ConstraintsV1

* log if a scrutinizer is skipped

* update versioning handling in the backend

* correct the order of "actual" and "expected" for assertEquals method

* use regex to check manifest versions

* 1. add wikibase-manager.js, wikibase-dialog.js, etc.
2. move dialog/schema-alignment-dialog.js -> schema-alignment.js
3. remove unused schema-alignment-dialog.html
4. change most mentions of "Wikidata" to "Wikibase"

* support saving cookies for different Wikibases & fix LoginCommandTest

* fix schema related tests

* removed unused WikibaseCredentials

* include MediaWiki API endpoint in the schema

* fetch language codes for different Wikibases

* fix lgtm-bot alerts

* keep a connection map (MediaWiki API endpoint => Connection) in ConnectionManager

* simplify the constraint configurations of the manifest and remove lots of unnecessary code.

* add slash to the end of mediawiki.root

* add manifest schema and use ajv to validate the manifest

* remove JSONP support (Wikibase manifest host should support CORS)

* save manifests on manifest update

* add unit tests for Manifest

* include the exception in logger.error() method to make it easier to debug

* include the message of ManifestException when calling respondError

* test multiple connections

* test no manifest & test invalid manifest

* adapt manage-account-dialog.js to support multiple Wikibase connections

* update instance/subclass of related translations

* beautify import-schema-dialog.html

* use "${lang}" variable in the reconciliation service endpoint of the manifest

* adapt schema-alignment.js after introducing "${lang}" variable in the reconciliation service endpoint

* use WikibaseManager.getSelectedWikibaseApi() in SchemaAlignment._getPropertyType

* replace more mentions of "Wikidata" to "Wikibase"

* use WikibaseManager.getSelectedWikibaseApi() in previewrenderer.js

* support fetching language codes of different Wikibases in the frontend

* skip EditInspector if missing 'property_constraint_pid' in the manifest

* improve unit tests for fetching lang codes

* skip scrutinizers depending on fetcher if 'property_constraint_pid' is missing in the manifest

* make sure the schema alignment panel is set up before rendering

* fix preview bug

* add getters of "instance of" and "subclass of" to the Manifest interface and use them in NewItemScrutinizer

* fix hardcode for Wikidata in WbItemVariable

* rename 'entity_prefix' to 'site_iri' and move it from 'manifest.wikibase.properties' to 'manifest.wikibase'

* include oauth configurations in the manifest & support logging in with owner-only consumer for Wikibases with the OAuth extension

* correct schema fallback logic

* select default wikibase according to the saved schema

* include maxlag in the manifest

* [backend] move maxlag setting from preferences to request parameter

* support setting maxlag when uploading edits

* rename "Manage Wikibase" to "Select Wikibase instance" and localize it

* fix manifest updating bug

* include EditGroups in the manifest

* add the reconciliation service from the manifest to standard services if it's not present yet when adding a new manifest

* update according to review feedback

1. use inherited color variable
2. rename 'gridwroks' to 'openrefine'
3. remove unnecessary 'async: true'
4. add 'format: url' validation to urls to the schema

* rename 'wikibasePrefix' to 'siteIri'
2020-08-22 11:58:56 -04:00

125 lines
4.7 KiB
JavaScript

const WikibaseDialog = {};
WikibaseDialog.launch = function () {
const frame = $(DOM.loadHTML("wikidata", "scripts/dialogs/wikibase-dialog.html"));
const elmts = this.elmts = DOM.bind(frame);
elmts.dialogHeader.text($.i18n("wikibase-management/dialog-header"));
elmts.explainSelectWikibase.text($.i18n("wikibase-management/explain-select-wikibase"));
elmts.currentSelectedWikibase.html($.i18n("wikibase-management/current-selected-wikibase",
WikibaseManager.getSelectedWikibaseMainPage(), WikibaseManager.getSelectedWikibaseName()));
elmts.closeButton.text($.i18n("wikibase-management/close"));
elmts.addButton.text($.i18n("wikibase-management/add-wikibase"));
WikibaseDialog.populateDialog();
let level = DialogSystem.showDialog(frame);
elmts.closeButton.click(function () {
DialogSystem.dismissUntil(level - 1);
});
elmts.addButton.click(function () {
WikibaseDialog.addWikibaseManifest();
});
};
WikibaseDialog.populateDialog = function () {
let wikibases = WikibaseManager.getAllWikibases();
WikibaseDialog.elmts.wikibaseList.empty();
for (let wikibaseName in wikibases) {
if (wikibases.hasOwnProperty(wikibaseName)) {
let item = "<tr onclick=\"WikibaseDialog.selectWikibase('" + wikibaseName + "')\">";
item += "<td>" + wikibaseName + "</td>";
if (wikibaseName.toLowerCase() === WikibaseManager.getSelectedWikibaseName().toLowerCase()) {
item += "<td><a class=\"wikibase-dialog-selector-remove wikibase-selected\" onclick=\"void(0)\"></a></td>";
} else {
item += "<td><a class=\"wikibase-dialog-selector-remove\" onclick=\"WikibaseDialog.removeWikibase(event, '" + wikibaseName + "')\"></a></td>";
}
item += "</tr>";
WikibaseDialog.elmts.wikibaseList.append(item);
}
}
};
WikibaseDialog.selectWikibase = function (wikibaseName) {
if (wikibaseName !== WikibaseManager.getSelectedWikibaseName()) {
WikibaseManager.selectWikibase(wikibaseName);
WikibaseDialog.elmts.currentSelectedWikibase.html($.i18n("wikibase-management/current-selected-wikibase",
WikibaseManager.getSelectedWikibaseMainPage(), WikibaseManager.getSelectedWikibaseName()));
WikibaseDialog.populateDialog();
SchemaAlignment.onWikibaseChange();
}
};
WikibaseDialog.removeWikibase = function (e, wikibaseName) {
e.stopPropagation(); // must stop, otherwise the removed Wikibase will be selected
WikibaseManager.removeWikibase(wikibaseName);
WikibaseDialog.populateDialog();
};
WikibaseDialog.addWikibaseManifest = function () {
const frame = $(DOM.loadHTML("wikidata", "scripts/dialogs/add-wikibase-dialog.html"));
const elmts = DOM.bind(frame);
elmts.dialogHeader.text($.i18n("wikibase-addition/dialog-header"));
elmts.explainAddManifest.text($.i18n("wikibase-addition/explain-add-manifest"));
elmts.explainAddManifestViaURL.text($.i18n("wikibase-addition/explain-add-manifest-via-url"));
elmts.explainPasteManifest.html($.i18n("wikibase-addition/explain-paste-manifest"));
elmts.cancelButton.text($.i18n("wikibase-addition/cancel"));
elmts.addButton.text($.i18n("wikibase-addition/add-wikibase"));
elmts.invalidManifest.hide();
elmts.invalidManifest.text($.i18n("wikibase-addition/invalid-manifest"));
let level = DialogSystem.showDialog(frame);
elmts.cancelButton.click(function () {
DialogSystem.dismissUntil(level - 1);
});
elmts.addButton.click(function () {
let addManifest = function (manifest) {
if (!WikibaseDialog.validateManifest(manifest)) {
return;
}
WikibaseManager.addWikibase(manifest);
let lang = $.i18n('core-recon/wd-recon-lang');
let reconEndpoint = manifest.reconciliation.endpoint.replace("${lang}", lang);
ReconciliationManager.getOrRegisterServiceFromUrl(reconEndpoint, function () {}, true);
DialogSystem.dismissUntil(level - 1);
WikibaseDialog.populateDialog();
};
let manifestURL = $.trim(elmts.manifestURLInput.val());
if (manifestURL.length) {
WikibaseManager.fetchManifestFromURL(manifestURL, addManifest);
} else {
try {
let manifest = JSON.parse(elmts.manifestTextarea.val());
addManifest(manifest);
} catch (e) {
console.error(e);
elmts.invalidManifest.show();
}
}
});
};
WikibaseDialog.validateManifest = function (manifest) {
if (!WikibaseDialog.ajv) {
WikibaseDialog.ajv = new Ajv();
WikibaseDialog.validateWikibaseManifestV1 = WikibaseDialog.ajv.compile(WikibaseManifestSchemaV1);
}
if (WikibaseDialog.validateWikibaseManifestV1(manifest)) {
return true;
} else {
let errMsg = WikibaseDialog.ajv.errorsText(WikibaseDialog.validateWikibaseManifestV1.errors, {
dataVar: "manifest"
});
alert(errMsg);
return false;
}
};