7d4e182c75
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'
263 lines
9.6 KiB
JavaScript
263 lines
9.6 KiB
JavaScript
/**
|
|
* renders an item update (an edit on an item) in HTML.
|
|
*/
|
|
|
|
var EditRenderer = {};
|
|
|
|
// settings
|
|
EditRenderer.maxTerms = 15; // max number of terms displayed
|
|
EditRenderer.maxStatements = 25; // max number of statements per statement group
|
|
|
|
// main method: takes a DOM element and a list
|
|
// of edits to render there.
|
|
EditRenderer.renderEdits = function(edits, container) {
|
|
for(var i = 0; i < edits.length; i++) {
|
|
EditRenderer._renderItem(edits[i], container);
|
|
}
|
|
};
|
|
|
|
/**************/
|
|
/*** ITEMS ****/
|
|
/**************/
|
|
|
|
EditRenderer._renderItem = function(json, container) {
|
|
var subject = json;
|
|
var statementGroups = null;
|
|
var nameDescs = null;
|
|
if (json) {
|
|
subject = json.subject;
|
|
statementGroups = json.statementGroups;
|
|
nameDescs = json.nameDescs;
|
|
}
|
|
|
|
var item = $('<div></div>').addClass('wbs-item').appendTo(container);
|
|
var inputContainer = $('<div></div>').addClass('wbs-item-input').appendTo(item);
|
|
EditRenderer._renderEntity(json.subject, inputContainer);
|
|
var right = $('<div></div>').addClass('wbs-item-contents').appendTo(item);
|
|
|
|
// Terms
|
|
if ((json.labels && json.labels.length) ||
|
|
(json.labelsIfNew && json.labelsIfNew.length) ||
|
|
(json.descriptions && json.descriptions.length) ||
|
|
(json.descriptionsIfNew && json.descriptionsIfNew.length) ||
|
|
(json.addedAliases && json.addedAliases.length)) {
|
|
var termsContainer = $('<div></div>').addClass('wbs-namedesc-container')
|
|
.appendTo(right);
|
|
|
|
this._renderTermsList(json.labels, "label-override", termsContainer);
|
|
this._renderTermsList(json.labelsIfNew, "label-if-new", termsContainer);
|
|
this._renderTermsList(json.descriptions, "description-override", termsContainer);
|
|
this._renderTermsList(json.descriptionsIfNew, "description-if-new", termsContainer);
|
|
this._renderTermsList(json.addedAliases, "alias", termsContainer);
|
|
|
|
// Clear the float
|
|
$('<div></div>').attr('style', 'clear: right').appendTo(right);
|
|
}
|
|
|
|
// Statements
|
|
if (json.addedStatementGroups && json.addedStatementGroups.length) {
|
|
// $('<div></div>').addClass('wbs-statements-header')
|
|
// .text($.i18n('wikibase-schema/statements-header')).appendTo(right);
|
|
var statementsGroupContainer = $('<div></div>').addClass('wbs-statement-group-container')
|
|
.appendTo(right);
|
|
for(var i = 0; i != json.addedStatementGroups.length; i++) {
|
|
EditRenderer._renderStatementGroup(json.addedStatementGroups[i], statementsGroupContainer);
|
|
}
|
|
}
|
|
};
|
|
|
|
/**************************
|
|
* NAMES AND DESCRIPTIONS *
|
|
**************************/
|
|
|
|
EditRenderer._renderTermsList = function(termList, termType, termsContainer) {
|
|
if(!termList) {
|
|
return;
|
|
}
|
|
for(var i = 0; i != Math.min(termList.length, this.maxTerms); i++) {
|
|
EditRenderer._renderTerm(termType, termList[i], termsContainer);
|
|
}
|
|
if(termList.length > this.maxTerms) {
|
|
$('<div></div>').addClass('wbs-namedesc').text('...').appendTo(termsContainer);
|
|
}
|
|
};
|
|
|
|
EditRenderer._renderTerm = function(termType, json, container) {
|
|
var namedesc = $('<div></div>').addClass('wbs-namedesc').appendTo(container);
|
|
var type_container = $('<div></div>').addClass('wbs-namedesc-type').appendTo(namedesc);
|
|
var type_span = $('<span></span>').appendTo(type_container)
|
|
.text($.i18n('wikibase-schema/'+termType));
|
|
|
|
var right = $('<div></div>').addClass('wbs-right').appendTo(namedesc);
|
|
var value_container = $('<div></div>').addClass('wbs-namedesc-value').appendTo(namedesc);
|
|
EditRenderer._renderValue({datavalue:json,datatype:'monolingualtext'}, value_container);
|
|
};
|
|
|
|
/********************
|
|
* STATEMENT GROUPS *
|
|
********************/
|
|
|
|
EditRenderer._renderStatementGroup = function(json, container) {
|
|
|
|
var statementGroup = $('<div></div>').addClass('wbs-statement-group').appendTo(container);
|
|
var inputContainer = $('<div></div>').addClass('wbs-prop-input').appendTo(statementGroup);
|
|
var right = $('<div></div>').addClass('wbs-right').appendTo(statementGroup);
|
|
EditRenderer._renderEntity(json.property, inputContainer);
|
|
|
|
var statementContainer = $('<div></div>').addClass('wbs-statement-container').appendTo(right);
|
|
for (var i = 0; i != json.statements.length; i++) {
|
|
EditRenderer._renderStatement(json.statements[i], statementContainer);
|
|
}
|
|
if(json.statements.length > EditRenderer.maxStatements) {
|
|
$('<div></div>')
|
|
.text('...')
|
|
.addClass('wbs-statement')
|
|
.appendTo(statementContainer);
|
|
}
|
|
};
|
|
|
|
/**************
|
|
* STATEMENTS *
|
|
**************/
|
|
|
|
EditRenderer._renderStatement = function(json, container) {
|
|
|
|
var statement = $('<div></div>').addClass('wbs-statement').appendTo(container);
|
|
var inputContainer = $('<div></div>').addClass('wbs-target-input').appendTo(statement);
|
|
EditRenderer._renderValue(json.mainsnak, inputContainer);
|
|
|
|
// add rank
|
|
var rank = $('<div></div>').addClass('wbs-rank-selector-icon').prependTo(inputContainer);
|
|
|
|
// add qualifiers...
|
|
var right = $('<div></div>').addClass('wbs-right').appendTo(statement);
|
|
var qualifierContainer = $('<div></div>').addClass('wbs-qualifier-container').appendTo(right);
|
|
|
|
if (json.qualifiers) {
|
|
for (var pid_id in json['qualifiers-order']) {
|
|
var pid = json['qualifiers-order'][pid_id];
|
|
if (json.qualifiers.hasOwnProperty(pid)) {
|
|
var qualifiers = json.qualifiers[pid];
|
|
for (var i = 0; i != qualifiers.length; i++) {
|
|
EditRenderer._renderSnak(qualifiers[i], qualifierContainer);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// and references
|
|
$('<div></div>').attr('style', 'clear: right').appendTo(statement);
|
|
var referencesToggleContainer = $('<div></div>').addClass('wbs-references-toggle').appendTo(statement);
|
|
var triangle = $('<div></div>').addClass('triangle-icon').addClass('pointing-right').appendTo(referencesToggleContainer);
|
|
var referencesToggle = $('<a></a>').appendTo(referencesToggleContainer);
|
|
right = $('<div></div>').addClass('wbs-right').appendTo(statement);
|
|
var referenceContainer = $('<div></div>').addClass('wbs-reference-container').appendTo(right);
|
|
referencesToggle.click(function () {
|
|
triangle.toggleClass('pointing-down');
|
|
triangle.toggleClass('pointing-right');
|
|
referenceContainer.toggle(100);
|
|
});
|
|
referenceContainer.hide();
|
|
|
|
if (json.references) {
|
|
for (var i = 0; i != json.references.length; i++) {
|
|
EditRenderer._renderReference(json.references[i], referenceContainer);
|
|
}
|
|
}
|
|
EditRenderer._updateReferencesNumber(referenceContainer);
|
|
};
|
|
|
|
/*********************************
|
|
* QUALIFIER AND REFERENCE SNAKS *
|
|
*********************************/
|
|
|
|
EditRenderer._renderSnak = function(json, container) {
|
|
|
|
var qualifier = $('<div></div>').addClass('wbs-qualifier').appendTo(container);
|
|
var toolbar1 = $('<div></div>').addClass('wbs-toolbar').appendTo(qualifier);
|
|
var inputContainer = $('<div></div>').addClass('wbs-prop-input').appendTo(qualifier);
|
|
var right = $('<div></div>').addClass('wbs-right').appendTo(qualifier);
|
|
var statementContainer = $('<div></div>').addClass('wbs-statement-container').appendTo(right);
|
|
EditRenderer._renderEntity(json.full_property, inputContainer);
|
|
EditRenderer._renderValue(json, statementContainer);
|
|
};
|
|
|
|
/**************
|
|
* REFERENCES *
|
|
**************/
|
|
|
|
EditRenderer._renderReference = function(json, container) {
|
|
var reference = $('<div></div>').addClass('wbs-reference').appendTo(container);
|
|
var referenceHeader = $('<div></div>').addClass('wbs-reference-header').appendTo(reference);
|
|
var right = $('<div></div>').addClass('wbs-right').appendTo(reference);
|
|
var qualifierContainer = $('<div></div>').addClass('wbs-qualifier-container').appendTo(right);
|
|
|
|
for (var pid in json.snaks) {
|
|
if (json.snaks.hasOwnProperty(pid)) {
|
|
var snaks = json.snaks[pid];
|
|
for(var i = 0; i != snaks.length; i++) {
|
|
EditRenderer._renderSnak(snaks[i], qualifierContainer);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
EditRenderer._updateReferencesNumber = function(container) {
|
|
var childrenCount = container.children().length;
|
|
var statement = container.parents('.wbs-statement');
|
|
var a = statement.find('.wbs-references-toggle a').first();
|
|
a.html(childrenCount+$.i18n('wikibase-schema/nb-references'));
|
|
};
|
|
|
|
/*******************
|
|
* VALUE RENDERING *
|
|
*******************/
|
|
|
|
EditRenderer.renderedValueCache = {};
|
|
|
|
EditRenderer._renderEntity = function(json, container) {
|
|
var html = WarningsRenderer._renderEntity(json);
|
|
$(html).appendTo(container);
|
|
};
|
|
|
|
EditRenderer._renderValue = function(json, container) {
|
|
var input = $('<span></span>').appendTo(container);
|
|
var mode = json.datatype;
|
|
|
|
if (mode === "wikibase-item" || mode === "wikibase-property") {
|
|
EditRenderer._renderEntity(json.datavalue, container);
|
|
} else {
|
|
var jsonValue = JSON.stringify(json.datavalue);
|
|
var fullJsonValue = JSON.stringify(json);
|
|
if (fullJsonValue in EditRenderer.renderedValueCache) {
|
|
$('<span>'+EditRenderer.renderedValueCache[fullJsonValue]+'</span>').appendTo(container);
|
|
} else {
|
|
var params = {
|
|
action: 'wbformatvalue',
|
|
generate: 'text/html',
|
|
datavalue: jsonValue,
|
|
options: '{"lang":"'+$.i18n('core-recon/wd-recon-lang')+'"}',
|
|
format: 'json'
|
|
};
|
|
if ('property' in json) {
|
|
params.property = json.property;
|
|
} else {
|
|
params.datatype = json.datatype;
|
|
}
|
|
$.get(
|
|
WikibaseManager.getSelectedWikibaseApi(),
|
|
params,
|
|
function (data) {
|
|
if('result' in data) {
|
|
EditRenderer.renderedValueCache[fullJsonValue] = data.result;
|
|
$('<span>'+data.result+'</span>').appendTo(container);
|
|
}
|
|
},
|
|
'jsonp'
|
|
);
|
|
}
|
|
}
|
|
};
|
|
|
|
|