diff --git a/scripts/langindex.json b/scripts/langindex.json index 3ab3ca3a4..feedd73b5 100644 --- a/scripts/langindex.json +++ b/scripts/langindex.json @@ -1106,6 +1106,7 @@ "addon.storagemanager.deletecourses": "local_moodlemobileapp", "addon.storagemanager.deletedatafrom": "local_moodlemobileapp", "addon.storagemanager.info": "local_moodlemobileapp", + "addon.storagemanager.managecoursestorage": "local_moodlemobileapp", "addon.storagemanager.managestorage": "local_moodlemobileapp", "addon.storagemanager.storageused": "local_moodlemobileapp", "assets.countries.AD": "countries", diff --git a/src/addons/block/sitemainmenu/components/sitemainmenu/addon-block-sitemainmenu.html b/src/addons/block/sitemainmenu/components/sitemainmenu/addon-block-sitemainmenu.html index c650ba61e..de45bf3af 100644 --- a/src/addons/block/sitemainmenu/components/sitemainmenu/addon-block-sitemainmenu.html +++ b/src/addons/block/sitemainmenu/components/sitemainmenu/addon-block-sitemainmenu.html @@ -12,7 +12,6 @@ - + diff --git a/src/addons/block/sitemainmenu/components/sitemainmenu/sitemainmenu.ts b/src/addons/block/sitemainmenu/components/sitemainmenu/sitemainmenu.ts index c0aad05ef..d550062d7 100644 --- a/src/addons/block/sitemainmenu/components/sitemainmenu/sitemainmenu.ts +++ b/src/addons/block/sitemainmenu/components/sitemainmenu/sitemainmenu.ts @@ -91,7 +91,7 @@ export class AddonBlockSiteMainMenuComponent extends CoreBlockBaseComponent impl const items = config.frontpageloggedin.split(','); const hasNewsItem = items.find((item) => parseInt(item, 10) == FrontPageItemNames['NEWS_ITEMS']); - const result = CoreCourseHelper.addHandlerDataForModules( + const result = await CoreCourseHelper.addHandlerDataForModules( [mainMenuBlock], this.siteHomeId, undefined, diff --git a/src/addons/storagemanager/lang.json b/src/addons/storagemanager/lang.json index 8efc60a30..389a65e62 100644 --- a/src/addons/storagemanager/lang.json +++ b/src/addons/storagemanager/lang.json @@ -4,5 +4,6 @@ "deletedatafrom": "Offload data from {{name}}", "info": "Files stored on your device make the app work faster and enable the app to be used offline. You can safely offload files if you need to free up storage space.", "managestorage": "Manage storage", + "managecoursestorage": "Manage course storage", "storageused": "File storage used:" } diff --git a/src/addons/storagemanager/pages/course-storage/course-storage.html b/src/addons/storagemanager/pages/course-storage/course-storage.html index 42371c995..4f1b55179 100644 --- a/src/addons/storagemanager/pages/course-storage/course-storage.html +++ b/src/addons/storagemanager/pages/course-storage/course-storage.html @@ -4,7 +4,7 @@ -

{{ 'addon.storagemanager.managestorage' | translate }}

+

{{ 'addon.storagemanager.managecoursestorage' | translate }}

 @@ -12,54 +12,90 @@ - {{ course.displayname }} - {{ course.fullname }} + {{ title }}

{{ 'addon.storagemanager.info' | translate }}

{{ 'addon.storagemanager.storageused' | translate }}

+ {{ totalSize | coreBytesToSize }} -

{{ totalSize | coreBytesToSize }}

 + + + + {{ prefetchCourseData.statusTranslatable | translate }} + - +

{{ section.name }}

+ + {{ section.totalSize | coreBytesToSize }} + + +

+ + +

-

{{ section.totalSize | coreBytesToSize }}

- - - - +
+ + + + + +
- - +

{{ module.name }}

+ + {{ module.totalSize | coreBytesToSize }} + -

{{ module.totalSize | coreBytesToSize }}

- - - - + +
+ + + + + + +
diff --git a/src/addons/storagemanager/pages/course-storage/course-storage.scss b/src/addons/storagemanager/pages/course-storage/course-storage.scss index 4e413a248..5e459df34 100644 --- a/src/addons/storagemanager/pages/course-storage/course-storage.scss +++ b/src/addons/storagemanager/pages/course-storage/course-storage.scss @@ -9,3 +9,12 @@ font-size: 1.2rem; } } + +.storage-buttons { + display: flex; + align-items: center; +} + +ion-item { + --inner-padding-end: 0px; +} diff --git a/src/addons/storagemanager/pages/course-storage/course-storage.ts b/src/addons/storagemanager/pages/course-storage/course-storage.ts index 80e28b258..3abf047de 100644 --- a/src/addons/storagemanager/pages/course-storage/course-storage.ts +++ b/src/addons/storagemanager/pages/course-storage/course-storage.ts @@ -13,37 +13,77 @@ // limitations under the License. import { CoreConstants } from '@/core/constants'; -import { Component, OnInit } from '@angular/core'; -import { CoreCourse } from '@features/course/services/course'; -import { CoreCourseHelper, CoreCourseModuleData, CoreCourseSection } from '@features/course/services/course-helper'; -import { CoreCourseModulePrefetchDelegate } from '@features/course/services/module-prefetch-delegate'; -import { CoreEnrolledCourseData } from '@features/courses/services/courses'; +import { Component, OnDestroy, OnInit } from '@angular/core'; +import { CoreCourse, CoreCourseProvider } from '@features/course/services/course'; +import { + CoreCourseHelper, + CoreCourseModuleData, + CoreCourseSectionWithStatus, + CorePrefetchStatusInfo, +} from '@features/course/services/course-helper'; +import { + CoreCourseModulePrefetchDelegate, + CoreCourseModulePrefetchHandler } from '@features/course/services/module-prefetch-delegate'; +import { CoreCourses, CoreEnrolledCourseData } from '@features/courses/services/courses'; import { CoreNavigator } from '@services/navigator'; +import { CoreSites } from '@services/sites'; import { CoreDomUtils } from '@services/utils/dom'; +import { CoreUtils } from '@services/utils/utils'; import { Translate } from '@singletons'; +import { CoreEventObserver, CoreEvents } from '@singletons/events'; /** * Page that displays the amount of file storage used by each activity on the course, and allows - * the user to delete these files. + * the user to prefecth and delete this data. */ @Component({ selector: 'page-addon-storagemanager-course-storage', templateUrl: 'course-storage.html', styleUrls: ['course-storage.scss'], }) -export class AddonStorageManagerCourseStoragePage implements OnInit { +export class AddonStorageManagerCourseStoragePage implements OnInit, OnDestroy { - course!: CoreEnrolledCourseData; + course?: CoreEnrolledCourseData; + courseId!: number; + title = ''; loaded = false; sections: AddonStorageManagerCourseSection[] = []; totalSize = 0; + downloadEnabled = false; + downloadCourseEnabled = false; + + prefetchCourseData: CorePrefetchStatusInfo = { + icon: CoreConstants.ICON_LOADING, + statusTranslatable: 'core.course.downloadcourse', + status: '', + loading: true, + }; + + protected siteUpdatedObserver?: CoreEventObserver; + protected courseStatusObserver?: CoreEventObserver; + protected sectionStatusObserver?: CoreEventObserver; + protected moduleStatusObserver?: CoreEventObserver; + protected isDestroyed = false; + protected isGuest = false; + + constructor() { + // Refresh the enabled flags if site is updated. + this.siteUpdatedObserver = CoreEvents.on(CoreEvents.SITE_UPDATED, () => { + this.downloadCourseEnabled = !!this.course && !CoreCourses.isDownloadCourseDisabledInSite(); + this.downloadEnabled = !CoreSites.getRequiredCurrentSite().isOfflineDisabled(); + + this.initCoursePrefetch(); + this.initModulePrefetch(); + }, CoreSites.getCurrentSiteId()); + } + /** - * View loaded. + * @inheritdoc */ async ngOnInit(): Promise { try { - this.course = CoreNavigator.getRequiredRouteParam('course'); + this.courseId = CoreNavigator.getRequiredRouteParam('courseId'); } catch (error) { CoreDomUtils.showErrorModal(error); @@ -52,16 +92,160 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { return; } - const sections = await CoreCourse.getSections(this.course.id, false, true); - this.sections = CoreCourseHelper.addHandlerDataForModules(sections, this.course.id).sections; + this.course = CoreNavigator.getRouteParam('course'); + this.title = this.course?.displayname ?? this.course?.fullname ?? ''; + if (!this.title && this.courseId == CoreSites.getCurrentSiteHomeId()) { + this.title = Translate.instant('core.sitehome.sitehome'); + } + this.isGuest = !!CoreNavigator.getRouteBooleanParam('isGuest'); + + this.downloadCourseEnabled = !!this.course && !CoreCourses.isDownloadCourseDisabledInSite(); + this.downloadEnabled = !CoreSites.getRequiredCurrentSite().isOfflineDisabled(); + + const sections = await CoreCourse.getSections(this.courseId, false, true); + this.sections = (await CoreCourseHelper.addHandlerDataForModules(sections, this.courseId)).sections + .map((section) => ({ ...section, totalSize: 0 })); + + await Promise.all([ + this.loadSizes(), + this.initCoursePrefetch(), + this.initModulePrefetch(), + ]); + + this.loaded = true; + } + + /** + * Init course prefetch information. + * + * @return Promise resolved when done. + */ + protected async initCoursePrefetch(): Promise { + if (!this.downloadCourseEnabled || this.courseStatusObserver) { + return; + } + + // Listen for changes in course status. + this.courseStatusObserver = CoreEvents.on(CoreEvents.COURSE_STATUS_CHANGED, (data) => { + if (data.courseId == this.courseId || data.courseId == CoreCourseProvider.ALL_COURSES_CLEARED) { + this.updateCourseStatus(data.status); + } + }, CoreSites.getCurrentSiteId()); + + // Determine the course prefetch status. + await this.determineCoursePrefetchIcon(); + + if (this.prefetchCourseData.icon != CoreConstants.ICON_LOADING) { + return; + } + + // Course is being downloaded. Get the download promise. + const promise = CoreCourseHelper.getCourseDownloadPromise(this.courseId); + if (promise) { + // There is a download promise. Show an error if it fails. + promise.catch((error) => { + if (!this.isDestroyed) { + CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true); + } + }); + } else { + // No download, this probably means that the app was closed while downloading. Set previous status. + const status = await CoreCourse.setCoursePreviousStatus(this.courseId); + + this.updateCourseStatus(status); + } + } + + /** + * Init module prefetch information. + * + * @return Promise resolved when done. + */ + protected async initModulePrefetch(): Promise { + if (!this.downloadEnabled || this.sectionStatusObserver) { + return; + } + + // Listen for section status changes. + this.sectionStatusObserver = CoreEvents.on( + CoreEvents.SECTION_STATUS_CHANGED, + async (data) => { + if (!this.downloadEnabled || !this.sections.length || !data.sectionId || data.courseId != this.courseId) { + return; + } + + // Check if the affected section is being downloaded. + // If so, we don't update section status because it'll already be updated when the download finishes. + const downloadId = CoreCourseHelper.getSectionDownloadId({ id: data.sectionId }); + if (CoreCourseModulePrefetchDelegate.isBeingDownloaded(downloadId)) { + return; + } + + // Get the affected section. + const section = this.sections.find(section => section.id == data.sectionId); + if (!section) { + return; + } + + // Recalculate the status. + await CoreCourseHelper.calculateSectionStatus(section, this.courseId, false); + + if (section.isDownloading && !CoreCourseModulePrefetchDelegate.isBeingDownloaded(downloadId)) { + // All the modules are now downloading, set a download all promise. + this.prefecthSection(section); + } + }, + CoreSites.getCurrentSiteId(), + ); + + // The download status of a section might have been changed from within a module page. + CoreCourseHelper.calculateSectionsStatus(this.sections, this.courseId, false, false); + + this.sections.forEach((section) => { + section.modules.forEach((module) => { + if (module.handlerData?.showDownloadButton) { + + module.spinner = true; + // Listen for changes on this module status, even if download isn't enabled. + module.prefetchHandler = CoreCourseModulePrefetchDelegate.getPrefetchHandlerFor(module.modname); + this.calculateModuleStatus(module); + } + }); + }); + + this.moduleStatusObserver = CoreEvents.on(CoreEvents.PACKAGE_STATUS_CHANGED, (data) => { + let module: AddonStorageManagerModule | undefined; + + this.sections.some((section) => { + module = section.modules.find((module) => + module.id == data.componentId && module.prefetchHandler && data.component == module.prefetchHandler?.component); + + return !!module; + }); + + if (!module) { + return; + } + + // Call determineModuleStatus to get the right status to display. + const status = CoreCourseModulePrefetchDelegate.determineModuleStatus(module, data.status); + + // Update the status. + this.updateModuleStatus(module, status); + }, CoreSites.getCurrentSiteId()); + } + + /** + * Init section, course and modules sizes. + */ + protected async loadSizes(): Promise { this.totalSize = 0; const promises: Promise[] = []; this.sections.forEach((section) => { section.totalSize = 0; section.modules.forEach((module) => { - module.parentSection = section; module.totalSize = 0; // Note: This function only gets the size for modules which are downloadable. @@ -71,11 +255,11 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { // But these aren't necessarily consistent, for example mod_frog vs mmaModFrog. // There is nothing enforcing correct values. // Most modules which have large files are downloadable, so I think this is sufficient. - const promise = CoreCourseModulePrefetchDelegate.getModuleStoredSize(module, this.course.id).then((size) => { + const promise = CoreCourseModulePrefetchDelegate.getModuleStoredSize(module, this.courseId).then((size) => { // There are some cases where the return from this is not a valid number. if (!isNaN(size)) { module.totalSize = Number(size); - section.totalSize! += size; + section.totalSize += size; this.totalSize += size; } @@ -86,8 +270,8 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { }); await Promise.all(promises); - this.loaded = true; + // Mark course as not downloaded if course size is 0. if (this.totalSize == 0) { this.markCourseAsNotDownloaded(); } @@ -146,15 +330,16 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { } }); - this.deleteModules(modules); + this.deleteModules(modules, section); } /** * The user has requested a delete for a module's data * * @param module Module details + * @param section Section the module belongs to. */ - async deleteForModule(module: AddonStorageManagerModule): Promise { + async deleteForModule(module: AddonStorageManagerModule, section: AddonStorageManagerCourseSection): Promise { if (module.totalSize === 0) { return; } @@ -169,25 +354,29 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { return; } - this.deleteModules([module]); + this.deleteModules([module], section); } /** * Deletes the specified modules, showing the loading overlay while it happens. * * @param modules Modules to delete + * @param section Section the modules belong to. * @return Promise Once deleting has finished */ - protected async deleteModules(modules: AddonStorageManagerModule[]): Promise { + protected async deleteModules(modules: AddonStorageManagerModule[], section?: AddonStorageManagerCourseSection): Promise { const modal = await CoreDomUtils.showModalLoading(); const promises: Promise[] = []; modules.forEach((module) => { // Remove the files. - const promise = CoreCourseHelper.removeModuleStoredData(module, this.course.id).then(() => { + const promise = CoreCourseHelper.removeModuleStoredData(module, this.courseId).then(() => { + const moduleSize = module.totalSize || 0; // When the files and cache are removed, update the size. - module.parentSection!.totalSize! -= module.totalSize!; - this.totalSize -= module.totalSize!; + if (section) { + section.totalSize -= moduleSize; + } + this.totalSize -= moduleSize; module.totalSize = 0; return; @@ -203,13 +392,8 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { } finally { modal.dismiss(); - // @TODO This is a workaround that should be more specific solving MOBILE-3305. - // Also should take into account all modules are not downloaded. - - // Mark course as not downloaded if course size is 0. - if (this.totalSize == 0) { - this.markCourseAsNotDownloaded(); - } + await this.loadSizes(); + CoreCourseHelper.calculateSectionsStatus(this.sections, this.courseId, false, false); } } @@ -221,17 +405,201 @@ export class AddonStorageManagerCourseStoragePage implements OnInit { // Also should take into account all modules are not downloaded. // Check after MOBILE-3188 is integrated. - CoreCourse.setCourseStatus(this.course.id, CoreConstants.NOT_DOWNLOADED); + CoreCourse.setCourseStatus(this.courseId, CoreConstants.NOT_DOWNLOADED); + } + + /** + * Calculate the status of sections. + * + * @param refresh If refresh or not. + */ + protected calculateSectionsStatus(refresh?: boolean): void { + if (!this.sections) { + return; + } + + CoreUtils.ignoreErrors(CoreCourseHelper.calculateSectionsStatus(this.sections, this.courseId, refresh)); + } + + /** + * Confirm and prefetch a section. If the section is "all sections", prefetch all the sections. + * + * @param section Section to download. + * @param refresh Refresh clicked (not used). + */ + async prefecthSection(section: AddonStorageManagerCourseSection): Promise { + section.isCalculating = true; + + try { + await CoreCourseHelper.confirmDownloadSizeSection(this.courseId, section, this.sections); + + try { + await CoreCourseHelper.prefetchSection(section, this.courseId, this.sections); + + } catch (error) { + if (!this.isDestroyed) { + CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingsection', true); + } + } finally { + await this.loadSizes(); + } + } catch (error) { + // User cancelled or there was an error calculating the size. + if (!this.isDestroyed && error) { + CoreDomUtils.showErrorModal(error); + + return; + } + } finally { + section.isCalculating = false; + } + } + + /** + * Download the module. + * + * @param module Module to prefetch. + * @param refresh Whether it's refreshing. + * @return Promise resolved when done. + */ + async prefetchModule( + module: AddonStorageManagerModule, + refresh = false, + ): Promise { + if (!module.prefetchHandler) { + return; + } + + // Show spinner since this operation might take a while. + module.spinner = true; + + try { + // Get download size to ask for confirm if it's high. + const size = await module.prefetchHandler.getDownloadSize(module, module.course, true); + + await CoreCourseHelper.prefetchModule(module.prefetchHandler, module, size, module.course, refresh); + + CoreCourseHelper.calculateSectionsStatus(this.sections, this.courseId, false, false); + } catch (error) { + if (!this.isDestroyed) { + CoreDomUtils.showErrorModalDefault(error, 'core.errordownloading', true); + } + } finally { + module.spinner = false; + + await this.loadSizes(); + } + } + + /** + * Show download buttons according to module status. + * + * @param module Module to update. + * @param status Module status. + */ + protected updateModuleStatus(module: AddonStorageManagerModule, status: string): void { + if (!status) { + return; + } + + module.spinner = false; + module.downloadStatus = status; + + module.handlerData?.updateStatus?.(status); + } + + /** + * Calculate and show module status. + * + * @param module Module to update. + * @return Promise resolved when done. + */ + protected async calculateModuleStatus(module: AddonStorageManagerModule): Promise { + if (!module) { + return; + } + + const status = await CoreCourseModulePrefetchDelegate.getModuleStatus(module, this.courseId); + + this.updateModuleStatus(module, status); + } + + /** + * Determines the prefetch icon of the course. + * + * @return Promise resolved when done. + */ + protected async determineCoursePrefetchIcon(): Promise { + this.prefetchCourseData = await CoreCourseHelper.getCourseStatusIconAndTitle(this.courseId); + } + + /** + * Update the course status icon and title. + * + * @param status Status to show. + */ + protected updateCourseStatus(status: string): void { + const statusData = CoreCourseHelper.getCoursePrefetchStatusInfo(status); + + this.prefetchCourseData.status = statusData.status; + this.prefetchCourseData.icon = statusData.icon; + this.prefetchCourseData.statusTranslatable = statusData.statusTranslatable; + this.prefetchCourseData.loading = statusData.loading; + } + + /** + * Prefetch the whole course. + */ + async prefetchCourse(): Promise { + if (!this.course) { + return; + } + + try { + await CoreCourseHelper.confirmAndPrefetchCourse( + this.prefetchCourseData, + this.course, + { + sections: this.sections, + isGuest: this.isGuest, + }, + ); + } catch (error) { + if (this.isDestroyed) { + return; + } + + CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true); + } + } + + /** + * @inheritdoc + */ + ngOnDestroy(): void { + this.courseStatusObserver?.off(); + this.sectionStatusObserver?.off(); + this.moduleStatusObserver?.off(); + this.siteUpdatedObserver?.off(); + + this.sections.forEach((section) => { + section.modules.forEach((module) => { + module.handlerData?.onDestroy?.(); + }); + }); + this.isDestroyed = true; } } -type AddonStorageManagerCourseSection = Omit & { - totalSize?: number; +type AddonStorageManagerCourseSection = Omit & { + totalSize: number; modules: AddonStorageManagerModule[]; }; type AddonStorageManagerModule = CoreCourseModuleData & { - parentSection?: AddonStorageManagerCourseSection; totalSize?: number; + prefetchHandler?: CoreCourseModulePrefetchHandler; + spinner?: boolean; + downloadStatus?: string; }; diff --git a/src/addons/storagemanager/services/handlers/course-menu.ts b/src/addons/storagemanager/services/handlers/course-menu.ts index 3d9cc77d1..14111d513 100644 --- a/src/addons/storagemanager/services/handlers/course-menu.ts +++ b/src/addons/storagemanager/services/handlers/course-menu.ts @@ -49,7 +49,7 @@ export class AddonStorageManagerCourseMenuHandlerService implements CoreCourseOp ): CoreCourseOptionsMenuHandlerData { return { icon: 'fas-archive', - title: 'addon.storagemanager.managestorage', + title: 'addon.storagemanager.managecoursestorage', page: 'storage/' + course.id, class: 'addon-storagemanager-coursemenu-handler', }; diff --git a/src/core/components/progress-bar/core-progress-bar.html b/src/core/components/progress-bar/core-progress-bar.html index 6d62b02e0..7178621c7 100644 --- a/src/core/components/progress-bar/core-progress-bar.html +++ b/src/core/components/progress-bar/core-progress-bar.html @@ -7,3 +7,5 @@ {{ 'core.percentagenumber' | translate: {$a: text} }} + + diff --git a/src/core/components/progress-bar/progress-bar.scss b/src/core/components/progress-bar/progress-bar.scss index d50a1f078..41584f3f8 100644 --- a/src/core/components/progress-bar/progress-bar.scss +++ b/src/core/components/progress-bar/progress-bar.scss @@ -35,4 +35,11 @@ border-radius: 0; } } + + ion-progress-bar { + --progress-background: var(--color); + height: var(--height); + margin-top: calc((var(--line-height) - var(--height)) /2); + margin-bottom: calc((var(--line-height) - var(--height)) /2); + } } diff --git a/src/core/components/progress-bar/progress-bar.ts b/src/core/components/progress-bar/progress-bar.ts index ae6f86fcc..1b2e1fd56 100644 --- a/src/core/components/progress-bar/progress-bar.ts +++ b/src/core/components/progress-bar/progress-bar.ts @@ -30,7 +30,7 @@ import { DomSanitizer, Translate } from '@singletons'; }) export class CoreProgressBarComponent implements OnChanges { - @Input() progress!: number | string; // Percentage from 0 to 100. + @Input() progress!: number | string; // Percentage from 0 to 100. Negative number will show an indeterminate progress bar. @Input() text?: string; // Percentage in text to be shown at the right. If not defined, progress will be used. @Input() a11yText?: string; // Accessibility text to read before the percentage. @Input() ariaDescribedBy?: string; // ID of the element that described the progress, if any. diff --git a/src/core/features/block/components/side-blocks-button/side-blocks-button.ts b/src/core/features/block/components/side-blocks-button/side-blocks-button.ts index 71f3e4898..bd59a030a 100644 --- a/src/core/features/block/components/side-blocks-button/side-blocks-button.ts +++ b/src/core/features/block/components/side-blocks-button/side-blocks-button.ts @@ -27,7 +27,6 @@ import { CoreBlockSideBlocksComponent } from '../side-blocks/side-blocks'; export class CoreBlockSideBlocksButtonComponent { @Input() courseId!: number; - @Input() downloadEnabled = false; /** * Open side blocks. @@ -37,7 +36,6 @@ export class CoreBlockSideBlocksButtonComponent { component: CoreBlockSideBlocksComponent, componentProps: { courseId: this.courseId, - downloadEnabled: this.downloadEnabled, }, }); } diff --git a/src/core/features/block/components/side-blocks/side-blocks.html b/src/core/features/block/components/side-blocks/side-blocks.html index 4b08c5b01..198cb21d2 100644 --- a/src/core/features/block/components/side-blocks/side-blocks.html +++ b/src/core/features/block/components/side-blocks/side-blocks.html @@ -17,8 +17,7 @@ - + diff --git a/src/core/features/block/components/side-blocks/side-blocks.ts b/src/core/features/block/components/side-blocks/side-blocks.ts index 0f817a4a0..b44b32557 100644 --- a/src/core/features/block/components/side-blocks/side-blocks.ts +++ b/src/core/features/block/components/side-blocks/side-blocks.ts @@ -33,7 +33,6 @@ import { CoreCoursesDashboard } from '@features/courses/services/dashboard'; export class CoreBlockSideBlocksComponent implements OnInit { @Input() courseId?: number; - @Input() downloadEnabled = false; @ViewChildren(CoreBlockComponent) blocksComponents?: QueryList; diff --git a/src/core/features/course/components/format/core-course-format.html b/src/core/features/course/components/format/core-course-format.html index e4b211c67..7e549a3c2 100644 --- a/src/core/features/course/components/format/core-course-format.html +++ b/src/core/features/course/components/format/core-course-format.html @@ -11,10 +11,8 @@ -
+ class="ion-text-wrap ion-justify-content-between ion-align-items-center core-button-selector-row"> {{ 'core.course.sections' | translate }} - -
- + (selectedSection.availabilityinfo || selectedSection.visible === 0))" lines="none" class="core-format-progress-list">
@@ -103,8 +99,7 @@ - + @@ -114,7 +109,7 @@
+ [class.item-dimmed]="section.visible === 0 || section.uservisible === false">

@@ -133,8 +128,6 @@

- - @@ -145,28 +138,10 @@ -

- - - - - diff --git a/src/core/features/course/components/format/format.scss b/src/core/features/course/components/format/format.scss index 46ca0f415..76335d842 100644 --- a/src/core/features/course/components/format/format.scss +++ b/src/core/features/course/components/format/format.scss @@ -55,21 +55,6 @@ } } - .core-section-download { - core-combobox { - max-width: calc(100% - 64px); - } - .core-button-spinner { - display: flex; - align-items: center; - @include margin-horizontal(10px); - - ion-badge.core-course-download-courses-progress { - @include margin(null, 12px, null, null); - } - } - } - .core-course-section-nav-buttons { display: flex; justify-content: flex-end; diff --git a/src/core/features/course/components/format/format.ts b/src/core/features/course/components/format/format.ts index 683eb061e..7d93a2084 100644 --- a/src/core/features/course/components/format/format.ts +++ b/src/core/features/course/components/format/format.ts @@ -27,7 +27,6 @@ import { ElementRef, } from '@angular/core'; import { ModalOptions } from '@ionic/core'; -import { CoreSites } from '@services/sites'; import { CoreDomUtils } from '@services/utils/dom'; import { CoreDynamicComponent } from '@components/dynamic-component/dynamic-component'; import { CoreCourseAnyCourseData } from '@features/courses/services/courses'; @@ -37,17 +36,14 @@ import { CoreCourseProvider, } from '@features/course/services/course'; import { - CoreCourseHelper, CoreCourseModuleData, CoreCourseModuleCompletionData, CoreCourseSection, - CoreCourseSectionWithStatus, } from '@features/course/services/course-helper'; import { CoreCourseFormatDelegate } from '@features/course/services/format-delegate'; import { CoreEventObserver, CoreEvents } from '@singletons/events'; import { IonContent, IonRefresher } from '@ionic/angular'; import { CoreUtils } from '@services/utils/utils'; -import { CoreCourseModulePrefetchDelegate } from '@features/course/services/module-prefetch-delegate'; import { CoreCourseSectionSelectorComponent } from '../section-selector/section-selector'; import { CoreBlockHelper } from '@features/block/services/block-helper'; @@ -71,8 +67,7 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { static readonly LOAD_MORE_ACTIVITIES = 20; // How many activities should load each time showMoreActivities is called. @Input() course?: CoreCourseAnyCourseData; // The course to render. - @Input() sections?: CoreCourseSectionWithStatus[]; // List of course sections. The status will be calculated in this component. - @Input() downloadEnabled?: boolean; // Whether the download of sections and modules is enabled. + @Input() sections?: CoreCourseSection[]; // List of course sections. @Input() initialSectionId?: number; // The section to load first (by ID). @Input() initialSectionNumber?: number; // The section to load first (by number). @Input() moduleId?: number; // The module ID to scroll to. Must be inside the initial selected section. @@ -108,7 +103,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { componentProps: {}, }; - protected sectionStatusObserver?: CoreEventObserver; protected selectTabObserver?: CoreEventObserver; protected lastCourseFormat?: string; protected sectionSelectorExpanded = false; @@ -125,38 +119,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { * Component being initialized. */ ngOnInit(): void { - // Listen for section status changes. - this.sectionStatusObserver = CoreEvents.on( - CoreEvents.SECTION_STATUS_CHANGED, - async (data) => { - if (!this.downloadEnabled || !this.sections?.length || !data.sectionId || data.courseId != this.course?.id) { - return; - } - - // Check if the affected section is being downloaded. - // If so, we don't update section status because it'll already be updated when the download finishes. - const downloadId = CoreCourseHelper.getSectionDownloadId({ id: data.sectionId }); - if (CoreCourseModulePrefetchDelegate.isBeingDownloaded(downloadId)) { - return; - } - - // Get the affected section. - const section = this.sections.find(section => section.id == data.sectionId); - if (!section) { - return; - } - - // Recalculate the status. - await CoreCourseHelper.calculateSectionStatus(section, this.course.id, false); - - if (section.isDownloading && !CoreCourseModulePrefetchDelegate.isBeingDownloaded(downloadId)) { - // All the modules are now downloading, set a download all promise. - this.prefetch(section); - } - }, - CoreSites.getCurrentSiteId(), - ); - // Listen for select course tab events to select the right section if needed. this.selectTabObserver = CoreEvents.on(CoreEvents.SELECT_COURSE_TAB, (data) => { if (data.name) { @@ -205,10 +167,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { this.sectionSelectorModalOptions.componentProps!.sections = this.sections; this.treatSections(this.sections); } - - if (this.downloadEnabled && (changes.downloadEnabled || changes.sections)) { - this.calculateSectionsStatus(false); - } } /** @@ -219,7 +177,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { this.data.sections = this.sections; this.data.initialSectionId = this.initialSectionId; this.data.initialSectionNumber = this.initialSectionNumber; - this.data.downloadEnabled = this.downloadEnabled; this.data.moduleId = this.moduleId; this.data.completionChanged = this.completionChanged; } @@ -394,9 +351,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { this.canLoadMore = false; this.showSectionId = 0; this.showMoreActivities(); - if (this.downloadEnabled) { - this.calculateSectionsStatus(false); - } } if (this.moduleId && previousValue === undefined) { @@ -432,62 +386,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { return section1 && section2 ? section1.id === section2.id : section1 === section2; } - /** - * Calculate the status of sections. - * - * @param refresh If refresh or not. - */ - protected calculateSectionsStatus(refresh?: boolean): void { - if (!this.sections || !this.course) { - return; - } - - CoreUtils.ignoreErrors(CoreCourseHelper.calculateSectionsStatus(this.sections, this.course.id, refresh)); - } - - /** - * Confirm and prefetch a section. If the section is "all sections", prefetch all the sections. - * - * @param section Section to download. - * @param refresh Refresh clicked (not used). - */ - async prefetch(section: CoreCourseSectionWithStatus): Promise { - section.isCalculating = true; - - try { - await CoreCourseHelper.confirmDownloadSizeSection(this.course!.id, section, this.sections); - - await this.prefetchSection(section, true); - } catch (error) { - // User cancelled or there was an error calculating the size. - if (error) { - CoreDomUtils.showErrorModal(error); - } - } finally { - section.isCalculating = false; - } - } - - /** - * Prefetch a section. - * - * @param section The section to download. - * @param manual Whether the prefetch was started manually or it was automatically started because all modules - * are being downloaded. - */ - protected async prefetchSection(section: CoreCourseSectionWithStatus, manual?: boolean): Promise { - try { - await CoreCourseHelper.prefetchSection(section, this.course!.id, this.sections); - } catch (error) { - // Don't show error message if it's an automatic download. - if (!manual) { - return; - } - - CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingsection', true); - } - } - /** * Refresh the data. * @@ -580,7 +478,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { * Component destroyed. */ ngOnDestroy(): void { - this.sectionStatusObserver && this.sectionStatusObserver.off(); this.selectTabObserver && this.selectTabObserver.off(); } @@ -591,17 +488,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { this.dynamicComponents?.forEach((component) => { component.callComponentFunction('ionViewDidEnter'); }); - - if (!this.downloadEnabled || !this.course || !this.sections) { - return; - } - - // The download status of a section might have been changed from within a module page. - if (this.selectedSection && this.selectedSection.id !== CoreCourseProvider.ALL_SECTIONS_ID) { - CoreCourseHelper.calculateSectionStatus(this.selectedSection, this.course.id, false, false); - } else { - CoreCourseHelper.calculateSectionsStatus(this.sections, this.course.id, false, false); - } } /** @@ -653,17 +539,6 @@ export class CoreCourseFormatComponent implements OnInit, OnChanges, OnDestroy { this.updateProgress(); } - /** - * Recalculate the download status of each section, in response to a module being downloaded. - */ - onModuleStatusChange(): void { - if (!this.downloadEnabled || !this.sections || !this.course) { - return; - } - - CoreCourseHelper.calculateSectionsStatus(this.sections, this.course.id, false, false); - } - /** * Update course progress. */ diff --git a/src/core/features/course/components/module/core-course-module.html b/src/core/features/course/components/module/core-course-module.html index 65637562c..fc9db736c 100644 --- a/src/core/features/course/components/module/core-course-module.html +++ b/src/core/features/course/components/module/core-course-module.html @@ -15,7 +15,7 @@

+ [courseId]="module.course" [attr.aria-label]="module.handlerData.a11yTitle + ', ' + modNameTranslated">

{{ 'core.restricted' | translate }} + [courseId]="module.course" class="ion-text-wrap"> @@ -48,13 +48,9 @@
- - - @@ -81,7 +77,7 @@ + contextLevel="module" [contextInstanceId]="module.id" [courseId]="module.course"> diff --git a/src/core/features/course/components/module/module.ts b/src/core/features/course/components/module/module.ts index 82df87061..936901f5f 100644 --- a/src/core/features/course/components/module/module.ts +++ b/src/core/features/course/components/module/module.ts @@ -15,20 +15,13 @@ import { Component, Input, Output, EventEmitter, OnInit, OnDestroy } from '@angular/core'; import { CoreSites } from '@services/sites'; -import { CoreDomUtils } from '@services/utils/dom'; -import { CoreEventObserver, CoreEvents } from '@singletons/events'; import { - CoreCourseHelper, CoreCourseModuleData, CoreCourseModuleCompletionData, CoreCourseSection, } from '@features/course/services/course-helper'; import { CoreCourse } from '@features/course/services/course'; import { CoreCourseModuleDelegate, CoreCourseModuleHandlerButton } from '@features/course/services/module-delegate'; -import { - CoreCourseModulePrefetchDelegate, - CoreCourseModulePrefetchHandler, -} from '@features/course/services/module-prefetch-delegate'; /** * Component to display a module entry in a list of modules. @@ -45,47 +38,20 @@ import { export class CoreCourseModuleComponent implements OnInit, OnDestroy { @Input() module!: CoreCourseModuleData; // The module to render. - @Input() courseId?: number; // The course the module belongs to. @Input() section?: CoreCourseSection; // The section the module belongs to. @Input() showActivityDates = false; // Whether to show activity dates. @Input() showCompletionConditions = false; // Whether to show activity completion conditions. - // eslint-disable-next-line @angular-eslint/no-input-rename - @Input('downloadEnabled') set enabled(value: boolean) { - this.downloadEnabled = value; - - if (!this.module.handlerData?.showDownloadButton || !this.downloadEnabled || this.statusCalculated) { - return; - } - - // First time that the download is enabled. Initialize the data. - this.statusCalculated = true; - this.spinner = true; // Show spinner while calculating the status. - - // Get current status to decide which icon should be shown. - this.calculateAndShowStatus(); - } - @Output() completionChanged = new EventEmitter(); // Notify when module completion changes. - @Output() statusChanged = new EventEmitter(); // Notify when the download status changes. - downloadStatus?: string; - spinner?: boolean; // Whether to display a loading spinner. - downloadEnabled?: boolean; // Whether the download of sections and modules is enabled. modNameTranslated = ''; hasInfo = false; showLegacyCompletion = false; // Whether to show module completion in the old format. showManualCompletion = false; // Whether to show manual completion when completion conditions are disabled. - protected prefetchHandler?: CoreCourseModulePrefetchHandler; - protected statusObserver?: CoreEventObserver; - protected statusCalculated = false; - protected isDestroyed = false; - /** * Component being initialized. */ ngOnInit(): void { - this.courseId = this.courseId || this.module.course; this.modNameTranslated = CoreCourse.translateModuleName(this.module.modname) || ''; this.showLegacyCompletion = !CoreSites.getCurrentSite()?.isVersionGreaterEqualThan('3.11'); this.checkShowManualCompletion(); @@ -103,29 +69,6 @@ export class CoreCourseModuleComponent implements OnInit, OnDestroy { (this.showCompletionConditions && this.module.completiondata.isautomatic)) ) ); - - if (this.module.handlerData.showDownloadButton) { - // Listen for changes on this module status, even if download isn't enabled. - this.prefetchHandler = CoreCourseModulePrefetchDelegate.getPrefetchHandlerFor(this.module.modname); - - this.statusObserver = CoreEvents.on(CoreEvents.PACKAGE_STATUS_CHANGED, (data) => { - if (!this.module || data.componentId != this.module.id || !this.prefetchHandler || - data.component != this.prefetchHandler.component) { - return; - } - - // Call determineModuleStatus to get the right status to display. - const status = CoreCourseModulePrefetchDelegate.determineModuleStatus(this.module, data.status); - - if (this.downloadEnabled) { - // Download is enabled, show the status. - this.showStatus(status); - } else if (this.module.handlerData?.updateStatus) { - // Download isn't enabled but the handler defines a updateStatus function, call it anyway. - this.module.handlerData.updateStatus(status); - } - }, CoreSites.getCurrentSiteId()); - } } /** @@ -143,7 +86,7 @@ export class CoreCourseModuleComponent implements OnInit, OnDestroy { */ moduleClicked(event: Event): void { if (this.module.uservisible !== false && this.module.handlerData?.action) { - this.module.handlerData.action(event, this.module, this.courseId!); + this.module.handlerData.action(event, this.module, this.module.course); } } @@ -161,91 +104,14 @@ export class CoreCourseModuleComponent implements OnInit, OnDestroy { event.preventDefault(); event.stopPropagation(); - button.action(event, this.module, this.courseId!); - } - - /** - * Download the module. - * - * @param refresh Whether it's refreshing. - * @return Promise resolved when done. - */ - async download(refresh: boolean): Promise { - if (!this.prefetchHandler || !this.module) { - return; - } - - // Show spinner since this operation might take a while. - this.spinner = true; - - try { - // Get download size to ask for confirm if it's high. - const size = await this.prefetchHandler.getDownloadSize(this.module, this.module.course, true); - - await CoreCourseHelper.prefetchModule(this.prefetchHandler, this.module, size, this.module.course, refresh); - - const eventData = { - sectionId: this.section?.id, - moduleId: this.module.id, - courseId: this.module.course, - }; - this.statusChanged.emit(eventData); - } catch (error) { - // Error, hide spinner. - this.spinner = false; - if (!this.isDestroyed) { - CoreDomUtils.showErrorModalDefault(error, 'core.errordownloading', true); - } - } - } - - /** - * Show download buttons according to module status. - * - * @param status Module status. - */ - protected showStatus(status: string): void { - if (!status) { - return; - } - - this.spinner = false; - this.downloadStatus = status; - - this.module.handlerData?.updateStatus?.(status); - } - - /** - * Calculate and show module status. - * - * @return Promise resolved when done. - */ - protected async calculateAndShowStatus(): Promise { - if (!this.module || !this.courseId) { - return; - } - - const status = await CoreCourseModulePrefetchDelegate.getModuleStatus(this.module, this.courseId); - - this.showStatus(status); + button.action(event, this.module, this.module.course); } /** * Component destroyed. */ ngOnDestroy(): void { - // this.statusObserver?.off(); this.module.handlerData?.onDestroy?.(); - this.isDestroyed = true; } } - -/** - * Data sent to the status changed output. - */ -export type CoreCourseModuleStatusChangedData = { - moduleId: number; - courseId: number; - sectionId?: number; -}; diff --git a/src/core/features/course/format/singleactivity/components/core-course-format-single-activity.html b/src/core/features/course/format/singleactivity/components/core-course-format-single-activity.html index 17cf0dd0f..68eedcebf 100644 --- a/src/core/features/course/format/singleactivity/components/core-course-format-single-activity.html +++ b/src/core/features/course/format/singleactivity/components/core-course-format-single-activity.html @@ -1,4 +1,4 @@ - + diff --git a/src/core/features/course/format/singleactivity/components/singleactivity.ts b/src/core/features/course/format/singleactivity/components/singleactivity.ts index 3fd7cf5c0..01da69058 100644 --- a/src/core/features/course/format/singleactivity/components/singleactivity.ts +++ b/src/core/features/course/format/singleactivity/components/singleactivity.ts @@ -36,7 +36,6 @@ export class CoreCourseFormatSingleActivityComponent implements OnChanges { @Input() course?: CoreCourseAnyCourseData; // The course to render. @Input() sections?: CoreCourseSectionWithStatus[]; // List of course sections. - @Input() downloadEnabled?: boolean; // Whether the download of sections and modules is enabled. @Input() initialSectionId?: number; // The section to load first (by ID). @Input() initialSectionNumber?: number; // The section to load first (by number). @Input() moduleId?: number; // The module ID to scroll to. Must be inside the initial selected section. diff --git a/src/core/features/course/format/singleactivity/services/handlers/singleactivity-format.ts b/src/core/features/course/format/singleactivity/services/handlers/singleactivity-format.ts index 3ce49d231..945b99e4c 100644 --- a/src/core/features/course/format/singleactivity/services/handlers/singleactivity-format.ts +++ b/src/core/features/course/format/singleactivity/services/handlers/singleactivity-format.ts @@ -68,13 +68,6 @@ export class CoreCourseFormatSingleActivityHandlerService implements CoreCourseF return ''; } - /** - * @inheritdoc - */ - displayEnableDownload(): boolean { - return false; - } - /** * @inheritdoc */ diff --git a/src/core/features/course/pages/contents/contents.html b/src/core/features/course/pages/contents/contents.html index 9c1633cad..1f6b46f1c 100644 --- a/src/core/features/course/pages/contents/contents.html +++ b/src/core/features/course/pages/contents/contents.html @@ -1,12 +1,5 @@ - - - - @@ -22,8 +15,7 @@ + [moduleId]="moduleId" (completionChanged)="onCompletionChange($event)" class="core-course-format-{{course.format}}"> diff --git a/src/core/features/course/pages/contents/contents.ts b/src/core/features/course/pages/contents/contents.ts index 768cfc65f..43bbcfb2d 100644 --- a/src/core/features/course/pages/contents/contents.ts +++ b/src/core/features/course/pages/contents/contents.ts @@ -15,20 +15,17 @@ import { Component, ViewChild, OnInit, OnDestroy } from '@angular/core'; import { IonContent, IonRefresher } from '@ionic/angular'; -import { CoreSites } from '@services/sites'; import { CoreDomUtils } from '@services/utils/dom'; import { CoreUtils } from '@services/utils/utils'; -import { CoreCourses, CoreCourseAnyCourseData, CoreCoursesProvider } from '@features/courses/services/courses'; +import { CoreCourses, CoreCourseAnyCourseData } from '@features/courses/services/courses'; import { CoreCourse, CoreCourseCompletionActivityStatus, - CoreCourseProvider, } from '@features/course/services/course'; import { CoreCourseHelper, CoreCourseModuleCompletionData, CoreCourseSection, - CorePrefetchStatusInfo, } from '@features/course/services/course-helper'; import { CoreCourseFormatDelegate } from '@features/course/services/format-delegate'; import { CoreCourseModulePrefetchDelegate } from '@features/course/services/module-prefetch-delegate'; @@ -43,7 +40,6 @@ import { CoreEventObserver, } from '@singletons/events'; import { CoreNavigator } from '@services/navigator'; -import { CoreConstants } from '@/core/constants'; /** * Page that displays the contents of a course. @@ -63,47 +59,19 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { sectionNumber?: number; courseMenuHandlers: CoreCourseOptionsMenuHandlerToDisplay[] = []; dataLoaded = false; - downloadEnabled = false; downloadCourseEnabled = false; moduleId?: number; displayEnableDownload = false; displayRefresher = false; - prefetchCourseData: CorePrefetchStatusInfo = { - icon: CoreConstants.ICON_LOADING, - statusTranslatable: 'core.course.downloadcourse', - status: '', - loading: true, - }; protected formatOptions?: Record; protected completionObserver?: CoreEventObserver; - protected courseStatusObserver?: CoreEventObserver; - protected siteUpdatedObserver?: CoreEventObserver; - protected downloadEnabledObserver?: CoreEventObserver; protected syncObserver?: CoreEventObserver; protected isDestroyed = false; protected modulesHaveCompletion = false; - protected isGuest?: boolean; + protected isGuest = false; protected debouncedUpdateCachedCompletion?: () => void; // Update the cached completion after a certain time. - constructor() { - // Refresh the enabled flags if site is updated. - this.siteUpdatedObserver = CoreEvents.on(CoreEvents.SITE_UPDATED, () => { - this.downloadCourseEnabled = !CoreCourses.isDownloadCourseDisabledInSite(); - - this.displayEnableDownload = !CoreSites.getRequiredCurrentSite().isOfflineDisabled() && - CoreCourseFormatDelegate.displayEnableDownload(this.course); - - this.downloadEnabled = this.displayEnableDownload && this.downloadEnabled; - - this.initListeners(); - }, CoreSites.getCurrentSiteId()); - - this.downloadEnabledObserver = CoreEvents.on(CoreCoursesProvider.EVENT_DASHBOARD_DOWNLOAD_ENABLED_CHANGED, (data) => { - this.downloadEnabled = this.displayEnableDownload && data.enabled; - }); - } - /** * @inheritdoc */ @@ -121,13 +89,7 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { this.sectionId = CoreNavigator.getRouteNumberParam('sectionId'); this.sectionNumber = CoreNavigator.getRouteNumberParam('sectionNumber'); this.moduleId = CoreNavigator.getRouteNumberParam('moduleId'); - this.isGuest = CoreNavigator.getRouteBooleanParam('isGuest'); - - this.displayEnableDownload = !CoreSites.getRequiredCurrentSite().isOfflineDisabled() && - CoreCourseFormatDelegate.displayEnableDownload(this.course); - this.downloadCourseEnabled = !CoreCourses.isDownloadCourseDisabledInSite(); - - this.downloadEnabled = this.displayEnableDownload && CoreCourses.getCourseDownloadOptionsEnabled(); + this.isGuest = !!CoreNavigator.getRouteBooleanParam('isGuest'); this.debouncedUpdateCachedCompletion = CoreUtils.debounce(() => { if (this.modulesHaveCompletion) { @@ -149,8 +111,6 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { await this.loadData(false, true); this.dataLoaded = true; - - this.initPrefetch(); } /** @@ -159,15 +119,6 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { * @return Promise resolved when done. */ protected async initListeners(): Promise { - if (this.downloadCourseEnabled && !this.courseStatusObserver) { - // Listen for changes in course status. - this.courseStatusObserver = CoreEvents.on(CoreEvents.COURSE_STATUS_CHANGED, (data) => { - if (data.courseId == this.course.id || data.courseId == CoreCourseProvider.ALL_COURSES_CLEARED) { - this.updateCourseStatus(data.status); - } - }, CoreSites.getCurrentSiteId()); - } - // Check if the course format requires the view to be refreshed when completion changes. const shouldRefresh = await CoreCourseFormatDelegate.shouldRefreshWhenCompletionChanges(this.course); if (!shouldRefresh) { @@ -200,41 +151,6 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { } } - /** - * Init prefetch data if needed. - * - * @return Promise resolved when done. - */ - protected async initPrefetch(): Promise { - if (!this.downloadCourseEnabled) { - // Cannot download the whole course, stop. - return; - } - - // Determine the course prefetch status. - await this.determineCoursePrefetchIcon(); - - if (this.prefetchCourseData.icon != CoreConstants.ICON_LOADING) { - return; - } - - // Course is being downloaded. Get the download promise. - const promise = CoreCourseHelper.getCourseDownloadPromise(this.course.id); - if (promise) { - // There is a download promise. Show an error if it fails. - promise.catch((error) => { - if (!this.isDestroyed) { - CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true); - } - }); - } else { - // No download, this probably means that the app was closed while downloading. Set previous status. - const status = await CoreCourse.setCoursePreviousStatus(this.course.id); - - this.updateCourseStatus(status); - } - } - /** * Fetch and load all the data required for the view. * @@ -314,7 +230,7 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { } // Add handlers - const result = CoreCourseHelper.addHandlerDataForModules( + const result = await CoreCourseHelper.addHandlerDataForModules( sections, this.course.id, completionStatus, @@ -463,59 +379,6 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { } } - /** - * Determines the prefetch icon of the course. - * - * @return Promise resolved when done. - */ - protected async determineCoursePrefetchIcon(): Promise { - this.prefetchCourseData = await CoreCourseHelper.getCourseStatusIconAndTitle(this.course.id); - } - - /** - * Prefetch the whole course. - */ - async prefetchCourse(): Promise { - try { - await CoreCourseHelper.confirmAndPrefetchCourse( - this.prefetchCourseData, - this.course, - { - sections: this.sections, - menuHandlers: this.courseMenuHandlers, - isGuest: this.isGuest, - }, - ); - } catch (error) { - if (this.isDestroyed) { - return; - } - - CoreDomUtils.showErrorModalDefault(error, 'core.course.errordownloadingcourse', true); - } - } - - /** - * Toggle download enabled. - */ - toggleDownload(): void { - CoreCourses.setCourseDownloadOptionsEnabled(this.downloadEnabled); - } - - /** - * Update the course status icon and title. - * - * @param status Status to show. - */ - protected updateCourseStatus(status: string): void { - const statusData = CoreCourseHelper.getCoursePrefetchStatusInfo(status); - - this.prefetchCourseData.status = statusData.status; - this.prefetchCourseData.icon = statusData.icon; - this.prefetchCourseData.statusTranslatable = statusData.statusTranslatable; - this.prefetchCourseData.loading = statusData.loading; - } - /** * Open the course summary */ @@ -542,10 +405,7 @@ export class CoreCourseContentsPage implements OnInit, OnDestroy { ngOnDestroy(): void { this.isDestroyed = true; this.completionObserver?.off(); - this.courseStatusObserver?.off(); this.syncObserver?.off(); - this.siteUpdatedObserver?.off(); - this.downloadEnabledObserver?.off(); } /** diff --git a/src/core/features/course/pages/list-mod-type/list-mod-type.html b/src/core/features/course/pages/list-mod-type/list-mod-type.html index 1d6d7d2aa..d0cf3b7d1 100644 --- a/src/core/features/course/pages/list-mod-type/list-mod-type.html +++ b/src/core/features/course/pages/list-mod-type/list-mod-type.html @@ -19,8 +19,7 @@ - + diff --git a/src/core/features/course/pages/list-mod-type/list-mod-type.page.ts b/src/core/features/course/pages/list-mod-type/list-mod-type.page.ts index 735cfc346..fde5d1830 100644 --- a/src/core/features/course/pages/list-mod-type/list-mod-type.page.ts +++ b/src/core/features/course/pages/list-mod-type/list-mod-type.page.ts @@ -14,7 +14,6 @@ import { Component, OnInit } from '@angular/core'; -import { CoreSites } from '@services/sites'; import { CoreDomUtils } from '@services/utils/dom'; import { CoreCourse } from '@features/course/services/course'; import { CoreCourseModuleDelegate } from '@features/course/services/module-delegate'; @@ -36,7 +35,6 @@ export class CoreCourseListModTypePage implements OnInit { sections: CoreCourseSection[] = []; title = ''; loaded = false; - downloadEnabled = false; courseId?: number; protected modName?: string; @@ -49,7 +47,6 @@ export class CoreCourseListModTypePage implements OnInit { this.title = CoreNavigator.getRouteParam('title') || ''; this.courseId = CoreNavigator.getRouteNumberParam('courseId'); this.modName = CoreNavigator.getRouteParam('modName'); - this.downloadEnabled = !CoreSites.getCurrentSite()?.isOfflineDisabled(); try { await this.fetchData(); @@ -105,7 +102,7 @@ export class CoreCourseListModTypePage implements OnInit { return section.modules.length > 0; }); - const result = CoreCourseHelper.addHandlerDataForModules(sections, this.courseId); + const result = await CoreCourseHelper.addHandlerDataForModules(sections, this.courseId); this.sections = result.sections; } catch (error) { diff --git a/src/core/features/course/services/course-helper.ts b/src/core/features/course/services/course-helper.ts index 071faa626..cfde46f6f 100644 --- a/src/core/features/course/services/course-helper.ts +++ b/src/core/features/course/services/course-helper.ts @@ -168,58 +168,60 @@ export class CoreCourseHelperProvider { * @param forCoursePage Whether the data will be used to render the course page. * @return Whether the sections have content. */ - addHandlerDataForModules( + async addHandlerDataForModules( sections: CoreCourseWSSection[], courseId: number, completionStatus?: Record, courseName?: string, forCoursePage = false, - ): { hasContent: boolean; sections: CoreCourseSection[] } { + ): Promise<{ hasContent: boolean; sections: CoreCourseSection[] }> { let hasContent = false; - const formattedSections = sections.map((courseSection) => { - const section = { - ...courseSection, - hasContent: this.sectionHasContent(courseSection), - }; + const formattedSections = await Promise.all( + sections.map>(async (courseSection) => { + const section = { + ...courseSection, + hasContent: this.sectionHasContent(courseSection), + }; - if (!section.hasContent) { - return section; - } - - hasContent = true; - - section.modules.forEach(async (module) => { - module.handlerData = await CoreCourseModuleDelegate.getModuleDataFor( - module.modname, - module, - courseId, - section.id, - forCoursePage, - ); - - if (!module.completiondata && completionStatus && completionStatus[module.id] !== undefined) { - // Should not happen on > 3.6. Check if activity has completions and if it's marked. - const activityStatus = completionStatus[module.id]; - - module.completiondata = { - state: activityStatus.state, - timecompleted: activityStatus.timecompleted, - overrideby: activityStatus.overrideby || 0, - valueused: activityStatus.valueused, - tracking: activityStatus.tracking, - courseId, - cmid: module.id, - }; + if (!section.hasContent) { + return section; } - // Check if the module is stealth. - module.isStealth = module.visibleoncoursepage === 0 || (!!module.visible && !section.visible); - }); + hasContent = true; - return section; - }); + await Promise.all(section.modules.map(async (module) => { + module.handlerData = await CoreCourseModuleDelegate.getModuleDataFor( + module.modname, + module, + courseId, + section.id, + forCoursePage, + ); + + if (!module.completiondata && completionStatus && completionStatus[module.id] !== undefined) { + // Should not happen on > 3.6. Check if activity has completions and if it's marked. + const activityStatus = completionStatus[module.id]; + + module.completiondata = { + state: activityStatus.state, + timecompleted: activityStatus.timecompleted, + overrideby: activityStatus.overrideby || 0, + valueused: activityStatus.valueused, + tracking: activityStatus.tracking, + courseId, + cmid: module.id, + }; + } + + // Check if the module is stealth. + module.isStealth = module.visibleoncoursepage === 0 || (!!module.visible && !section.visible); + })); + + return section; + }), + ); return { hasContent, sections: formattedSections }; } diff --git a/src/core/features/course/services/format-delegate.ts b/src/core/features/course/services/format-delegate.ts index b2ecc2f13..295691a0e 100644 --- a/src/core/features/course/services/format-delegate.ts +++ b/src/core/features/course/services/format-delegate.ts @@ -58,8 +58,9 @@ export interface CoreCourseFormatHandler extends CoreDelegateHandler { displayBlocks?(course: CoreCourseAnyCourseData): boolean; /** - * Whether the option to enable section/module download should be displayed. Defaults to true. + * Whether the option to enable section/module download should be displayed. * + * @deprecated on 4.0 Not used anymore because prefetch has been moved to storage manager. * @param course The course to check. * @return Whether the option to enable section/module download should be displayed. */ @@ -204,16 +205,6 @@ export class CoreCourseFormatDelegateService extends CoreDelegate(course.format || '', 'displayBlocks', [course]); } - /** - * Whether the option to enable section/module download should be displayed. Defaults to true. - * - * @param course The course to check. - * @return Whether the option to enable section/module download should be displayed - */ - displayEnableDownload(course: CoreCourseAnyCourseData): boolean { - return !!this.executeFunctionOnEnabled(course.format || '', 'displayEnableDownload', [course]); - } - /** * Whether the course refresher should be displayed. If it returns false, a refresher must be included in the course format, * and the doRefresh method of CoreCourseSectionPage must be called on refresh. Defaults to true. diff --git a/src/core/features/course/services/handlers/default-format.ts b/src/core/features/course/services/handlers/default-format.ts index c84073a96..4ef53ca4b 100644 --- a/src/core/features/course/services/handlers/default-format.ts +++ b/src/core/features/course/services/handlers/default-format.ts @@ -78,17 +78,6 @@ export class CoreCourseFormatDefaultHandler implements CoreCourseFormatHandler { return true; } - /** - * Whether the option to enable section/module download should be displayed. Defaults to true. - * - * @param course The course to check. - * @return Whether the option to enable section/module download should be displayed - */ - // eslint-disable-next-line @typescript-eslint/no-unused-vars - displayEnableDownload(course: CoreCourseAnyCourseData): boolean { - return true; - } - /** * Whether the default section selector should be displayed. Defaults to true. * diff --git a/src/core/features/courses/pages/dashboard/dashboard.html b/src/core/features/courses/pages/dashboard/dashboard.html index ee5fb7421..4e704d5e8 100644 --- a/src/core/features/courses/pages/dashboard/dashboard.html +++ b/src/core/features/courses/pages/dashboard/dashboard.html @@ -23,7 +23,7 @@ - + diff --git a/src/core/features/sitehome/pages/index/index.html b/src/core/features/sitehome/pages/index/index.html index 9220391ae..62b96b90c 100644 --- a/src/core/features/sitehome/pages/index/index.html +++ b/src/core/features/sitehome/pages/index/index.html @@ -3,10 +3,10 @@ - + @@ -24,8 +24,7 @@ - + @@ -52,7 +51,7 @@ - + @@ -71,8 +70,7 @@ - + diff --git a/src/core/features/sitehome/pages/index/index.ts b/src/core/features/sitehome/pages/index/index.ts index 8e9a4d6e7..b28c7d648 100644 --- a/src/core/features/sitehome/pages/index/index.ts +++ b/src/core/features/sitehome/pages/index/index.ts @@ -21,7 +21,7 @@ import { CoreCourse, CoreCourseWSSection } from '@features/course/services/cours import { CoreDomUtils } from '@services/utils/dom'; import { CoreSites } from '@services/sites'; import { CoreSiteHome } from '@features/sitehome/services/sitehome'; -import { CoreCourses, CoreCoursesProvider } from '@features//courses/services/courses'; +import { CoreCourses } from '@features//courses/services/courses'; import { CoreEventObserver, CoreEvents } from '@singletons/events'; import { CoreCourseHelper, CoreCourseModuleData } from '@features/course/services/course-helper'; import { CoreCourseModuleDelegate } from '@features/course/services/module-delegate'; @@ -50,24 +50,15 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { siteHomeId = 1; currentSite!: CoreSite; searchEnabled = false; - displayEnableDownload = false; - downloadEnabled = false; newsForumModule?: CoreCourseModuleData; protected updateSiteObserver: CoreEventObserver; - protected downloadEnabledObserver: CoreEventObserver; constructor() { // Refresh the enabled flags if site is updated. this.updateSiteObserver = CoreEvents.on(CoreEvents.SITE_UPDATED, () => { this.searchEnabled = !CoreCourses.isSearchCoursesDisabledInSite(); - - this.displayEnableDownload = !CoreSites.getRequiredCurrentSite().isOfflineDisabled(); }, CoreSites.getCurrentSiteId()); - - this.downloadEnabledObserver = CoreEvents.on(CoreCoursesProvider.EVENT_DASHBOARD_DOWNLOAD_ENABLED_CHANGED, (data) => { - this.downloadEnabled = data.enabled; - }); } /** @@ -85,9 +76,6 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { CoreCourseHelper.openModule(module, this.siteHomeId, undefined, modParams); } - this.displayEnableDownload = !CoreSites.getRequiredCurrentSite().isOfflineDisabled(); - this.downloadEnabled = CoreCourses.getCourseDownloadOptionsEnabled(); - this.loadContent().finally(() => { this.dataLoaded = true; }); @@ -129,13 +117,15 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { // Check "Include a topic section" setting from numsections. this.section = config.numsections ? sections.find((section) => section.section == 1) : undefined; if (this.section) { - const result = CoreCourseHelper.addHandlerDataForModules( + const result = await CoreCourseHelper.addHandlerDataForModules( [this.section], this.siteHomeId, undefined, undefined, true, ); + + this.section.hasContent = result.hasContent; this.hasContent = result.hasContent || this.hasContent; } @@ -184,13 +174,6 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { }); } - /** - * Switch download enabled. - */ - switchDownload(): void { - CoreCourses.setCourseDownloadOptionsEnabled(this.downloadEnabled); - } - /** * Open page to manage courses storage. */ @@ -198,6 +181,13 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { CoreNavigator.navigateToSitePath('/storage'); } + /** + * Open page to manage course storage. + */ + manageCourseStorage(): void { + CoreNavigator.navigateToSitePath('/storage/' + this.siteHomeId); + } + /** * Go to search courses. */ @@ -231,7 +221,6 @@ export class CoreSiteHomeIndexPage implements OnInit, OnDestroy { */ ngOnDestroy(): void { this.updateSiteObserver.off(); - this.downloadEnabledObserver.off(); } } diff --git a/src/core/features/siteplugins/classes/handlers/course-format-handler.ts b/src/core/features/siteplugins/classes/handlers/course-format-handler.ts index 1878f6186..89cfaff07 100644 --- a/src/core/features/siteplugins/classes/handlers/course-format-handler.ts +++ b/src/core/features/siteplugins/classes/handlers/course-format-handler.ts @@ -35,13 +35,6 @@ export class CoreSitePluginsCourseFormatHandler extends CoreSitePluginsBaseHandl return this.handlerSchema.canviewallsections ?? true; } - /** - * @inheritdoc - */ - displayEnableDownload(): boolean { - return this.handlerSchema.displayenabledownload ?? true; - } - /** * @inheritdoc */ diff --git a/src/theme/theme.base.scss b/src/theme/theme.base.scss index ff09724da..c045c2469 100644 --- a/src/theme/theme.base.scss +++ b/src/theme/theme.base.scss @@ -213,6 +213,10 @@ ion-button.button-outline { --background: var(--contrast-background); } +ion-button ion-spinner { + --color: inherit !important; +} + @each $color-name, $value in $colors { .text-#{$color-name}, p.text-#{$color-name} { diff --git a/upgrade.txt b/upgrade.txt index b373c0db4..ddb9fc2c5 100644 --- a/upgrade.txt +++ b/upgrade.txt @@ -9,6 +9,7 @@ information provided here is intended especially for developers. - CoreCourseModulePrefetchDelegate.getPrefetchHandlerFor now admits module name instead of full module object. - CoreCourse.getModuleBasicInfoByInstance and CoreCourse.getModuleBasicInfo have been modified to accept an "options" parameter instead of only siteId. - The function CoreFilepool.isFileDownloadingByUrl now returns Promise instead of relying on resolve/reject. +- downloadEnabled input has been removed from CoreBlockSideBlocksComponent, CoreCourseFormatComponent, CoreCourseFormatSingleActivityComponent and CoreCourseModuleComponent. === 3.9.5 ===