426 lines
17 KiB
TypeScript
426 lines
17 KiB
TypeScript
// (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 { CoreFileProvider } from '@providers/file';
|
|
import { CoreTextUtilsProvider } from '@providers/utils/text';
|
|
import { CoreCourseModulePrefetchHandlerBase } from '@core/course/classes/module-prefetch-handler';
|
|
import { AddonModScormProvider } from './scorm';
|
|
|
|
/**
|
|
* Progress event used when downloading a SCORM.
|
|
*/
|
|
export interface AddonModScormProgressEvent {
|
|
/**
|
|
* Whether the event is due to the download of a chunk of data.
|
|
* @type {boolean}
|
|
*/
|
|
downloading?: boolean;
|
|
|
|
/**
|
|
* Progress event sent by the download.
|
|
* @type {ProgressEvent}
|
|
*/
|
|
progress?: ProgressEvent;
|
|
|
|
/**
|
|
* A message related to the progress. This is usually used to notify that a certain step of the download has started.
|
|
* @type {string}
|
|
*/
|
|
message?: string;
|
|
}
|
|
|
|
/**
|
|
* Handler to prefetch SCORMs.
|
|
*/
|
|
@Injectable()
|
|
export class AddonModScormPrefetchHandler extends CoreCourseModulePrefetchHandlerBase {
|
|
name = 'AddonModScorm';
|
|
modName = 'scorm';
|
|
component = AddonModScormProvider.COMPONENT;
|
|
updatesNames = /^configuration$|^.*files$|^tracks$/;
|
|
|
|
constructor(injector: Injector, protected fileProvider: CoreFileProvider, protected textUtils: CoreTextUtilsProvider,
|
|
protected scormProvider: AddonModScormProvider) {
|
|
super(injector);
|
|
}
|
|
|
|
/**
|
|
* Download the module.
|
|
*
|
|
* @param {any} module The module object returned by WS.
|
|
* @param {number} courseId Course ID.
|
|
* @param {string} [dirPath] Path of the directory where to store all the content files.
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @return {Promise<any>} Promise resolved when all content is downloaded.
|
|
*/
|
|
download(module: any, courseId: number, dirPath?: string, onProgress?: (event: AddonModScormProgressEvent) => any)
|
|
: Promise<any> {
|
|
|
|
const siteId = this.sitesProvider.getCurrentSiteId();
|
|
|
|
return this.prefetchPackage(module, courseId, true, this.downloadOrPrefetchScorm.bind(this), siteId, false, onProgress);
|
|
}
|
|
|
|
/**
|
|
* Download or prefetch a SCORM.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to.
|
|
* @param {boolean} single True if we're downloading a single module, false if we're downloading a whole section.
|
|
* @param {String} siteId Site ID.
|
|
* @param {boolean} prefetch True to prefetch, false to download right away.
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @return {Promise<any>} Promise resolved with the "extra" data to store: the hash of the file.
|
|
*/
|
|
protected downloadOrPrefetchScorm(module: any, courseId: number, single: boolean, siteId: string, prefetch: boolean,
|
|
onProgress?: (event: AddonModScormProgressEvent) => any): Promise<string> {
|
|
|
|
let scorm;
|
|
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url, false, siteId).then((scormData) => {
|
|
scorm = scormData;
|
|
|
|
const promises = [],
|
|
introFiles = this.getIntroFilesFromInstance(module, scorm);
|
|
|
|
// Download WS data.
|
|
promises.push(this.fetchWSData(scorm, siteId).catch(() => {
|
|
// If prefetchData fails we don't want to fail the whole download, so we'll ignore the error for now.
|
|
// @todo Implement a warning system so the user knows which SCORMs have failed.
|
|
}));
|
|
|
|
// Download the package.
|
|
promises.push(this.downloadOrPrefetchMainFileIfNeeded(scorm, prefetch, onProgress, siteId));
|
|
|
|
// Download intro files.
|
|
promises.push(this.filepoolProvider.downloadOrPrefetchFiles(siteId, introFiles, prefetch, false, this.component,
|
|
module.id).catch(() => {
|
|
// Ignore errors.
|
|
}));
|
|
|
|
return Promise.all(promises);
|
|
}).then(() => {
|
|
// Success, return the hash.
|
|
return scorm.sha1hash;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Downloads/Prefetches and unzips the SCORM package.
|
|
*
|
|
* @param {any} scorm SCORM object.
|
|
* @param {boolean} [prefetch] True if prefetch, false otherwise.
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
|
* @return {Promise<any>} Promise resolved when the file is downloaded and unzipped.
|
|
*/
|
|
protected downloadOrPrefetchMainFile(scorm: any, prefetch?: boolean, onProgress?: (event: AddonModScormProgressEvent) => any,
|
|
siteId?: string): Promise<any> {
|
|
|
|
const packageUrl = this.scormProvider.getPackageUrl(scorm);
|
|
let dirPath;
|
|
|
|
// Get the folder where the unzipped files will be.
|
|
return this.scormProvider.getScormFolder(scorm.moduleurl).then((path) => {
|
|
dirPath = path;
|
|
|
|
// Notify that the download is starting.
|
|
onProgress && onProgress({message: 'core.downloading'});
|
|
|
|
// Download the ZIP file to the filepool.
|
|
if (prefetch) {
|
|
return this.filepoolProvider.addToQueueByUrl(siteId, packageUrl, this.component, scorm.coursemodule, undefined,
|
|
undefined, this.downloadProgress.bind(this, true, onProgress));
|
|
} else {
|
|
return this.filepoolProvider.downloadUrl(siteId, packageUrl, true, this.component, scorm.coursemodule,
|
|
undefined, this.downloadProgress.bind(this, true, onProgress));
|
|
}
|
|
}).then(() => {
|
|
// Remove the destination folder to prevent having old unused files.
|
|
return this.fileProvider.removeDir(dirPath).catch(() => {
|
|
// Ignore errors, it might have failed because the folder doesn't exist.
|
|
});
|
|
}).then(() => {
|
|
// Get the ZIP file path.
|
|
return this.filepoolProvider.getFilePathByUrl(siteId, packageUrl);
|
|
}).then((zipPath) => {
|
|
// Notify that the unzip is starting.
|
|
onProgress && onProgress({message: 'core.unzipping'});
|
|
|
|
// Unzip and delete the zip when finished.
|
|
return this.fileProvider.unzipFile(zipPath, dirPath, this.downloadProgress.bind(this, false, onProgress)).then(() => {
|
|
return this.filepoolProvider.removeFileByUrl(siteId, packageUrl).catch(() => {
|
|
// Ignore errors.
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Downloads/Prefetches and unzips the SCORM package if it should be downloaded.
|
|
*
|
|
* @param {any} scorm SCORM object.
|
|
* @param {boolean} [prefetch] True if prefetch, false otherwise.
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
|
* @return {Promise<any>} Promise resolved when the file is downloaded and unzipped.
|
|
*/
|
|
protected downloadOrPrefetchMainFileIfNeeded(scorm: any, prefetch?: boolean,
|
|
onProgress?: (event: AddonModScormProgressEvent) => any, siteId?: string): Promise<any> {
|
|
|
|
siteId = siteId || this.sitesProvider.getCurrentSiteId();
|
|
|
|
const result = this.scormProvider.isScormUnsupported(scorm);
|
|
|
|
if (result) {
|
|
return Promise.reject(this.translate.instant(result));
|
|
}
|
|
|
|
// First verify that the file needs to be downloaded.
|
|
// It needs to be checked manually because the ZIP file is deleted after unzipped, so the filepool will always download it.
|
|
return this.scormProvider.shouldDownloadMainFile(scorm, undefined, siteId).then((download) => {
|
|
if (download) {
|
|
return this.downloadOrPrefetchMainFile(scorm, prefetch, onProgress, siteId);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Function that converts a regular ProgressEvent into a AddonModScormProgressEvent.
|
|
*
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @param {ProgressEvent} [progress] Event returned by the download function.
|
|
*/
|
|
protected downloadProgress(downloading: boolean, onProgress?: (event: AddonModScormProgressEvent) => any,
|
|
progress?: ProgressEvent): void {
|
|
|
|
if (onProgress && progress && progress.loaded) {
|
|
onProgress({
|
|
downloading: downloading,
|
|
progress: progress
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get WS data for SCORM.
|
|
*
|
|
* @param {any} scorm SCORM object.
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
|
* @return {Promise<any>} Promise resolved when the data is prefetched.
|
|
*/
|
|
fetchWSData(scorm: any, siteId?: string): Promise<any> {
|
|
siteId = siteId || this.sitesProvider.getCurrentSiteId();
|
|
|
|
const promises = [];
|
|
|
|
// Prefetch number of attempts (including not completed).
|
|
promises.push(this.scormProvider.getAttemptCountOnline(scorm.id, undefined, true, siteId).catch(() => {
|
|
// If it fails, assume we have no attempts.
|
|
return 0;
|
|
}).then((numAttempts) => {
|
|
if (numAttempts > 0) {
|
|
// Get user data for each attempt.
|
|
const dataPromises = [];
|
|
|
|
for (let i = 1; i <= numAttempts; i++) {
|
|
dataPromises.push(this.scormProvider.getScormUserDataOnline(scorm.id, i, true, siteId).catch((err) => {
|
|
// Ignore failures of all the attempts that aren't the last one.
|
|
if (i == numAttempts) {
|
|
return Promise.reject(err);
|
|
}
|
|
}));
|
|
}
|
|
|
|
return Promise.all(dataPromises);
|
|
} else {
|
|
// No attempts. We'll still try to get user data to be able to identify SCOs not visible and so.
|
|
return this.scormProvider.getScormUserDataOnline(scorm.id, 0, true, siteId);
|
|
}
|
|
}));
|
|
|
|
// Prefetch SCOs.
|
|
promises.push(this.scormProvider.getScos(scorm.id, undefined, true, siteId));
|
|
|
|
return Promise.all(promises);
|
|
}
|
|
|
|
/**
|
|
* Get the download size of a module.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {Number} courseId Course ID the module belongs to.
|
|
* @param {boolean} [single] True if we're downloading a single module, false if we're downloading a whole section.
|
|
* @return {Promise<{size: number, total: boolean}>} Promise resolved with the size and a boolean indicating if it was able
|
|
* to calculate the total size.
|
|
*/
|
|
getDownloadSize(module: any, courseId: any, single?: boolean): Promise<{ size: number, total: boolean }> {
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url).then((scorm) => {
|
|
if (this.scormProvider.isScormUnsupported(scorm)) {
|
|
return {size: -1, total: false};
|
|
} else if (!scorm.packagesize) {
|
|
// We don't have package size, try to calculate it.
|
|
return this.scormProvider.calculateScormSize(scorm).then((size) => {
|
|
return {size: size, total: true};
|
|
});
|
|
} else {
|
|
return {size: scorm.packagesize, total: true};
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get the downloaded size of a module. If not defined, we'll use getFiles to calculate it (it can be slow).
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to.
|
|
* @return {number|Promise<number>} Size, or promise resolved with the size.
|
|
*/
|
|
getDownloadedSize(module: any, courseId: number): number | Promise<number> {
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url).then((scorm) => {
|
|
// Get the folder where SCORM should be unzipped.
|
|
return this.scormProvider.getScormFolder(scorm.moduleurl);
|
|
}).then((path) => {
|
|
return this.fileProvider.getDirectorySize(path);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get list of files. If not defined, we'll assume they're in module.contents.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {Number} courseId Course ID the module belongs to.
|
|
* @param {boolean} [single] True if we're downloading a single module, false if we're downloading a whole section.
|
|
* @return {Promise<any[]>} Promise resolved with the list of files.
|
|
*/
|
|
getFiles(module: any, courseId: number, single?: boolean): Promise<any[]> {
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url).then((scorm) => {
|
|
return this.scormProvider.getScormFileList(scorm);
|
|
}).catch(() => {
|
|
// SCORM not found, return empty list.
|
|
return [];
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Invalidate the prefetched content.
|
|
*
|
|
* @param {number} moduleId The module ID.
|
|
* @param {number} courseId The course ID the module belongs to.
|
|
* @return {Promise<any>} Promise resolved when the data is invalidated.
|
|
*/
|
|
invalidateContent(moduleId: number, courseId: number): Promise<any> {
|
|
return this.scormProvider.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<any>} Promise resolved when invalidated.
|
|
*/
|
|
invalidateModule(module: any, courseId: number): Promise<any> {
|
|
// Invalidate the calls required to check if a SCORM is downloadable.
|
|
return this.scormProvider.invalidateScormData(courseId);
|
|
}
|
|
|
|
/**
|
|
* Check if a module can be downloaded. If the function is not defined, we assume that all modules are downloadable.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to.
|
|
* @return {boolean|Promise<boolean>} Whether the module can be downloaded. The promise should never be rejected.
|
|
*/
|
|
isDownloadable(module: any, courseId: number): boolean | Promise<boolean> {
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url).then((scorm) => {
|
|
if (scorm.warningMessage) {
|
|
// SCORM closed or not opened yet.
|
|
return false;
|
|
}
|
|
|
|
if (this.scormProvider.isScormUnsupported(scorm)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Whether or not the handler is enabled on a site level.
|
|
*
|
|
* @return {boolean|Promise<boolean>} A boolean, or a promise resolved with a boolean, indicating if the handler is enabled.
|
|
*/
|
|
isEnabled(): boolean | Promise<boolean> {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Prefetch a module.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to.
|
|
* @param {boolean} [single] True if we're downloading a single module, false if we're downloading a whole section.
|
|
* @param {string} [dirPath] Path of the directory where to store all the content files.
|
|
* @param {Function} [onProgress] Function to call on progress.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
prefetch(module: any, courseId?: number, single?: boolean, dirPath?: string,
|
|
onProgress?: (event: AddonModScormProgressEvent) => any): Promise<any> {
|
|
|
|
const siteId = this.sitesProvider.getCurrentSiteId();
|
|
|
|
return this.prefetchPackage(module, courseId, single, this.downloadOrPrefetchScorm.bind(this), siteId, true, onProgress);
|
|
}
|
|
|
|
/**
|
|
* Remove module downloaded files. If not defined, we'll use getFiles to remove them (slow).
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
removeFiles(module: any, courseId: number): Promise<any> {
|
|
const siteId = this.sitesProvider.getCurrentSiteId();
|
|
let scorm;
|
|
|
|
return this.scormProvider.getScorm(courseId, module.id, module.url, false, siteId).then((scormData) => {
|
|
scorm = scormData;
|
|
|
|
// Get the folder where SCORM should be unzipped.
|
|
return this.scormProvider.getScormFolder(scorm.moduleurl);
|
|
}).then((path) => {
|
|
const promises = [];
|
|
|
|
// Remove the unzipped folder.
|
|
promises.push(this.fileProvider.removeDir(path).catch((error) => {
|
|
if (error && error.code == 1) {
|
|
// Not found, ignore error.
|
|
} else {
|
|
return Promise.reject(error);
|
|
}
|
|
}));
|
|
|
|
// Maybe the ZIP wasn't deleted for some reason. Try to delete it too.
|
|
promises.push(this.filepoolProvider.removeFileByUrl(siteId, this.scormProvider.getPackageUrl(scorm)).catch(() => {
|
|
// Ignore errors.
|
|
}));
|
|
|
|
return Promise.all(promises);
|
|
});
|
|
}
|
|
}
|