From 852af8bc0ec096878e7aa2fe25fdaea9a6103a39 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pau=20Ferrer=20Oca=C3=B1a?= <crazyserver@gmail.com>
Date: Wed, 10 Aug 2022 11:43:55 +0200
Subject: [PATCH] MOBILE-4081 modicon: Fix modicon purpose

---
 .../addon-block-recentlyaccesseditems.html    |  2 +-
 .../services/recentlyaccesseditems.ts         |  3 +++
 .../events/addon-block-timeline-events.html   |  2 +-
 .../addon-calendar-upcoming-events.html       |  2 +-
 src/addons/calendar/pages/day/day.html        |  2 +-
 src/addons/calendar/pages/event/event.html    |  2 +-
 .../calendar/services/calendar-helper.ts      |  1 +
 src/addons/calendar/services/calendar.ts      |  2 ++
 src/core/components/mod-icon/mod-icon.ts      | 22 ++++++++++++-------
 9 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/src/addons/block/recentlyaccesseditems/components/recentlyaccesseditems/addon-block-recentlyaccesseditems.html b/src/addons/block/recentlyaccesseditems/components/recentlyaccesseditems/addon-block-recentlyaccesseditems.html
index bdab2ad19..2b185a878 100644
--- a/src/addons/block/recentlyaccesseditems/components/recentlyaccesseditems/addon-block-recentlyaccesseditems.html
+++ b/src/addons/block/recentlyaccesseditems/components/recentlyaccesseditems/addon-block-recentlyaccesseditems.html
@@ -16,7 +16,7 @@
                 <ion-card>
                     <ion-item class="core-course-module-handler ion-text-wrap" detail="false" (click)="action($event, item)" button>
                         <core-mod-icon slot="start" *ngIf="item.iconUrl" [modicon]="item.iconUrl" [modname]="item.modname"
-                            [componentId]="item.cmid" [showAlt]="false">
+                            [componentId]="item.cmid" [showAlt]="false" [purpose]="item.purpose">
                         </core-mod-icon>
                         <ion-label>
                             <!-- Add the icon title so accessibility tools read it. -->
diff --git a/src/addons/block/recentlyaccesseditems/services/recentlyaccesseditems.ts b/src/addons/block/recentlyaccesseditems/services/recentlyaccesseditems.ts
index 1a1c3c65b..de78e4ea6 100644
--- a/src/addons/block/recentlyaccesseditems/services/recentlyaccesseditems.ts
+++ b/src/addons/block/recentlyaccesseditems/services/recentlyaccesseditems.ts
@@ -103,6 +103,8 @@ export const AddonBlockRecentlyAccessedItems = makeSingleton(AddonBlockRecentlyA
 
 /**
  * Result of WS block_recentlyaccesseditems_get_recent_items.
+ *
+ * The most recently accessed activities/resources by the logged user.
  */
 export type AddonBlockRecentlyAccessedItemsItem = {
     id: number; // Id.
@@ -116,6 +118,7 @@ export type AddonBlockRecentlyAccessedItemsItem = {
     viewurl: string; // Viewurl.
     courseviewurl: string; // Courseviewurl.
     icon: string; // Icon.
+    purpose?: string; // Purpose. @since 4.0
 } & AddonBlockRecentlyAccessedItemsItemCalculatedData;
 
 /**
diff --git a/src/addons/block/timeline/components/events/addon-block-timeline-events.html b/src/addons/block/timeline/components/events/addon-block-timeline-events.html
index 4ce38eaa3..3aab6a77b 100644
--- a/src/addons/block/timeline/components/events/addon-block-timeline-events.html
+++ b/src/addons/block/timeline/components/events/addon-block-timeline-events.html
@@ -23,7 +23,7 @@
                             <ion-col class="addon-block-timeline-activity-time ion-no-padding">
                                 <small>{{event.timesort * 1000 | coreFormatDate:"strftimetime24" }}</small>
                                 <core-mod-icon *ngIf="event.iconUrl" [modicon]="event.iconUrl" [componentId]="event.instance"
-                                    [modname]="event.modulename">
+                                    [modname]="event.modulename" [purpose]="event.purpose">
                                 </core-mod-icon>
                             </ion-col>
                             <ion-col class="addon-block-timeline-activity-name ion-no-padding">
diff --git a/src/addons/calendar/components/upcoming-events/addon-calendar-upcoming-events.html b/src/addons/calendar/components/upcoming-events/addon-calendar-upcoming-events.html
index ef63f7816..701ee61b4 100644
--- a/src/addons/calendar/components/upcoming-events/addon-calendar-upcoming-events.html
+++ b/src/addons/calendar/components/upcoming-events/addon-calendar-upcoming-events.html
@@ -8,7 +8,7 @@
                 <ion-item class="ion-text-wrap addon-calendar-event" [attr.aria-label]="event.name" (click)="eventClicked(event)" button
                     [ngClass]="['addon-calendar-eventtype-'+event.eventtype]" [detail]="false">
                     <core-mod-icon *ngIf="event.moduleIcon" [modicon]="event.moduleIcon" slot="start" [modname]="event.modulename"
-                        [componentId]="event.instance" [showAlt]="false"></core-mod-icon>
+                        [componentId]="event.instance" [showAlt]="false" [purpose]="event.purpose"></core-mod-icon>
                     <ion-icon *ngIf="event.eventIcon && !event.moduleIcon" [name]="event.eventIcon" slot="start" aria-hidden="true">
                     </ion-icon>
                     <ion-label>
diff --git a/src/addons/calendar/pages/day/day.html b/src/addons/calendar/pages/day/day.html
index e126fbfc2..1abcf2c16 100644
--- a/src/addons/calendar/pages/day/day.html
+++ b/src/addons/calendar/pages/day/day.html
@@ -70,7 +70,7 @@
                                         (click)="gotoEvent(event.id, day)" [class.item-dimmed]="event.ispast"
                                         [ngClass]="['addon-calendar-eventtype-'+event.eventtype]" button [detail]="false">
                                         <core-mod-icon *ngIf="event.moduleIcon" [modicon]="event.moduleIcon" slot="start" [showAlt]="false"
-                                            [modname]="event.modulename" [componentId]="event.instance">
+                                            [modname]="event.modulename" [componentId]="event.instance" [purpose]="event.purpose">
                                         </core-mod-icon>
                                         <ion-icon *ngIf="event.eventIcon && !event.moduleIcon" [name]="event.eventIcon" slot="start"
                                             aria-hidden="true">
diff --git a/src/addons/calendar/pages/event/event.html b/src/addons/calendar/pages/event/event.html
index 5180e04a9..1a7587712 100644
--- a/src/addons/calendar/pages/event/event.html
+++ b/src/addons/calendar/pages/event/event.html
@@ -42,7 +42,7 @@
         <ion-list *ngIf="event">
             <ion-item class="ion-text-wrap addon-calendar-event" collapsible [ngClass]="['addon-calendar-eventtype-'+event.eventtype]">
                 <core-mod-icon *ngIf="event.moduleIcon" [modicon]="event.moduleIcon" [showAlt]="false" [modname]="event.modulename"
-                    [componentId]="event.instance" slot="start"></core-mod-icon>
+                    [componentId]="event.instance" slot="start" [purpose]="event.purpose"></core-mod-icon>
                 <ion-icon *ngIf=" event.eventIcon && !event.moduleIcon" [name]="event.eventIcon" aria-hidden="true" slot="start">
                 </ion-icon>
                 <ion-label>
diff --git a/src/addons/calendar/services/calendar-helper.ts b/src/addons/calendar/services/calendar-helper.ts
index 8e263037d..95366cf1a 100644
--- a/src/addons/calendar/services/calendar-helper.ts
+++ b/src/addons/calendar/services/calendar-helper.ts
@@ -178,6 +178,7 @@ export class AddonCalendarHelperProvider {
             format: 1,
             visible: 1,
             offline: false,
+            purpose: 'purpose' in event ? event.purpose : undefined,
         };
 
         if (event.modulename) {
diff --git a/src/addons/calendar/services/calendar.ts b/src/addons/calendar/services/calendar.ts
index dc5c47d18..155861284 100644
--- a/src/addons/calendar/services/calendar.ts
+++ b/src/addons/calendar/services/calendar.ts
@@ -1949,6 +1949,7 @@ export type AddonCalendarEventBase = {
  */
 export type AddonCalendarEvent = AddonCalendarEventBase & {
     url: string; // Url.
+    purpose?: string; // Purpose. @since 4.0
     action?: {
         name: string; // Name.
         url: string; // Url.
@@ -2302,6 +2303,7 @@ export type AddonCalendarEventToDisplay = Partial<AddonCalendarCalendarEvent> &
     ispast?: boolean; // Calculated in the app. Whether the event is in the past.
     contextLevel?: ContextLevel;
     contextInstanceId?: number;
+    purpose?: string; // Purpose. @since 4.0
 };
 
 /**
diff --git a/src/core/components/mod-icon/mod-icon.ts b/src/core/components/mod-icon/mod-icon.ts
index f0362138b..f2e59c7d7 100644
--- a/src/core/components/mod-icon/mod-icon.ts
+++ b/src/core/components/mod-icon/mod-icon.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { CoreConstants } from '@/core/constants';
+import { CoreConstants, ModPurpose } from '@/core/constants';
 import { Component, ElementRef, Input, OnChanges, OnInit, SimpleChange } from '@angular/core';
 import { CoreCourse } from '@features/course/services/course';
 import { CoreCourseModuleDelegate } from '@features/course/services/module-delegate';
@@ -31,10 +31,11 @@ const fallbackModName = 'external-tool';
 })
 export class CoreModIconComponent implements OnInit, OnChanges {
 
-    @Input() modname?; // The module name. Used also as component if set.
-    @Input() componentId?; // Component Id for external icons.
+    @Input() modname?: string; // The module name. Used also as component if set.
+    @Input() componentId?: number; // Component Id for external icons.
     @Input() modicon?: string; // Module icon url or local url.
     @Input() showAlt = true; // Show alt otherwise it's only presentation icon.
+    @Input() purpose: ModPurpose = ModPurpose.MOD_PURPOSE_OTHER; // Purpose of the module.
 
     icon = '';
     modNameTranslated = '';
@@ -62,10 +63,15 @@ export class CoreModIconComponent implements OnInit, OnChanges {
         this.modNameTranslated = this.modname ? CoreCourse.translateModuleName(this.modname) || '' : '';
         if (CoreSites.getCurrentSite()?.isVersionGreaterEqualThan('4.0')) {
             this.legacyIcon = false;
-            const purposeClass =
-                CoreCourseModuleDelegate.supportsFeature<string>(this.modname, CoreConstants.FEATURE_MOD_PURPOSE, '');
 
-            if (purposeClass != '') {
+            const purposeClass =
+                CoreCourseModuleDelegate.supportsFeature<ModPurpose>(
+                    this.modname || '',
+                    CoreConstants.FEATURE_MOD_PURPOSE,
+                    this.purpose,
+                );
+
+            if (purposeClass) {
                 const element: HTMLElement = this.el.nativeElement;
                 element.classList.add(purposeClass);
             }
@@ -94,8 +100,8 @@ export class CoreModIconComponent implements OnInit, OnChanges {
         // If modname is not set icon won't be cached.
         // Also if the url matches the regexp (the theme will manage the image so it's not cached).
         this.linkIconWithComponent =
-            this.modname &&
-            this.componentId &&
+            !!this.modname &&
+            !!this.componentId &&
             !this.isLocalUrl &&
             !this.icon.match('/theme/image.php/[^/]+/' + this.modname + '/[-0-9]*/');
     }