// (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 { AddonModResourceProvider } from './resource'; import { AddonModResourceHelperProvider } from './helper'; import { AddonModResourceIndexComponent } from '../components/index/index'; import { CoreCourseModuleHandler, CoreCourseModuleHandlerData } from '@core/course/providers/module-delegate'; import { CoreCourseProvider } from '@core/course/providers/course'; import { CoreMimetypeUtilsProvider } from '@providers/utils/mimetype'; /** * Handler to support resource modules. */ @Injectable() export class AddonModResourceModuleHandler implements CoreCourseModuleHandler { name = 'resource'; constructor(protected resourceProvider: AddonModResourceProvider, private courseProvider: CoreCourseProvider, protected mimetypeUtils: CoreMimetypeUtilsProvider, private resourceHelper: AddonModResourceHelperProvider) { } /** * 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 this.resourceProvider.isPluginEnabled(); } /** * 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 { const handlerData = { icon: this.courseProvider.getModuleIconSrc('resource'), title: module.name, class: 'addon-mod_resource-handler', showDownloadButton: true, action(event: Event, navCtrl: NavController, module: any, courseId: number, options: NavOptions): void { navCtrl.push('AddonModResourceIndexPage', {module: module, courseId: courseId}, options); }, buttons: [ { hidden: !this.resourceHelper.isDisplayedInIframe(module), icon: 'document', label: 'addon.mod_resource.openthefile', action: (event: Event, navCtrl: NavController, module: any, courseId: number): void => { this.hideOpenButton(module, courseId).then((hide) => { if (!hide) { this.resourceHelper.openModuleFile(module, courseId); } }); } } ] }; this.getIcon(module, courseId).then((icon) => { handlerData.icon = icon; }); this.hideOpenButton(module, courseId).then((hideOpenButton) => { handlerData.buttons[0].hidden = hideOpenButton; }); return handlerData; } /** * Returns if contents are loaded to show open button. * * @param {any} module The module object. * @param {number} courseId The course ID. * @return {Promise} Resolved when done. */ protected hideOpenButton(module: any, courseId: number): Promise { return this.courseProvider.loadModuleContents(module, courseId).then(() => { return this.resourceHelper.isDisplayedInIframe(module); }); } /** * Returns the activity icon. * * @param {any} module The module object. * @param {number} courseId The course ID. * @return {Promise} Icon URL. */ protected getIcon(module: any, courseId: number): Promise { return this.courseProvider.loadModuleContents(module, courseId).then(() => { if (module.contents.length) { const filename = module.contents[0].filename, extension = this.mimetypeUtils.getFileExtension(filename); if (module.contents.length == 1 || (extension != 'html' && extension != 'htm')) { return this.mimetypeUtils.getFileIcon(filename); } } return this.courseProvider.getModuleIconSrc('resource'); }); } /** * 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 AddonModResourceIndexComponent; } }