MOBILE-3890 mod: Get module forced lang

Author: crazyserver

src/addons/mod/assign/services/assign.ts

@@ -46,7 +46,7 @@ import {
     AddonModAssignSubmissionStatusValues,
 } from '../constants';
 import { CoreTextFormat } from '@singletons/text';
-import { CoreCourseModuleHelper } from '@features/course/services/course-module-helper';
+import { CoreCourseModuleHelper, CoreCourseModuleStandardElements } from '@features/course/services/course-module-helper';
 import { CoreUserDescriptionExporter } from '@features/user/services/user';
 
 declare module '@singletons/events' {
@@ -1460,12 +1460,12 @@ export type AddonModAssignSubmissionStatusOptions = CoreCourseCommonModWSOptions
 
 /**
  * Assign data returned by mod_assign_get_assignments.
+ * We're using Omit to exclude properties because type is not consistent with the rest of the WS but
+ * it should be.
  */
-export type AddonModAssignAssign = {
-    id: number; // Assignment id.
+export type AddonModAssignAssign =
+    Omit<CoreCourseModuleStandardElements, 'coursemodule'|'section'|'visible'|'groupmode'|'groupingid'|'lang'> & {
     cmid: number; // Course module id.
-    course: number; // Course id.
-    name: string; // Assignment name.
     nosubmissions: number; // No submissions.
     submissiondrafts: number; // Submissions drafts.
     sendnotifications: number; // Send notifications.
@@ -1493,9 +1493,6 @@ export type AddonModAssignAssign = {
     submissionstatement?: string; // Submission statement formatted.
     submissionstatementformat?: CoreTextFormat; // Submissionstatement format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
     configs: AddonModAssignConfig[]; // Configuration settings.
-    intro?: string; // Assignment intro, not allways returned because it deppends on the activity configuration.
-    introformat?: CoreTextFormat; // Intro format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
-    introfiles?: CoreWSExternalFile[];
     introattachments?: CoreWSExternalFile[];
     activity?: string; // @since 4.0. Description of activity.
     activityformat?: CoreTextFormat; // @since 4.0. Format of activity.

src/addons/mod/bigbluebuttonbn/services/handlers/module.ts

@@ -21,6 +21,7 @@ import { makeSingleton } from '@singletons';
 import { AddonModBBB } from '../bigbluebuttonbn';
 import { ADDON_MOD_BBB_COMPONENT, ADDON_MOD_BBB_MODNAME, ADDON_MOD_BBB_PAGE_NAME } from '../../constants';
 import { ModFeature, ModPurpose } from '@addons/mod/constants';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support Big Blue Button activities.
@@ -103,6 +104,19 @@ export class AddonModBBBModuleHandlerService extends CoreModuleHandlerBase imple
         return AddonModBBBIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModBBB.getBBB(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 
 export const AddonModBBBModuleHandler = makeSingleton(AddonModBBBModuleHandlerService);

src/addons/mod/book/services/handlers/module.ts

@@ -19,6 +19,8 @@ import { makeSingleton } from '@singletons';
 import { CoreModuleHandlerBase } from '@features/course/classes/module-base-handler';
 import { ADDON_MOD_BOOK_COMPONENT, ADDON_MOD_BOOK_MODNAME, ADDON_MOD_BOOK_PAGE_NAME } from '../../constants';
 import { ModFeature, ModArchetype, ModPurpose } from '@addons/mod/constants';
+import { CoreCourseModuleData } from '@features/course/services/course-helper';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support book modules.
@@ -59,5 +61,18 @@ export class AddonModBookModuleHandlerService extends CoreModuleHandlerBase impl
         return AddonModBookIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModBook.getBook(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 export const AddonModBookModuleHandler = makeSingleton(AddonModBookModuleHandlerService);

src/addons/mod/chat/services/handlers/module.ts

@@ -18,6 +18,9 @@ import { CoreCourseModuleHandler } from '@features/course/services/module-delega
 import { makeSingleton } from '@singletons';
 import { ADDON_MOD_CHAT_MODNAME, ADDON_MOD_CHAT_PAGE_NAME } from '../../constants';
 import { ModFeature, ModPurpose } from '@addons/mod/constants';
+import { AddonModChat } from '../chat';
+import { CoreCourseModuleData } from '@features/course/services/course-helper';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support chat modules.
@@ -50,6 +53,19 @@ export class AddonModChatModuleHandlerService extends CoreModuleHandlerBase impl
         return AddonModChatIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModChat.getChat(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 
 export const AddonModChatModuleHandler = makeSingleton(AddonModChatModuleHandlerService);

src/addons/mod/choice/services/handlers/module.ts

@@ -18,6 +18,9 @@ import { CoreCourseModuleHandler } from '@features/course/services/module-delega
 import { makeSingleton } from '@singletons';
 import { ADDON_MOD_CHOICE_MODNAME, ADDON_MOD_CHOICE_PAGE_NAME } from '../../constants';
 import { ModFeature, ModPurpose } from '@addons/mod/constants';
+import { AddonModChoice } from '../choice';
+import { CoreCourseModuleData } from '@features/course/services/course-helper';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support choice modules.
@@ -51,6 +54,19 @@ export class AddonModChoiceModuleHandlerService extends CoreModuleHandlerBase im
         return AddonModChoiceIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModChoice.getChoice(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 
 export const AddonModChoiceModuleHandler = makeSingleton(AddonModChoiceModuleHandlerService);

src/addons/mod/data/services/handlers/module.ts

@@ -18,6 +18,9 @@ import { CoreCourseModuleHandler } from '@features/course/services/module-delega
 import { makeSingleton } from '@singletons';
 import { ADDON_MOD_DATA_COMPONENT, ADDON_MOD_DATA_MODNAME, ADDON_MOD_DATA_PAGE_NAME } from '../../constants';
 import { ModFeature, ModPurpose } from '@addons/mod/constants';
+import { AddonModData } from '../data';
+import { CoreCourseModuleData } from '@features/course/services/course-helper';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support data modules.
@@ -53,5 +56,18 @@ export class AddonModDataModuleHandlerService extends CoreModuleHandlerBase impl
         return AddonModDataIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModData.getDatabase(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 export const AddonModDataModuleHandler = makeSingleton(AddonModDataModuleHandlerService);

src/addons/mod/feedback/services/handlers/module.ts

@@ -18,6 +18,9 @@ import { makeSingleton } from '@singletons';
 import { CoreModuleHandlerBase } from '@features/course/classes/module-base-handler';
 import { ADDON_MOD_FEEDBACK_MODNAME, ADDON_MOD_FEEDBACK_PAGE_NAME } from '../../constants';
 import { ModFeature, ModPurpose } from '@addons/mod/constants';
+import { AddonModFeedback } from '../feedback';
+import { CoreCourseModuleData } from '@features/course/services/course-helper';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support feedback modules.
@@ -51,6 +54,19 @@ export class AddonModFeedbackModuleHandlerService extends CoreModuleHandlerBase
         return AddonModFeedbackIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModFeedback.getFeedback(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 
 export const AddonModFeedbackModuleHandler = makeSingleton(AddonModFeedbackModuleHandlerService);

src/addons/mod/folder/services/handlers/module.ts

@@ -21,6 +21,8 @@ import { convertTextToHTMLElement } from '@/core/utils/create-html-element';
 import { makeSingleton } from '@singletons';
 import { ADDON_MOD_FOLDER_MODNAME, ADDON_MOD_FOLDER_PAGE_NAME } from '../../constants';
 import { ModFeature, ModArchetype, ModPurpose } from '@addons/mod/constants';
+import { AddonModFolder } from '../folder';
+import { CoreSitesReadingStrategy } from '@services/sites';
 
 /**
  * Handler to support folder modules.
@@ -89,5 +91,18 @@ export class AddonModFolderModuleHandlerService extends CoreModuleHandlerBase im
         return AddonModFolderIndexComponent;
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModFolder.getFolder(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 export const AddonModFolderModuleHandler = makeSingleton(AddonModFolderModuleHandlerService);

src/addons/mod/forum/services/forum.ts

@@ -53,7 +53,7 @@ import { CorePromiseUtils } from '@singletons/promise-utils';
 import { CoreWSError } from '@classes/errors/wserror';
 import { CoreObject } from '@singletons/object';
 import { CoreTextFormat } from '@singletons/text';
-import { CoreCourseModuleHelper } from '@features/course/services/course-module-helper';
+import { CoreCourseModuleHelper, CoreCourseModuleStandardElements } from '@features/course/services/course-module-helper';
 import { CoreUserPreferences } from '@features/user/services/user-preferences';
 
 declare module '@singletons/events' {
@@ -1375,15 +1375,12 @@ type AddonModForumGetForumsByCoursesWSParams = {
 
 /**
  * General forum activity data.
+ * We're using Omit to exclude properties because type is not consistent with the rest of the WS but
+ * it should be.
  */
-export type AddonModForumData = {
-    id: number; // Forum id.
-    course: number; // Course id.
+export type AddonModForumData =
+    Omit<CoreCourseModuleStandardElements, 'coursemodule'|'section'|'visible'|'groupmode'|'groupingid'> & {
     type: AddonModForumType; // The forum type.
-    name: string; // Forum name.
-    intro: string; // The forum intro.
-    introformat: CoreTextFormat; // Intro format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
-    introfiles?: CoreWSExternalFile[];
     duedate?: number; // Duedate for the user.
     cutoffdate?: number; // Cutoffdate for the user.
     assessed: number; // Aggregate type.

src/addons/mod/forum/services/handlers/module.ts

@@ -180,6 +180,19 @@ export class AddonModForumModuleHandlerService extends CoreModuleHandlerBase imp
         return super.getOverviewItemContent(item, activity, courseId);
     }
 
+    /**
+     * @inheritdoc
+     */
+    async getModuleForcedLang(module: CoreCourseModuleData): Promise<string | undefined> {
+        const mod = await AddonModForum.getForum(
+            module.course,
+            module.id,
+            { readingStrategy: CoreSitesReadingStrategy.PREFER_CACHE },
+        );
+
+        return mod?.lang;
+    }
+
 }
 
 export const AddonModForumModuleHandler = makeSingleton(AddonModForumModuleHandlerService);