forked from EVOgeek/Vmeda.Online
311 lines
11 KiB
TypeScript
311 lines
11 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 { Component, Input, OnInit, OnDestroy, Optional } from '@angular/core';
|
|
import { NavController, PopoverController } from 'ionic-angular';
|
|
import { CoreEventsProvider } from '@providers/events';
|
|
import { CoreSitesProvider } from '@providers/sites';
|
|
import { CoreDomUtilsProvider } from '@providers/utils/dom';
|
|
import { CoreUserProvider } from '@core/user/providers/user';
|
|
import { CoreCoursesProvider } from '@core/courses/providers/courses';
|
|
import { CoreCourseProvider } from '@core/course/providers/course';
|
|
import { CoreCourseHelperProvider } from '@core/course/providers/helper';
|
|
import { CoreCoursesCourseOptionsMenuComponent } from '../course-options-menu/course-options-menu';
|
|
import { Translate } from '@singletons/core.singletons';
|
|
import { CoreConstants } from '@core/constants';
|
|
|
|
/**
|
|
* This component is meant to display a course for a list of courses with progress.
|
|
*
|
|
* Example usage:
|
|
*
|
|
* <core-courses-course-progress [course]="course">
|
|
* </core-courses-course-progress>
|
|
*/
|
|
@Component({
|
|
selector: 'core-courses-course-progress',
|
|
templateUrl: 'core-courses-course-progress.html'
|
|
})
|
|
export class CoreCoursesCourseProgressComponent implements OnInit, OnDestroy {
|
|
@Input() course: any; // The course to render.
|
|
@Input() showAll = false; // If true, will show all actions, options, star and progress.
|
|
@Input() showDownload = true; // If true, will show download button. Only works if the options menu is not shown.
|
|
|
|
courseStatus = CoreConstants.NOT_DOWNLOADED;
|
|
isDownloading: boolean;
|
|
prefetchCourseData = {
|
|
downloadSucceeded: false,
|
|
prefetchCourseIcon: 'spinner',
|
|
title: 'core.course.downloadcourse'
|
|
};
|
|
showSpinner = false;
|
|
downloadCourseEnabled: boolean;
|
|
courseOptionMenuEnabled: boolean;
|
|
|
|
protected isDestroyed = false;
|
|
protected courseStatusObserver;
|
|
protected siteUpdatedObserver;
|
|
|
|
constructor(@Optional() private navCtrl: NavController, private courseHelper: CoreCourseHelperProvider,
|
|
private domUtils: CoreDomUtilsProvider,
|
|
private courseProvider: CoreCourseProvider, private eventsProvider: CoreEventsProvider,
|
|
private sitesProvider: CoreSitesProvider, private coursesProvider: CoreCoursesProvider,
|
|
private popoverCtrl: PopoverController, private userProvider: CoreUserProvider) { }
|
|
|
|
/**
|
|
* Component being initialized.
|
|
*/
|
|
ngOnInit(): void {
|
|
|
|
this.downloadCourseEnabled = !this.coursesProvider.isDownloadCourseDisabledInSite();
|
|
|
|
if (this.downloadCourseEnabled) {
|
|
this.initPrefetchCourse();
|
|
}
|
|
|
|
// This field is only available from 3.6 onwards.
|
|
this.courseOptionMenuEnabled = this.showAll && typeof this.course.isfavourite != 'undefined';
|
|
|
|
// Refresh the enabled flag if site is updated.
|
|
this.siteUpdatedObserver = this.eventsProvider.on(CoreEventsProvider.SITE_UPDATED, () => {
|
|
const wasEnabled = this.downloadCourseEnabled;
|
|
|
|
this.downloadCourseEnabled = !this.coursesProvider.isDownloadCourseDisabledInSite();
|
|
|
|
if (!wasEnabled && this.downloadCourseEnabled) {
|
|
// Download course is enabled now, initialize it.
|
|
this.initPrefetchCourse();
|
|
}
|
|
}, this.sitesProvider.getCurrentSiteId());
|
|
}
|
|
|
|
/**
|
|
* Initialize prefetch course.
|
|
*/
|
|
initPrefetchCourse(): void {
|
|
if (typeof this.courseStatusObserver != 'undefined') {
|
|
// Already initialized.
|
|
return;
|
|
}
|
|
|
|
// Listen for status change in course.
|
|
this.courseStatusObserver = this.eventsProvider.on(CoreEventsProvider.COURSE_STATUS_CHANGED, (data) => {
|
|
if (data.courseId == this.course.id || data.courseId == CoreCourseProvider.ALL_COURSES_CLEARED) {
|
|
this.updateCourseStatus(data.status);
|
|
}
|
|
}, this.sitesProvider.getCurrentSiteId());
|
|
|
|
// Determine course prefetch icon.
|
|
this.courseProvider.getCourseStatus(this.course.id).then((status) => {
|
|
const data = this.courseHelper.getCourseStatusIconAndTitleFromStatus(status);
|
|
|
|
this.courseStatus = status;
|
|
this.prefetchCourseData.prefetchCourseIcon = data.icon;
|
|
this.prefetchCourseData.title = data.title;
|
|
|
|
if (data.icon == 'spinner') {
|
|
// Course is being downloaded. Get the download promise.
|
|
const promise = this.courseHelper.getCourseDownloadPromise(this.course.id);
|
|
if (promise) {
|
|
// There is a download promise. If it fails, show an error.
|
|
promise.catch((error) => {
|
|
if (!this.isDestroyed) {
|
|
this.domUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true);
|
|
}
|
|
});
|
|
} else {
|
|
// No download, this probably means that the app was closed while downloading. Set previous status.
|
|
this.courseProvider.setCoursePreviousStatus(this.course.id);
|
|
}
|
|
}
|
|
});
|
|
|
|
}
|
|
|
|
/**
|
|
* Open a course.
|
|
*
|
|
* @param course The course to open.
|
|
*/
|
|
openCourse(course: any): void {
|
|
this.courseHelper.openCourse(this.navCtrl, course);
|
|
}
|
|
|
|
/**
|
|
* Prefetch the course.
|
|
*
|
|
* @param e Click event.
|
|
*/
|
|
prefetchCourse(e: Event): void {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
|
|
this.courseHelper.confirmAndPrefetchCourse(this.prefetchCourseData, this.course).catch((error) => {
|
|
if (!this.isDestroyed) {
|
|
this.domUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Delete the course.
|
|
*/
|
|
async deleteCourse(): Promise<void> {
|
|
try {
|
|
await this.domUtils.showDeleteConfirm('core.course.confirmdeletemodulefiles');
|
|
} catch (error) {
|
|
if (!error.coreCanceled) {
|
|
throw error;
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
const modal = this.domUtils.showModalLoading();
|
|
|
|
try {
|
|
await this.courseHelper.deleteCourseFiles(this.course.id);
|
|
} catch (error) {
|
|
this.domUtils.showErrorModalDefault(error, Translate.instance.instant('core.errordeletefile'));
|
|
} finally {
|
|
modal.dismiss();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update the course status icon and title.
|
|
*
|
|
* @param status Status to show.
|
|
*/
|
|
protected updateCourseStatus(status: string): void {
|
|
const statusData = this.courseHelper.getCourseStatusIconAndTitleFromStatus(status);
|
|
|
|
this.courseStatus = status;
|
|
this.prefetchCourseData.prefetchCourseIcon = statusData.icon;
|
|
this.prefetchCourseData.title = statusData.title;
|
|
}
|
|
|
|
/**
|
|
* Show the context menu.
|
|
*
|
|
* @param e Click Event.
|
|
*/
|
|
showCourseOptionsMenu(e: Event): void {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
|
|
const popover = this.popoverCtrl.create(CoreCoursesCourseOptionsMenuComponent, {
|
|
course: this.course,
|
|
courseStatus: this.courseStatus,
|
|
prefetch: this.prefetchCourseData
|
|
});
|
|
popover.onDidDismiss((action) => {
|
|
if (action) {
|
|
switch (action) {
|
|
case 'download':
|
|
if (this.prefetchCourseData.prefetchCourseIcon != 'spinner') {
|
|
this.prefetchCourse(e);
|
|
}
|
|
break;
|
|
case 'delete':
|
|
if (this.courseStatus == 'downloaded' || this.courseStatus == 'outdated') {
|
|
this.deleteCourse();
|
|
}
|
|
break;
|
|
case 'hide':
|
|
this.setCourseHidden(true);
|
|
break;
|
|
case 'show':
|
|
this.setCourseHidden(false);
|
|
break;
|
|
case 'favourite':
|
|
this.setCourseFavourite(true);
|
|
break;
|
|
case 'unfavourite':
|
|
this.setCourseFavourite(false);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
});
|
|
popover.present({
|
|
ev: e
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Hide/Unhide the course from the course list.
|
|
*
|
|
* @param hide True to hide and false to show.
|
|
*/
|
|
protected setCourseHidden(hide: boolean): void {
|
|
this.showSpinner = true;
|
|
|
|
// We should use null to unset the preference.
|
|
this.userProvider.updateUserPreference('block_myoverview_hidden_course_' + this.course.id, hide ? 1 : null).then(() => {
|
|
this.course.hidden = hide;
|
|
this.eventsProvider.trigger(CoreCoursesProvider.EVENT_MY_COURSES_UPDATED, {
|
|
courseId: this.course.id,
|
|
course: this.course,
|
|
action: CoreCoursesProvider.ACTION_STATE_CHANGED,
|
|
state: CoreCoursesProvider.STATE_HIDDEN,
|
|
value: hide,
|
|
}, this.sitesProvider.getCurrentSiteId());
|
|
}).catch((error) => {
|
|
if (!this.isDestroyed) {
|
|
this.domUtils.showErrorModalDefault(error, 'Error changing course visibility.');
|
|
}
|
|
}).finally(() => {
|
|
this.showSpinner = false;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Favourite/Unfavourite the course from the course list.
|
|
*
|
|
* @param favourite True to favourite and false to unfavourite.
|
|
*/
|
|
protected setCourseFavourite(favourite: boolean): void {
|
|
this.showSpinner = true;
|
|
|
|
this.coursesProvider.setFavouriteCourse(this.course.id, favourite).then(() => {
|
|
this.course.isfavourite = favourite;
|
|
this.eventsProvider.trigger(CoreCoursesProvider.EVENT_MY_COURSES_UPDATED, {
|
|
courseId: this.course.id,
|
|
course: this.course,
|
|
action: CoreCoursesProvider.ACTION_STATE_CHANGED,
|
|
state: CoreCoursesProvider.STATE_FAVOURITE,
|
|
value: favourite,
|
|
}, this.sitesProvider.getCurrentSiteId());
|
|
}).catch((error) => {
|
|
if (!this.isDestroyed) {
|
|
this.domUtils.showErrorModalDefault(error, 'Error changing course favourite attribute.');
|
|
}
|
|
}).finally(() => {
|
|
this.showSpinner = false;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Component destroyed.
|
|
*/
|
|
ngOnDestroy(): void {
|
|
this.isDestroyed = true;
|
|
|
|
this.siteUpdatedObserver && this.siteUpdatedObserver.off();
|
|
this.courseStatusObserver && this.courseStatusObserver.off();
|
|
}
|
|
}
|