RandomSec/extensions/wikidata/module/scripts/schema-alignment.js
2021-04-24 15:47:05 +02:00

1392 lines
48 KiB
JavaScript

/*
Copyright 2010, Google Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
var SchemaAlignment = {
_isSetUp: false
};
/**
* Installs the tabs in the UI the first time the Wikidata
* extension is called.
*/
SchemaAlignment.setUpTabs = function() {
this._isSetUp = true;
this._rightPanel = $('#right-panel');
this._viewPanel = $('#view-panel').addClass('main-view-panel-tab');
this._toolPanel = $('#tool-panel');
this._summaryBar = $('#summary-bar')
.addClass('main-view-panel-tab-header')
.addClass('active')
.attr('href', '#view-panel');
// append panels
this._schemaPanel = $('<div id="wikibase-schema-panel"></div>')
.addClass('main-view-panel-tab')
.appendTo(this._rightPanel);
this._issuesPanel = $('<div id="wikibase-issues-panel"></div>')
.addClass('main-view-panel-tab')
.appendTo(this._rightPanel);
this._previewPanel = $('<div id="wikibase-preview-panel"></div>')
.addClass('main-view-panel-tab')
.appendTo(this._rightPanel);
// append tools
var schemaButton = $('<div></div>')
.addClass('main-view-panel-tab-header')
.attr('href', '#wikibase-schema-panel')
.text($.i18n('wikibase-schema/schema-tab-header'))
.appendTo(this._toolPanel);
var issuesButton = $('<div></div>')
.addClass('main-view-panel-tab-header')
.attr('href', '#wikibase-issues-panel')
.text($.i18n('wikibase-schema/warnings-tab-header')+' ')
.appendTo(this._toolPanel);
this.issuesTabCount = $('<span></span>')
.addClass('schema-alignment-total-warning-count')
.appendTo(issuesButton)
.hide();
this.issueSpinner = $('<img />')
.attr('src', 'images/large-spinner.gif')
.attr('width', '16px')
.appendTo(issuesButton);
var previewButton = $('<div></div>')
.addClass('main-view-panel-tab-header')
.attr('href', '#wikibase-preview-panel')
.text($.i18n('wikibase-schema/edits-preview-tab-header'))
.appendTo(this._toolPanel);
this.previewSpinner = $('<img />')
.attr('src', 'images/large-spinner.gif')
.attr('width', '16px')
.appendTo(previewButton);
this._unsavedIndicator = $('<span></span>')
.html('&nbsp;*')
.attr('title', $.i18n('wikibase-schema/unsaved-changes-alt'))
.hide()
.appendTo(schemaButton);
$('.main-view-panel-tab-header').click(function(e) {
var targetTab = $(this).attr('href');
SchemaAlignment.switchTab(targetTab);
e.preventDefault();
});
SchemaAlignment._rerenderTabs();
};
/**
* Called on tabs setup or Wikibase manifest change.
*/
SchemaAlignment._rerenderTabs = function() {
if (!SchemaAlignment._isSetUp) {
SchemaAlignment.setUpTabs();
return;
}
/**
* Init the schema tab
*/
this._schemaPanel.empty();
var schemaTab = $(DOM.loadHTML("wikidata", "scripts/schema-alignment-tab.html")).appendTo(this._schemaPanel);
var schemaElmts = this._schemaElmts = DOM.bind(schemaTab);
schemaElmts.dialogExplanation.html($.i18n('wikibase-schema/dialog-explanation',
WikibaseManager.getSelectedWikibaseMainPage(),
WikibaseManager.getSelectedWikibaseName(),
WikibaseManager.getSelectedWikibaseReconEndpoint().replace("${lang}", "en")));
this._plusButton($.i18n('wikibase-schema/add-item-button'), schemaElmts.addItemButton);
schemaElmts.addItemButton.click(function(e) {
SchemaAlignment._addItem();
SchemaAlignment._hasChanged();
e.preventDefault();
});
schemaElmts.saveButton
.text($.i18n('wikibase-schema/save-button'))
.attr('title', $.i18n('wikibase-schema/save-schema-alt'))
.prop('disabled', true)
.addClass('disabled')
.click(function() { SchemaAlignment._save(); });
schemaElmts.discardButton
.text($.i18n('wikibase-schema/discard-button'))
.attr('title', $.i18n('wikibase-schema/discard-schema-changes-alt'))
.prop('disabled', true)
.addClass('disabled')
.click(function() { SchemaAlignment._discardChanges(); });
// Init the column area
this.updateColumns();
/**
* Init the issues tab
*/
this._issuesPanel.empty();
var issuesTab = $(DOM.loadHTML("wikidata", "scripts/issues-tab.html")).appendTo(this._issuesPanel);
var issuesElmts = this._issuesElmts = DOM.bind(issuesTab);
issuesElmts.invalidSchemaWarningIssues.text($.i18n('wikibase-schema/invalid-schema-warning-issues'));
/**
* Init the preview tab
*/
this._previewPanel.empty();
var previewTab = $(DOM.loadHTML("wikidata", "scripts/preview-tab.html")).appendTo(this._previewPanel);
var previewElmts = this._previewElmts = DOM.bind(previewTab);
SchemaAlignment.updateNbEdits(0);
previewElmts.invalidSchemaWarningPreview.text($.i18n('wikibase-schema/invalid-schema-warning-preview'));
this._previewPanes = $(".schema-alignment-dialog-preview");
var reconServiceURL = WikibaseManager.getSelectedWikibaseReconEndpoint()
.replace("${lang}", $.i18n("core-recon/wd-recon-lang"));
ReconciliationManager.getOrRegisterServiceFromUrl(reconServiceURL, function (service) {
SchemaAlignment._reconService = service;
// Load the existing schema
SchemaAlignment._reset(theProject.overlayModels.wikibaseSchema);
// Perform initial preview
SchemaAlignment.preview();
}, false);
};
SchemaAlignment.onWikibaseChange = function() {
SchemaAlignment._rerenderTabs();
SchemaAlignment._save(function () {
SchemaAlignment._reset(theProject.overlayModels.wikibaseSchema);
SchemaAlignment.preview();
});
};
SchemaAlignment.updateColumns = function() {
var columns = theProject.columnModel.columns;
this._columnArea = $(".schema-alignment-dialog-columns-area");
this._columnArea.empty();
for (var i = 0; i < columns.length; i++) {
var column = columns[i];
var reconConfig = column.reconConfig;
// make sure the column was reconciled to the target Wikibase
var cell = SchemaAlignment._createDraggableColumn(column.name,
reconConfig && reconConfig.identifierSpace === WikibaseManager.getSelectedWikibaseSiteIri() && column.reconStats);
this._columnArea.append(cell);
}
$('.wbs-reconciled-column').draggable({
helper: "clone",
cursor: "crosshair",
snap: ".wbs-item-input input, .wbs-target-input input",
zIndex: 100,
});
$('.wbs-unreconciled-column').draggable({
helper: "clone",
cursor: "crosshair",
snap: ".wbs-target-input input",
zIndex: 100,
});
};
SchemaAlignment.switchTab = function(targetTab) {
$('.main-view-panel-tab').hide();
$('.main-view-panel-tab-header').removeClass('active');
$('.main-view-panel-tab-header[href="'+targetTab+'"]').addClass('active');
$(targetTab).show();
resizeAll();
var panelHeight = this._viewPanel.height();
this._schemaPanel.height(panelHeight);
this._issuesPanel.height(panelHeight);
this._previewPanel.height(panelHeight);
// Resize the inside of the schema panel
var headerHeight = this._schemaElmts.schemaHeader.outerHeight();
this._schemaElmts.canvas.height(panelHeight - headerHeight - 10);
if (targetTab === "#view-panel") {
ui.dataTableView.render();
}
};
SchemaAlignment.isSetUp = function() {
return SchemaAlignment._isSetUp;
};
SchemaAlignment.launch = function() {
this._hasUnsavedChanges = false;
if (!SchemaAlignment.isSetUp()) {
SchemaAlignment.setUpTabs();
}
SchemaAlignment.switchTab('#wikibase-schema-panel');
};
var beforeUnload = function(e) {
if (SchemaAlignment.isSetUp() && SchemaAlignment._hasUnsavedChanges === true) {
return $.i18n('wikibase-schema/unsaved-warning');
}
};
$(window).bind('beforeunload', beforeUnload);
SchemaAlignment._reset = function(schema) {
if (!schema) {
schema = {};
}
// fall back to Wikidata
if (!schema.siteIri) {
schema.siteIri = WikidataManifestV1_0.wikibase.site_iri;
}
if (!schema.mediaWikiApiEndpoint) {
schema.mediaWikiApiEndpoint = WikidataManifestV1_0.mediawiki.api;
}
if (!schema.itemDocuments) {
schema.itemDocuments = [];
}
this._originalSchema = schema;
this._schema = cloneDeep(this._originalSchema); // this is what can be munched on
this._copiedReference = null;
$('#schema-alignment-statements-container').empty();
if (this._schema && this._schema.itemDocuments) {
for(var i = 0; i !== this._schema.itemDocuments.length; i++) {
this._addItem(this._schema.itemDocuments[i]);
}
}
};
SchemaAlignment._save = function(onDone) {
var self = this;
var schema = this.getJSON();
if (schema === null) {
alert($.i18n('wikibase-schema/incomplete-schema-could-not-be-saved'));
}
Refine.postProcess(
"wikidata",
"save-wikibase-schema",
{},
{ schema: JSON.stringify(schema) },
{},
{
onDone: function() {
theProject.overlayModels.wikibaseSchema = schema;
$('.invalid-schema-warning').hide();
self._changesCleared();
if (onDone) onDone();
},
onError: function(e) {
alert($.i18n('wikibase-schema/incomplete-schema-could-not-be-saved'));
},
}
);
};
SchemaAlignment._discardChanges = function() {
this._reset(theProject.overlayModels.wikibaseSchema);
this._changesCleared();
};
SchemaAlignment._changesCleared = function() {
this._hasUnsavedChanges = false;
this._unsavedIndicator.hide();
this._schemaElmts.saveButton
.prop('disabled', true)
.addClass('disabled');
this._schemaElmts.discardButton
.prop('disabled', true)
.addClass('disabled');
};
SchemaAlignment._createDraggableColumn = function(name, reconciled) {
var cell = $("<div></div>").addClass('wbs-draggable-column').text(name);
if (reconciled) {
cell.addClass('wbs-reconciled-column');
} else {
cell.addClass('wbs-unreconciled-column');
}
return cell;
};
SchemaAlignment._plusButton = function(label, element) {
$('<b></b>').html('+&nbsp;').appendTo(element);
$('<span></span>').text(label).appendTo(element);
};
SchemaAlignment._makeDeleteButton = function (noText) {
var button = $('<div></div>').addClass('wbs-remove').append(
$('<span></span>').addClass('wbs-icon')
);
if(noText === undefined) {
button.append(
$('<span></span>').text($.i18n('wikibase-schema/remove')));
}
return button;
};
/**************/
/*** ITEMS ****/
/**************/
SchemaAlignment._addItem = function(json) {
var subject = null;
var statementGroups = null;
var nameDescs = null;
if (json) {
subject = json.subject;
statementGroups = json.statementGroups;
nameDescs = json.nameDescs;
}
var item = $('<div></div>').addClass('wbs-item');
$('#schema-alignment-statements-container').append(item);
var deleteToolbar = $('<div></div>').addClass('wbs-toolbar')
.attr('style', 'margin-top: 10px')
.appendTo(item);
var deleteButton = SchemaAlignment._makeDeleteButton()
.appendTo(deleteToolbar)
.click(function(e) {
item.remove();
SchemaAlignment._hasChanged();
e.preventDefault();
});
var inputContainer = $('<div></div>').addClass('wbs-item-input').appendTo(item);
SchemaAlignment._initField(inputContainer, "wikibase-item", subject);
var right = $('<div></div>').addClass('wbs-item-contents').appendTo(item);
// Terms
$('<span></span>').addClass('wbs-namedesc-header')
.text($.i18n('wikibase-schema/terms-header')).appendTo(right);
$('<div></div>').addClass('wbs-namedesc-container')
.attr('data-emptyplaceholder', $.i18n('wikibase-schema/empty-terms'))
.appendTo(right);
var termToolbar = $('<div></div>').addClass('wbs-toolbar').appendTo(right);
var addNamedescButton = $('<a></a>').addClass('wbs-add-namedesc')
.click(function(e) {
SchemaAlignment._addNameDesc(item, null);
e.preventDefault();
}).appendTo(termToolbar);
SchemaAlignment._plusButton(
$.i18n('wikibase-schema/add-term'), addNamedescButton);
// Clear the float
$('<div></div>').attr('style', 'clear: right').appendTo(right);
// Statements
$('<div></div>').addClass('wbs-statements-header')
.text($.i18n('wikibase-schema/statements-header')).appendTo(right);
$('<div></div>').addClass('wbs-statement-group-container')
.attr('data-emptyplaceholder', $.i18n('wikibase-schema/empty-statements'))
.appendTo(right);
var statementToolbar = $('<div></div>').addClass('wbs-toolbar').appendTo(right);
var addStatementButton = $('<a></a>').addClass('wbs-add-statement-group')
.click(function(e) {
SchemaAlignment._addStatementGroup(item, null);
e.preventDefault();
}).appendTo(statementToolbar);
SchemaAlignment._plusButton(
$.i18n('wikibase-schema/add-statement'), addStatementButton);
if (statementGroups) {
for(var i = 0; i != statementGroups.length; i++) {
SchemaAlignment._addStatementGroup(item, statementGroups[i]);
}
}
if (nameDescs) {
for(var i = 0; i != nameDescs.length; i++) {
SchemaAlignment._addNameDesc(item, nameDescs[i]);
}
}
};
SchemaAlignment._itemToJSON = function (item) {
var statementGroupLst = new Array();
var statementsDom = item.find('.wbs-statement-group');
statementsDom.each(function () {
var statementGroupJSON = SchemaAlignment._statementGroupToJSON($(this));
if (statementGroupJSON !== null) {
statementGroupLst.push(statementGroupJSON);
}
});
var nameDescLst = new Array();
var nameDescsDom = item.find('.wbs-namedesc');
nameDescsDom.each(function () {
var nameDescJSON = SchemaAlignment._nameDescToJSON($(this));
if (nameDescJSON !== null) {
nameDescLst.push(nameDescJSON);
}
});
var inputContainer = item.find(".wbs-item-input").first();
var subjectJSON = SchemaAlignment._inputContainerToJSON(inputContainer);
if (subjectJSON !== null &&
statementGroupLst.length === statementsDom.length &&
nameDescLst.length === nameDescsDom.length) {
return {subject: subjectJSON,
statementGroups: statementGroupLst,
nameDescs: nameDescLst};
} else {
return null;
}
};
/**************************
* NAMES AND DESCRIPTIONS *
**************************/
SchemaAlignment._addNameDesc = function(item, json) {
var term_type = 'ALIAS';
var value = null;
var override = false;
if (json) {
term_type = json.name_type.replace('_IF_NEW', '');
value = json.value;
override = json.name_type.indexOf('_IF_NEW') == -1;
}
var container = item.find('.wbs-namedesc-container').first();
var namedesc = $('<div></div>').addClass('wbs-namedesc').appendTo(container);
var type_container = $('<div></div>').addClass('wbs-namedesc-type').appendTo(namedesc);
var type_input = $('<select></select>').appendTo(type_container);
$('<option></option>')
.val('LABEL')
.text($.i18n('wikibase-schema/label'))
.appendTo(type_input);
$('<option></option>')
.val('DESCRIPTION')
.text($.i18n('wikibase-schema/description'))
.appendTo(type_input);
$('<option></option>')
.val('ALIAS')
.text($.i18n('wikibase-schema/alias'))
.appendTo(type_input);
type_input.val(term_type);
var toolbar = $('<div></div>').addClass('wbs-toolbar').appendTo(namedesc);
SchemaAlignment._makeDeleteButton().click(function(e) {
namedesc.remove();
SchemaAlignment._hasChanged();
e.preventDefault();
}).appendTo(toolbar);
$('<div></div>').addClass('wbs-right').appendTo(namedesc);
var value_container = $('<div></div>').addClass('wbs-namedesc-value').appendTo(namedesc);
SchemaAlignment._initField(value_container, "monolingualtext", value);
var override_container = $('<div></div>').addClass('wbs-namedesc-override').appendTo(namedesc);
var label = $('<label></label>').appendTo(override_container);
var checkbox = $('<input></input>')
.attr('type', 'checkbox')
.prop('checked', override)
.appendTo(label);
$('<span></span>').text($.i18n('wikibase-schema/override-term')).appendTo(label);
checkbox.on('change', function(e) {
SchemaAlignment._hasChanged();
});
type_input.on('change', function(e) {
var checkbox_visible = type_input.val() !== 'ALIAS';
if (checkbox_visible) {
override_container.show();
} else {
override_container.hide();
}
SchemaAlignment._hasChanged();
});
};
SchemaAlignment._nameDescToJSON = function (namedesc) {
var term_type = namedesc.find('select').first().val();
var type = term_type;
if (term_type !== 'ALIAS') {
var override = namedesc.find('input[type=checkbox]').first().prop('checked');
if (!override) {
type = term_type + '_IF_NEW';
}
}
var value = namedesc.find('.wbs-namedesc-value').first().data("jsonValue");
return {
type: "wbnamedescexpr",
name_type: type,
value: value,
};
};
/********************
* STATEMENT GROUPS *
********************/
SchemaAlignment._addStatementGroup = function(item, json) {
var property = null;
var statements = null;
if (json) {
property = json.property;
statements = json.statements;
}
var container = item.find('.wbs-statement-group-container').first();
var statementGroup = $('<div></div>').addClass('wbs-statement-group');
var inputContainer = $('<div></div>').addClass('wbs-prop-input').appendTo(statementGroup);
var right = $('<div></div>').addClass('wbs-right').appendTo(statementGroup);
var statementContainer = $('<div></div>').addClass('wbs-statement-container').appendTo(right);
SchemaAlignment._initPropertyField(inputContainer, statementContainer, property);
var toolbar = $('<div></div>').addClass('wbs-toolbar').appendTo(right);
var addValueButton = $('<a></a>').addClass('wbs-add-statement').click(function(e) {
var datatype = inputContainer.data("jsonValue").datatype;
SchemaAlignment._addStatement(statementContainer, datatype, null);
e.preventDefault();
}).appendTo(toolbar).hide();
SchemaAlignment._plusButton($.i18n('wikibase-schema/add-value'), addValueButton);
var removeButton = SchemaAlignment._makeDeleteButton()
.addClass('wbs-remove-statement-group')
.appendTo(toolbar)
.click(function(e) {
statementGroup.remove();
e.preventDefault();
});
container.append(statementGroup);
if (statements) {
for (var i = 0; i != statements.length; i++) {
SchemaAlignment._addStatement(statementContainer, property.datatype, statements[i]);
addValueButton.show();
removeButton.hide();
}
} else {
inputContainer.find('input').focus();
}
};
SchemaAlignment._statementGroupToJSON = function (statementGroup) {
var lst = new Array();
var domStatements = statementGroup.find('.wbs-statement-container').first().children('.wbs-statement');
domStatements.each(function () {
var statementJSON = SchemaAlignment._statementToJSON($(this));
if (statementJSON !== null) {
lst.push(statementJSON);
}
});
var inputContainer = statementGroup.find(".wbs-prop-input").first();
var propertyJSON = SchemaAlignment._inputContainerToJSON(inputContainer);
if (propertyJSON !== null && domStatements.length === lst.length && lst.length > 0) {
return {property: propertyJSON,
statements: lst};
} else {
return null;
}
};
/**************
* STATEMENTS *
**************/
SchemaAlignment._addStatement = function(container, datatype, json) {
var qualifiers = null;
var references = null;
var value = null;
if (json) {
qualifiers = json.qualifiers;
references = json.references;
value = json.value;
}
var statement = $('<div></div>').addClass('wbs-statement');
var inputContainer = $('<div></div>').addClass('wbs-target-input').appendTo(statement);
SchemaAlignment._initField(inputContainer, datatype, value);
// If we are in a mainsnak...
// (see https://www.mediawiki.org/wiki/Wikibase/DataModel#Snaks)
if (container.parents('.wbs-statement').length == 0) {
// add delete button
var toolbar1 = $('<div></div>').addClass('wbs-toolbar').appendTo(statement);
SchemaAlignment._makeDeleteButton().click(function(e) {
SchemaAlignment._removeStatement(statement);
e.preventDefault();
}).appendTo(toolbar1);
// 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);
var toolbar2 = $('<div></div>').addClass('wbs-toolbar').appendTo(right);
var addQualifierButton = $('<a></a>').addClass('wbs-add-qualifier')
.click(function(e) {
SchemaAlignment._addQualifier(qualifierContainer, null);
e.preventDefault();
}).appendTo(toolbar2);
SchemaAlignment._plusButton($.i18n('wikibase-schema/add-qualifier'), addQualifierButton);
if (qualifiers) {
for (var i = 0; i != qualifiers.length; i++) {
SchemaAlignment._addQualifier(qualifierContainer, qualifiers[i]);
}
}
// 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);
referencesToggleContainer.click(function(e) {
triangle.toggleClass('pointing-down');
triangle.toggleClass('pointing-right');
referenceContainer.toggle(100);
e.preventDefault();
});
referenceContainer.hide();
var right2 = $('<div></div>').addClass('wbs-right').appendTo(right);
var toolbar3 = $('<div></div>').addClass('wbs-toolbar').appendTo(right2);
var addReferenceButton = $('<a></a>').addClass('wbs-add-reference')
.click(function(e) {
referenceContainer.show();
SchemaAlignment._addReference(referenceContainer, null);
SchemaAlignment._updateReferencesNumber(referenceContainer);
e.preventDefault();
}).appendTo(toolbar3);
SchemaAlignment._plusButton($.i18n('wikibase-schema/add-reference'), addReferenceButton);
var pasteToolbar = $('<div></div>').addClass('wbs-toolbar').appendTo(referencesToggleContainer);
var referencePaste = $('<span></span>')
.addClass('wbs-paste-reference')
.appendTo(pasteToolbar);
if (SchemaAlignment._copiedReference === null) {
referencePaste.hide();
}
$('<span></span>').addClass('wbs-icon').appendTo(referencePaste);
$('<a></a>')
.addClass('wbs-paste-reference-button')
.text($.i18n('wikibase-schema/paste-reference'))
.appendTo(referencePaste)
.click(function(e) {
if (SchemaAlignment._copiedReference !== null) {
SchemaAlignment._addReference(referenceContainer, SchemaAlignment._copiedReference);
SchemaAlignment._updateReferencesNumber(referenceContainer);
referencePaste.hide();
SchemaAlignment._hasChanged();
}
e.preventDefault();
e.stopPropagation();
});
if (references) {
for (var i = 0; i != references.length; i++) {
SchemaAlignment._addReference(referenceContainer, references[i]);
}
}
SchemaAlignment._updateReferencesNumber(referenceContainer);
}
container.append(statement);
};
SchemaAlignment._statementToJSON = function (statement) {
var inputContainer = statement.find(".wbs-target-input").first();
var qualifiersList = new Array();
var referencesList = new Array();
var qualifiersDom = statement.find('.wbs-qualifier-container').first().children();
qualifiersDom.each(function () {
var qualifierJSON = SchemaAlignment._qualifierToJSON($(this));
if (qualifierJSON !== null) {
qualifiersList.push(qualifierJSON);
}
});
var referencesDom = statement.find('.wbs-reference-container').first().children();
referencesDom.each(function () {
var referenceJSON = SchemaAlignment._referenceToJSON($(this));
if (referenceJSON !== null) {
referencesList.push(referenceJSON);
}
});
var valueJSON = SchemaAlignment._inputContainerToJSON(inputContainer);
if (referencesList.length === referencesDom.length &&
qualifiersList.length === qualifiersDom.length &&
valueJSON !== null) {
return {
value: valueJSON,
qualifiers: qualifiersList,
references: referencesList,
};
} else {
return null;
}
};
/**************
* QUALIFIERS *
**************/
SchemaAlignment._addQualifier = function(container, json) {
var property = null;
var value = null;
if (json) {
property = json.prop;
value = json.value;
}
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 deleteButton = SchemaAlignment._makeDeleteButton()
.addClass('wbs-remove-statement-group')
.appendTo(toolbar1).click(function(e) {
qualifier.remove();
SchemaAlignment._hasChanged();
e.preventDefault();
});
var statementContainer = $('<div></div>').addClass('wbs-statement-container').appendTo(right);
SchemaAlignment._initPropertyField(inputContainer, statementContainer, property);
if (value && property) {
SchemaAlignment._addStatement(statementContainer, property.datatype, {value:value});
} else {
inputContainer.find('input').focus();
}
};
SchemaAlignment._qualifierToJSON = function(elem) {
var prop = elem.find(".wbs-prop-input").first();
var target = elem.find(".wbs-target-input").first();
var propJSON = SchemaAlignment._inputContainerToJSON(prop);
var valueJSON = SchemaAlignment._inputContainerToJSON(target);
if (propJSON !== null && valueJSON !== null) {
return {
prop: propJSON,
value: valueJSON,
};
} else {
return null;
}
};
/**************
* REFERENCES *
**************/
SchemaAlignment._addReference = function(container, json) {
var snaks = null;
if (json) {
snaks = json.snaks;
}
var reference = $('<div></div>').addClass('wbs-reference').appendTo(container);
var referenceHeader = $('<div></div>').addClass('wbs-reference-header').appendTo(reference);
var referenceCopy = $('<span></span>').addClass('wbs-copy-reference').appendTo(referenceHeader);
var referenceCopyIcon = $('<span></span>').addClass('wbs-icon').appendTo(referenceCopy);
var copyButton = $('<span></span>')
.addClass('wbs-copy-reference-button')
.text($.i18n('wikibase-schema/copy-reference'))
.appendTo(referenceCopy)
.click(function(e) {
if (SchemaAlignment._copyReference(reference)) {
$(this).text($.i18n('wikibase-schema/reference-copied'))
.parent().addClass('wbs-copied-reference');
container.parent().parent().find('.wbs-paste-reference').hide();
}
e.preventDefault();
});
var toolbarRef = $('<div></div>').addClass('wbs-toolbar').appendTo(referenceHeader);
SchemaAlignment._makeDeleteButton().click(function(e) {
reference.remove();
SchemaAlignment._updateReferencesNumber(container);
SchemaAlignment._hasChanged();
e.preventDefault();
}).appendTo(toolbarRef);
var right = $('<div></div>').addClass('wbs-right').appendTo(reference);
var qualifierContainer = $('<div></div>').addClass('wbs-qualifier-container').appendTo(right);
var toolbar2 = $('<div></div>').addClass('wbs-toolbar').appendTo(right);
var addSnakButton = $('<a></a>').addClass('wbs-add-qualifier')
.click(function(e) {
SchemaAlignment._addQualifier(qualifierContainer, null);
e.preventDefault();
}).appendTo(toolbar2);
SchemaAlignment._plusButton($.i18n('wikibase-schema/add-reference-snak'), addSnakButton);
if (snaks) {
for (var i = 0; i != snaks.length; i++) {
SchemaAlignment._addQualifier(qualifierContainer, snaks[i]);
}
} else {
SchemaAlignment._addQualifier(qualifierContainer, null);
}
};
SchemaAlignment._referenceToJSON = function(reference) {
var snaks = reference.find('.wbs-qualifier-container').first().children();
var snaksList = new Array();
snaks.each(function () {
var qualifier = SchemaAlignment._qualifierToJSON($(this));
if (qualifier !== null) {
snaksList.push(qualifier);
}
});
if (snaksList.length === snaks.length) {
return {snaks:snaksList};
} else {
return null;
}
};
SchemaAlignment._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'));
};
SchemaAlignment._copyReference = function(reference) {
// mark any other copied reference as not copied
$('.wbs-copy-reference-button')
.text($.i18n('wikibase-schema/copy-reference'));
$('.wbs-copy-reference')
.removeClass('wbs-copied-reference');
var copiedReference = SchemaAlignment._referenceToJSON(reference);
if (copiedReference !== null) {
SchemaAlignment._copiedReference = copiedReference;
$('.wbs-paste-reference').show();
return true;
} else {
return false;
}
};
/************************
* FIELD INITIALIZATION *
************************/
SchemaAlignment._getPropertyType = function(pid, callback) {
$.ajax({
url: WikibaseManager.getSelectedWikibaseApi(),
data: {
action: "wbgetentities",
format: "json",
ids: pid,
props: "datatype",
},
dataType: "jsonp",
success: function(data) {
callback(data.entities[pid].datatype);
}});
};
SchemaAlignment._initPropertyField = function(inputContainer, targetContainer, initialValue) {
var input = $('<input></input>').appendTo(inputContainer);
input.attr("placeholder", $.i18n('wikibase-schema/property-placeholder'));
if (this._reconService !== null) {
var endpoint = this._reconService.suggest.property;
var suggestConfig = $.extend({}, endpoint);
suggestConfig.key = null;
suggestConfig.query_param_name = "prefix";
input.suggestP(suggestConfig).bind("fb-select", function(evt, data) {
// Fetch the type of this property and add the appropriate target value type
SchemaAlignment._getPropertyType(data.id, function(datatype) {
inputContainer.data("jsonValue", {
type : "wbpropconstant",
pid : data.id,
label: data.name,
datatype: datatype,
});
SchemaAlignment._addStatement(targetContainer, datatype, null);
var addValueButtons = targetContainer.parent().find('.wbs-add-statement');
var removeGroupButton = targetContainer.parent().find('.wbs-remove-statement-group');
removeGroupButton.hide();
addValueButtons.show();
});
SchemaAlignment._hasChanged();
}).bind("fb-textchange", function(evt, data) {
inputContainer.data("jsonValue", null);
targetContainer.find('.wbs-statement').remove();
var addValueButtons = targetContainer.parent().find('.wbs-add-statement');
var removeGroupButton = targetContainer.parent().find('.wbs-remove-statement-group');
addValueButtons.hide();
removeGroupButton.show();
});
// adds tweaks to display the validation status more clearly, like in Wikidata
fixSuggestInput(input);
}
// Init with the provided initial value.
if (initialValue) {
if (initialValue.type === "wbpropconstant") {
input.val(initialValue.label);
input.addClass('wbs-validated-input');
}
inputContainer.data("jsonValue", initialValue);
}
};
SchemaAlignment._initField = function(inputContainer, mode, initialValue, changedCallback) {
var input = $('<input></input>').appendTo(inputContainer);
if (! changedCallback) {
changedCallback = SchemaAlignment._hasChanged;
}
if (this._reconService !== null && (mode === "wikibase-item" || mode === "unit")) {
if (mode === "wikibase-item") {
input.attr("placeholder", $.i18n('wikibase-schema/item-or-reconciled-column'));
} else {
input.attr("placeholder", $.i18n('wikibase-schema/unit'));
}
var endpoint = null;
endpoint = this._reconService.suggest.entity;
var suggestConfig = $.extend({}, endpoint);
suggestConfig.key = null;
suggestConfig.query_param_name = "prefix";
if ('view' in this._reconService && 'url' in this._reconService.view && !('view_url' in endpoint)) {
suggestConfig.view_url = this._reconService.view.url;
}
input.suggest(suggestConfig).bind("fb-select", function(evt, data) {
inputContainer.data("jsonValue", {
type : "wbitemconstant",
qid : data.id,
label: data.name,
});
changedCallback();
});
// adds tweaks to display the validation status more clearly, like in Wikidata
fixSuggestInput(input);
} else if (this._reconService !== null && mode === "wikibase-property") {
var endpoint = null;
endpoint = this._reconService.suggest.property;
var suggestConfig = $.extend({}, endpoint);
suggestConfig.key = null;
suggestConfig.query_param_name = "prefix";
input.suggestP(suggestConfig).bind("fb-select", function(evt, data) {
inputContainer.data("jsonValue", {
type : "wbpropconstant",
pid : data.id,
label: data.name,
datatype: "not-important",
});
changedCallback();
});
// adds tweaks to display the validation status more clearly, like in Wikidata
fixSuggestInput(input);
} else if (mode === "time") {
input.attr("placeholder", "YYYY(-MM(-DD))");
var propagateValue = function(val) {
// TODO add validation here
inputContainer.data("jsonValue", {
type: "wbdateconstant",
value: val,
});
};
propagateValue("");
input.change(function() {
propagateValue($(this).val());
changedCallback();
});
SchemaAlignment.setupStringInputValidation(input, /^(([\-]?\d{4}(-[0-1]\d(-[0-3]\d)?)?)|TODAY)$/);
} else if (mode === "globe-coordinate") {
input.attr("placeholder", "lat,lon");
var propagateValue = function(val) {
// TODO add validation here
inputContainer.data("jsonValue", {
type: "wblocationconstant",
value: val,
});
};
propagateValue("");
input.change(function() {
propagateValue($(this).val());
changedCallback();
});
SchemaAlignment.setupStringInputValidation(input, /^[\-+]?\d+(\.\d*)?[,\/][\-+]?\d+(\.\d*)?([,\/]\d+(\.\d*)?)?$/);
} else if (mode === "language") {
input.attr("placeholder", "lang");
input.addClass("wbs-language-input");
input.langsuggest().bind("fb-select", function(evt, data) {
inputContainer.data("jsonValue", {
type: "wblanguageconstant",
id: data.id,
label: data.name,
});
changedCallback();
});
fixSuggestInput(input);
} else if (mode === "monolingualtext") {
input.remove();
var inputContainerLanguage = $('<div></div>')
.addClass('wbs-monolingual-container')
.width('30%')
.appendTo(inputContainer);
var inputContainerValue = $('<div></div>')
.addClass('wbs-monolingual-container')
.width('70%')
.appendTo(inputContainer);
var langValue = null;
var strValue = null;
if (initialValue) {
langValue = initialValue.language;
strValue = initialValue.value;
}
var propagateValue = function() {
inputContainer.data("jsonValue", {
type: "wbmonolingualexpr",
language: inputContainerLanguage.data("jsonValue"),
value: inputContainerValue.data("jsonValue"),
});
changedCallback();
};
SchemaAlignment._initField(inputContainerLanguage, "language", langValue, propagateValue);
SchemaAlignment._initField(inputContainerValue, "string", strValue, propagateValue);
} else if (mode === "quantity") {
input.remove();
var inputContainerAmount = $('<div></div>')
.addClass('wbs-quantity-container')
.width('60%')
.appendTo(inputContainer);
var inputContainerUnit = $('<div></div>')
.addClass('wbs-quantity-container')
.width('40%')
.appendTo(inputContainer);
var amountValue = null;
var unitValue = null;
if (initialValue) {
amountValue = initialValue.amount;
unitValue = initialValue.unit;
}
var propagateValue = function() {
inputContainer.data("jsonValue", {
type: "wbquantityexpr",
amount: inputContainerAmount.data("jsonValue"),
unit: inputContainerUnit.data("jsonValue"),
});
changedCallback();
};
SchemaAlignment._initField(inputContainerAmount, "amount", amountValue, propagateValue);
SchemaAlignment._initField(inputContainerUnit, "unit", unitValue, propagateValue);
} else {
var propagateValue = function(val) {
inputContainer.data("jsonValue", {
type: "wbstringconstant",
value: val,
});
};
propagateValue("");
input.change(function() {
propagateValue($(this).val());
changedCallback();
});
if (mode === "amount") {
input.attr("placeholder", $.i18n('wikibase-schema/amount'));
SchemaAlignment.setupStringInputValidation(input, /^[\-+]?\d+(\.\d*)?(E[\-+]\d+)?$/);
} else if (mode === "url") {
input.attr("placeholder", $.i18n('wikibase-schema/full-url'));
SchemaAlignment.setupStringInputValidation(input, /^https?:\/\/.+$/);
} else if (mode === "tabular-data") {
input.attr("placeholder", $.i18n('wikibase-schema/tabular-data-with-prefix'));
SchemaAlignment.setupStringInputValidation(input, /^Data:.+$/);
} else if (mode === "commonsMedia") {
input.attr("placeholder", $.i18n('wikibase-schema/commons-media'));
} else if (mode === "math") {
input.attr("placeholder", $.i18n('wikibase-schema/math-expression'));
} else if (mode === "geo-shape") {
input.attr("placeholder", $.i18n('wikibase-schema/geoshape-with-prefix'));
SchemaAlignment.setupStringInputValidation(input, /^Data:.+$/);
} else {
SchemaAlignment.setupStringInputValidation(input, /^.+$/);
}
if (mode !== "external-id" &&
mode !== "url" &&
mode !== "string" &&
mode !== "amount" &&
mode !== "tabular-data" &&
mode !== "commonsMedia" &&
mode !== "geo-shape" &&
mode !== "math") {
alert($.i18n('wikibase-schema/datatype-not-supported-yet'));
}
}
var acceptDraggableColumn = function(column) {
input.hide();
input.val("");
var columnDiv = $('<div></div>').appendTo(inputContainer);
column.appendTo(columnDiv);
var origText = column.text();
column.text("");
column.append($('<div></div>').addClass('wbs-restricted-column-name').text(origText));
var deleteButton = SchemaAlignment._makeDeleteButton(true).appendTo(column);
deleteButton.attr('alt', $.i18n('wikibase-schema/remove-column'));
deleteButton.click(function (e) {
columnDiv.remove();
input.show();
inputContainer.data("jsonValue", null);
changedCallback();
e.preventDefault();
});
};
// Make it droppable
var acceptClass = ".wbs-draggable-column";
var wbVariableType = "wbstringvariable";
if (mode === "wikibase-item" || mode === "unit") {
acceptClass = ".wbs-reconciled-column";
wbVariableType = "wbitemvariable";
} else if (mode === "time") {
wbVariableType = "wbdatevariable";
} else if (mode === "globe-coordinate") {
wbVariableType = "wblocationvariable";
} else if (mode === "monolingualtext" || mode === "quantity") {
wbVariableType = null; // not droppable directly
} else if (mode === "language") {
wbVariableType = "wblanguagevariable";
}
if (wbVariableType) {
inputContainer.droppable({
accept: acceptClass,
}).on("drop", function (evt, ui) {
var column = ui.draggable.clone();
acceptDraggableColumn(column);
inputContainer.data("jsonValue", {
type : wbVariableType,
columnName: ui.draggable.text(),
});
changedCallback();
return true;
}).on("dropactivate", function(evt, ui) {
input.addClass("wbs-accepting-input");
}).on("dropdeactivate", function(evt, ui) {
input.removeClass("wbs-accepting-input");
});
}
// Init with the provided initial value.
if (initialValue) {
if (initialValue.type === "wbitemconstant" || initialValue.type === "wbpropconstant") {
input.val(initialValue.label);
input.addClass("wbs-validated-input");
} else if (initialValue.type == "wbitemvariable") {
var cell = SchemaAlignment._createDraggableColumn(initialValue.columnName, true);
acceptDraggableColumn(cell);
} else if (initialValue.type === "wbstringconstant" ||
initialValue.type === "wbdateconstant" ||
initialValue.type === "wblocationconstant") {
input.val(initialValue.value);
} else if (initialValue.type === "wblanguageconstant") {
input.val(initialValue.id);
input.addClass("wbs-validated-input");
} else if (initialValue.type === "wbstringvariable" ||
initialValue.type === "wbdatevariable" ||
initialValue.type === "wblocationvariable" ||
initialValue.type === "wblanguagevariable") {
var cell = SchemaAlignment._createDraggableColumn(initialValue.columnName, false);
acceptDraggableColumn(cell);
}
inputContainer.data("jsonValue", initialValue);
}
};
SchemaAlignment.setupStringInputValidation = function(input, regex) {
input.focus(function() {
input.removeClass('wbs-unvalidated-input');
}).blur(function() {
var currentValue = input.val();
if (regex.test(currentValue)) {
input.addClass('wbs-validated-input');
} else {
input.addClass('wbs-unvalidated-input');
}
});
};
SchemaAlignment._inputContainerToJSON = function (inputContainer) {
var data = inputContainer.data();
if (data && 'jsonValue' in data) {
return data.jsonValue;
} else {
return null;
}
};
SchemaAlignment._removeStatement = function(statement) {
var statementGroup = statement.parents('.wbs-statement-group, .wbs-qualifier').first();
statement.remove();
var remainingStatements = statementGroup.find('.wbs-statement').length;
if (remainingStatements === 0) {
statementGroup.remove();
}
SchemaAlignment._hasChanged();
};
SchemaAlignment.getJSON = function() {
var list = [];
var itemsDom = $('#schema-alignment-statements-container .wbs-item');
itemsDom.each(function () {
var itemJSON = SchemaAlignment._itemToJSON($(this));
if (itemJSON !== null) {
list.push(itemJSON);
}
});
if (list.length === itemsDom.length) {
return {
itemDocuments: list,
siteIri: WikibaseManager.getSelectedWikibaseSiteIri(),
mediaWikiApiEndpoint: WikibaseManager.getSelectedWikibaseApi()
};
} else {
return null;
}
};
SchemaAlignment._hasChanged = function() {
SchemaAlignment._hasUnsavedChanges = true;
SchemaAlignment.preview();
SchemaAlignment._unsavedIndicator.show();
SchemaAlignment._schemaElmts.saveButton
.prop('disabled', false)
.removeClass('disabled');
SchemaAlignment._schemaElmts.discardButton
.prop('disabled', false)
.removeClass('disabled');
$('.wbs-copy-reference-button')
.text($.i18n('wikibase-schema/copy-reference'));
$('.wbs-copy-reference')
.removeClass('wbs-copied-reference');
};
SchemaAlignment.updateNbEdits = function(nb_edits) {
this._previewElmts.previewExplanation.html($.i18n('wikibase-schema/preview-explanation',
nb_edits,
WikibaseManager.getSelectedWikibaseMainPage(),
WikibaseManager.getSelectedWikibaseName()
));
};
SchemaAlignment.preview = function() {
var self = this;
$('.invalid-schema-warning').hide();
this._previewPanes.empty();
this.updateNbEdits(0);
this.issueSpinner.show();
this.previewSpinner.show();
var schema = this.getJSON();
if (schema === null) {
$('.invalid-schema-warning').show();
return;
}
Refine.postCSRF(
"command/wikidata/preview-wikibase-schema?" + $.param({ project: theProject.id }),
{ schema: JSON.stringify(schema), manifest: JSON.stringify(WikibaseManager.getSelectedWikibase()), engine: JSON.stringify(ui.browsingEngine.getJSON()) },
function(data) {
self.issueSpinner.hide();
self.previewSpinner.hide();
if ("edits_preview" in data) {
var previewContainer = self._previewPanes[0];
EditRenderer.renderEdits(data.edits_preview, previewContainer);
self.updateNbEdits(data["edit_count"]);
}
if (data.warnings) {
self._updateWarnings(data.warnings, data.nb_warnings);
} else {
self._updateWarnings([], 0);
}
if ("code" in data && data.code === "error") {
$('.invalid-schema-warning').show();
}
},
"json"
);
};
// Used for injecting tabs in any project where the schema has been defined.
SchemaAlignment.onProjectUpdate = function(options) {
if(theProject.overlayModels.wikibaseSchema && !SchemaAlignment.isSetUp()) {
SchemaAlignment.setUpTabs();
}
if (SchemaAlignment.isSetUp() && (options.everythingChanged || options.modelsChanged ||
options.rowsChanged || options.rowMetadataChanged || options.cellsChanged || options.engineChanged)) {
if (!SchemaAlignment._hasUnsavedChanges) {
SchemaAlignment._discardChanges();
}
SchemaAlignment.updateColumns();
SchemaAlignment.preview();
}
};
/*************************
* WARNINGS RENDERING *
*************************/
SchemaAlignment._updateWarnings = function(warnings, totalCount) {
var mainDiv = $('#wikibase-issues-panel');
var countsElem = this.issuesTabCount;
// clear everything
mainDiv.empty();
countsElem.hide();
var table = $('<table></table>').appendTo(mainDiv);
for (var i = 0; i != warnings.length; i++) {
var rendered = WarningsRenderer._renderWarning(warnings[i]);
rendered.appendTo(table);
}
// update the counts
if (totalCount) {
countsElem.text(totalCount);
countsElem.show();
}
};