From 14ccd74b3aeb2337aa4d2d6f671e5023b18a6165 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pau=20Ferrer=20Oca=C3=B1a?= Date: Mon, 5 Mar 2018 17:42:54 +0100 Subject: [PATCH 1/3] MOBILE-2340 folder: Folder activity implementation --- .../folder/components/components.module.ts | 45 ++++ .../mod/folder/components/index/index.html | 29 +++ .../mod/folder/components/index/index.ts | 212 ++++++++++++++++++ src/addon/mod/folder/folder.module.ts | 38 ++++ src/addon/mod/folder/lang/en.json | 4 + src/addon/mod/folder/pages/index/index.html | 16 ++ .../mod/folder/pages/index/index.module.ts | 33 +++ src/addon/mod/folder/pages/index/index.ts | 50 +++++ src/addon/mod/folder/providers/folder.ts | 147 ++++++++++++ src/addon/mod/folder/providers/helper.ts | 90 ++++++++ .../mod/folder/providers/module-handler.ts | 70 ++++++ src/app/app.module.ts | 2 + 12 files changed, 736 insertions(+) create mode 100644 src/addon/mod/folder/components/components.module.ts create mode 100644 src/addon/mod/folder/components/index/index.html create mode 100644 src/addon/mod/folder/components/index/index.ts create mode 100644 src/addon/mod/folder/folder.module.ts create mode 100644 src/addon/mod/folder/lang/en.json create mode 100644 src/addon/mod/folder/pages/index/index.html create mode 100644 src/addon/mod/folder/pages/index/index.module.ts create mode 100644 src/addon/mod/folder/pages/index/index.ts create mode 100644 src/addon/mod/folder/providers/folder.ts create mode 100644 src/addon/mod/folder/providers/helper.ts create mode 100644 src/addon/mod/folder/providers/module-handler.ts diff --git a/src/addon/mod/folder/components/components.module.ts b/src/addon/mod/folder/components/components.module.ts new file mode 100644 index 000000000..8edeb4c95 --- /dev/null +++ b/src/addon/mod/folder/components/components.module.ts @@ -0,0 +1,45 @@ +// (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 { CommonModule } from '@angular/common'; +import { IonicModule } from 'ionic-angular'; +import { TranslateModule } from '@ngx-translate/core'; +import { CoreComponentsModule } from '@components/components.module'; +import { CoreDirectivesModule } from '@directives'; +import { CoreCourseComponentsModule } from '@core/course/components/components.module'; +import { AddonModFolderIndexComponent } from './index/index'; + +@NgModule({ + declarations: [ + AddonModFolderIndexComponent + ], + imports: [ + CommonModule, + IonicModule, + TranslateModule.forChild(), + CoreComponentsModule, + CoreDirectivesModule, + CoreCourseComponentsModule + ], + providers: [ + ], + exports: [ + AddonModFolderIndexComponent + ], + entryComponents: [ + AddonModFolderIndexComponent + ] +}) +export class AddonModFolderComponentsModule {} diff --git a/src/addon/mod/folder/components/index/index.html b/src/addon/mod/folder/components/index/index.html new file mode 100644 index 000000000..48bc258e1 --- /dev/null +++ b/src/addon/mod/folder/components/index/index.html @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + +

{{file.name}}

+ + + + + + + + diff --git a/src/addon/mod/folder/components/index/index.ts b/src/addon/mod/folder/components/index/index.ts new file mode 100644 index 000000000..326c34b61 --- /dev/null +++ b/src/addon/mod/folder/components/index/index.ts @@ -0,0 +1,212 @@ +// (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 { Component, OnInit, OnDestroy, Input, Output, EventEmitter, Optional } from '@angular/core'; +import { NavParams, NavController, Content } from 'ionic-angular'; +import { TranslateService } from '@ngx-translate/core'; +import { CoreAppProvider } from '@providers/app'; +import { CoreDomUtilsProvider } from '@providers/utils/dom'; +import { CoreTextUtilsProvider } from '@providers/utils/text'; +import { CoreCourseProvider } from '@core/course/providers/course'; +import { CoreCourseHelperProvider } from '@core/course/providers/helper'; +import { CoreCourseModuleMainComponent } from '@core/course/providers/module-delegate'; +import { AddonModFolderProvider } from '../../providers/folder'; +import { AddonModFolderHelperProvider } from '../../providers/helper'; + +/** + * Component that displays a folder. + * @todo Adding a new file in a folder updates the revision of all the files, so they're all shown as outdated. + * To ignore revision in folders we'll have to modify $mmCoursePrefetchDelegate, core-file and $mmFilepool. + */ +@Component({ + selector: 'addon-mod-folder-index', + templateUrl: 'index.html', +}) +export class AddonModFolderIndexComponent implements OnInit, OnDestroy, CoreCourseModuleMainComponent { + @Input() module: any; // The module of the folder. + @Input() courseId: number; // Course ID the folder belongs to. + @Input() path: string; // For subfolders. Use the path instead of a boolean so Angular detects them as different states. + @Output() folderRetrieved?: EventEmitter; + + loaded: boolean; + canReload: boolean; + component = AddonModFolderProvider.COMPONENT; + componentId: number; + canGetFolder: boolean; + contents: any; + + // Data for context menu. + externalUrl: string; + description: string; + refreshIcon: string; + prefetchStatusIcon: string; + prefetchText: string; + size: string; + + protected isDestroyed; + protected statusObserver; + + constructor(private folderProvider: AddonModFolderProvider, private courseProvider: CoreCourseProvider, + private domUtils: CoreDomUtilsProvider, private appProvider: CoreAppProvider, private textUtils: CoreTextUtilsProvider, + private courseHelper: CoreCourseHelperProvider, private translate: TranslateService, + @Optional() private content: Content, private folderHelper: AddonModFolderHelperProvider) { + this.folderRetrieved = new EventEmitter(); + } + + /** + * Component being initialized. + */ + ngOnInit(): void { + this.description = this.module.description; + this.componentId = this.module.id; + this.externalUrl = this.module.url; + this.loaded = false; + this.canReload = false; + this.refreshIcon = 'spinner'; + + this.canGetFolder = this.folderProvider.isGetFolderWSAvailable(); + + if (this.path) { + // Subfolder. Use module param. + this.showModuleData(this.module); + this.loaded = true; + this.canReload = false; + this.refreshIcon = 'refresh'; + } else { + this.fetchContent().then(() => { + this.folderProvider.logView(this.module.instance).then(() => { + this.courseProvider.checkModuleCompletion(this.courseId, this.module.completionstatus); + }); + }).finally(() => { + this.loaded = true; + this.canReload = true; + this.refreshIcon = 'refresh'; + }); + } + } + + /** + * Refresh the data. + * + * @param {any} [refresher] Refresher. + * @param {Function} [done] Function to call when done. + * @return {Promise} Promise resolved when done. + */ + doRefresh(refresher?: any, done?: () => void): Promise { + if (this.canReload) { + this.refreshIcon = 'spinner'; + + return this.folderProvider.invalidateContent(this.module.id, this.courseId).catch(() => { + // Ignore errors. + }).then(() => { + return this.fetchContent(true); + }).finally(() => { + this.refreshIcon = 'refresh'; + refresher && refresher.complete(); + done && done(); + }); + } + } + + /** + * Expand the description. + */ + expandDescription(): void { + this.textUtils.expandText(this.translate.instant('core.description'), this.description, this.component, this.module.id); + } + + /** + * Prefetch the module. + */ + prefetch(): void { + this.courseHelper.contextMenuPrefetch(this, this.module, this.courseId); + } + + /** + * Confirm and remove downloaded files. + */ + removeFiles(): void { + this.courseHelper.confirmAndRemoveFiles(this.module, this.courseId); + } + + /** + * Convenience function to set scope data using module. + * @param {any} module Module to show. + */ + protected showModuleData(module: any): void { + this.description = module.intro || module.description; + + this.folderRetrieved.emit(module); + + if (this.path) { + // Subfolder. + this.contents = module.contents; + } else { + this.contents = this.folderHelper.formatContents(module.contents); + } + } + + /** + * Download folder contents. + * + * @param {boolean} [refresh] Whether we're refreshing data. + * @return {Promise} Promise resolved when done. + */ + protected fetchContent(refresh?: boolean): Promise { + let promise; + + if (this.canGetFolder) { + promise = this.folderProvider.getFolder(this.courseId, this.module.id).then((folder) => { + return this.courseProvider.loadModuleContents(this.module, this.courseId).then(() => { + folder.contents = this.module.contents; + + return folder; + }); + }); + } else { + promise = this.courseProvider.getModule(this.module.id, this.courseId).then((folder) => { + if (!folder.contents.length && this.module.contents.length && !this.appProvider.isOnline()) { + // The contents might be empty due to a cached data. Use the old ones. + folder.contents = this.module.contents; + } + this.module = folder; + + return folder; + }); + } + + return promise.then((folder) => { + if (folder) { + this.description = folder.intro || folder.description; + this.folderRetrieved.emit(folder); + } + + this.showModuleData(folder); + + // All data obtained, now fill the context menu. + this.courseHelper.fillContextMenu(this, this.module, this.courseId, refresh, this.component); + }).catch((error) => { + // Error getting data, fail. + this.domUtils.showErrorModalDefault(error, 'core.course.errorgetmodule', true); + }).finally(() => { + this.loaded = true; + this.refreshIcon = 'refresh'; + }); + } + + ngOnDestroy(): void { + this.isDestroyed = true; + this.statusObserver && this.statusObserver.off(); + } +} diff --git a/src/addon/mod/folder/folder.module.ts b/src/addon/mod/folder/folder.module.ts new file mode 100644 index 000000000..b21495eb9 --- /dev/null +++ b/src/addon/mod/folder/folder.module.ts @@ -0,0 +1,38 @@ +// (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 { AddonModFolderProvider } from './providers/folder'; +import { AddonModFolderHelperProvider } from './providers/helper'; +import { AddonModFolderModuleHandler } from './providers/module-handler'; +import { CoreCourseModuleDelegate } from '@core/course/providers/module-delegate'; +import { AddonModFolderComponentsModule } from './components/components.module'; + +@NgModule({ + declarations: [ + ], + imports: [ + AddonModFolderComponentsModule + ], + providers: [ + AddonModFolderProvider, + AddonModFolderHelperProvider, + AddonModFolderModuleHandler + ] +}) +export class AddonModFolderModule { + constructor(moduleDelegate: CoreCourseModuleDelegate, moduleHandler: AddonModFolderModuleHandler) { + moduleDelegate.registerHandler(moduleHandler); + } +} diff --git a/src/addon/mod/folder/lang/en.json b/src/addon/mod/folder/lang/en.json new file mode 100644 index 000000000..57d4c7f95 --- /dev/null +++ b/src/addon/mod/folder/lang/en.json @@ -0,0 +1,4 @@ +{ + "emptyfilelist": "There are no files to show.", + "errorwhilegettingfolder": "Error while getting folder data." +} \ No newline at end of file diff --git a/src/addon/mod/folder/pages/index/index.html b/src/addon/mod/folder/pages/index/index.html new file mode 100644 index 000000000..9830c28cf --- /dev/null +++ b/src/addon/mod/folder/pages/index/index.html @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/src/addon/mod/folder/pages/index/index.module.ts b/src/addon/mod/folder/pages/index/index.module.ts new file mode 100644 index 000000000..5091915b2 --- /dev/null +++ b/src/addon/mod/folder/pages/index/index.module.ts @@ -0,0 +1,33 @@ +// (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 { IonicPageModule } from 'ionic-angular'; +import { TranslateModule } from '@ngx-translate/core'; +import { CoreDirectivesModule } from '@directives'; +import { AddonModFolderComponentsModule } from '../../components/components.module'; +import { AddonModFolderIndexPage } from './index'; + +@NgModule({ + declarations: [ + AddonModFolderIndexPage, + ], + imports: [ + CoreDirectivesModule, + AddonModFolderComponentsModule, + IonicPageModule.forChild(AddonModFolderIndexPage), + TranslateModule.forChild() + ], +}) +export class AddonModFolderIndexPageModule {} diff --git a/src/addon/mod/folder/pages/index/index.ts b/src/addon/mod/folder/pages/index/index.ts new file mode 100644 index 000000000..e0b187c19 --- /dev/null +++ b/src/addon/mod/folder/pages/index/index.ts @@ -0,0 +1,50 @@ +// (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 { Component, ViewChild } from '@angular/core'; +import { IonicPage, NavParams } from 'ionic-angular'; +import { AddonModFolderIndexComponent } from '../../components/index/index'; + +/** + * Page that displays a folder. + */ +@IonicPage({ segment: 'addon-mod-folder-index' }) +@Component({ + selector: 'page-addon-mod-folder-index', + templateUrl: 'index.html', +}) +export class AddonModFolderIndexPage { + @ViewChild(AddonModFolderIndexComponent) folderComponent: AddonModFolderIndexComponent; + + title: string; + module: any; + courseId: number; + path: string; + + constructor(navParams: NavParams) { + this.module = navParams.get('module') || {}; + this.courseId = navParams.get('courseId'); + this.path = navParams.get('path'); + this.title = this.module.name; + } + + /** + * Update some data based on the folder instance. + * + * @param {any} folder Folder instance. + */ + updateData(folder: any): void { + this.title = folder.name || this.title; + } +} diff --git a/src/addon/mod/folder/providers/folder.ts b/src/addon/mod/folder/providers/folder.ts new file mode 100644 index 000000000..5f019f9c8 --- /dev/null +++ b/src/addon/mod/folder/providers/folder.ts @@ -0,0 +1,147 @@ +// (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 { CoreLoggerProvider } from '@providers/logger'; +import { CoreSitesProvider } from '@providers/sites'; +import { CoreUtilsProvider } from '@providers/utils/utils'; +import { CoreCourseProvider } from '@core/course/providers/course'; + +/** + * Service that provides some features for folder. + */ +@Injectable() +export class AddonModFolderProvider { + static COMPONENT = 'mmaModFolder'; + + protected ROOT_CACHE_KEY = 'mmaModFolder:'; + protected logger; + + constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private courseProvider: CoreCourseProvider, + private utils: CoreUtilsProvider) { + this.logger = logger.getInstance('mmaModFolderProvider'); + } + + /** + * Get a folder by course module ID. + * + * @param {number} courseId Course ID. + * @param {number} cmId Course module ID. + * @param {string} [siteId] Site ID. If not defined, current site. + * @return {Promise} Promise resolved when the book is retrieved. + */ + getFolder(courseId: number, cmId: number, siteId?: string): Promise { + return this.getFolderByKey(courseId, 'coursemodule', cmId, siteId); + } + + /** + * Get a folder. + * + * @param {number} courseId Course ID. + * @param {string} key Name of the property to check. + * @param {any} value Value to search. + * @param {string} [siteId] Site ID. If not defined, current site. + * @return {Promise} Promise resolved when the book is retrieved. + */ + protected getFolderByKey(courseId: number, key: string, value: any, siteId?: string): Promise { + return this.sitesProvider.getSite(siteId).then((site) => { + const params = { + courseids: [courseId] + }, + preSets = { + cacheKey: this.getFolderCacheKey(courseId) + }; + + return site.read('mod_folder_get_folders_by_courses', params, preSets).then((response) => { + if (response && response.folders) { + const currentFolder = response.folders.find((folder) => { + return folder[key] == value; + }); + if (currentFolder) { + return currentFolder; + } + } + + return Promise.reject(null); + }); + }); + } + + /** + * Get cache key for folder data WS calls. + * + * @param {number} courseId Course ID. + * @return {string} Cache key. + */ + protected getFolderCacheKey(courseId: number): string { + return this.ROOT_CACHE_KEY + 'folder:' + courseId; + } + + /** + * Invalidate the prefetched content. + * + * @param {number} moduleId The module ID. + * @param {number} courseId Course ID of the module. + * @param {string} [siteId] Site ID. If not defined, current site. + * @return {Promise} + */ + invalidateContent(moduleId: number, courseId: number, siteId?: string): Promise { + const promises = []; + + promises.push(this.invalidateFolderData(courseId, siteId)); + promises.push(this.courseProvider.invalidateModule(moduleId, siteId)); + + return this.utils.allPromises(promises); + } + + /** + * Invalidates folder data. + * + * @param {number} courseId Course ID. + * @param {string} [siteId] Site ID. If not defined, current site. + * @return {Promise} Promise resolved when the data is invalidated. + */ + invalidateFolderData(courseId: number, siteId?: string): Promise { + return this.sitesProvider.getSite(siteId).then((site) => { + return site.invalidateWsCacheForKey(this.getFolderCacheKey(courseId)); + }); + } + + /** + * Returns whether or not getFolder WS available or not. + * + * @return {boolean} If WS is avalaible. + */ + isGetFolderWSAvailable(): boolean { + return this.sitesProvider.wsAvailableInCurrentSite('mod_folder_get_folders_by_courses'); + } + + /** + * Report a folder as being viewed. + * + * @param {number} id Module ID. + * @return {Promise} Promise resolved when the WS call is successful. + */ + logView(id: number): Promise { + if (id) { + const params = { + folderid: id + }; + + return this.sitesProvider.getCurrentSite().write('mod_folder_view_folder', params); + } + + return Promise.reject(null); + } +} diff --git a/src/addon/mod/folder/providers/helper.ts b/src/addon/mod/folder/providers/helper.ts new file mode 100644 index 000000000..0527eff2a --- /dev/null +++ b/src/addon/mod/folder/providers/helper.ts @@ -0,0 +1,90 @@ +// (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 { CoreLoggerProvider } from '@providers/logger'; +import { CoreCourseProvider } from '@core/course/providers/course'; + +/** + * Service that provides some features for folder. + */ +@Injectable() +export class AddonModFolderHelperProvider { + + constructor(logger: CoreLoggerProvider, private courseProvider: CoreCourseProvider) { + } + + /** + * Format folder contents, creating directory structure. + * Folders found in filepaths are added to the array. Each folder has the properties: name, fileicon, + * type (folder), filepath and contents (array with files and subfolders). + * + * @param {any[]} contents Folder contents. + * @return {any[]} Formatted contents. + */ + formatContents(contents: any[]): any[] { + const files = [], + folders = [], + folderIcon = this.courseProvider.getModuleIconSrc('folder'); + + contents.forEach((entry) => { + if (entry.filepath !== '/') { + // It's a file in a subfolder. Lets treat the path to add the subfolders to the array. + let directories, + currentList = folders, // Start at root level. + path = entry.filepath, + subpath = ''; + + // Remove first and last slash if needed. + if (path.substr(0, 1) === '/') { + path = path.substr(1); + } + if (path.substr(path.length - 1) === '/') { + path = path.slice(0, -1); + } + + directories = path.split('/'); + + directories.forEach((directory) => { + subpath = subpath + '/' + directory; + // Search if the directory is already stored in folders array. + const foundList = currentList.find((list) => { + return list.name === directory; + }); + + if (foundList) { + currentList = foundList.contents; + } else { + // Directory not found. Add it to the array. + const newFolder = { + name: directory, + fileicon: folderIcon, + contents: [], + filepath: subpath, + type: 'folder' + }; + currentList.push(newFolder); + currentList = newFolder.contents; + } + }); + + currentList.push(entry); + } else { + files.push(entry); + } + }); + + return folders.concat(files); + } +} diff --git a/src/addon/mod/folder/providers/module-handler.ts b/src/addon/mod/folder/providers/module-handler.ts new file mode 100644 index 000000000..e30a9b890 --- /dev/null +++ b/src/addon/mod/folder/providers/module-handler.ts @@ -0,0 +1,70 @@ +// (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 { NavController, NavOptions } from 'ionic-angular'; +import { AddonModFolderIndexComponent } from '../components/index/index'; +import { CoreCourseModuleHandler, CoreCourseModuleHandlerData } from '@core/course/providers/module-delegate'; +import { CoreCourseProvider } from '@core/course/providers/course'; + +/** + * Handler to support folder modules. + */ +@Injectable() +export class AddonModFolderModuleHandler implements CoreCourseModuleHandler { + name = 'folder'; + + constructor(private courseProvider: CoreCourseProvider) { } + + /** + * Check if the handler is enabled on a site level. + * + * @return {boolean|Promise} Whether or not the handler is enabled on a site level. + */ + isEnabled(): boolean | Promise { + return true; + } + + /** + * Get the data required to display the module in the course contents view. + * + * @param {any} module The module object. + * @param {number} courseId The course ID. + * @param {number} sectionId The section ID. + * @return {CoreCourseModuleHandlerData} Data to render the module. + */ + getData(module: any, courseId: number, sectionId: number): CoreCourseModuleHandlerData { + return { + icon: this.courseProvider.getModuleIconSrc('folder'), + title: module.name, + class: 'addon-mod_folder-handler', + showDownloadButton: true, + action(event: Event, navCtrl: NavController, module: any, courseId: number, options: NavOptions): void { + navCtrl.push('AddonModFolderIndexPage', {module: module, courseId: courseId}, options); + } + }; + } + + /** + * Get the component to render the module. This is needed to support singleactivity course format. + * The component returned must implement CoreCourseModuleMainComponent. + * + * @param {any} course The course object. + * @param {any} module The module object. + * @return {any} The component to use, undefined if not found. + */ + getMainComponent(course: any, module: any): any { + return AddonModFolderIndexComponent; + } +} diff --git a/src/app/app.module.ts b/src/app/app.module.ts index 615e5096f..3748cb268 100644 --- a/src/app/app.module.ts +++ b/src/app/app.module.ts @@ -76,6 +76,7 @@ import { AddonFilesModule } from '@addon/files/files.module'; import { AddonModBookModule } from '@addon/mod/book/book.module'; import { AddonModLabelModule } from '@addon/mod/label/label.module'; import { AddonModResourceModule } from '@addon/mod/resource/resource.module'; +import { AddonModFolderModule } from '@addon/mod/folder/folder.module'; import { AddonMessagesModule } from '@addon/messages/messages.module'; import { AddonPushNotificationsModule } from '@addon/pushnotifications/pushnotifications.module'; @@ -155,6 +156,7 @@ export const CORE_PROVIDERS: any[] = [ AddonModBookModule, AddonModLabelModule, AddonModResourceModule, + AddonModFolderModule, AddonMessagesModule, AddonPushNotificationsModule ], From 6cdb32d30d78318ec7bc31661dd6e99aea4e5ccc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pau=20Ferrer=20Oca=C3=B1a?= Date: Mon, 5 Mar 2018 18:01:25 +0100 Subject: [PATCH 2/3] MOBILE-2340 folder: Add link, prefetch and plugin handlers --- src/addon/mod/book/providers/link-handler.ts | 3 +- .../folder/components/components.module.ts | 2 - .../mod/folder/components/index/index.scss | 6 ++ .../mod/folder/components/index/index.ts | 11 +-- src/addon/mod/folder/folder.module.ts | 19 ++++- src/addon/mod/folder/lang/en.json | 3 +- .../mod/folder/pages/index/index.module.ts | 2 +- src/addon/mod/folder/providers/folder.ts | 13 ++- src/addon/mod/folder/providers/helper.ts | 3 +- .../mod/folder/providers/link-handler.ts | 30 +++++++ .../folder/providers/pluginfile-handler.ts | 49 +++++++++++ .../mod/folder/providers/prefetch-handler.ts | 81 +++++++++++++++++++ .../mod/resource/components/index/index.ts | 2 + .../mod/resource/providers/link-handler.ts | 3 +- .../context-menu/context-menu-item.ts | 2 +- 15 files changed, 204 insertions(+), 25 deletions(-) create mode 100644 src/addon/mod/folder/components/index/index.scss create mode 100644 src/addon/mod/folder/providers/link-handler.ts create mode 100644 src/addon/mod/folder/providers/pluginfile-handler.ts create mode 100644 src/addon/mod/folder/providers/prefetch-handler.ts diff --git a/src/addon/mod/book/providers/link-handler.ts b/src/addon/mod/book/providers/link-handler.ts index 8f10bade7..1dc92ac85 100644 --- a/src/addon/mod/book/providers/link-handler.ts +++ b/src/addon/mod/book/providers/link-handler.ts @@ -15,6 +15,7 @@ import { Injectable } from '@angular/core'; import { CoreContentLinksModuleIndexHandler } from '@core/contentlinks/classes/module-index-handler'; import { CoreCourseHelperProvider } from '@core/course/providers/helper'; +import { AddonModBookProvider } from './book'; /** * Handler to treat links to book. @@ -24,6 +25,6 @@ export class AddonModBookLinkHandler extends CoreContentLinksModuleIndexHandler name = 'AddonModBookLinkHandler'; constructor(courseHelper: CoreCourseHelperProvider) { - super(courseHelper, 'mmaModBook', 'book'); + super(courseHelper, AddonModBookProvider.COMPONENT, 'book'); } } diff --git a/src/addon/mod/folder/components/components.module.ts b/src/addon/mod/folder/components/components.module.ts index 8edeb4c95..42c787a25 100644 --- a/src/addon/mod/folder/components/components.module.ts +++ b/src/addon/mod/folder/components/components.module.ts @@ -17,7 +17,6 @@ import { CommonModule } from '@angular/common'; import { IonicModule } from 'ionic-angular'; import { TranslateModule } from '@ngx-translate/core'; import { CoreComponentsModule } from '@components/components.module'; -import { CoreDirectivesModule } from '@directives'; import { CoreCourseComponentsModule } from '@core/course/components/components.module'; import { AddonModFolderIndexComponent } from './index/index'; @@ -30,7 +29,6 @@ import { AddonModFolderIndexComponent } from './index/index'; IonicModule, TranslateModule.forChild(), CoreComponentsModule, - CoreDirectivesModule, CoreCourseComponentsModule ], providers: [ diff --git a/src/addon/mod/folder/components/index/index.scss b/src/addon/mod/folder/components/index/index.scss new file mode 100644 index 000000000..6c1df1ccc --- /dev/null +++ b/src/addon/mod/folder/components/index/index.scss @@ -0,0 +1,6 @@ +addon-mod-folder-index { + .item-media > img:first-child { + width: 24px; + height: 24px; + } +} \ No newline at end of file diff --git a/src/addon/mod/folder/components/index/index.ts b/src/addon/mod/folder/components/index/index.ts index 326c34b61..910988501 100644 --- a/src/addon/mod/folder/components/index/index.ts +++ b/src/addon/mod/folder/components/index/index.ts @@ -12,8 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -import { Component, OnInit, OnDestroy, Input, Output, EventEmitter, Optional } from '@angular/core'; -import { NavParams, NavController, Content } from 'ionic-angular'; +import { Component, OnInit, OnDestroy, Input, Output, EventEmitter } from '@angular/core'; import { TranslateService } from '@ngx-translate/core'; import { CoreAppProvider } from '@providers/app'; import { CoreDomUtilsProvider } from '@providers/utils/dom'; @@ -27,7 +26,7 @@ import { AddonModFolderHelperProvider } from '../../providers/helper'; /** * Component that displays a folder. * @todo Adding a new file in a folder updates the revision of all the files, so they're all shown as outdated. - * To ignore revision in folders we'll have to modify $mmCoursePrefetchDelegate, core-file and $mmFilepool. + * To ignore revision in folders we'll have to modify CoreCourseModulePrefetchDelegate, core-file and CoreFilepoolProvider. */ @Component({ selector: 'addon-mod-folder-index', @@ -60,7 +59,7 @@ export class AddonModFolderIndexComponent implements OnInit, OnDestroy, CoreCour constructor(private folderProvider: AddonModFolderProvider, private courseProvider: CoreCourseProvider, private domUtils: CoreDomUtilsProvider, private appProvider: CoreAppProvider, private textUtils: CoreTextUtilsProvider, private courseHelper: CoreCourseHelperProvider, private translate: TranslateService, - @Optional() private content: Content, private folderHelper: AddonModFolderHelperProvider) { + private folderHelper: AddonModFolderHelperProvider) { this.folderRetrieved = new EventEmitter(); } @@ -107,7 +106,7 @@ export class AddonModFolderIndexComponent implements OnInit, OnDestroy, CoreCour if (this.canReload) { this.refreshIcon = 'spinner'; - return this.folderProvider.invalidateContent(this.module.id, this.courseId).catch(() => { + this.folderProvider.invalidateContent(this.module.id, this.courseId).catch(() => { // Ignore errors. }).then(() => { return this.fetchContent(true); @@ -117,6 +116,8 @@ export class AddonModFolderIndexComponent implements OnInit, OnDestroy, CoreCour done && done(); }); } + + return Promise.resolve(); } /** diff --git a/src/addon/mod/folder/folder.module.ts b/src/addon/mod/folder/folder.module.ts index b21495eb9..5cb35a2b5 100644 --- a/src/addon/mod/folder/folder.module.ts +++ b/src/addon/mod/folder/folder.module.ts @@ -18,6 +18,12 @@ import { AddonModFolderHelperProvider } from './providers/helper'; import { AddonModFolderModuleHandler } from './providers/module-handler'; import { CoreCourseModuleDelegate } from '@core/course/providers/module-delegate'; import { AddonModFolderComponentsModule } from './components/components.module'; +import { AddonModFolderPrefetchHandler } from './providers/prefetch-handler'; +import { AddonModFolderLinkHandler } from './providers/link-handler'; +import { AddonModFolderPluginFileHandler } from './providers/pluginfile-handler'; +import { CoreContentLinksDelegate } from '@core/contentlinks/providers/delegate'; +import { CoreCourseModulePrefetchDelegate } from '@core/course/providers/module-prefetch-delegate'; +import { CorePluginFileDelegate } from '@providers/plugin-file-delegate'; @NgModule({ declarations: [ @@ -28,11 +34,20 @@ import { AddonModFolderComponentsModule } from './components/components.module'; providers: [ AddonModFolderProvider, AddonModFolderHelperProvider, - AddonModFolderModuleHandler + AddonModFolderModuleHandler, + AddonModFolderPrefetchHandler, + AddonModFolderLinkHandler, + AddonModFolderPluginFileHandler ] }) export class AddonModFolderModule { - constructor(moduleDelegate: CoreCourseModuleDelegate, moduleHandler: AddonModFolderModuleHandler) { + constructor(moduleDelegate: CoreCourseModuleDelegate, moduleHandler: AddonModFolderModuleHandler, + prefetchDelegate: CoreCourseModulePrefetchDelegate, prefetchHandler: AddonModFolderPrefetchHandler, + contentLinksDelegate: CoreContentLinksDelegate, linkHandler: AddonModFolderLinkHandler, + pluginfileDelegate: CorePluginFileDelegate, pluginfileHandler: AddonModFolderPluginFileHandler) { moduleDelegate.registerHandler(moduleHandler); + prefetchDelegate.registerHandler(prefetchHandler); + contentLinksDelegate.registerHandler(linkHandler); + pluginfileDelegate.registerHandler(pluginfileHandler); } } diff --git a/src/addon/mod/folder/lang/en.json b/src/addon/mod/folder/lang/en.json index 57d4c7f95..7b622c58b 100644 --- a/src/addon/mod/folder/lang/en.json +++ b/src/addon/mod/folder/lang/en.json @@ -1,4 +1,3 @@ { - "emptyfilelist": "There are no files to show.", - "errorwhilegettingfolder": "Error while getting folder data." + "emptyfilelist": "There are no files to show." } \ No newline at end of file diff --git a/src/addon/mod/folder/pages/index/index.module.ts b/src/addon/mod/folder/pages/index/index.module.ts index 5091915b2..b0a275274 100644 --- a/src/addon/mod/folder/pages/index/index.module.ts +++ b/src/addon/mod/folder/pages/index/index.module.ts @@ -15,7 +15,7 @@ import { NgModule } from '@angular/core'; import { IonicPageModule } from 'ionic-angular'; import { TranslateModule } from '@ngx-translate/core'; -import { CoreDirectivesModule } from '@directives'; +import { CoreDirectivesModule } from '@directives/directives.module'; import { AddonModFolderComponentsModule } from '../../components/components.module'; import { AddonModFolderIndexPage } from './index'; diff --git a/src/addon/mod/folder/providers/folder.ts b/src/addon/mod/folder/providers/folder.ts index 5f019f9c8..0e7d80d33 100644 --- a/src/addon/mod/folder/providers/folder.ts +++ b/src/addon/mod/folder/providers/folder.ts @@ -122,6 +122,7 @@ export class AddonModFolderProvider { * Returns whether or not getFolder WS available or not. * * @return {boolean} If WS is avalaible. + * @since 3.3 */ isGetFolderWSAvailable(): boolean { return this.sitesProvider.wsAvailableInCurrentSite('mod_folder_get_folders_by_courses'); @@ -134,14 +135,10 @@ export class AddonModFolderProvider { * @return {Promise} Promise resolved when the WS call is successful. */ logView(id: number): Promise { - if (id) { - const params = { - folderid: id - }; + const params = { + folderid: id + }; - return this.sitesProvider.getCurrentSite().write('mod_folder_view_folder', params); - } - - return Promise.reject(null); + return this.sitesProvider.getCurrentSite().write('mod_folder_view_folder', params); } } diff --git a/src/addon/mod/folder/providers/helper.ts b/src/addon/mod/folder/providers/helper.ts index 0527eff2a..9715a6a8a 100644 --- a/src/addon/mod/folder/providers/helper.ts +++ b/src/addon/mod/folder/providers/helper.ts @@ -13,7 +13,6 @@ // limitations under the License. import { Injectable } from '@angular/core'; -import { CoreLoggerProvider } from '@providers/logger'; import { CoreCourseProvider } from '@core/course/providers/course'; /** @@ -22,7 +21,7 @@ import { CoreCourseProvider } from '@core/course/providers/course'; @Injectable() export class AddonModFolderHelperProvider { - constructor(logger: CoreLoggerProvider, private courseProvider: CoreCourseProvider) { + constructor(private courseProvider: CoreCourseProvider) { } /** diff --git a/src/addon/mod/folder/providers/link-handler.ts b/src/addon/mod/folder/providers/link-handler.ts new file mode 100644 index 000000000..6de6b010c --- /dev/null +++ b/src/addon/mod/folder/providers/link-handler.ts @@ -0,0 +1,30 @@ +// (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 { CoreContentLinksModuleIndexHandler } from '@core/contentlinks/classes/module-index-handler'; +import { CoreCourseHelperProvider } from '@core/course/providers/helper'; +import { AddonModFolderProvider } from './folder'; + +/** + * Handler to treat links to resource. + */ +@Injectable() +export class AddonModFolderLinkHandler extends CoreContentLinksModuleIndexHandler { + name = 'AddonModFolderLinkHandler'; + + constructor(courseHelper: CoreCourseHelperProvider) { + super(courseHelper, AddonModFolderProvider.COMPONENT, 'folder'); + } +} diff --git a/src/addon/mod/folder/providers/pluginfile-handler.ts b/src/addon/mod/folder/providers/pluginfile-handler.ts new file mode 100644 index 000000000..b35efe663 --- /dev/null +++ b/src/addon/mod/folder/providers/pluginfile-handler.ts @@ -0,0 +1,49 @@ +// (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 { CorePluginFileHandler } from '@providers/plugin-file-delegate'; + +/** + * Handler to treat links to folder. + */ +@Injectable() +export class AddonModFolderPluginFileHandler implements CorePluginFileHandler { + name = 'AddonModFolderPluginFileHandler'; + + /** + * Return the RegExp to match the revision on pluginfile URLs. + * + * @param {string[]} args Arguments of the pluginfile URL defining component and filearea at least. + * @return {RegExp} RegExp to match the revision on pluginfile URLs. + */ + getComponentRevisionRegExp(args: string[]): RegExp { + // Check filearea. + if (args[2] == 'content') { + // Component + Filearea + Revision + return new RegExp('/mod_folder/content/([0-9]+)/'); + } + } + + /** + * Should return the string to remove the revision on pluginfile url. + * + * @param {string[]} args Arguments of the pluginfile URL defining component and filearea at least. + * @return {string} String to remove the revision on pluginfile url. + */ + getComponentRevisionReplace(args: string[]): string { + // Component + Filearea + Revision + return '/mod_folder/content/0/'; + } +} diff --git a/src/addon/mod/folder/providers/prefetch-handler.ts b/src/addon/mod/folder/providers/prefetch-handler.ts new file mode 100644 index 000000000..e764111d5 --- /dev/null +++ b/src/addon/mod/folder/providers/prefetch-handler.ts @@ -0,0 +1,81 @@ +// (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, Injector } from '@angular/core'; +import { CoreCourseModulePrefetchHandlerBase } from '@core/course/classes/module-prefetch-handler'; +import { AddonModFolderProvider } from './folder'; + +/** + * Handler to prefetch folders. + */ +@Injectable() +export class AddonModFolderPrefetchHandler extends CoreCourseModulePrefetchHandlerBase { + name = 'folder'; + component = AddonModFolderProvider.COMPONENT; + isResource = true; + + constructor(injector: Injector, protected folderProvider: AddonModFolderProvider) { + super(injector); + } + + /** + * Download or prefetch the content. + * + * @param {any} module The module object returned by WS. + * @param {number} courseId Course ID. + * @param {boolean} [prefetch] True to prefetch, false to download right away. + * @param {string} [dirPath] Path of the directory where to store all the content files. This is to keep the files + * relative paths and make the package work in an iframe. Undefined to download the files + * in the filepool root folder. + * @return {Promise} Promise resolved when all content is downloaded. Data returned is not reliable. + */ + downloadOrPrefetch(module: any, courseId: number, prefetch?: boolean, dirPath?: string): Promise { + const promises = []; + + promises.push(super.downloadOrPrefetch(module, courseId, prefetch)); + + if (this.folderProvider.isGetFolderWSAvailable()) { + promises.push(this.folderProvider.getFolder(courseId, module.id)); + } + + return Promise.all(promises); + } + + /** + * Invalidate the prefetched content. + * + * @param {number} moduleId The module ID. + * @param {number} courseId Course ID the module belongs to. + * @return {Promise} Promise resolved when the data is invalidated. + */ + invalidateContent(moduleId: number, courseId: number): Promise { + return this.folderProvider.invalidateContent(moduleId, courseId); + } + + /** + * Invalidate WS calls needed to determine module status. + * + * @param {any} module Module. + * @param {number} courseId Course ID the module belongs to. + * @return {Promise} Promise resolved when invalidated. + */ + invalidateModule(module: any, courseId: number): Promise { + const promises = []; + + promises.push(this.folderProvider.invalidateFolderData(courseId)); + promises.push(this.courseProvider.invalidateModule(module.id)); + + return Promise.all(promises); + } +} diff --git a/src/addon/mod/resource/components/index/index.ts b/src/addon/mod/resource/components/index/index.ts index 353ede9f9..04e96c2de 100644 --- a/src/addon/mod/resource/components/index/index.ts +++ b/src/addon/mod/resource/components/index/index.ts @@ -104,6 +104,8 @@ export class AddonModResourceIndexComponent implements OnInit, OnDestroy, CoreCo done && done(); }); } + + return Promise.resolve(); } /** diff --git a/src/addon/mod/resource/providers/link-handler.ts b/src/addon/mod/resource/providers/link-handler.ts index 267174f97..86ae7acc9 100644 --- a/src/addon/mod/resource/providers/link-handler.ts +++ b/src/addon/mod/resource/providers/link-handler.ts @@ -15,6 +15,7 @@ import { Injectable } from '@angular/core'; import { CoreContentLinksModuleIndexHandler } from '@core/contentlinks/classes/module-index-handler'; import { CoreCourseHelperProvider } from '@core/course/providers/helper'; +import { AddonModResourceProvider } from './resource'; /** * Handler to treat links to resource. @@ -24,6 +25,6 @@ export class AddonModResourceLinkHandler extends CoreContentLinksModuleIndexHand name = 'AddonModResourceLinkHandler'; constructor(courseHelper: CoreCourseHelperProvider) { - super(courseHelper, AddonModResourceLinkHandler.name, 'resource'); + super(courseHelper, AddonModResourceProvider.COMPONENT, 'resource'); } } diff --git a/src/components/context-menu/context-menu-item.ts b/src/components/context-menu/context-menu-item.ts index 6700a1521..e748dee34 100644 --- a/src/components/context-menu/context-menu-item.ts +++ b/src/components/context-menu/context-menu-item.ts @@ -49,7 +49,7 @@ export class CoreContextMenuItemComponent implements OnInit, OnDestroy, OnChange @Input() badge?: string; // A badge to show in the item. @Input() badgeClass?: number; // A class to set in the badge. @Input() hidden?: boolean; // Whether the item should be hidden. - @Output() action?: EventEmitter; // Will emit an event when the item clicked. + @Output() action?: EventEmitter<() => void>; // Will emit an event when the item clicked. protected hasAction = false; protected destroyed = false; From 66ee81609c41aca37d9d882ffc2d5a08c8189458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pau=20Ferrer=20Oca=C3=B1a?= Date: Thu, 15 Mar 2018 15:24:22 +0100 Subject: [PATCH 3/3] MOBILE-2340 core: Fix linter errors --- src/addon/messages/providers/mainmenu-handler.ts | 2 +- src/addon/mod/resource/providers/helper.ts | 6 +----- .../userprofilefield/checkbox/component/checkbox.ts | 6 +++--- .../userprofilefield/datetime/component/datetime.ts | 4 ++-- src/addon/userprofilefield/menu/component/menu.ts | 4 ++-- src/addon/userprofilefield/text/component/text.ts | 4 ++-- .../userprofilefield/textarea/component/textarea.ts | 4 ++-- src/components/chrono/chrono.ts | 2 +- src/components/rich-text-editor/rich-text-editor.ts | 2 +- src/components/search-box/search-box.ts | 8 ++++---- src/components/tabs/tab.ts | 4 ++-- src/components/tabs/tabs.ts | 4 ---- src/core/emulator/providers/file-transfer.ts | 2 -- src/core/mainmenu/pages/menu/menu.ts | 3 +-- src/core/mainmenu/pages/more/more.ts | 2 +- src/directives/link.ts | 2 +- src/providers/sites.ts | 6 ++---- src/providers/utils/utils.ts | 10 ---------- tslint.json | 1 - 19 files changed, 26 insertions(+), 50 deletions(-) diff --git a/src/addon/messages/providers/mainmenu-handler.ts b/src/addon/messages/providers/mainmenu-handler.ts index 33f22fbb7..a30ac88a4 100644 --- a/src/addon/messages/providers/mainmenu-handler.ts +++ b/src/addon/messages/providers/mainmenu-handler.ts @@ -14,7 +14,7 @@ import { Injectable } from '@angular/core'; import { AddonMessagesProvider } from './messages'; -import { CoreMainMenuDelegate, CoreMainMenuHandler, CoreMainMenuHandlerToDisplay } from '@core/mainmenu/providers/delegate'; +import { CoreMainMenuHandler, CoreMainMenuHandlerToDisplay } from '@core/mainmenu/providers/delegate'; import { CoreCronHandler } from '@providers/cron'; import { CoreSitesProvider } from '@providers/sites'; import { CoreEventsProvider } from '@providers/events'; diff --git a/src/addon/mod/resource/providers/helper.ts b/src/addon/mod/resource/providers/helper.ts index a9077b3d5..3eb43e727 100644 --- a/src/addon/mod/resource/providers/helper.ts +++ b/src/addon/mod/resource/providers/helper.ts @@ -17,15 +17,12 @@ import { CoreDomUtilsProvider } from '@providers/utils/dom'; import { CoreCourseProvider } from '@core/course/providers/course'; import { CoreCourseHelperProvider } from '@core/course/providers/helper'; import { AddonModResourceProvider } from './resource'; -import { TranslateService } from '@ngx-translate/core'; import { CoreSitesProvider } from '@providers/sites'; -import { CoreUtilsProvider } from '@providers/utils/utils'; import { CoreFilepoolProvider } from '@providers/filepool'; import { CoreFileProvider } from '@providers/file'; import { CoreAppProvider } from '@providers/app'; import { CoreMimetypeUtilsProvider } from '@providers/utils/mimetype'; import { CoreTextUtilsProvider } from '@providers/utils/text'; -import { CoreConstants } from '@core/constants'; /** * Service that provides helper functions for resources. @@ -43,8 +40,7 @@ export class AddonModResourceHelperProvider { private resourceProvider: AddonModResourceProvider, private courseHelper: CoreCourseHelperProvider, private textUtils: CoreTextUtilsProvider, private mimetypeUtils: CoreMimetypeUtilsProvider, private fileProvider: CoreFileProvider, private appProvider: CoreAppProvider, - private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider, - private sitesProvider: CoreSitesProvider, private translate: TranslateService) { + private filepoolProvider: CoreFilepoolProvider, private sitesProvider: CoreSitesProvider) { } /** diff --git a/src/addon/userprofilefield/checkbox/component/checkbox.ts b/src/addon/userprofilefield/checkbox/component/checkbox.ts index 998187701..de4a3392e 100644 --- a/src/addon/userprofilefield/checkbox/component/checkbox.ts +++ b/src/addon/userprofilefield/checkbox/component/checkbox.ts @@ -25,9 +25,9 @@ import { CoreUtilsProvider } from '@providers/utils/utils'; }) export class AddonUserProfileFieldCheckboxComponent implements OnInit { @Input() field: any; // The profile field to be rendered. - @Input() edit?: false; // True if editing the field. Defaults to false. - @Input() disabled?: false; // True if disabled. Defaults to false. - @Input() form?: FormGroup; // Form where to add the form control. + @Input() edit = false; // True if editing the field. Defaults to false. + @Input() disabled = false; // True if disabled. Defaults to false. + @Input() form: FormGroup; // Form where to add the form control. constructor(private fb: FormBuilder, protected utils: CoreUtilsProvider) { } diff --git a/src/addon/userprofilefield/datetime/component/datetime.ts b/src/addon/userprofilefield/datetime/component/datetime.ts index 1d43eaf80..cf72c309b 100644 --- a/src/addon/userprofilefield/datetime/component/datetime.ts +++ b/src/addon/userprofilefield/datetime/component/datetime.ts @@ -26,8 +26,8 @@ import { CoreUtilsProvider } from '@providers/utils/utils'; }) export class AddonUserProfileFieldDatetimeComponent implements OnInit { @Input() field: any; // The profile field to be rendered. - @Input() edit? = false; // True if editing the field. Defaults to false. - @Input() disabled? = false; // True if disabled. Defaults to false. + @Input() edit = false; // True if editing the field. Defaults to false. + @Input() disabled = false; // True if disabled. Defaults to false. @Input() form?: FormGroup; // Form where to add the form control. constructor(private fb: FormBuilder, private timeUtils: CoreTimeUtilsProvider, protected utils: CoreUtilsProvider) { } diff --git a/src/addon/userprofilefield/menu/component/menu.ts b/src/addon/userprofilefield/menu/component/menu.ts index b9e74c51a..338d40a33 100644 --- a/src/addon/userprofilefield/menu/component/menu.ts +++ b/src/addon/userprofilefield/menu/component/menu.ts @@ -24,8 +24,8 @@ import { FormGroup, FormBuilder, Validators } from '@angular/forms'; }) export class AddonUserProfileFieldMenuComponent implements OnInit { @Input() field: any; // The profile field to be rendered. - @Input() edit? = false; // True if editing the field. Defaults to false. - @Input() disabled? = false; // True if disabled. Defaults to false. + @Input() edit = false; // True if editing the field. Defaults to false. + @Input() disabled = false; // True if disabled. Defaults to false. @Input() form?: FormGroup; // Form where to add the form control. constructor(private fb: FormBuilder) { } diff --git a/src/addon/userprofilefield/text/component/text.ts b/src/addon/userprofilefield/text/component/text.ts index 84f1f44c1..c8ebd6b21 100644 --- a/src/addon/userprofilefield/text/component/text.ts +++ b/src/addon/userprofilefield/text/component/text.ts @@ -25,8 +25,8 @@ import { CoreUtilsProvider } from '@providers/utils/utils'; }) export class AddonUserProfileFieldTextComponent implements OnInit { @Input() field: any; // The profile field to be rendered. - @Input() edit? = false; // True if editing the field. Defaults to false. - @Input() disabled? = false; // True if disabled. Defaults to false. + @Input() edit = false; // True if editing the field. Defaults to false. + @Input() disabled = false; // True if disabled. Defaults to false. @Input() form?: FormGroup; // Form where to add the form control. constructor(private fb: FormBuilder, protected utils: CoreUtilsProvider) { } diff --git a/src/addon/userprofilefield/textarea/component/textarea.ts b/src/addon/userprofilefield/textarea/component/textarea.ts index efd1dae99..61b24b458 100644 --- a/src/addon/userprofilefield/textarea/component/textarea.ts +++ b/src/addon/userprofilefield/textarea/component/textarea.ts @@ -24,8 +24,8 @@ import { FormGroup, Validators, FormControl } from '@angular/forms'; }) export class AddonUserProfileFieldTextareaComponent implements OnInit { @Input() field: any; // The profile field to be rendered. - @Input() edit? = false; // True if editing the field. Defaults to false. - @Input() disabled? = false; // True if disabled. Defaults to false. + @Input() edit = false; // True if editing the field. Defaults to false. + @Input() disabled = false; // True if disabled. Defaults to false. @Input() form?: FormGroup; // Form where to add the form control. control: FormControl; diff --git a/src/components/chrono/chrono.ts b/src/components/chrono/chrono.ts index 885d62565..ca8757a41 100644 --- a/src/components/chrono/chrono.ts +++ b/src/components/chrono/chrono.ts @@ -32,7 +32,7 @@ import { Component, Input, OnChanges, OnDestroy, Output, EventEmitter, SimpleCha }) export class CoreChronoComponent implements OnChanges, OnDestroy { @Input() running: boolean; // Set it to true to start the chrono. Set it to false to stop it. - @Input() startTime? = 0; // Number of milliseconds to put in the chrono before starting. + @Input() startTime = 0; // Number of milliseconds to put in the chrono before starting. @Input() endTime?: number; // Number of milliseconds to stop the chrono. @Input() reset?: boolean; // Set it to true to reset the chrono. @Output() onEnd?: EventEmitter; // Will emit an event when the endTime is reached. diff --git a/src/components/rich-text-editor/rich-text-editor.ts b/src/components/rich-text-editor/rich-text-editor.ts index bf0e9c0ec..97a6a6530 100644 --- a/src/components/rich-text-editor/rich-text-editor.ts +++ b/src/components/rich-text-editor/rich-text-editor.ts @@ -40,7 +40,7 @@ export class CoreRichTextEditorComponent { // Based on: https://github.com/judgewest2000/Ionic3RichText/ // @todo: Resize, images, anchor button, fullscreen... - @Input() placeholder? = ''; // Placeholder to set in textarea. + @Input() placeholder = ''; // Placeholder to set in textarea. @Input() control: FormControl; // Form control. @Output() contentChanged: EventEmitter; diff --git a/src/components/search-box/search-box.ts b/src/components/search-box/search-box.ts index 2c5110b65..dabae223c 100644 --- a/src/components/search-box/search-box.ts +++ b/src/components/search-box/search-box.ts @@ -33,12 +33,12 @@ import { CoreUtilsProvider } from '@providers/utils/utils'; export class CoreSearchBoxComponent implements OnInit { @Input() searchLabel?: string; // Label to be used on action button. @Input() placeholder?: string; // Placeholder text for search text input. - @Input() autocorrect? = 'on'; // Enables/disable Autocorrection on search text input. + @Input() autocorrect = 'on'; // Enables/disable Autocorrection on search text input. @Input() spellcheck?: string | boolean = true; // Enables/disable Spellchecker on search text input. @Input() autoFocus?: string | boolean; // Enables/disable Autofocus when entering view. - @Input() lengthCheck? = 3; // Check value length before submit. If 0, any string will be submitted. - @Input() showClear? = true; // Show/hide clear button. - @Input() disabled? = false; // Disables the input text. + @Input() lengthCheck = 3; // Check value length before submit. If 0, any string will be submitted. + @Input() showClear = true; // Show/hide clear button. + @Input() disabled = false; // Disables the input text. @Output() onSubmit: EventEmitter; // Send data when submitting the search form. @Output() onClear?: EventEmitter; // Send event when clearing the search form. diff --git a/src/components/tabs/tab.ts b/src/components/tabs/tab.ts index 95102e758..fe5ef6fc3 100644 --- a/src/components/tabs/tab.ts +++ b/src/components/tabs/tab.ts @@ -46,8 +46,8 @@ export class CoreTabComponent implements OnInit, OnDestroy { @Input() icon?: string; // The tab icon. @Input() badge?: string; // A badge to add in the tab. @Input() badgeStyle?: string; // The badge color. - @Input() enabled? = true; // Whether the tab is enabled. - @Input() show? = true; // Whether the tab should be shown. + @Input() enabled = true; // Whether the tab is enabled. + @Input() show = true; // Whether the tab should be shown. @Input() id?: string; // An ID to identify the tab. @Output() ionSelect: EventEmitter = new EventEmitter(); diff --git a/src/components/tabs/tabs.ts b/src/components/tabs/tabs.ts index 9c9cee453..0734f63eb 100644 --- a/src/components/tabs/tabs.ts +++ b/src/components/tabs/tabs.ts @@ -242,15 +242,11 @@ export class CoreTabsComponent implements OnInit, AfterViewInit, OnChanges { protected sortTabs(): void { if (this.originalTabsContainer) { const newTabs = []; - let newSelected; this.tabs.forEach((tab, index) => { const originalIndex = Array.prototype.indexOf.call(this.originalTabsContainer.children, tab.element); if (originalIndex != -1) { newTabs[originalIndex] = tab; - if (this.selected == index) { - newSelected = originalIndex; - } } }); diff --git a/src/core/emulator/providers/file-transfer.ts b/src/core/emulator/providers/file-transfer.ts index 7adff60e3..f6a5db400 100644 --- a/src/core/emulator/providers/file-transfer.ts +++ b/src/core/emulator/providers/file-transfer.ts @@ -238,7 +238,6 @@ export class FileTransferObjectMock extends FileTransferObject { const basicAuthHeader = this.getBasicAuthHeader(url); let fileKey = null, fileName = null, - mimeType = null, params = null, headers = null, httpMethod = null; @@ -254,7 +253,6 @@ export class FileTransferObjectMock extends FileTransferObject { if (options) { fileKey = options.fileKey; fileName = options.fileName; - mimeType = options.mimeType; headers = options.headers; httpMethod = options.httpMethod || 'POST'; diff --git a/src/core/mainmenu/pages/menu/menu.ts b/src/core/mainmenu/pages/menu/menu.ts index 19476a899..dd5872b6c 100644 --- a/src/core/mainmenu/pages/menu/menu.ts +++ b/src/core/mainmenu/pages/menu/menu.ts @@ -14,7 +14,6 @@ import { Component, OnDestroy, ViewChild } from '@angular/core'; import { IonicPage, NavController, NavParams, Tabs } from 'ionic-angular'; -import { CoreEventsProvider } from '@providers/events'; import { CoreSitesProvider } from '@providers/sites'; import { CoreMainMenuProvider } from '../../providers/mainmenu'; import { CoreMainMenuDelegate, CoreMainMenuHandlerData } from '../../providers/delegate'; @@ -66,7 +65,7 @@ export class CoreMainMenuPage implements OnDestroy { protected redirectPageLoaded = false; constructor(private menuDelegate: CoreMainMenuDelegate, private sitesProvider: CoreSitesProvider, navParams: NavParams, - private navCtrl: NavController, private eventsProvider: CoreEventsProvider) { + private navCtrl: NavController) { this.redirectPage = navParams.get('redirectPage'); this.redirectParams = navParams.get('redirectParams'); } diff --git a/src/core/mainmenu/pages/more/more.ts b/src/core/mainmenu/pages/more/more.ts index 8f36a3101..ce0e1ccfe 100644 --- a/src/core/mainmenu/pages/more/more.ts +++ b/src/core/mainmenu/pages/more/more.ts @@ -43,7 +43,7 @@ export class CoreMainMenuMorePage implements OnDestroy { constructor(private menuDelegate: CoreMainMenuDelegate, private sitesProvider: CoreSitesProvider, private navCtrl: NavController, private mainMenuProvider: CoreMainMenuProvider, - private eventsProvider: CoreEventsProvider) { + eventsProvider: CoreEventsProvider) { this.langObserver = eventsProvider.on(CoreEventsProvider.LANGUAGE_CHANGED, this.loadSiteInfo.bind(this)); this.updateSiteObserver = eventsProvider.on(CoreEventsProvider.SITE_UPDATED, this.loadSiteInfo.bind(this), diff --git a/src/directives/link.ts b/src/directives/link.ts index 75c50b186..7165f82f7 100644 --- a/src/directives/link.ts +++ b/src/directives/link.ts @@ -30,7 +30,7 @@ import { CoreConfigConstants } from '../configconstants'; export class CoreLinkDirective implements OnInit { @Input() capture?: boolean | string; // If the link needs to be captured by the app. @Input() inApp?: boolean | string; // True to open in embedded browser, false to open in system browser. - @Input() autoLogin?= 'check'; // If the link should be open with auto-login. Accepts the following values: + @Input() autoLogin = 'check'; // If the link should be open with auto-login. Accepts the following values: // "yes" -> Always auto-login. // "no" -> Never auto-login. // "check" -> Auto-login only if it points to the current site. Default value. diff --git a/src/providers/sites.ts b/src/providers/sites.ts index 4b34327a9..53154c12a 100644 --- a/src/providers/sites.ts +++ b/src/providers/sites.ts @@ -21,7 +21,6 @@ import { CoreLoggerProvider } from './logger'; import { CoreSitesFactoryProvider } from './sites-factory'; import { CoreTextUtilsProvider } from './utils/text'; import { CoreUrlUtilsProvider } from './utils/url'; -import { CoreUtilsProvider } from './utils/utils'; import { CoreConstants } from '@core/constants'; import { CoreConfigConstants } from '../configconstants'; import { CoreSite } from '@classes/site'; @@ -211,9 +210,8 @@ export class CoreSitesProvider { protected siteTablesSchemas = []; // Schemas for site tables. Other providers can add schemas in here. constructor(logger: CoreLoggerProvider, private http: HttpClient, private sitesFactory: CoreSitesFactoryProvider, - private appProvider: CoreAppProvider, private utils: CoreUtilsProvider, private translate: TranslateService, - private eventsProvider: CoreEventsProvider, private urlUtils: CoreUrlUtilsProvider, - private textUtils: CoreTextUtilsProvider) { + private appProvider: CoreAppProvider, private translate: TranslateService, private urlUtils: CoreUrlUtilsProvider, + private eventsProvider: CoreEventsProvider, private textUtils: CoreTextUtilsProvider) { this.logger = logger.getInstance('CoreSitesProvider'); this.appDB = appProvider.getDB(); diff --git a/src/providers/utils/utils.ts b/src/providers/utils/utils.ts index 40044549d..2c485ed85 100644 --- a/src/providers/utils/utils.ts +++ b/src/providers/utils/utils.ts @@ -14,7 +14,6 @@ import { Injectable } from '@angular/core'; import { Platform } from 'ionic-angular'; -import { Observable } from 'rxjs'; import { InAppBrowser, InAppBrowserObject } from '@ionic-native/in-app-browser'; import { Clipboard } from '@ionic-native/clipboard'; import { CoreAppProvider } from '../app'; @@ -699,15 +698,6 @@ export class CoreUtilsProvider { options.location = 'no'; } - // Convert the options to a string. - const optionsArray = []; - let optionsString; - - for (const name in options) { - optionsArray.push(`${name}=${options[name]}`); - } - optionsString = optionsArray.join(','); - this.iabInstance = this.iab.create(url, '_blank', options); if (this.appProvider.isDesktop() || this.appProvider.isMobile()) { diff --git a/tslint.json b/tslint.json index 54d006b00..e553d9a05 100644 --- a/tslint.json +++ b/tslint.json @@ -58,7 +58,6 @@ "no-unused-variable": true, "no-var-keyword": true, "switch-default": true, - "typeof-compare": true, "use-isnan": true, "eofline": true, "indent": [true, "spaces", 4],