105 lines
4.2 KiB
TypeScript
105 lines
4.2 KiB
TypeScript
// (C) Copyright 2015 Moodle Pty Ltd.
|
|
//
|
|
// 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 { TranslateService } from '@ngx-translate/core';
|
|
import { CoreAppProvider } from '@providers/app';
|
|
import { CoreFilepoolProvider } from '@providers/filepool';
|
|
import { CoreSitesProvider } from '@providers/sites';
|
|
import { CoreDomUtilsProvider } from '@providers/utils/dom';
|
|
import { CoreUtilsProvider } from '@providers/utils/utils';
|
|
import { CoreCourseProvider } from '@core/course/providers/course';
|
|
import { CoreCourseResourcePrefetchHandlerBase } from '@core/course/classes/resource-prefetch-handler';
|
|
import { AddonModPageProvider } from './page';
|
|
import { AddonModPageHelperProvider } from './helper';
|
|
import { CoreFilterHelperProvider } from '@core/filter/providers/helper';
|
|
import { CorePluginFileDelegate } from '@providers/plugin-file-delegate';
|
|
|
|
/**
|
|
* Handler to prefetch pages.
|
|
*/
|
|
@Injectable()
|
|
export class AddonModPagePrefetchHandler extends CoreCourseResourcePrefetchHandlerBase {
|
|
name = 'AddonModPage';
|
|
modName = 'page';
|
|
component = AddonModPageProvider.COMPONENT;
|
|
updatesNames = /^configuration$|^.*files$/;
|
|
|
|
constructor(translate: TranslateService,
|
|
appProvider: CoreAppProvider,
|
|
utils: CoreUtilsProvider,
|
|
courseProvider: CoreCourseProvider,
|
|
filepoolProvider: CoreFilepoolProvider,
|
|
sitesProvider: CoreSitesProvider,
|
|
domUtils: CoreDomUtilsProvider,
|
|
filterHelper: CoreFilterHelperProvider,
|
|
pluginFileDelegate: CorePluginFileDelegate,
|
|
protected pageProvider: AddonModPageProvider,
|
|
protected pageHelper: AddonModPageHelperProvider) {
|
|
|
|
super(translate, appProvider, utils, courseProvider, filepoolProvider, sitesProvider, domUtils, filterHelper,
|
|
pluginFileDelegate);
|
|
}
|
|
|
|
/**
|
|
* Download or prefetch the content.
|
|
*
|
|
* @param module The module object returned by WS.
|
|
* @param courseId Course ID.
|
|
* @param prefetch True to prefetch, false to download right away.
|
|
* @param 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 page.
|
|
* @return Promise resolved when all content is downloaded. Data returned is not reliable.
|
|
*/
|
|
downloadOrPrefetch(module: any, courseId: number, prefetch?: boolean, dirPath?: string): Promise<any> {
|
|
const promises = [];
|
|
|
|
promises.push(super.downloadOrPrefetch(module, courseId, prefetch));
|
|
|
|
if (this.pageProvider.isGetPageWSAvailable()) {
|
|
promises.push(this.pageProvider.getPageData(courseId, module.id));
|
|
}
|
|
|
|
return Promise.all(promises);
|
|
}
|
|
|
|
/**
|
|
* Invalidate the prefetched content.
|
|
*
|
|
* @param moduleId The module ID.
|
|
* @param courseId Course ID the module belongs to.
|
|
* @return Promise resolved when the data is invalidated.
|
|
*/
|
|
invalidateContent(moduleId: number, courseId: number): Promise<any> {
|
|
return this.pageProvider.invalidateContent(moduleId, courseId);
|
|
}
|
|
|
|
/**
|
|
* Invalidate WS calls needed to determine module status.
|
|
*
|
|
* @param module Module.
|
|
* @param courseId Course ID the module belongs to.
|
|
* @return Promise resolved when invalidated.
|
|
*/
|
|
invalidateModule(module: any, courseId: number): Promise<any> {
|
|
const promises = [];
|
|
|
|
promises.push(this.pageProvider.invalidatePageData(courseId));
|
|
promises.push(this.courseProvider.invalidateModule(module.id));
|
|
|
|
return this.utils.allPromises(promises);
|
|
}
|
|
}
|