2

Author: crazyserver

src/core/features/user/services/user-helper.ts

@@ -17,7 +17,7 @@ import { CoreNavigator } from '@services/navigator';
 import { CoreSites } from '@services/sites';
 
 import { makeSingleton, Translate } from '@singletons';
-import { CoreUser, CoreUserProfile, CoreUserRole } from './user';
+import { CoreUser, CoreUserBasicData, CoreUserProfile, CoreUserRole } from './user';
 import { CoreTime } from '@singletons/time';
 
 /**
@@ -90,24 +90,8 @@ export class CoreUserHelperProvider {
      *
      * @param user User object.
      * @returns User initials.
-     * @deprecated since 4.4. Use getUserInitialsFromParts instead.
      */
     getUserInitials(user: Partial<CoreUserProfile>): string {
-        if (!user.firstname && !user.lastname) {
-            // @TODO: Use local info or check WS to get initials from.
-            return '';
-        }
-
-        return (user.firstname?.charAt(0) || '') + (user.lastname?.charAt(0) || '');
-    }
-
-    /**
-     * Get the user initials.
-     *
-     * @param parts User name parts. Containing firstname, lastname, fullname and userId.
-     * @returns User initials.
-     */
-    async getUserInitialsFromParts(parts: CoreUserNameParts): Promise<string> {
         const nameFields = ['firstname', 'lastname'];
         const dummyUser = {
             firstname: 'firstname',
@@ -118,28 +102,30 @@ export class CoreUserHelperProvider {
             .filter((field) => nameFormat.indexOf(field) >= 0)
             .sort((a, b) => nameFormat.indexOf(a) - nameFormat.indexOf(b));
 
-        if (!parts.firstname && !parts.lastname) {
-            if (!parts.fullname && parts.userId) {
-                const user = await CoreUser.getProfile(parts.userId, undefined, true);
-                parts.fullname = user.fullname || '';
-            }
-
-            if (parts.fullname) {
-                // It's a complete workaround.
-                const split = parts.fullname.split(' ');
-                parts.firstname = split[0];
-                if (split.length > 1) {
-                    parts.lastname = split[split.length - 1];
-                }
-            }
-        }
-
         const initials = availableFieldsSorted.reduce((initials, fieldName) =>
-            initials + (parts[fieldName]?.charAt(0) ?? ''), '');
+            initials + (user[fieldName]?.charAt(0) ?? ''), '');
 
         return initials || 'UNK';
     }
 
+    /**
+     * Get the user initials.
+     *
+     * @param parts User name parts. Containing firstname, lastname, fullname and userId.
+     * @returns User initials.
+     */
+    async getUserInitialsFromParts(parts: CoreUserNameParts): Promise<string> {
+        const initials = this.getUserInitials(parts);
+        if (initials !== 'UNK' || !parts.userId) {
+            return initials;
+        }
+        const user = await CoreUser.getProfile(parts.userId, undefined, false);
+        console.error(user, parts.userId);
+
+        return user.initials || 'UNK';
+
+    }
+
     /**
      * Translates legacy timezone names.
      *
@@ -151,8 +137,52 @@ export class CoreUserHelperProvider {
         return CoreTime.translateLegacyTimezone(tz);
     }
 
+    normalizeBasicFields<T extends CoreUserBasicData = CoreUserBasicData>(profile: CoreUserDenormalized): T {
+        let normalized = {
+            id: profile.id ?? profile.userid ?? 0,
+            fullname:  profile.fullname ?? profile.userfullname ?? '',
+            profileimageurl: profile.profileimageurl ?? profile.userprofileimageurl ??
+                profile.userpictureurl ?? profile.profileimageurlsmall ?? profile.urls?.profileimage ?? '',
+        } as T;
+
+        delete profile.userid;
+        delete profile.userfullname;
+        delete profile.userpictureurl;
+        delete profile.userprofileimageurl;
+        delete profile.profileimageurlsmall;
+        delete profile.urls;
+
+        normalized = { ...profile, ...normalized };
+
+        if (normalized.id === 0) {
+            throw new Error('Invalid user ID');
+        }
+
+        normalized.initials = CoreUserHelper.getUserInitials(profile);
+
+        return normalized;
+    }
+
 }
 
 export const CoreUserHelper = makeSingleton(CoreUserHelperProvider);
 
 type CoreUserNameParts = { firstname?: string; lastname?: string; fullname?: string; userId?: number };
+
+type CoreUserDenormalized = CoreUserBasicData & {
+    id?: number;
+    userid?: number;
+
+    initials?: string; // Initials.
+
+    fullname?: string;
+    userfullname?: string;
+
+    profileimageurl?: string;
+    userpictureurl?: string;
+    userprofileimageurl?: string;
+    profileimageurlsmall?: string;
+    urls?: {
+        profileimage?: string;
+    };
+};

src/core/features/user/services/user.ts

@@ -33,6 +33,7 @@ import { CorePromiseUtils } from '@singletons/promise-utils';
 import { CoreTextFormat } from '@singletons/text';
 import { CORE_USER_PROFILE_REFRESHED, CORE_USER_PROFILE_PICTURE_UPDATED, CORE_USER_PARTICIPANTS_LIST_LIMIT } from '../constants';
 import { CoreStoredCache } from '@classes/stored-cache';
+import { CoreUserHelper } from './user-helper';
 
 declare module '@singletons/events' {
 
@@ -349,7 +350,7 @@ export class CoreUserProvider {
         let users: CoreUserDescriptionExporter[] | CoreUserCourseProfile[] | undefined;
 
         // Determine WS and data to use.
-        if (courseId && courseId != site.getSiteHomeId()) {
+        if (courseId && courseId !== site.getSiteHomeId()) {
             this.logger.debug(`Get participant with ID '${userId}' in course '${courseId}`);
 
             const params: CoreUserGetCourseUserProfilesWSParams = {
@@ -362,6 +363,7 @@ export class CoreUserProvider {
             };
 
             users = await site.read<CoreUserGetCourseUserProfilesWSResponse>('core_user_get_course_user_profiles', params, preSets);
+            console.error('core_user_get_course_user_profiles', users);
         } else {
             this.logger.debug(`Get user with ID '${userId}'`);
 
@@ -371,15 +373,16 @@ export class CoreUserProvider {
             };
 
             users = await site.read<CoreUserGetUsersByFieldWSResponse>('core_user_get_users_by_field', params, preSets);
+            console.error('core_user_get_users_by_field', users);
         }
 
         if (users.length === 0) {
             // Shouldn't happen.
             throw new CoreError('Cannot retrieve user info.');
         }
 
-        const user = users[0];
-        if ('country' in user && user.country) {
+        const user = CoreUserHelper.normalizeBasicFields<CoreUserData | CoreUserCourseProfile>(users[0]);
+        if (user.country) {
             user.country = CoreCountries.getCountryName(user.country);
         }
 
@@ -725,6 +728,7 @@ export class CoreUserProvider {
             initials: user.initials,
         };
 
+        console.error(userRecord);
 
         await this.userCache.setEntry(user.id, userRecord, siteId);
     }
@@ -854,10 +858,9 @@ export type CoreUserProfilePictureUpdatedData = {
 export type CoreUserBasicData = {
     id: number; // ID of the user.
     fullname: string; // The fullname of the user.
-    profileimageurl: string; // User image profile URL - big version.
+    profileimageurl?: string; // User image profile URL - big version.
     firstname?: string; // The first name(s) of the user.
     lastname?: string; // The family name of the user.
-    lastaccess?: number;
     initials?: string; // Initials.
 };
 
@@ -911,6 +914,33 @@ export type CoreUserEnrolledCourse = {
     shortname: string; // Shortname of the course.
 };
 
+export type CoreUserNormalized = {
+    id: number; // ID of the user.
+    fullname: string; // The fullname of the user.
+    profileimageurl: string; // User image profile URL - big version.
+    username?: string; // The username.
+    firstname?: string; // The first name(s) of the user.
+    lastname?: string; // The family name of the user.
+    initials?: string; // Initials, added by the app.
+    email?: string; // An email address - allow email as root@localhost.
+    address?: string; // Postal address.
+    phone1?: string; // Phone 1.
+    phone2?: string; // Phone 2.
+    department?: string; // Department.
+    idnumber?: string; // An arbitrary ID code number perhaps from the institution.
+    interests?: string; // User interests (separated by commas).
+    firstaccess?: number; // First access to the site (0 if never).
+    lastaccess?: number; // Last access to the site (0 if never).
+    timezone?: string; // Timezone code such as Australia/Perth, or 99 for default.
+    trackforums?: number; // @since 4.4. Whether the user is tracking forums.
+    description?: string; // User profile description.
+    city?: string; // Home city of the user.
+    url?: string; // URL of the user.
+    country?: string; // Home country code of the user, such as AU or CZ.
+    customfields?: CoreUserProfileField[]; // User custom fields (also known as user profile fields).
+    preferences?: CoreUserPreference[]; // Users preferences.
+};
+
 /**
  * Type for exporting a user description.
  * This relates to LMS core_user_external::user_description, do not modify unless the exporter changes.