EVOgeek
/
Vmeda.Online
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MOBILE-1611 mathjax: Support MathJax in the app

main
Dani Palou 2019-10-09 12:06:41 +02:00
parent 012aa2563f
commit c18d8b1d12
18 changed files with 652 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/addon/calendar/pages/edit-event/edit-event.ts
View File

@ -245,8 +245,8 @@ export class AddonCalendarEditEventPage implements OnInit, OnDestroy {
const subPromises = [];
courses.forEach((course) => {
subPromises.push(this.filterHelper.getFiltersAndFormatText(course.fullname, 'course', course.id)
.then((text) => {
course.fullname = text;
.then((result) => {
course.fullname = result.text;
}).catch(() => {
// Ignore errors.
}));

2
src/addon/filter/filter.module.ts
View File

@ -20,6 +20,7 @@ import { AddonFilterDataModule } from './data/data.module';
import { AddonFilterEmailProtectModule } from './emailprotect/emailprotect.module';
import { AddonFilterEmoticonModule } from './emoticon/emoticon.module';
import { AddonFilterGlossaryModule } from './glossary/glossary.module';
import { AddonFilterMathJaxLoaderModule } from './mathjaxloader/mathjaxloader.module';
import { AddonFilterMediaPluginModule } from './mediaplugin/mediaplugin.module';
import { AddonFilterMultilangModule } from './multilang/multilang.module';
import { AddonFilterTexModule } from './tex/tex.module';
@ -36,6 +37,7 @@ import { AddonFilterUrlToLinkModule } from './urltolink/urltolink.module';
AddonFilterEmailProtectModule,
AddonFilterEmoticonModule,
AddonFilterGlossaryModule,
AddonFilterMathJaxLoaderModule,
AddonFilterMediaPluginModule,
AddonFilterMultilangModule,
AddonFilterTexModule,

34
src/addon/filter/mathjaxloader/mathjaxloader.module.ts 100644
View File

@ -0,0 +1,34 @@
// (C) Copyright 2015 Martin Dougiamas
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { NgModule } from '@angular/core';
import { IonicModule } from 'ionic-angular';
import { CoreFilterDelegate } from '@core/filter/providers/delegate';
import { AddonFilterMathJaxLoaderHandler } from './providers/handler';
@NgModule({
declarations: [
],
imports: [
IonicModule
],
providers: [
AddonFilterMathJaxLoaderHandler
]
})
export class AddonFilterMathJaxLoaderModule {
constructor(filterDelegate: CoreFilterDelegate, handler: AddonFilterMathJaxLoaderHandler) {
filterDelegate.registerHandler(handler);
}
}

374
src/addon/filter/mathjaxloader/providers/handler.ts 100644
View File

@ -0,0 +1,374 @@
// (C) Copyright 2015 Martin Dougiamas
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { Injectable } from '@angular/core';
import { CoreFilterDefaultHandler } from '@core/filter/providers/default-filter';
import { CoreFilterFilter, CoreFilterFormatTextOptions } from '@core/filter/providers/filter';
import { CoreEventsProvider } from '@providers/events';
import { CoreLangProvider } from '@providers/lang';
import { CoreSitesProvider } from '@providers/sites';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreSite } from '@classes/site';
/**
* Handler to support the MathJax filter.
*/
@Injectable()
export class AddonFilterMathJaxLoaderHandler extends CoreFilterDefaultHandler {
name = 'AddonFilterMathJaxLoaderHandler';
filterName = 'mathjaxloader';
// Default values for MathJax config for sites where we cannot retrieve it.
protected DEFAULT_URL = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js';
protected DEFAULT_CONFIG = 'MathJax.Hub.Config({' +
'config: ["Accessible.js", "Safe.js"],' +
'errorSettings: { message: ["!"] },' +
'skipStartupTypeset: true,' +
'messageStyle: "none"' +
'});';
// List of language codes found in the MathJax/localization/ directory.
protected MATHJAX_LANG_CODES = [
'ar', 'ast', 'bcc', 'bg', 'br', 'ca', 'cdo', 'ce', 'cs', 'cy', 'da', 'de', 'diq', 'en', 'eo', 'es', 'fa',
'fi', 'fr', 'gl', 'he', 'ia', 'it', 'ja', 'kn', 'ko', 'lb', 'lki', 'lt', 'mk', 'nl', 'oc', 'pl', 'pt',
'pt-br', 'qqq', 'ru', 'scn', 'sco', 'sk', 'sl', 'sv', 'th', 'tr', 'uk', 'vi', 'zh-hans', 'zh-hant'
];
// List of explicit mappings and known exceptions (moodle => mathjax).
protected EXPLICIT_MAPPING = {
'cz': 'cs',
'zh-tw': 'zh-hant',
'zh-cn': 'zh-hans',
};
protected window: any = window; // Convert the window to <any> to be able to use non-standard properties like MathJax.
constructor(eventsProvider: CoreEventsProvider,
private langProvider: CoreLangProvider,
private sitesProvider: CoreSitesProvider,
private textUtils: CoreTextUtilsProvider,
private utils: CoreUtilsProvider) {
super();
// Load the JS.
this.loadJS();
// Get the current language.
this.langProvider.getCurrentLanguage().then((lang) => {
lang = this.mapLanguageCode(lang);
// Now call the configure function.
this.window.M.filter_mathjaxloader.configure({
mathjaxconfig: this.DEFAULT_CONFIG,
lang: lang
});
});
// Update MathJax locale if app language changes.
eventsProvider.on(CoreEventsProvider.LANGUAGE_CHANGED, (lang) => {
if (typeof this.window.MathJax != 'undefined') {
lang = this.mapLanguageCode(lang);
this.window.MathJax.Hub.Queue(() => {
this.window.MathJax.Localization.setLocale(lang);
});
}
});
}
/**
* Filter some text.
*
* @param text The text to filter.
* @param filter The filter.
* @param options Options passed to the filters.
* @param siteId Site ID. If not defined, current site.
* @return Filtered text (or promise resolved with the filtered text).
*/
filter(text: string, filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, siteId?: string)
: string | Promise<string> {
return this.sitesProvider.getSite(siteId).then((site) => {
// Don't apply this filter if Moodle is 3.7 or higher and the WS already filtered the content.
if (!options.wsNotFiltered && site.isVersionGreaterEqualThan('3.7')) {
return text;
}
if (text.indexOf('class="filter_mathjaxloader_equation"') != -1) {
// The content seems to have treated mathjax already, don't do it.
return text;
}
// We cannot get the filter settings, so we cannot know if it can be used as a replacement for the TeX filter.
// Assume it cannot (default value).
let hasDisplayOrInline = false;
if (text.match(/\\[\[\(]/) || text.match(/\$\$/)) {
// Only parse the text if there are mathjax symbols in it.
// The recognized math environments are \[ \] and $$ $$ for display mathematics and \( \) for inline mathematics.
// Wrap display and inline math environments in nolink spans.
const result = this.wrapMathInNoLink(text);
text = result.text;
hasDisplayOrInline = result.changed;
}
if (hasDisplayOrInline) {
return '<span class="filter_mathjaxloader_equation">' + text + '</span>';
}
return text;
});
}
/**
* Handle HTML. This function is called after "filter", and it will receive an HTMLElement containing the text that was
* filtered.
*
* @param container The HTML container to handle.
* @param filter The filter.
* @param options Options passed to the filters.
* @param siteId Site ID. If not defined, current site.
* @return If async, promise resolved when done.
*/
handleHtml(container: HTMLElement, filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, siteId?: string)
: void | Promise<void> {
return this.waitForReady().then(() => {
this.window.M.filter_mathjaxloader.typeset(container);
});
}
/**
* Wrap a portion of the $text inside a no link span. The whole text is then returned.
*
* @param text The text to modify.
* @param start The start index of the substring in text that should be wrapped in the span.
* @param end The end index of the substring in text that should be wrapped in the span.
* @return The whole text with the span inserted around the defined substring.
*/
protected insertSpan(text: string, start: number, end: number): string {
return this.textUtils.substrReplace(text,
'<span class="nolink">' + text.substr(start, end - start + 1) + '</span>',
start,
end - start + 1);
}
/**
* Check if the JS library has been loaded.
*
* @return {boolean} Whether the library has been loaded.
*/
protected jsLoaded(): boolean {
return this.window.M && this.window.M.filter_mathjaxloader;
}
/**
* Load the JS to make MathJax work in the app. The JS loaded is extracted from Moodle filter's loader JS file.
*/
protected loadJS(): void {
// tslint:disable: no-this-assignment
const that = this;
this.window.M = this.window.M || {};
this.window.M.filter_mathjaxloader = this.window.M.filter_mathjaxloader || {
_lang: '',
_configured: false,
// Add the configuration to the head and set the lang.
configure: function (params: any): void {
// Add a js configuration object to the head.
const script = document.createElement('script');
script.type = 'text/x-mathjax-config';
script.text = params.mathjaxconfig;
document.head.appendChild(script);
// Save the lang config until MathJax is actually loaded.
this._lang = params.lang;
},
// Set the correct language for the MathJax menus.
_setLocale: function (): void {
if (!this._configured) {
const lang = this._lang;
if (typeof that.window.MathJax != 'undefined') {
that.window.MathJax.Hub.Queue(() => {
that.window.MathJax.Localization.setLocale(lang);
});
that.window.MathJax.Hub.Configured();
this._configured = true;
}
}
},
// Called by the filter when an equation is found while rendering the page.
typeset: function (container: HTMLElement): void {
if (!this._configured) {
this._setLocale();
}
if (typeof that.window.MathJax != 'undefined') {
const processDelay = that.window.MathJax.Hub.processSectionDelay;
// Set the process section delay to 0 when updating the formula.
that.window.MathJax.Hub.processSectionDelay = 0;
const equations = Array.from(container.querySelectorAll('.filter_mathjaxloader_equation'));
equations.forEach((node) => {
that.window.MathJax.Hub.Queue(['Typeset', that.window.MathJax.Hub, node]);
});
// Set the delay back to normal after processing.
that.window.MathJax.Hub.processSectionDelay = processDelay;
}
}
};
}
/**
* Perform a mapping of the app language code to the equivalent for MathJax.
*
* @param langCode The app language code.
* @return The MathJax language code.
*/
protected mapLanguageCode(langCode: string): string {
// If defined, explicit mapping takes the highest precedence.
if (this.EXPLICIT_MAPPING[langCode]) {
return this.EXPLICIT_MAPPING[langCode];
}
// If there is exact match, it will be probably right.
if (this.MATHJAX_LANG_CODES.indexOf(langCode) != -1) {
return langCode;
}
// Finally try to find the best matching mathjax pack.
const parts = langCode.split('-');
if (this.MATHJAX_LANG_CODES.indexOf(parts[0]) != -1) {
return parts[0];
}
// No more guessing, use default language.
return this.langProvider.getDefaultLanguage();
}
/**
* Check if the filter should be applied in a certain site based on some filter options.
*
* @param options Options.
* @param site Site.
* @return Whether filter should be applied.
*/
shouldBeApplied(options: CoreFilterFormatTextOptions, site?: CoreSite): boolean {
// Only apply the filter if logged in and we're filtering current site.
return site && site.getId() == this.sitesProvider.getCurrentSiteId();
}
/**
* Wait for the MathJax library and our JS object to be loaded.
*
* @param retries Number of times this has been retried.
* @return Promise resolved when ready or if it took too long to load.
*/
protected waitForReady(retries: number = 0): Promise<any> {
if ((this.window.MathJax && this.jsLoaded()) || retries >= 20) {
// Loaded or too many retries, stop.
return Promise.resolve();
}
const deferred = this.utils.promiseDefer();
setTimeout(() => {
return this.waitForReady(retries + 1).finally(() => {
deferred.resolve();
});
}, 250);
return deferred.promise;
}
/**
* Find math environments in the $text and wrap them in no link spans
* (<span class="nolink"></span>). If math environments are nested, only
* the outer environment is wrapped in the span.
*
* The recognized math environments are \[ \] and $$ $$ for display
* mathematics and \( \) for inline mathematics.
*
* @param text The text to filter.
* @return Object containing the potentially modified text and a boolean that is true if any changes were made to the text.
*/
protected wrapMathInNoLink(text: string): {text: string, changed: boolean} {
let len = text.length,
i = 1,
displayStart = -1,
displayBracket = false,
displayDollar = false,
inlineStart = -1,
changesDone = false;
// Loop over the $text once.
while (i < len) {
if (displayStart === -1) {
// No display math has started yet.
if (text[i - 1] === '\\') {
if (text[i] === '[') {
// Display mode \[ begins.
displayStart = i - 1;
displayBracket = true;
} else if (text[i] === '(') {
// Inline math \( begins, not nested inside display math.
inlineStart = i - 1;
} else if (text[i] === ')' && inlineStart > -1) {
// Inline math ends, not nested inside display math. Wrap the span around it.
text = this.insertSpan(text, inlineStart, i);
inlineStart = -1; // Reset.
i += 28; // The text length changed due to the <span>.
len += 28;
changesDone = true;
}
} else if (text[i - 1] === '$' && text[i] === '$') {
// Display mode $$ begins.
displayStart = i - 1;
displayDollar = true;
}
} else {
// Display math open.
if ((text[i - 1] === '\\' && text[i] === ']' && displayBracket) ||
(text[i - 1] === '$' && text[i] === '$' && displayDollar)) {
// Display math ends, wrap the span around it.
text = this.insertSpan(text, displayStart, i);
displayStart = -1; // Reset.
displayBracket = false;
displayDollar = false;
i += 28; // The text length changed due to the <span>.
len += 28;
changesDone = true;
}
}
i++;
}
return {
text: text,
changed: changesDone
};
}
}

5
src/addon/filter/multilang/providers/handler.ts
View File

@ -47,11 +47,6 @@ export class AddonFilterMultilangHandler extends CoreFilterDefaultHandler {
return this.sitesProvider.getSite(siteId).then((site) => {
// Don't apply this filter if Moodle is 3.7 or higher and the WS already filtered the content.
if (!this.shouldBeApplied(options, site)) {
return text;
}
return this.langProvider.getCurrentLanguage().then((language) => {
// Match the current language.
const anyLangRegEx = /<(?:lang|span)[^>]+lang="[a-zA-Z0-9_-]+"[^>]*>(.*?)<\/(?:lang|span)>/g;

6
src/addon/messages/providers/mainmenu-handler.ts
View File

@ -298,9 +298,9 @@ export class AddonMessagesMainMenuHandler implements CoreMainMenuHandler, CoreCr
};
return this.filterHelper.getFiltersAndFormatText(message.text, 'system', 0, {clean: true, singleLine: true}).catch(() => {
return message.text;
}).then((formattedText) => {
data['text'] = formattedText;
return {text: message.text};
}).then((result) => {
data['text'] = result.text;
return data;
});

6
src/components/site-picker/site-picker.ts
View File

@ -51,10 +51,10 @@ export class CoreSitePickerComponent implements OnInit {
// Format the site name.
promises.push(this.filterHelper.getFiltersAndFormatText(site.siteName, 'system', 0,
{clean: true, singleLine: true}, site.getId()).catch(() => {
return site.siteName;
}).then((formatted) => {
return {text: site.siteName};
}).then((result) => {
site.fullNameAndSiteName = this.translate.instant('core.fullnameandsitename',
{ fullname: site.fullName, sitename: formatted });
{ fullname: site.fullName, sitename: result.text });
}));
});

6
src/core/course/components/module-completion/module-completion.ts
View File

@ -139,7 +139,7 @@ export class CoreCourseModuleCompletionComponent implements OnChanges {
if (moduleName) {
this.filterHelper.getFiltersAndFormatText(moduleName, 'module', this.moduleId,
{clean: true, singleLine: true, shortenLength: 50, courseId: this.completion.courseId}).then((modName) => {
{clean: true, singleLine: true, shortenLength: 50, courseId: this.completion.courseId}).then((result) => {
let promise;
@ -150,11 +150,11 @@ export class CoreCourseModuleCompletionComponent implements OnChanges {
(profile) => {
return {
overrideuser: profile.fullname,
modname: modName
modname: result.text
};
});
} else {
promise = Promise.resolve(modName);
promise = Promise.resolve(result.text);
}
return promise.then((translateParams) => {

4
src/core/course/pages/section/section.ts
View File

@ -264,8 +264,8 @@ export class CoreCourseSectionPage implements OnDestroy {
// Format the name of each section and check if it has content.
this.sections = sections.map((section) => {
this.filterHelper.getFiltersAndFormatText(section.name.trim(), 'course', this.course.id,
{clean: true, singleLine: true}).then((name) => {
section.formattedName = name;
{clean: true, singleLine: true}).then((result) => {
section.formattedName = result.text;
});
section.hasContent = this.courseHelper.sectionHasContent(section);

15
src/core/filter/providers/default-filter.ts
View File

@ -43,6 +43,21 @@ export class CoreFilterDefaultHandler implements CoreFilterHandler {
return text;
}
/**
* Handle HTML. This function is called after "filter", and it will receive an HTMLElement containing the text that was
* filtered.
*
* @param container The HTML container to handle.
* @param filter The filter.
* @param options Options passed to the filters.
* @param siteId Site ID. If not defined, current site.
* @return If async, promise resolved when done.
*/
handleHtml(container: HTMLElement, filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, siteId?: string)
: void | Promise<void> {
// To be overridden.
}
/**
* Whether or not the handler is enabled on a site level.
*

124
src/core/filter/providers/delegate.ts
View File

@ -41,6 +41,19 @@ export interface CoreFilterHandler extends CoreDelegateHandler {
*/
filter(text: string, filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, siteId?: string): string | Promise<string>;
/**
* Handle HTML. This function is called after "filter", and it will receive an HTMLElement containing the text that was
* filtered.
*
* @param container The HTML container to handle.
* @param filter The filter.
* @param options Options passed to the filters.
* @param siteId Site ID. If not defined, current site.
* @return If async, promise resolved when done.
*/
handleHtml?(container: HTMLElement, filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, siteId?: string)
: void | Promise<void>;
/**
* Check if the filter should be applied in a certain site based on some filter options.
*
@ -61,6 +74,7 @@ export class CoreFilterDelegate extends CoreDelegate {
constructor(loggerProvider: CoreLoggerProvider, protected sitesProvider: CoreSitesProvider, eventsProvider: CoreEventsProvider,
protected defaultHandler: CoreFilterDefaultHandler) {
super('CoreFilterDelegate', loggerProvider, sitesProvider, eventsProvider);
}
@ -79,19 +93,16 @@ export class CoreFilterDelegate extends CoreDelegate {
// Wait for filters to be initialized.
return this.handlersInitPromise.then(() => {
return this.sitesProvider.getSite(siteId);
}).then((site) => {
let promise: Promise<string> = Promise.resolve(text);
filters = filters || [];
options = options || {};
filters.forEach((filter) => {
if (skipFilters && skipFilters.indexOf(filter.filter) != -1) {
// Skip this filter.
return;
}
if (filter.localstate == -1 || (filter.localstate == 0 && filter.inheritedstate == -1)) {
// Filter is disabled, ignore it.
if (!this.isEnabledAndShouldApply(filter, options, site, skipFilters)) {
return;
}
@ -140,6 +151,77 @@ export class CoreFilterDelegate extends CoreDelegate {
return filters;
}
/**
* Let filters handle an HTML element.
*
* @param container The HTML container to handle.
* @param filters Filters to apply.
* @param options Options passed to the filters.
* @param skipFilters Names of filters that shouldn't be applied.
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved when done.
*/
handleHtml(container: HTMLElement, filters: CoreFilterFilter[], options?: any, skipFilters?: string[], siteId?: string)
: Promise<any> {
// Wait for filters to be initialized.
return this.handlersInitPromise.then(() => {
return this.sitesProvider.getSite(siteId);
}).then((site) => {
let promise: Promise<any> = Promise.resolve();
filters = filters || [];
options = options || {};
filters.forEach((filter) => {
if (!this.isEnabledAndShouldApply(filter, options, site, skipFilters)) {
return;
}
promise = promise.then(() => {
return Promise.resolve(this.executeFunctionOnEnabled(filter.filter, 'handleHtml',
[container, filter, options, siteId])).catch((error) => {
this.logger.error('Error handling HTML' + filter.filter, error);
});
});
});
return promise;
});
}
/**
* Check if a filter is enabled and should be applied.
*
* @param filters Filters to apply.
* @param options Options passed to the filters.
* @param site Site.
* @param skipFilters Names of filters that shouldn't be applied.
* @return Whether the filter is enabled and should be applied.
*/
isEnabledAndShouldApply(filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, site: CoreSite,
skipFilters?: string[]): boolean {
if (filter.localstate == -1 || (filter.localstate == 0 && filter.inheritedstate == -1)) {
// Filter is disabled, ignore it.
return false;
}
if (!this.shouldFilterBeApplied(filter, options, site)) {
// Filter shouldn't be applied.
return false;
}
if (skipFilters && skipFilters.indexOf(filter.filter) != -1) {
// Skip this filter.
return false;
}
return true;
}
/**
* Check if at least 1 filter should be applied in a certain site and with certain options.
*
@ -151,20 +233,11 @@ export class CoreFilterDelegate extends CoreDelegate {
shouldBeApplied(filters: CoreFilterFilter[], options: CoreFilterFormatTextOptions, site?: CoreSite): Promise<boolean> {
// Wait for filters to be initialized.
return this.handlersInitPromise.then(() => {
const promises = [];
let shouldBeApplied = false;
filters.forEach((filter) => {
promises.push(this.shouldFilterBeApplied(filter, options, site).then((applied) => {
if (applied) {
shouldBeApplied = applied;
}
}));
});
return Promise.all(promises).then(() => {
return shouldBeApplied;
});
for (let i = 0; i < filters.length; i++) {
if (this.shouldFilterBeApplied(filters[i], options, site)) {
return true;
}
}
});
}
@ -174,15 +247,14 @@ export class CoreFilterDelegate extends CoreDelegate {
* @param filter Filter to check.
* @param options Options passed to the filters.
* @param site Site. If not defined, current site.
* @return {Promise<boolean>} Promise resolved with true: whether the filter should be applied.
* @return Whether the filter should be applied.
*/
protected shouldFilterBeApplied(filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, site?: CoreSite)
: Promise<boolean> {
protected shouldFilterBeApplied(filter: CoreFilterFilter, options: CoreFilterFormatTextOptions, site?: CoreSite): boolean {
if (!this.hasHandler(filter.filter, true)) {
return Promise.resolve(false);
return false;
}
return Promise.resolve(this.executeFunctionOnEnabled(filter.filter, 'shouldBeApplied', [options, site]));
return this.executeFunctionOnEnabled(filter.filter, 'shouldBeApplied', [options, site]);
}
}

6
src/core/filter/providers/helper.ts
View File

@ -178,10 +178,12 @@ export class CoreFilterHelperProvider {
* @return Promise resolved with the formatted text.
*/
getFiltersAndFormatText(text: string, contextLevel: string, instanceId: number, options?: CoreFilterFormatTextOptions,
siteId?: string): Promise<string> {
siteId?: string): Promise<{text: string, filters: CoreFilterFilter[]}> {
return this.getFilters(contextLevel, instanceId, options, siteId).then((filters) => {
return this.filterProvider.formatText(text, options, filters, siteId);
return this.filterProvider.formatText(text, options, filters, siteId).then((text) => {
return {text: text, filters: filters};
});
});
}

5
src/core/login/pages/sites/sites.ts
View File

@ -87,9 +87,10 @@ export class CoreLoginSitesPage {
siteName = site.siteName;
this.filterHelper.getFiltersAndFormatText(siteName, 'system', 0, {clean: true, singleLine: true}, site.id)
.then((siteName) => {
.then((result) => {
this.domUtils.showConfirm(this.translate.instant('core.login.confirmdeletesite', { sitename: siteName })).then(() => {
this.domUtils.showConfirm(this.translate.instant('core.login.confirmdeletesite', { sitename: result.text }))
.then(() => {
this.sitesProvider.deleteSite(site.id).then(() => {
this.sites.splice(index, 1);
this.showDelete = false;

2
src/core/settings/pages/general/general.ts
View File

@ -133,7 +133,7 @@ export class CoreSettingsGeneralPage {
*/
languageChanged(): void {
this.langProvider.changeCurrentLanguage(this.selectedLanguage).finally(() => {
this.eventsProvider.trigger(CoreEventsProvider.LANGUAGE_CHANGED);
this.eventsProvider.trigger(CoreEventsProvider.LANGUAGE_CHANGED, this.selectedLanguage);
});
}

4
src/core/settings/pages/space-usage/space-usage.ts
View File

@ -168,10 +168,10 @@ export class CoreSettingsSpaceUsagePage {
*/
deleteSiteStorage(siteData: any): void {
this.filterHelper.getFiltersAndFormatText(siteData.siteName, 'system', 0,
{clean: true, singleLine: true}, siteData.id).then((siteName) => {
{clean: true, singleLine: true}, siteData.id).then((result) => {
const title = this.translate.instant('core.settings.deletesitefilestitle');
const message = this.translate.instant('core.settings.deletesitefiles', {sitename: siteName});
const message = this.translate.instant('core.settings.deletesitefiles', {sitename: result.text});
this.domUtils.showConfirm(message, title).then(() => {
return this.sitesProvider.getSite(siteData.id);

72
src/directives/format-text.ts
View File

@ -30,8 +30,9 @@ import { CoreLinkDirective } from '../directives/link';
import { CoreExternalContentDirective } from '../directives/external-content';
import { CoreContentLinksHelperProvider } from '@core/contentlinks/providers/helper';
import { CoreSplitViewComponent } from '@components/split-view/split-view';
import { CoreFilterProvider } from '@core/filter/providers/filter';
import { CoreFilterProvider, CoreFilterFilter, CoreFilterFormatTextOptions } from '@core/filter/providers/filter';
import { CoreFilterHelperProvider } from '@core/filter/providers/helper';
import { CoreFilterDelegate } from '@core/filter/providers/delegate';
/**
* Directive to format text rendered. It renders the HTML and treats all links and media, using CoreLinkDirective
@ -70,14 +71,27 @@ export class CoreFormatTextDirective implements OnChanges {
protected showMoreDisplayed: boolean;
protected loadingChangedListener;
constructor(element: ElementRef, private sitesProvider: CoreSitesProvider, private domUtils: CoreDomUtilsProvider,
private textUtils: CoreTextUtilsProvider, private translate: TranslateService, private platform: Platform,
private utils: CoreUtilsProvider, private urlUtils: CoreUrlUtilsProvider, private loggerProvider: CoreLoggerProvider,
private filepoolProvider: CoreFilepoolProvider, private appProvider: CoreAppProvider,
private contentLinksHelper: CoreContentLinksHelperProvider, @Optional() private navCtrl: NavController,
@Optional() private content: Content, @Optional() private svComponent: CoreSplitViewComponent,
private iframeUtils: CoreIframeUtilsProvider, private eventsProvider: CoreEventsProvider,
private filterProvider: CoreFilterProvider, private filterHelper: CoreFilterHelperProvider) {
constructor(element: ElementRef,
private sitesProvider: CoreSitesProvider,
private domUtils: CoreDomUtilsProvider,
private textUtils: CoreTextUtilsProvider,
private translate: TranslateService,
private platform: Platform,
private utils: CoreUtilsProvider,
private urlUtils: CoreUrlUtilsProvider,
private loggerProvider: CoreLoggerProvider,
private filepoolProvider: CoreFilepoolProvider,
private appProvider: CoreAppProvider,
private contentLinksHelper: CoreContentLinksHelperProvider,
@Optional() private navCtrl: NavController,
@Optional() private content: Content, @Optional()
private svComponent: CoreSplitViewComponent,
private iframeUtils: CoreIframeUtilsProvider,
private eventsProvider: CoreEventsProvider,
private filterProvider: CoreFilterProvider,
private filterHelper: CoreFilterHelperProvider,
private filterDelegate: CoreFilterDelegate) {
this.element = element.nativeElement;
this.element.classList.add('opacity-hide'); // Hide contents until they're treated.
this.afterRender = new EventEmitter();
@ -323,15 +337,15 @@ export class CoreFormatTextDirective implements OnChanges {
this.text = this.text ? this.text.trim() : '';
this.formatContents().then((div: HTMLElement) => {
this.formatContents().then((result) => {
// Disable media adapt to correctly calculate the height.
this.element.classList.add('core-disable-media-adapt');
this.element.innerHTML = ''; // Remove current contents.
if (this.maxHeight && div.innerHTML != '') {
if (this.maxHeight && result.div.innerHTML != '') {
// Move the children to the current element to be able to calculate the height.
this.domUtils.moveChildren(div, this.element);
this.domUtils.moveChildren(result.div, this.element);
// Calculate the height now.
this.calculateHeight();
@ -349,12 +363,17 @@ export class CoreFormatTextDirective implements OnChanges {
});
}
} else {
this.domUtils.moveChildren(div, this.element);
this.domUtils.moveChildren(result.div, this.element);
// Add magnifying glasses to images.
this.addMagnifyingGlasses();
}
if (result.options.filter) {
// Let filters hnadle HTML. We do it here because we don't want them to block the render of the text.
this.filterDelegate.handleHtml(this.element, result.filters, result.options, [], result.siteId);
}
this.element.classList.remove('core-disable-media-adapt');
this.finishRender();
});
@ -365,8 +384,15 @@ export class CoreFormatTextDirective implements OnChanges {
*
* @return Promise resolved with a div element containing the code.
*/
protected formatContents(): Promise<HTMLElement> {
protected formatContents(): Promise<{div: HTMLElement, filters: CoreFilterFilter[], options: CoreFilterFormatTextOptions,
siteId: string}> {
const result = {
div: <HTMLElement> null,
filters: <CoreFilterFilter[]> [],
options: <CoreFilterFormatTextOptions> {},
siteId: this.siteId
};
let site: CoreSite;
// Retrieve the site since it might be needed later.
@ -374,6 +400,7 @@ export class CoreFormatTextDirective implements OnChanges {
// Error getting the site. This probably means that there is no current site and no siteId was supplied.
}).then((siteInstance: CoreSite) => {
site = siteInstance;
result.siteId = site.getId();
if (this.contextLevel == 'course' && this.contextInstanceId <= 0) {
this.contextInstanceId = site.getSiteHomeId();
@ -381,7 +408,7 @@ export class CoreFormatTextDirective implements OnChanges {
this.filter = typeof this.filter == 'undefined' ? !!(this.contextLevel && this.contextInstanceId) : !!this.filter;
const options = {
result.options = {
clean: this.utils.isTrueOrOne(this.clean),
singleLine: this.utils.isTrueOrOne(this.singleLine),
highlight: this.highlight,
@ -390,10 +417,15 @@ export class CoreFormatTextDirective implements OnChanges {
};
if (this.filter) {
return this.filterHelper.getFiltersAndFormatText(this.text, this.contextLevel, this.contextInstanceId, options,
site.getId());
return this.filterHelper.getFiltersAndFormatText(this.text, this.contextLevel, this.contextInstanceId,
result.options, site.getId()).then((res) => {
result.filters = res.filters;
return res.text;
});
} else {
return this.filterProvider.formatText(this.text, options);
return this.filterProvider.formatText(this.text, result.options);
}
}).then((formatted) => {
@ -517,7 +549,9 @@ export class CoreFormatTextDirective implements OnChanges {
return promise.catch(() => {
// Ignore errors. So content gets always shown.
}).then(() => {
return div;
result.div = div;
return result;
});
});
}

30
src/providers/utils/text.ts
View File

@ -735,6 +735,36 @@ export class CoreTextUtilsProvider {
return stripped;
}
/**
* Replace text within a portion of a string. Equivalent to PHP's substr_replace.
* Credits to http://locutus.io/php/strings/substr_replace/
*
* @param str The string to treat.
* @param replace The value to put inside the string.
* @param start The index where to start putting the new string. If negative, it will count from the end of the string.
* @param length Length of the portion of string which is to be replaced. If negative, it represents the number of characters
* from the end of string at which to stop replacing. If not provided, replace until the end of the string.
* @return Treated string.
*/
substrReplace(str: string, replace: string, start: number, length?: number): string {
length = typeof length != 'undefined' ? length : str.length;
if (start < 0) {
start = start + str.length;
}
if (length < 0) {
length = length + str.length - start;
}
return [
str.slice(0, start),
replace.substr(0, length),
replace.slice(length),
str.slice(start + length)
].join('');
}
/**
* Treat the list of disabled features, replacing old nomenclature with the new one.
*

23
src/providers/utils/url.ts
View File

@ -44,6 +44,29 @@ export class CoreUrlUtilsProvider {
return url;
}
/**
* Add params to a URL.
*
* @param url URL to add the params to.
* @param params Object with the params to add.
* @return URL with params.
*/
addParamsToUrl(url: string, params: {[key: string]: any}): string {
let separator = url.indexOf('?') != -1 ? '&' : '?';
for (const key in params) {
const value = params[key];
// Ignore objects.
if (typeof value != 'object') {
url += separator + key + '=' + value;
separator = '&';
}
}
return url;
}
/**
* Given a URL and a text, return an HTML link.
*