forked from EVOgeek/Vmeda.Online
301 lines
12 KiB
TypeScript
301 lines
12 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 } 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 { CoreCourseActivityPrefetchHandlerBase } from '@core/course/classes/activity-prefetch-handler';
|
|
import { CoreGroupsProvider } from '@providers/groups';
|
|
import { AddonModForumProvider } from './forum';
|
|
import { AddonModForumSyncProvider } from './sync';
|
|
|
|
/**
|
|
* Handler to prefetch forums.
|
|
*/
|
|
@Injectable()
|
|
export class AddonModForumPrefetchHandler extends CoreCourseActivityPrefetchHandlerBase {
|
|
name = 'AddonModForum';
|
|
modName = 'forum';
|
|
component = AddonModForumProvider.COMPONENT;
|
|
updatesNames = /^configuration$|^.*files$|^discussions$/;
|
|
|
|
constructor(translate: TranslateService,
|
|
appProvider: CoreAppProvider,
|
|
utils: CoreUtilsProvider,
|
|
courseProvider: CoreCourseProvider,
|
|
filepoolProvider: CoreFilepoolProvider,
|
|
sitesProvider: CoreSitesProvider,
|
|
domUtils: CoreDomUtilsProvider,
|
|
private groupsProvider: CoreGroupsProvider,
|
|
private forumProvider: AddonModForumProvider,
|
|
private syncProvider: AddonModForumSyncProvider) {
|
|
|
|
super(translate, appProvider, utils, courseProvider, filepoolProvider, sitesProvider, domUtils);
|
|
}
|
|
|
|
/**
|
|
* 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.forumProvider.getForum(courseId, module.id).then((forum) => {
|
|
const files = this.getIntroFilesFromInstance(module, forum);
|
|
|
|
// Get posts.
|
|
return this.getPostsForPrefetch(forum).then((posts) => {
|
|
// Add posts attachments and embedded files.
|
|
return files.concat(this.getPostsFiles(posts));
|
|
});
|
|
}).catch(() => {
|
|
// Forum not found, return empty list.
|
|
return [];
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Given a list of forum posts, return a list with all the files (attachments and embedded files).
|
|
*
|
|
* @param {any[]} posts Forum posts.
|
|
* @return {any[]} Files.
|
|
*/
|
|
protected getPostsFiles(posts: any[]): any[] {
|
|
let files = [];
|
|
const getInlineFiles = this.sitesProvider.getCurrentSite().isVersionGreaterEqualThan('3.2');
|
|
|
|
posts.forEach((post) => {
|
|
if (post.attachments && post.attachments.length) {
|
|
files = files.concat(post.attachments);
|
|
}
|
|
if (getInlineFiles && post.messageinlinefiles && post.messageinlinefiles.length) {
|
|
files = files.concat(post.messageinlinefiles);
|
|
} else if (post.message && !getInlineFiles) {
|
|
files = files.concat(this.domUtils.extractDownloadableFilesFromHtmlAsFakeFileObjects(post.message));
|
|
}
|
|
});
|
|
|
|
return files;
|
|
}
|
|
|
|
/**
|
|
* Get the posts to be prefetched.
|
|
*
|
|
* @param {any} forum Forum instance.
|
|
* @return {Promise<any[]>} Promise resolved with array of posts.
|
|
*/
|
|
protected getPostsForPrefetch(forum: any): Promise<any[]> {
|
|
const promises = this.forumProvider.getAvailableSortOrders().map((sortOrder) => {
|
|
// Get discussions in first 2 pages.
|
|
return this.forumProvider.getDiscussionsInPages(forum.id, sortOrder.value, false, 2).then((response) => {
|
|
if (response.error) {
|
|
return Promise.reject(null);
|
|
}
|
|
|
|
const promises = [];
|
|
|
|
response.discussions.forEach((discussion) => {
|
|
promises.push(this.forumProvider.getDiscussionPosts(discussion.discussion));
|
|
});
|
|
|
|
return Promise.all(promises);
|
|
});
|
|
});
|
|
|
|
return Promise.all(promises);
|
|
}
|
|
|
|
/**
|
|
* 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.forumProvider.invalidateContent(moduleId, courseId);
|
|
}
|
|
|
|
/**
|
|
* Invalidate WS calls needed to determine module status (usually, to check if module is downloadable).
|
|
* It doesn't need to invalidate check updates. It should NOT invalidate files nor all the prefetched data.
|
|
*
|
|
* @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 forum data to recalculate unread message count badge.
|
|
const promises = [];
|
|
|
|
promises.push(this.forumProvider.invalidateForumData(courseId));
|
|
promises.push(this.courseProvider.invalidateModule(module.id));
|
|
|
|
return Promise.all(promises);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
prefetch(module: any, courseId?: number, single?: boolean, dirPath?: string): Promise<any> {
|
|
return this.prefetchPackage(module, courseId, single, this.prefetchForum.bind(this));
|
|
}
|
|
|
|
/**
|
|
* Prefetch a forum.
|
|
*
|
|
* @param {any} module The module object returned by WS.
|
|
* @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.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
protected prefetchForum(module: any, courseId: number, single: boolean, siteId: string): Promise<any> {
|
|
// Get the forum data.
|
|
return this.forumProvider.getForum(courseId, module.id).then((forum) => {
|
|
const promises = [];
|
|
|
|
// Prefetch the posts.
|
|
promises.push(this.getPostsForPrefetch(forum).then((posts) => {
|
|
const promises = [];
|
|
|
|
// Gather user profile images.
|
|
const avatars = {}; // List of user avatars, preventing duplicates.
|
|
|
|
posts.forEach((post) => {
|
|
if (post.userpictureurl) {
|
|
avatars[post.userpictureurl] = true;
|
|
}
|
|
});
|
|
|
|
// Prefetch intro files, attachments, embedded files and user avatars.
|
|
const files = this.getIntroFilesFromInstance(module, forum).concat(this.getPostsFiles(posts))
|
|
.concat(Object.keys(avatars));
|
|
promises.push(this.filepoolProvider.addFilesToQueue(siteId, files, this.component, module.id));
|
|
|
|
// Prefetch groups data.
|
|
promises.push(this.prefetchGroupsInfo(forum, courseId, forum.cancreatediscussions));
|
|
|
|
return Promise.all(promises);
|
|
}));
|
|
|
|
// Prefetch access information.
|
|
promises.push(this.forumProvider.getAccessInformation(forum.id));
|
|
|
|
// Prefetch sort order preference.
|
|
if (this.forumProvider.isDiscussionListSortingAvailable()) {
|
|
promises.push(this.userProvider.getUserPreference(AddonModForumProvider.PREFERENCE_SORTORDER));
|
|
}
|
|
|
|
return Promise.all(promises);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Prefetch groups info for a forum.
|
|
*
|
|
* @param {any} module The module object returned by WS.
|
|
* @param {number} courseI Course ID the module belongs to.
|
|
* @param {boolean} canCreateDiscussions Whether the user can create discussions in the forum.
|
|
* @return {Promise<any>} Promise resolved when group data has been prefetched.
|
|
*/
|
|
protected prefetchGroupsInfo(forum: any, courseId: number, canCreateDiscussions: boolean): any {
|
|
// Check group mode.
|
|
return this.groupsProvider.getActivityGroupMode(forum.cmid).then((mode) => {
|
|
if (mode !== CoreGroupsProvider.SEPARATEGROUPS && mode !== CoreGroupsProvider.VISIBLEGROUPS) {
|
|
// Activity doesn't use groups. Prefetch canAddDiscussionToAll to determine if user can pin/attach.
|
|
return this.forumProvider.canAddDiscussionToAll(forum.id).catch(() => {
|
|
// Ignore errors.
|
|
});
|
|
}
|
|
|
|
// Activity uses groups, prefetch allowed groups.
|
|
return this.groupsProvider.getActivityAllowedGroups(forum.cmid).then((groups) => {
|
|
if (mode === CoreGroupsProvider.SEPARATEGROUPS) {
|
|
// Groups are already filtered by WS. Prefetch canAddDiscussionToAll to determine if user can pin/attach.
|
|
return this.forumProvider.canAddDiscussionToAll(forum.id).catch(() => {
|
|
// Ignore errors.
|
|
});
|
|
}
|
|
|
|
if (canCreateDiscussions) {
|
|
// Prefetch data to check the visible groups when creating discussions.
|
|
return this.forumProvider.canAddDiscussionToAll(forum.id).catch(() => {
|
|
// The call failed, let's assume he can't.
|
|
return {
|
|
status: false
|
|
};
|
|
}).then((response) => {
|
|
if (response.status) {
|
|
// User can post to all groups, nothing else to prefetch.
|
|
return;
|
|
}
|
|
|
|
// The user can't post to all groups, let's check which groups he can post to.
|
|
const groupPromises = [];
|
|
groups.forEach((group) => {
|
|
groupPromises.push(this.forumProvider.canAddDiscussion(forum.id, group.id).catch(() => {
|
|
// Ignore errors.
|
|
}));
|
|
});
|
|
|
|
return Promise.all(groupPromises);
|
|
});
|
|
}
|
|
});
|
|
}).catch((error) => {
|
|
// Ignore errors if cannot create discussions.
|
|
if (canCreateDiscussions) {
|
|
return Promise.reject(error);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Sync a module.
|
|
*
|
|
* @param {any} module Module.
|
|
* @param {number} courseId Course ID the module belongs to
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
sync(module: any, courseId: number, siteId?: any): Promise<any> {
|
|
const promises = [];
|
|
|
|
promises.push(this.syncProvider.syncForumDiscussions(module.instance, undefined, siteId));
|
|
promises.push(this.syncProvider.syncForumReplies(module.instance, undefined, siteId));
|
|
promises.push(this.syncProvider.syncRatings(module.id, undefined, true, siteId));
|
|
|
|
return Promise.all(promises).then((results) => {
|
|
return results.reduce((a, b) => ({
|
|
updated: a.updated || b.updated,
|
|
warnings: (a.warnings || []).concat(b.warnings || []),
|
|
}), {updated: false});
|
|
});
|
|
}
|
|
}
|