{
const dontShowWarning = await CoreConfig.get(CoreLoginHelperProvider.FAQ_QRCODE_INFO_DONE, 0);
if (dontShowWarning) {
return;
}
const message = Translate.instant(
'core.login.faqwhereisqrcodeanswer',
{ $image: ''+ CoreLoginHelperProvider.FAQ_QRCODE_IMAGE_HTML + '
' },
);
const header = Translate.instant('core.login.faqwhereisqrcode');
try {
const dontShowAgain = await CoreDomUtils.showPrompt(
message,
header,
Translate.instant('core.dontshowagain'),
'checkbox',
{ okText: Translate.instant('core.next'), cancelText: Translate.instant('core.cancel') },
);
if (dontShowAgain) {
CoreConfig.set(CoreLoginHelperProvider.FAQ_QRCODE_INFO_DONE, 1);
}
} catch {
// User canceled.
throw new CoreCanceledError('');
}
}
/**
* Scan a QR code and tries to authenticate the user using custom URL scheme.
*
* @returns Promise resolved when done.
*/
async scanQR(): Promise {
// Scan for a QR code.
const text = await CoreUtils.scanQR();
if (text && CoreCustomURLSchemes.isCustomURL(text)) {
try {
await CoreCustomURLSchemes.handleCustomURL(text);
} catch (error) {
CoreCustomURLSchemes.treatHandleCustomURLError(error);
}
} else if (text) {
// Not a custom URL scheme, check if it's a URL scheme to another app.
const scheme = CoreUrlUtils.getUrlProtocol(text);
if (scheme && scheme != 'http' && scheme != 'https') {
CoreDomUtils.showErrorModal(Translate.instant('core.errorurlschemeinvalidscheme', { $a: text }));
} else {
CoreDomUtils.showErrorModal('core.login.errorqrnoscheme', true);
}
}
}
/**
* Get the accounts list classified per site.
*
* @returns Promise resolved with account list.
*/
async getAccountsList(): Promise {
const sites = await CoreUtils.ignoreErrors(CoreSites.getSortedSites(), [] as CoreSiteBasicInfo[]);
const accountsList: CoreAccountsList = {
sameSite: [],
otherSites: [],
count: sites.length,
};
const currentSiteId = CoreSites.getCurrentSiteId();
let siteUrl = '';
if (currentSiteId) {
siteUrl = sites.find((site) => site.id == currentSiteId)?.siteUrlWithoutProtocol ?? '';
}
const otherSites: Record = {};
// Add site counter and classify sites.
await Promise.all(sites.map(async (site) => {
site.badge = await CoreUtils.ignoreErrors(CorePushNotifications.getSiteCounter(site.id)) || 0;
if (site.id === currentSiteId) {
accountsList.currentSite = site;
} else if (site.siteUrlWithoutProtocol == siteUrl) {
accountsList.sameSite.push(site);
} else {
if (!otherSites[site.siteUrlWithoutProtocol]) {
otherSites[site.siteUrlWithoutProtocol] = [];
}
otherSites[site.siteUrlWithoutProtocol].push(site);
}
return;
}));
accountsList.otherSites = CoreUtils.objectToArray(otherSites);
return accountsList;
}
/**
* Find and delete a site from the list of sites.
*
* @param accountsList Account list.
* @param site Site to be deleted.
* @returns Resolved when done.
*/
async deleteAccountFromList(accountsList: CoreAccountsList, site: CoreSiteBasicInfo): Promise {
await CoreSites.deleteSite(site.id);
const siteUrl = site.siteUrlWithoutProtocol;
let index = 0;
// Found on same site.
if (accountsList.sameSite.length > 0 && accountsList.sameSite[0].siteUrlWithoutProtocol == siteUrl) {
index = accountsList.sameSite.findIndex((listedSite) => listedSite.id == site.id);
if (index >= 0) {
accountsList.sameSite.splice(index, 1);
accountsList.count--;
}
return;
}
const otherSiteIndex = accountsList.otherSites.findIndex((sites) =>
sites.length > 0 && sites[0].siteUrlWithoutProtocol == siteUrl);
if (otherSiteIndex < 0) {
// Site Url not found.
return;
}
index = accountsList.otherSites[otherSiteIndex].findIndex((listedSite) => listedSite.id == site.id);
if (index >= 0) {
accountsList.otherSites[otherSiteIndex].splice(index, 1);
accountsList.count--;
}
if (accountsList.otherSites[otherSiteIndex].length == 0) {
accountsList.otherSites.splice(otherSiteIndex, 1);
}
}
/**
* Get reconnect page route module.
*
* @returns Reconnect page route module.
*/
async getReconnectRouteModule(): Promise {
return import('@features/login/login-reconnect-lazy.module').then(m => m.CoreLoginReconnectLazyModule);
}
/**
* Get credentials page route module.
*
* @returns Credentials page route module.
*/
async getCredentialsRouteModule(): Promise {
return import('@features/login/login-credentials-lazy.module').then(m => m.CoreLoginCredentialsLazyModule);
}
/**
* Retrieve login methods.
*
* @returns Login methods found.
*/
async getLoginMethods(): Promise {
return [];
}
/**
* Retrieve default login method.
*
* @returns Default login method.
*/
async getDefaultLoginMethod(): Promise {
return null;
}
/**
* Record that a password reset has been requested for a given site.
*
* @param siteUrl Site url.
*/
async passwordResetRequested(siteUrl: string): Promise {
const passwordResets = await this.getPasswordResets();
passwordResets[siteUrl] = Date.now();
await CoreConfig.set(PASSWORD_RESETS_CONFIG_KEY, JSON.stringify(passwordResets));
}
/**
* Find out if a password reset has been requested recently for a given site.
*
* @param siteUrl Site url.
* @returns Whether a password reset has been requested recently.
*/
async wasPasswordResetRequestedRecently(siteUrl: string): Promise {
const passwordResets = await this.getPasswordResets();
return siteUrl in passwordResets
&& passwordResets[siteUrl] > Date.now() - CoreConstants.MILLISECONDS_HOUR;
}
/**
* Clean up expired password reset records from the database.
*/
async cleanUpPasswordResets(): Promise {
const passwordResets = await this.getPasswordResets();
const siteUrls = Object.keys(passwordResets);
for (const siteUrl of siteUrls) {
if (passwordResets[siteUrl] > Date.now() - CoreConstants.MILLISECONDS_HOUR) {
continue;
}
delete passwordResets[siteUrl];
}
if (Object.values(passwordResets).length === 0) {
await CoreConfig.delete(PASSWORD_RESETS_CONFIG_KEY);
} else {
await CoreConfig.set(PASSWORD_RESETS_CONFIG_KEY, JSON.stringify(passwordResets));
}
}
/**
* Build the HTML message to show once login attempts have been exceeded.
*
* @param canContactSupport Whether contacting support is enabled in the site.
* @param canRecoverPassword Whether recovering the password is enabled in the site.
* @returns HTML message.
*/
buildExceededAttemptsHTML(canContactSupport: boolean, canRecoverPassword: boolean): SafeHtml | string | null {
const safeHTML = (html: string) => DomSanitizer.sanitize(SecurityContext.HTML, html) ?? '';
const recoverPasswordHTML = (messageKey: string) => {
const placeholder = '%%RECOVER_PASSWORD%%';
const message = safeHTML(Translate.instant(messageKey, { recoverPassword: placeholder }));
const recoverPassword = safeHTML(Translate.instant('core.login.exceededloginattemptsrecoverpassword'));
return DomSanitizer.bypassSecurityTrustHtml(
message.replace(placeholder, `${recoverPassword}`),
);
};
if (canContactSupport && canRecoverPassword) {
return recoverPasswordHTML('core.login.exceededloginattempts');
}
if (canContactSupport) {
return Translate.instant('core.login.exceededloginattemptswithoutpassword');
}
if (canRecoverPassword) {
return recoverPasswordHTML('core.login.exceededloginattemptswithoutsupport');
}
return null;
}
/**
* Get a record indexing the last time a password reset was requested for a site.
*
* @returns Password resets.
*/
protected async getPasswordResets(): Promise> {
const passwordResetsJson = await CoreConfig.get(PASSWORD_RESETS_CONFIG_KEY, '{}');
return CoreTextUtils.parseJSON>(passwordResetsJson, {});
}
/**
* Check if a URL belongs to the demo mode site.
*
* @returns Whether the URL belongs to the demo mode site.
*/
isDemoModeSite(url: string): boolean {
const demoSiteData = CoreLoginHelper.getDemoModeSiteInfo();
if (!demoSiteData) {
return false;
}
const demoSiteUrl = CoreTextUtils.addEndingSlash(CoreUrlUtils.removeProtocolAndWWW(demoSiteData.url));
url = CoreTextUtils.addEndingSlash(CoreUrlUtils.removeProtocolAndWWW(url));
return demoSiteUrl.indexOf(url) === 0;
}
}
export const CoreLoginHelper = makeSingleton(CoreLoginHelperProvider);
/**
* Accounts list for selecting sites interfaces.
*/
export type CoreAccountsList = {
currentSite?: T; // If logged in, current site info.
sameSite: T[]; // If logged in, accounts info on the same site.
otherSites: T[][]; // Other accounts in other sites.
count: number; // Number of sites.
};
/**
* Data related to a SSO authentication.
*/
export type CoreLoginSSOData = CoreRedirectPayload & {
siteUrl: string; // The site's URL.
token?: string; // User's token.
privateToken?: string; // User's private token.
ssoUrlParams?: CoreUrlParams; // Other params added to the login url.
};
/**
* Result of WS core_user_agree_site_policy.
*/
type AgreeSitePolicyResult = {
status: boolean; // Status: true only if we set the policyagreed to 1 for the user.
warnings?: CoreWSExternalWarning[];
};
/**
* Result of WS auth_email_get_signup_settings.
*/
export type AuthEmailSignupSettings = {
namefields: string[];
passwordpolicy?: string; // Password policy.
sitepolicy?: string; // Site policy.
sitepolicyhandler?: string; // Site policy handler.
defaultcity?: string; // Default city.
country?: string; // Default country.
profilefields?: AuthEmailSignupProfileField[]; // Required profile fields.
recaptchapublickey?: string; // Recaptcha public key.
recaptchachallengehash?: string; // Recaptcha challenge hash.
recaptchachallengeimage?: string; // Recaptcha challenge noscript image.
recaptchachallengejs?: string; // Recaptcha challenge js url.
warnings?: CoreWSExternalWarning[];
};
/**
* Profile field for signup.
*/
export type AuthEmailSignupProfileField = {
id?: number; // Profile field id.
shortname?: string; // Profile field shortname.
name?: string; // Profield field name.
datatype?: string; // Profield field datatype.
description?: string; // Profield field description.
descriptionformat: number; // Description format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
categoryid?: number; // Profield field category id.
categoryname?: string; // Profield field category name.
sortorder?: number; // Profield field sort order.
required?: number; // Profield field required.
locked?: number; // Profield field locked.
visible?: number; // Profield field visible.
forceunique?: number; // Profield field unique.
signup?: number; // Profield field in signup form.
defaultdata?: string; // Profield field default data.
defaultdataformat: number; // Defaultdata format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
param1?: string; // Profield field settings.
param2?: string; // Profield field settings.
param3?: string; // Profield field settings.
param4?: string; // Profield field settings.
param5?: string; // Profield field settings.
};
/**
* Category of profile fields for signup.
*/
export type AuthEmailSignupProfileFieldsCategory = {
id: number; // Category ID.
name: string; // Category name.
fields: AuthEmailSignupProfileField[]; // Field in the category.
};
/**
* Result of WS core_auth_request_password_reset.
*/
export type CoreLoginRequestPasswordResetResult = {
status: string; // The returned status of the process
notice: string; // Important information for the user about the process.
warnings?: CoreWSExternalWarning[];
};
/**
* Result of WS core_auth_resend_confirmation_email.
*/
type ResendConfirmationEmailResult = {
status: boolean; // True if the confirmation email was sent, false otherwise.
warnings?: CoreWSExternalWarning[];
};
type StoredLoginLaunchData = CoreRedirectPayload & {
siteUrl: string;
passport: number;
ssoUrlParams: CoreUrlParams;
};
export type CoreLoginSiteSelectorListMethod =
'url'|
'sitefinder'|
'list'|
'';
export type CoreLoginMethod = {
name: string; // Name of the login method.
icon: string; // Icon of the provider.
action: () => unknown; // Action to execute on button click.
};
export type CoreLoginSiteFinderSettings = {
displayalias: boolean;
displaycity: boolean;
displaycountry: boolean;
displayimage: boolean;
displaysitename: boolean;
displayurl: boolean;
defaultimageurl?: string;
};
';
static readonly FAQ_QRCODE_IMAGE_HTML = '
';
protected logger: CoreLogger;
protected sessionExpiredCheckingSite: Record