RandomSec/extensions/wikidata/module/scripts/dialogs/manage-account-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

227 lines
8.0 KiB
JavaScript

var ManageAccountDialog = {};
/**
* Displays the logged in page if the user is logged in,
* displays the login page otherwise.
*/
ManageAccountDialog.display = function (logged_in_username, onSuccess) {
if (logged_in_username == null) {
ManageAccountDialog.tryLoginWithCookies(onSuccess);
} else {
ManageAccountDialog.displayLoggedIn(logged_in_username);
}
};
ManageAccountDialog.tryLoginWithCookies = function (onSuccess) {
// Try with cookies first.
const discardWaiter = DialogSystem.showBusy($.i18n('wikibase-account/connecting-to-wikibase'));
Refine.postCSRF(
"command/wikidata/login",
{"wb-api-endpoint": WikibaseManager.getSelectedWikibaseApi()},
function (data) {
discardWaiter();
if (data.logged_in) {
onSuccess(data.username);
ManageAccountDialog.displayLoggedIn(data.username);
} else {
// If failed, then login with username/password.
ManageAccountDialog.displayPasswordLogin(onSuccess);
}
});
};
ManageAccountDialog.initCommon = function (elmts) {
elmts.dialogHeader.text($.i18n('wikibase-account/dialog-header', WikibaseManager.getSelectedWikibaseName()));
elmts.explainLogIn.html($.i18n('wikibase-account/explain-log-in',
WikibaseManager.getSelectedWikibaseMainPage(), WikibaseManager.getSelectedWikibaseName()));
elmts.cancelButton.text($.i18n('wikibase-account/close'));
};
ManageAccountDialog.displayLoggedIn = function (logged_in_username) {
var frame = $(DOM.loadHTML("wikidata", "scripts/dialogs/logged-in-dialog.html"));
var elmts = DOM.bind(frame);
ManageAccountDialog.initCommon(elmts);
elmts.loggedInAs.text($.i18n('wikibase-account/logged-in-as'));
elmts.logoutButton.text($.i18n('wikibase-account/log-out'));
var level = DialogSystem.showDialog(frame);
var dismiss = function () {
DialogSystem.dismissUntil(level - 1);
};
elmts.loggedInUsername
.text(logged_in_username)
.attr('href', WikibaseManager.getSelectedWikibaseRoot() + 'User:' + logged_in_username);
elmts.cancelButton.click(function (e) {
dismiss();
});
elmts.logoutButton.click(function () {
frame.hide();
Refine.postCSRF(
"command/wikidata/login",
$.param({
"logout": "true",
"wb-api-endpoint": WikibaseManager.getSelectedWikibaseApi()
}),
function (data) {
frame.show();
if (!data.logged_in) {
dismiss();
}
});
});
};
ManageAccountDialog.displayPasswordLogin = function (onSuccess) {
const frame = $(DOM.loadHTML("wikidata", "scripts/dialogs/password-login-dialog.html"));
const elmts = DOM.bind(frame);
ManageAccountDialog.initCommon(elmts);
elmts.explainOwnerOnlyConsumerLogin.html($.i18n('wikibase-account/explain-owner-only-consumer-login'));
elmts.invalidCredentials.text($.i18n('wikibase-account/invalid-credentials'));
elmts.invalidCredentials.hide();
elmts.usernameLabel.text($.i18n('wikibase-account/username-label'));
elmts.usernameInput.attr("placeholder", $.i18n('wikibase-account/username-placeholder'));
elmts.passwordLabel.text($.i18n('wikibase-account/password-label'));
elmts.passwordInput.attr("placeholder", $.i18n('wikibase-account/password-placeholder'));
elmts.rememberMe.text($.i18n('wikibase-account/remember-me'));
elmts.passwordRememberMeTitle.attr("title", $.i18n('wikibase-account/password-remember-me-title'));
elmts.loginButton.text($.i18n('wikibase-account/log-in'));
elmts.usernameInput.focus();
// We don't support logging in with owner-only consumer if the target Wikibase doesn't support OAuth.
if (!WikibaseManager.getSelectedWikibaseOAuth()) {
elmts.dialogFooter.hide();
}
var level = DialogSystem.showDialog(frame);
var dismiss = function () {
DialogSystem.dismissUntil(level - 1);
};
elmts.cancelButton.click(function (e) {
dismiss();
});
elmts.explainOwnerOnlyConsumerLogin.click(function (e) {
dismiss();
ManageAccountDialog.displayOwnerOnlyConsumerLogin(onSuccess);
});
elmts.loginForm.submit(function (e) {
frame.hide();
let formArr = elmts.loginForm.serializeArray();
formArr.push({name: "wb-api-endpoint", value: WikibaseManager.getSelectedWikibaseApi()});
Refine.postCSRF(
"command/wikidata/login",
$.param(formArr),
function (data) {
if (data.logged_in) {
dismiss();
onSuccess(data.username);
} else {
frame.show();
elmts.invalidCredentials.show();
}
});
e.preventDefault();
});
};
ManageAccountDialog.displayOwnerOnlyConsumerLogin = function (onSuccess) {
var frame = $(DOM.loadHTML("wikidata", "scripts/dialogs/owner-only-consumer-login-dialog.html"));
var elmts = DOM.bind(frame);
ManageAccountDialog.initCommon(elmts);
elmts.explainOwnerOnlyConsumerWiki.html($.i18n('wikibase-account/explain-owner-only-consumer-wiki',
WikibaseManager.getSelectedWikibaseOAuth().registration_page));
elmts.explainPasswordLogin.html($.i18n('wikibase-account/explain-password-login'));
elmts.invalidCredentials.text($.i18n('wikibase-account/invalid-credentials'));
elmts.invalidCredentials.hide();
elmts.consumerTokenLabel.text($.i18n('wikibase-account/consumer-token-label'));
elmts.consumerTokenInput.attr("placeholder", $.i18n('wikibase-account/consumer-token-placeholder'));
elmts.consumerSecretLabel.text($.i18n('wikibase-account/consumer-secret-label'));
elmts.consumerSecretInput.attr("placeholder", $.i18n('wikibase-account/consumer-secret-placeholder'));
elmts.accessTokenLabel.text($.i18n('wikibase-account/access-token-label'));
elmts.accessTokenInput.attr("placeholder", $.i18n('wikibase-account/access-token-placeholder'));
elmts.accessSecretLabel.text($.i18n('wikibase-account/access-secret-label'));
elmts.accessSecretInput.attr("placeholder", $.i18n('wikibase-account/access-secret-placeholder'));
elmts.rememberMe.text($.i18n('wikibase-account/remember-me'));
elmts.ownerOnlyConsumerRememberMeTitle.attr("title", $.i18n('wikibase-account/owner-only-consumer-remember-me-title'));
elmts.loginButton.text($.i18n('wikibase-account/log-in'));
elmts.consumerTokenInput.focus();
var level = DialogSystem.showDialog(frame);
var dismiss = function () {
DialogSystem.dismissUntil(level - 1);
};
elmts.cancelButton.click(function (e) {
dismiss();
});
elmts.explainPasswordLogin.click(function (e) {
dismiss();
ManageAccountDialog.displayPasswordLogin(onSuccess);
});
elmts.loginForm.submit(function (e) {
frame.hide();
let formArr = elmts.loginForm.serializeArray();
formArr.push({name: "wb-api-endpoint", value: WikibaseManager.getSelectedWikibaseApi()});
Refine.postCSRF(
"command/wikidata/login",
$.param(formArr),
function (data) {
if (data.logged_in) {
dismiss();
onSuccess(data.username);
} else {
frame.show();
elmts.invalidCredentials.show();
}
});
e.preventDefault();
});
};
/**
* Checks if the user is logged in or not.
*
* The callback needs to react to both cases.
*/
ManageAccountDialog.isLoggedIn = function (callback) {
$.get(
"command/wikidata/login",
{"wb-api-endpoint": WikibaseManager.getSelectedWikibaseApi()},
function (data) {
if (data.logged_in) {
// make sure that the user is logged in to the selected Wikibase
callback(data.username)
} else {
callback(null);
}
});
};
/**
* The onSuccess callback is called if and only if the user is logged in.
*/
ManageAccountDialog.ensureLoggedIn = function (onSuccess) {
ManageAccountDialog.isLoggedIn(function (logged_in_username) {
if (logged_in_username == null) {
ManageAccountDialog.display(null, onSuccess);
} else {
onSuccess(logged_in_username);
}
});
};
ManageAccountDialog.checkAndLaunch = function () {
ManageAccountDialog.isLoggedIn(function (logged_in_username) {
ManageAccountDialog.display(logged_in_username, function (success) {
});
});
};