CIT/Vmeda.Online
3
0
Fork 1
forked from EVOgeek/Vmeda.Online
Code Pull Requests Activity

MOBILE-3134 filepool: Fix issues when handling componentId

Browse Source
This commit is contained in:
Dani Palou 2020-04-09 08:59:39 +02:00
parent df79abe1e8
commit 8c38f3a216
3 changed files with 122 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/core/constants.ts
View File

@ -69,10 +69,10 @@ export class CoreConstants {
static NOT_DOWNLOADABLE = 'notdownloadable'; static NOT_DOWNLOADABLE = 'notdownloadable';
// File status constants. // File status constants.
static FILE_DOWNLOAD = 'download'; static FILE_ACTION_DOWNLOAD = 'download';
static FILE_DOWNLOADING = 'downloading'; static FILE_ACTION_DOWNLOADING = 'downloading';
static FILE_DELETED = 'deleted'; static FILE_ACTION_DELETED = 'deleted';
static FILE_OUTDATE = 'outdated'; static FILE_ACTION_OUTDATED = 'outdated';
// Constants from Moodle's resourcelib. // Constants from Moodle's resourcelib.
static RESOURCELIB_DISPLAY_AUTO = 0; // Try the best way. static RESOURCELIB_DISPLAY_AUTO = 0; // Try the best way.

17
src/core/course/providers/helper.ts
View File

@ -800,6 +800,8 @@ export class CoreCourseHelperProvider {
* @return Promise resolved when done. * @return Promise resolved when done.
*/ */
fillContextMenu(instance: any, module: any, courseId: number, invalidateCache?: boolean, component?: string): Promise<any> { fillContextMenu(instance: any, module: any, courseId: number, invalidateCache?: boolean, component?: string): Promise<any> {
const siteId = this.sitesProvider.getCurrentSiteId();
return this.getModulePrefetchInfo(module, courseId, invalidateCache, component).then((moduleInfo) => { return this.getModulePrefetchInfo(module, courseId, invalidateCache, component).then((moduleInfo) => {
instance.size = moduleInfo.size > 0 ? moduleInfo.sizeReadable : 0; instance.size = moduleInfo.size > 0 ? moduleInfo.sizeReadable : 0;
instance.prefetchStatusIcon = moduleInfo.statusIcon; instance.prefetchStatusIcon = moduleInfo.statusIcon;
@ -825,19 +827,20 @@ export class CoreCourseHelperProvider {
if (data.componentId == module.id && data.component == component) { if (data.componentId == module.id && data.component == component) {
this.fillContextMenu(instance, module, courseId, false, component); this.fillContextMenu(instance, module, courseId, false, component);
} }
}, this.sitesProvider.getCurrentSiteId()); }, siteId);
} }
if (typeof instance.contextFileStatusObserver == 'undefined' && component) { if (typeof instance.contextFileStatusObserver == 'undefined' && component) {
const componentFileChangeStatusEvent = CoreFilepoolProvider.getComponentEventName( const componentFileChangeStatusEvent = CoreFilepoolProvider.getComponentEventName(siteId, component, module.id);
this.sitesProvider.getCurrentSiteId(), component, module.id);
instance.contextFileStatusObserver = this.eventsProvider.on(componentFileChangeStatusEvent, (data) => { instance.contextFileStatusObserver = this.eventsProvider.on(componentFileChangeStatusEvent, (data) => {
if (((data.action == CoreConstants.FILE_DOWNLOAD && data.success == true) ||
data.action == CoreConstants.FILE_DELETED) && if (((data.action == CoreConstants.FILE_ACTION_DOWNLOAD && data.success == true) ||
moduleInfo.status != CoreConstants.DOWNLOADING) { data.action == CoreConstants.FILE_ACTION_DELETED) &&
instance.prefetchStatus != CoreConstants.DOWNLOADING) {
this.fillContextMenu(instance, module, courseId, true, component); this.fillContextMenu(instance, module, courseId, true, component);
} }
}, this.sitesProvider.getCurrentSiteId()); }, siteId);
} }
}); });
} }

166
src/providers/filepool.ts
View File

@ -144,7 +144,7 @@ export interface CoreFilepoolQueueEntry {
/** /**
* File links (to link the file to components and componentIds). * File links (to link the file to components and componentIds).
*/ */
links?: any[]; links?: CoreFilepoolComponentLink[];
} }
/** /**
@ -197,6 +197,21 @@ export interface CoreFilepoolPackageEntry {
extra?: string; extra?: string;
} }
/**
* A component link.
*/
export interface CoreFilepoolComponentLink {
/**
* Link's component.
*/
component: string;
/**
* Link's componentId.
*/
componentId?: string | number;
}
/* /*
* Factory for handling downloading files and retrieve downloaded files. * Factory for handling downloading files and retrieve downloaded files.
* *
@ -495,7 +510,7 @@ export class CoreFilepoolProvider {
* @param links Array of objects containing the component and optionally componentId. * @param links Array of objects containing the component and optionally componentId.
* @return Promise resolved on success. * @return Promise resolved on success.
*/ */
protected addFileLinks(siteId: string, fileId: string, links: any[]): Promise<any> { protected addFileLinks(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): Promise<any> {
const promises = []; const promises = [];
links.forEach((link) => { links.forEach((link) => {
promises.push(this.addFileLink(siteId, fileId, link.component, link.componentId)); promises.push(this.addFileLink(siteId, fileId, link.component, link.componentId));
@ -575,7 +590,9 @@ export class CoreFilepoolProvider {
* @return Promise resolved when the file is downloaded. * @return Promise resolved when the file is downloaded.
*/ */
protected async addToQueue(siteId: string, fileId: string, url: string, priority: number, revision: number, protected async addToQueue(siteId: string, fileId: string, url: string, priority: number, revision: number,
timemodified: number, filePath: string, onProgress?: (event: any) => any, options: any = {}, link?: any): Promise<any> { timemodified: number, filePath: string, onProgress?: (event: any) => any, options: any = {},
link?: CoreFilepoolComponentLink): Promise<any> {
await this.dbReady; await this.dbReady;
this.logger.debug(`Adding ${fileId} to the queue`); this.logger.debug(`Adding ${fileId} to the queue`);
@ -623,7 +640,6 @@ export class CoreFilepoolProvider {
await this.dbReady; await this.dbReady;
let fileId, let fileId,
link,
queueDeferred; queueDeferred;
if (!this.fileProvider.isAvailable()) { if (!this.fileProvider.isAvailable()) {
@ -651,12 +667,7 @@ export class CoreFilepoolProvider {
const primaryKey = { siteId: siteId, fileId: fileId }; const primaryKey = { siteId: siteId, fileId: fileId };
// Set up the component. // Set up the component.
if (typeof component != 'undefined') { const link = this.createComponentLink(component, componentId);
link = {
component: component,
componentId: this.fixComponentId(componentId)
};
}
// Retrieve the queue deferred now if it exists. // Retrieve the queue deferred now if it exists.
// This is to prevent errors if file is removed from queue while we're checking if the file is in queue. // This is to prevent errors if file is removed from queue while we're checking if the file is in queue.
@ -866,7 +877,7 @@ export class CoreFilepoolProvider {
return this.sitesProvider.getSiteDb(siteId).then((db) => { return this.sitesProvider.getSiteDb(siteId).then((db) => {
const conditions = { const conditions = {
component: component, component: component,
componentId: componentId || '' componentId: this.fixComponentId(componentId)
}; };
return db.countRecords(this.LINKS_TABLE, conditions).then((count) => { return db.countRecords(this.LINKS_TABLE, conditions).then((count) => {
@ -878,14 +889,31 @@ export class CoreFilepoolProvider {
} }
/** /**
* Prepare links from component and componentId. * Prepare a component link.
* *
* @param component The component to link the file to. * @param component The component to link the file to.
* @param componentId An ID to use in conjunction with the component. * @param componentId An ID to use in conjunction with the component.
* @return Resolved means yes, rejected means no. * @return Link, null if nothing to link.
*/ */
createFileLinks(component: string, componentId: string | number): any[] { protected createComponentLink(component: string, componentId?: string | number): CoreFilepoolComponentLink {
return [{ component: component, componentId: this.fixComponentId(componentId) }]; if (typeof component != 'undefined' && component != null) {
return { component: component, componentId: this.fixComponentId(componentId) };
}
return null;
}
/**
* Prepare list of links from component and componentId.
*
* @param component The component to link the file to.
* @param componentId An ID to use in conjunction with the component.
* @return Links.
*/
protected createComponentLinks(component: string, componentId?: string | number): CoreFilepoolComponentLink[] {
const link = this.createComponentLink(component, componentId);
return link ? [link] : [];
} }
/** /**
@ -1204,18 +1232,20 @@ export class CoreFilepoolProvider {
options.revision = revision || this.getRevisionFromUrl(fileUrl); options.revision = revision || this.getRevisionFromUrl(fileUrl);
fileId = this.getFileIdByUrl(fileUrl); fileId = this.getFileIdByUrl(fileUrl);
const links = this.createComponentLinks(component, componentId);
return this.hasFileInPool(siteId, fileId).then((fileObject) => { return this.hasFileInPool(siteId, fileId).then((fileObject) => {
if (typeof fileObject === 'undefined') { if (typeof fileObject === 'undefined') {
// We do not have the file, download and add to pool. // We do not have the file, download and add to pool.
this.notifyFileDownloading(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloading(siteId, fileId, links);
return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress); return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress);
} else if (this.isFileOutdated(fileObject, options.revision, options.timemodified) && } else if (this.isFileOutdated(fileObject, options.revision, options.timemodified) &&
this.appProvider.isOnline() && !ignoreStale) { this.appProvider.isOnline() && !ignoreStale) {
// The file is outdated, force the download and update it. // The file is outdated, force the download and update it.
this.notifyFileDownloading(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloading(siteId, fileId, links);
return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress, fileObject); return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress, fileObject);
} }
@ -1231,14 +1261,14 @@ export class CoreFilepoolProvider {
return response; return response;
}, () => { }, () => {
// The file was not found in the pool, weird. // The file was not found in the pool, weird.
this.notifyFileDownloading(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloading(siteId, fileId, links);
return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress, fileObject); return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress, fileObject);
}); });
}, () => { }, () => {
// The file is not in the pool just yet. // The file is not in the pool just yet.
this.notifyFileDownloading(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloading(siteId, fileId, links);
return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress); return this.downloadForPoolByUrl(siteId, fileUrl, options, filePath, onProgress);
}).then((response) => { }).then((response) => {
@ -1247,11 +1277,11 @@ export class CoreFilepoolProvider {
// Ignore errors. // Ignore errors.
}); });
} }
this.notifyFileDownloaded(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloaded(siteId, fileId, links);
return response; return response;
}, (err) => { }, (err) => {
this.notifyFileDownloadError(siteId, fileId, this.createFileLinks(component, componentId)); this.notifyFileDownloadError(siteId, fileId, links);
return Promise.reject(err); return Promise.reject(err);
}); });
@ -1413,7 +1443,7 @@ export class CoreFilepoolProvider {
* @return Event name. * @return Event name.
*/ */
static getComponentEventName(siteId: string, component: string, componentId: string | number): string { static getComponentEventName(siteId: string, component: string, componentId: string | number): string {
return 'ComponentEventFileChangeStatus:' + siteId + ':' + component + ':' + componentId; return 'CoreFilepoolComponentFile:' + siteId + ':' + component + ':' + componentId;
} }
/** /**
@ -1427,10 +1457,16 @@ export class CoreFilepoolProvider {
protected getComponentFiles(db: SQLiteDB, component: string, componentId?: string | number): Promise<any[]> { protected getComponentFiles(db: SQLiteDB, component: string, componentId?: string | number): Promise<any[]> {
const conditions = { const conditions = {
component: component, component: component,
componentId: componentId || '' componentId: this.fixComponentId(componentId)
}; };
return db.getRecords(this.LINKS_TABLE, conditions); return db.getRecords(this.LINKS_TABLE, conditions).then((items) => {
items.forEach((item) => {
item.componentId = this.fixComponentId(item.componentId);
});
return items;
});
} }
/** /**
@ -1539,6 +1575,12 @@ export class CoreFilepoolProvider {
protected getFileLinks(siteId: string, fileId: string): Promise<any[]> { protected getFileLinks(siteId: string, fileId: string): Promise<any[]> {
return this.sitesProvider.getSiteDb(siteId).then((db) => { return this.sitesProvider.getSiteDb(siteId).then((db) => {
return db.getRecords(this.LINKS_TABLE, { fileId: fileId }); return db.getRecords(this.LINKS_TABLE, { fileId: fileId });
}).then((items) => {
items.forEach((item) => {
item.componentId = this.fixComponentId(item.componentId);
});
return items;
}); });
} }
@ -2463,18 +2505,17 @@ export class CoreFilepoolProvider {
} }
/** /**
* Notify a file has been changed status to Component. * Notify an action performed on a file to a list of components.
* *
* @param siteId The site ID. * @param siteId The site ID.
* @param fileId The file ID. * @param eventData The event data.
* @param fileStatus The file status after changed * @param links The links to the components.
* @param links The links to the Components
*/ */
protected notifyFileStatusToComponents(siteId: string, fileId: string, fileStatus: any, links: any[]): void { protected notifyFileActionToComponents(siteId: string, eventData: any, links: CoreFilepoolComponentLink[]): void {
fileStatus.fileId = fileId;
links.forEach((link) => { links.forEach((link) => {
this.eventsProvider.trigger(CoreFilepoolProvider.getComponentEventName(siteId, link.component, link.componentId), this.eventsProvider.trigger(CoreFilepoolProvider.getComponentEventName(siteId, link.component, link.componentId),
fileStatus, siteId); eventData, siteId);
}); });
} }
@ -2485,12 +2526,14 @@ export class CoreFilepoolProvider {
* @param fileId The file ID. * @param fileId The file ID.
* @param links The links to components. * @param links The links to components.
*/ */
protected notifyFileDeleted(siteId: string, fileId: string, links: any[]): void { protected notifyFileDeleted(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): void {
const fileStatus = { const data = {
action: CoreConstants.FILE_DELETED fileId: fileId,
action: CoreConstants.FILE_ACTION_DELETED
}; };
this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), fileStatus);
this.notifyFileStatusToComponents(siteId, fileId, fileStatus, links); this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), data);
this.notifyFileActionToComponents(siteId, data, links);
} }
/** /**
@ -2500,13 +2543,15 @@ export class CoreFilepoolProvider {
* @param fileId The file ID. * @param fileId The file ID.
* @param links The links to components. * @param links The links to components.
*/ */
protected notifyFileDownloaded(siteId: string, fileId: string, links: any[]): void { protected notifyFileDownloaded(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): void {
const fileStatus = { const data = {
action: CoreConstants.FILE_DOWNLOAD, fileId: fileId,
action: CoreConstants.FILE_ACTION_DOWNLOAD,
success: true success: true
}; };
this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), fileStatus);
this.notifyFileStatusToComponents(siteId, fileId, fileStatus, links); this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), data);
this.notifyFileActionToComponents(siteId, data, links);
} }
/** /**
@ -2516,13 +2561,15 @@ export class CoreFilepoolProvider {
* @param fileId The file ID. * @param fileId The file ID.
* @param links The links to components. * @param links The links to components.
*/ */
protected notifyFileDownloadError(siteId: string, fileId: string, links: any[]): void { protected notifyFileDownloadError(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): void {
const fileStatus = { const data = {
action: CoreConstants.FILE_DOWNLOAD, fileId: fileId,
action: CoreConstants.FILE_ACTION_DOWNLOAD,
success: false success: false
}; };
this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), fileStatus);
this.notifyFileStatusToComponents(siteId, fileId, fileStatus, links); this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), data);
this.notifyFileActionToComponents(siteId, data, links);
} }
/** /**
@ -2532,12 +2579,14 @@ export class CoreFilepoolProvider {
* @param fileId The file ID. * @param fileId The file ID.
* @param links The links to components. * @param links The links to components.
*/ */
protected notifyFileDownloading(siteId: string, fileId: string, links: any[]): void { protected notifyFileDownloading(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): void {
const fileStatus = { const data = {
action: CoreConstants.FILE_DOWNLOADING fileId: fileId,
action: CoreConstants.FILE_ACTION_DOWNLOADING
}; };
this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), fileStatus);
this.notifyFileStatusToComponents(siteId, fileId, fileStatus, links); this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), data);
this.notifyFileActionToComponents(siteId, data, links);
} }
@ -2548,12 +2597,13 @@ export class CoreFilepoolProvider {
* @param fileId The file ID. * @param fileId The file ID.
* @param links The links to components. * @param links The links to components.
*/ */
protected notifyFileOutdated(siteId: string, fileId: string, links: any[]): void { protected notifyFileOutdated(siteId: string, fileId: string, links: CoreFilepoolComponentLink[]): void {
const fileStatus = { const data = {
action: CoreConstants.FILE_OUTDATE action: CoreConstants.FILE_ACTION_OUTDATED
}; };
this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), fileStatus);
this.notifyFileStatusToComponents(siteId, fileId, fileStatus, links); this.eventsProvider.trigger(this.getFileEventName(siteId, fileId), data);
this.notifyFileActionToComponents(siteId, data, links);
} }
/** /**
@ -2801,8 +2851,8 @@ export class CoreFilepoolProvider {
fileId: fileId fileId: fileId
}; };
// Get links to components to notify to them before remove. // Get links to components to notify them after remove.
return db.getRecords(this.LINKS_TABLE, conditions).then((links) => { return this.getFileLinks(siteId, fileId).then((links) => {
const promises = []; const promises = [];
// Remove entry from filepool store. // Remove entry from filepool store.