Merge pull request #4632 from crazyserver/MOBILE-3890

MOBILE-3890: Support course forced language in the app interface

Author: dpalou

UPGRADE.md

@@ -6,6 +6,7 @@ For more information about upgrading, read the official documentation: https://m
 =====
 
  - The core-files component now treats the `files` input array as immutable to simplify the change detection strategy and improve performance. To trigger an update, you must provide a new array reference (e.g. using `concat()` or the spread operator) rather than mutating the existing one with `push()` or `splice()`.
+ - CoreCourses.getCoursesByField and CoreCourses.getCourseByField now accepts CoreSitesCommonWSOptions, direct usage of siteId has been deprecated.
 
 5.1.0
 =====

src/addons/badges/badges.module.ts

@@ -28,6 +28,7 @@ import { CoreTagAreaDelegate } from '@features/tag/services/tag-area-delegate';
 import { AddonBadgesTagAreaHandler } from './services/handlers/tag-area';
 import { conditionalRoutes } from '@/app/app-routing.module';
 import { CoreScreen } from '@services/screen';
+import { CoreCourseForceLanguageSource } from '@features/course/constants';
 
 /**
  * Get badges services.
@@ -47,11 +48,12 @@ const mobileRoutes: Routes = [
         path: '',
         pathMatch: 'full',
         loadComponent: () => import('./pages/user-badges/user-badges'),
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
     {
         path: ':badgeHash',
         loadComponent: () => import('./pages/issued-badge/issued-badge'),
-        data: { usesSwipeNavigation: true },
+        data: { usesSwipeNavigation: true, checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
 ];
 
@@ -66,6 +68,7 @@ const tabletRoutes: Routes = [
                 data: { usesSwipeNavigation: true },
             },
         ],
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
 ];
 

src/addons/blog/blog.module.ts

@@ -33,11 +33,13 @@ import { CORE_SITE_SCHEMAS } from '@services/sites';
 import { BLOG_OFFLINE_SITE_SCHEMA } from './services/database/blog';
 import { CoreCronDelegate } from '@services/cron';
 import { AddonBlogSyncCronHandler } from './services/handlers/sync-cron';
+import { CoreCourseForceLanguageSource } from '@features/course/constants';
 
 const routes: Routes = [
     {
         path: ADDON_BLOG_MAINMENU_PAGE_NAME,
         loadChildren: () => import('@addons/blog/blog-lazy.module'),
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
 ];
 

src/addons/competency/competency.module.ts

@@ -28,7 +28,7 @@ import { Routes } from '@angular/router';
 import { CoreMainMenuTabRoutingModule } from '@features/mainmenu/mainmenu-tab-routing.module';
 import { CoreCourseIndexRoutingModule } from '@features/course/course-routing.module';
 import { PARTICIPANTS_PAGE_NAME } from '@features/user/constants';
-import { CORE_COURSE_PAGE_NAME } from '@features/course/constants';
+import { CORE_COURSE_PAGE_NAME, CoreCourseForceLanguageSource } from '@features/course/constants';
 import {
     ADDON_COMPETENCY_LEARNING_PLANS_PAGE,
     ADDON_COMPETENCY_COMPETENCIES_PAGE,
@@ -155,10 +155,12 @@ const mainMenuChildrenRoutes: Routes = [
     {
         path: `${CORE_COURSE_PAGE_NAME}/:courseId/${ADDON_COMPETENCY_COMPETENCIES_PAGE}`,
         loadChildren: () => getCompetencyCourseDetailsRoutes(),
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
     {
         path: `${CORE_COURSE_PAGE_NAME}/:courseId/${PARTICIPANTS_PAGE_NAME}/:userId/${ADDON_COMPETENCY_COMPETENCIES_PAGE}`,
         loadChildren: () => getCompetencyCourseDetailsRoutes(),
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
 ];
 

src/addons/coursecompletion/coursecompletion.module.ts

@@ -22,6 +22,7 @@ import { CoreUserDelegate } from '@features/user/services/user-delegate';
 import { AddonCourseCompletionStatusLinkHandler } from './services/handlers/completionstatus-link';
 import { AddonCourseCompletionCourseOptionHandler } from './services/handlers/course-option';
 import { AddonCourseCompletionUserHandler } from './services/handlers/user';
+import { CoreCourseForceLanguageSource } from '@features/course/constants';
 
 /**
  * Get course completion services.
@@ -40,6 +41,7 @@ const routes: Routes = [
     {
         path: 'coursecompletion',
         loadComponent: () => import('./pages/report/report'),
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.COURSE },
     },
 ];
 

src/addons/filter/mathjaxloader/services/handlers/mathjaxloader.ts

@@ -67,7 +67,7 @@ export class AddonFilterMathJaxLoaderHandlerService extends CoreFilterDefaultHan
 
         await this.window.MathJax?.startup.promise;
 
-        // @todo: Once MathJax supports locale, set current language and listen for CoreEvents.LANGUAGE_CHANGED events.
+        // @todo: Once MathJax supports locale, set current language and listen for Translate.onLangChange events.
     }
 
     /**
@@ -164,6 +164,8 @@ export class AddonFilterMathJaxLoaderHandlerService extends CoreFilterDefaultHan
 
     /**
      * Called by the filter when an equation is found while rendering the content.
+     *
+     * @param container The container element.
      */
     protected async typeset(container: HTMLElement): Promise<void> {
         const equations = Array.from(container.getElementsByClassName('filter_mathjaxloader_equation'));

src/addons/mod/assign/assign.module.ts

@@ -35,6 +35,7 @@ import { ADDON_MOD_ASSIGN_COMPONENT_LEGACY, ADDON_MOD_ASSIGN_PAGE_NAME } from '.
 import { conditionalRoutes } from '@/app/app-routing.module';
 import { canLeaveGuard } from '@guards/can-leave';
 import { CoreScreen } from '@services/screen';
+import { CoreCourseForceLanguageSource } from '@features/course/constants';
 
 /**
  * Get mod assign services.
@@ -121,6 +122,7 @@ const routes: Routes = [
             ...conditionalRoutes(mobileRoutes, () => CoreScreen.isMobile),
             ...conditionalRoutes(tabletRoutes, () => CoreScreen.isTablet),
         ],
+        data: { checkForcedLanguage: CoreCourseForceLanguageSource.MODULE },
     },
 ];
 

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

@@ -46,7 +46,7 @@ import {
     AddonModAssignSubmissionStatusValues,
 } from '../constants';
 import { CoreTextFormat } from '@static/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 '@static/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/assign/services/handlers/prefetch.ts

@@ -256,7 +256,7 @@ export class AddonModAssignPrefetchHandlerService extends CoreCourseActivityPref
 
         promises.push(CoreCourse.getModuleBasicInfoByInstance(assign.id, ADDON_MOD_ASSIGN_MODNAME, { siteId }));
         // Get course data, needed to determine upload max size if it's configured to be course limit.
-        promises.push(CorePromiseUtils.ignoreErrors(CoreCourses.getCourseByField('id', courseId, siteId)));
+        promises.push(CorePromiseUtils.ignoreErrors(CoreCourses.getCourseByField('id', courseId, { siteId })));
 
         // Download intro files and attachments. Do not call getFiles because it'd call some WS twice.
         let files: CoreWSFile[] = assign.introattachments || [];

src/addons/mod/assign/tests/behat/force_language.feature

@@ -0,0 +1,31 @@
+@app_parallel_run_assign @addon_mod_assign @app @mod @mod_assign @javascript @forced_language
+
+Feature: Forced activity language is applied in the app
+  In order to ensure users see the activity in the correct language
+  As a user
+  I want the app to apply the forced activity language when set
+
+  Background:
+    Given the following "courses" exist:
+      | fullname   | shortname | lang |
+      | Course 1   | C1        | es   |
+    And the following "activities" exist:
+      | activity        | name                   | intro | course   | lang |
+      | assign          | Test assignment name   | -     | C1       | ca   |
+    And the following "users" exist:
+      | username | firstname | lastname |
+      | student  | Student   | 1        |
+    And the following "course enrolments" exist:
+      | user    | course     | role           |
+      | student | C1         | student        |
+    And the following "language pack" exists:
+      | language | es | ca |
+
+  Scenario: Forced course and module language is applied when entering a course or activity
+    Given I entered the course "Course 1" as "student" in the app
+    Then I should find "Curso" in the app
+
+    # Assignment does not have any force language support in the app.
+    # Until MDL-87241 is solved, the fallback will be the course language.
+    When I press "Test assignment name" in the app
+    Then I should find "Estado de la entrega" in the app