CIT/Vmeda.Online
3
0
Fork 1
forked from EVOgeek/Vmeda.Online
Code Pull Requests Activity

MOBILE-3887 notifications: Always use core_message_get_messages

Browse Source
This commit is contained in:
Dani Palou 2021-10-06 08:41:39 +02:00
parent 8926a95db6
commit 3bc68dd28a
8 changed files with 149 additions and 258 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/addons/notifications/pages/list/list.html
View File

@ -36,7 +36,7 @@
<ion-label>
<p class="item-heading">{{ notification.subject }}</p>
<p *ngIf="notification.userfromfullname">{{ notification.userfromfullname }}</p>
<p *ngIf="notification.useridfrom > 0">{{ notification.userfromfullname }}</p>
</ion-label>
<ion-note slot="end" class="ion-float-end ion-text-end">
{{ notification.timecreated | coreDateDayOrTime }}

20
src/addons/notifications/pages/list/list.ts
View File

@ -21,8 +21,11 @@ import { CoreDomUtils } from '@services/utils/dom';
import { CoreTextUtils } from '@services/utils/text';
import { CoreUtils } from '@services/utils/utils';
import { CoreEvents, CoreEventObserver } from '@singletons/events';
import { AddonNotifications, AddonNotificationsAnyNotification, AddonNotificationsProvider } from '../../services/notifications';
import { AddonNotificationsHelper } from '../../services/notifications-helper';
import {
AddonNotifications,
AddonNotificationsNotificationMessageFormatted,
AddonNotificationsProvider,
} from '../../services/notifications';
import { CorePushNotificationsDelegate } from '@features/pushnotifications/services/push-delegate';
/**
@ -89,9 +92,7 @@ export class AddonNotificationsListPage implements OnInit, OnDestroy {
this.loadMoreError = false;
try {
const result = await AddonNotificationsHelper.getNotifications(refresh ? [] : this.notifications, {
onlyPopupNotifications: true,
});
const result = await AddonNotifications.getNotifications(refresh ? [] : this.notifications);
const notifications = result.notifications.map((notification) => this.formatText(notification));
@ -156,8 +157,9 @@ export class AddonNotificationsListPage implements OnInit, OnDestroy {
try {
this.loadingMarkAllNotificationsAsRead = true;
const unread = await AddonNotifications.getUnreadNotificationsCount();
let unread = await AddonNotifications.getUnreadNotificationsCount();
unread = typeof unread === 'string' ? parseInt(unread) : unread;
this.canMarkAllNotificationsAsRead = unread > 0;
} finally {
this.loadingMarkAllNotificationsAsRead = false;
@ -198,14 +200,14 @@ export class AddonNotificationsListPage implements OnInit, OnDestroy {
*
* @param notification The notification object.
*/
protected formatText(notification: AddonNotificationsAnyNotification): FormattedNotification {
protected formatText(notification: AddonNotificationsNotificationMessageFormatted): FormattedNotification {
const formattedNotification: FormattedNotification = notification;
formattedNotification.displayfullhtml = this.shouldDisplayFullHtml(notification);
formattedNotification.iconurl = formattedNotification.iconurl || undefined; // Make sure the property exists.
formattedNotification.mobiletext = formattedNotification.displayfullhtml ?
notification.fullmessagehtml :
CoreTextUtils.replaceNewLines(formattedNotification.mobiletext!.replace(/-{4,}/ig, ''), '<br>');
CoreTextUtils.replaceNewLines((formattedNotification.mobiletext || '').replace(/-{4,}/ig, ''), '<br>');
return formattedNotification;
}
@ -253,7 +255,7 @@ export class AddonNotificationsListPage implements OnInit, OnDestroy {
}
type FormattedNotification = AddonNotificationsAnyNotification & {
type FormattedNotification = AddonNotificationsNotificationMessageFormatted & {
displayfullhtml?: boolean; // Whether to display the full HTML of the notification.
iconurl?: string;
};

2
src/addons/notifications/pages/settings/settings.html
View File

@ -23,7 +23,7 @@
<ion-card>
<ion-item class="ion-text-wrap" *ngIf="preferences">
<ion-label>{{ 'addon.notifications.notifications' | translate }}</ion-label>
<ion-toggle [(ngModel)]="preferences!.enableall" (ngModelChange)="enableAll(preferences!.enableall)"></ion-toggle>
<ion-toggle [(ngModel)]="preferences.enableall" (ngModelChange)="enableAll(preferences.enableall)"></ion-toggle>
</ion-item>
<ion-item class="ion-text-wrap" *ngIf="canChangeSound">
<ion-label>{{ 'addon.notifications.playsound' | translate }}</ion-label>

8
src/addons/notifications/pages/settings/settings.ts
View File

@ -161,7 +161,7 @@ export class AddonNotificationsSettingsPage implements OnInit, OnDestroy {
* @param name Name of the selected processor.
*/
changeProcessor(name: string): void {
const processor = this.preferences!.processors.find((processor) => processor.name == name);
const processor = this.preferences?.processors.find((processor) => processor.name == name);
if (processor) {
this.loadProcessor(processor);
@ -246,6 +246,10 @@ export class AddonNotificationsSettingsPage implements OnInit, OnDestroy {
* @return Promise resolved when done.
*/
async enableAll(enable?: boolean): Promise<void> {
if (!this.preferences) {
return;
}
const modal = await CoreDomUtils.showModalLoading('core.sending', true);
try {
@ -256,7 +260,7 @@ export class AddonNotificationsSettingsPage implements OnInit, OnDestroy {
} catch (error) {
// Show error and revert change.
CoreDomUtils.showErrorModal(error);
this.preferences!.enableall = !this.preferences!.enableall;
this.preferences.enableall = !this.preferences.enableall;
} finally {
modal.dismiss();
}

5
src/addons/notifications/services/handlers/mainmenu.ts
View File

@ -112,8 +112,9 @@ export class AddonNotificationsMainMenuHandlerService implements CoreMainMenuHan
try {
const unreadCount = await AddonNotifications.getUnreadNotificationsCount(undefined, siteId);
this.handlerData.badge = unreadCount > 0 ? String(unreadCount) : '';
CorePushNotifications.updateAddonCounter('AddonNotifications', unreadCount, siteId);
const unreadCountNumber = typeof unreadCount === 'string' ? parseInt(unreadCount) : unreadCount;
this.handlerData.badge = unreadCountNumber > 0 ? String(unreadCount) : '';
CorePushNotifications.updateAddonCounter('AddonNotifications', unreadCountNumber, siteId);
} catch {
this.handlerData.badge = '';
} finally {

63
src/addons/notifications/services/notifications-helper.ts
View File

@ -14,20 +14,15 @@
import { Injectable } from '@angular/core';
import { CoreSites } from '@services/sites';
import { CoreUtils } from '@services/utils/utils';
import { makeSingleton } from '@singletons';
import { AddonMessageOutputDelegate } from '@addons/messageoutput/services/messageoutput-delegate';
import {
AddonNotifications,
AddonNotificationsAnyNotification,
AddonNotificationsGetNotificationsOptions,
AddonNotificationsPreferences,
AddonNotificationsPreferencesComponent,
AddonNotificationsPreferencesNotification,
AddonNotificationsPreferencesNotificationProcessor,
AddonNotificationsPreferencesProcessor,
AddonNotificationsProvider,
} from './notifications';
/**
@ -58,57 +53,6 @@ export class AddonNotificationsHelperProvider {
return formattedPreferences;
}
/**
* Get some notifications. It will try to use the new WS if available.
*
* @param notifications Current list of loaded notifications. It's used to calculate the offset.
* @param options Other options.
* @return Promise resolved with notifications and if can load more.
*/
async getNotifications(
notifications: AddonNotificationsAnyNotification[],
options?: AddonNotificationsHelperGetNotificationsOptions,
): Promise<{notifications: AddonNotificationsAnyNotification[]; canLoadMore: boolean}> {
notifications = notifications || [];
options = options || {};
options.limit = options.limit || AddonNotificationsProvider.LIST_LIMIT;
options.siteId = options.siteId || CoreSites.getCurrentSiteId();
if (options.onlyPopupNotifications) {
return AddonNotifications.getPopupNotifications(notifications.length, options);
}
// Use get_messages. We need 2 calls, one for read and the other one for unread.
const unreadFrom = notifications.reduce((total, current) => total + (current.read ? 0 : 1), 0);
const unread = await AddonNotifications.getUnreadNotifications(unreadFrom, options);
let newNotifications = unread;
if (unread.length < options.limit) {
// Limit not reached. Get read notifications until reach the limit.
const readLimit = options.limit - unread.length;
const readFrom = notifications.length - unreadFrom;
const readOptions = Object.assign({}, options, { limit: readLimit });
try {
const read = await AddonNotifications.getReadNotifications(readFrom, readOptions);
newNotifications = unread.concat(read);
} catch (error) {
if (unread.length <= 0) {
throw error;
}
}
}
return {
notifications: newNotifications,
canLoadMore: notifications.length >= options.limit,
};
}
/**
* Get a certain processor from a list of processors.
*
@ -207,10 +151,3 @@ export type AddonNotificationsPreferencesNotificationFormatted = AddonNotificati
export type AddonNotificationsPreferencesProcessorFormatted = AddonNotificationsPreferencesProcessor & {
supported?: boolean; // Calculated in the app. Whether the processor is supported in the app.
};
/**
* Options to pass to getNotifications.
*/
export type AddonNotificationsHelperGetNotificationsOptions = AddonNotificationsGetNotificationsOptions & {
onlyPopupNotifications?: boolean; // Whether to get only popup notifications.
};

306
src/addons/notifications/services/notifications.ts
View File

@ -22,6 +22,7 @@ import { CoreUser } from '@features/user/services/user';
import { CoreSite, CoreSiteWSPreSets } from '@classes/site';
import { CoreLogger } from '@singletons/logger';
import { makeSingleton } from '@singletons';
import { CoreCourseModuleDelegate } from '@features/course/services/module-delegate';
const ROOT_CACHE_KEY = 'mmaNotifications:';
@ -46,24 +47,14 @@ export class AddonNotificationsProvider {
* Function to format notification data.
*
* @param notifications List of notifications.
* @param read Whether the notifications are read or unread.
* @return Promise resolved with notifications.
*/
protected async formatNotificationsData(
notifications: AddonNotificationsGetMessagesMessage[],
read?: boolean,
): Promise<AddonNotificationsGetMessagesMessageFormatted[]>;
protected async formatNotificationsData(
notifications: AddonNotificationsPopupNotification[],
read?: boolean,
): Promise<AddonNotificationsPopupNotificationFormatted[]>;
protected async formatNotificationsData(
notifications: (AddonNotificationsGetMessagesMessage | AddonNotificationsPopupNotification)[],
read?: boolean,
): Promise<AddonNotificationsAnyNotification[]> {
notifications: AddonNotificationsNotificationMessage[],
): Promise<AddonNotificationsNotificationMessageFormatted[]> {
const promises = notifications.map(async (notificationRaw) => {
const notification = <AddonNotificationsAnyNotification> notificationRaw;
const notification = <AddonNotificationsNotificationMessageFormatted> notificationRaw;
// Set message to show.
if (notification.component && notification.component == 'mod_forum') {
@ -75,9 +66,7 @@ export class AddonNotificationsProvider {
notification.moodlecomponent = notification.component;
notification.notification = 1;
notification.notif = 1;
if (typeof read != 'undefined') {
notification.read = read;
}
notification.read = notification.timeread > 0;
if (typeof notification.customdata == 'string') {
notification.customdata = CoreTextUtils.parseJSON<Record<string, unknown>>(notification.customdata, {});
@ -93,6 +82,15 @@ export class AddonNotificationsProvider {
}
}
if (!notification.iconurl) {
// The iconurl is only returned in 4.0 or above. Calculate it if not present.
if (notification.component && notification.component.startsWith('mod_')) {
notification.iconurl = await CoreCourseModuleDelegate.getModuleIconSrc(
notification.component.replace('mod_', ''),
);
}
}
if (notification.useridfrom > 0) {
// Try to get the profile picture of the user.
try {
@ -153,32 +151,99 @@ export class AddonNotificationsProvider {
return ROOT_CACHE_KEY + 'list';
}
/**
* Get some notifications.
*
* @param notifications Current list of loaded notifications. It's used to calculate the offset.
* @param options Other options.
* @return Promise resolved with notifications and if can load more.
*/
async getNotifications(
notifications: AddonNotificationsNotificationMessageFormatted[],
options?: AddonNotificationsGetNotificationsOptions,
): Promise<{notifications: AddonNotificationsNotificationMessageFormatted[]; canLoadMore: boolean}> {
notifications = notifications || [];
options = options || {};
options.limit = options.limit || AddonNotificationsProvider.LIST_LIMIT;
options.siteId = options.siteId || CoreSites.getCurrentSiteId();
let newNotifications: AddonNotificationsNotificationMessageFormatted[];
// Request 1 more notification so we can know if there are more notifications.
const originalLimit = options.limit;
options.limit + 1;
const site = await CoreSites.getSite(options.siteId);
if (site.isVersionGreaterEqualThan('4.0')) {
// In 4.0 the app can request read and unread at the same time.
options.offset = notifications.length;
newNotifications = await this.getNotificationsWithStatus(
AddonNotificationsGetReadType.BOTH,
options,
);
} else {
// We need 2 calls, one for read and the other one for unread.
options.offset = notifications.reduce((total, current) => total + (current.read ? 0 : 1), 0);
const unread = await this.getNotificationsWithStatus(AddonNotificationsGetReadType.UNREAD, options);
newNotifications = unread;
if (unread.length < options.limit) {
// Limit not reached. Get read notifications until reach the limit.
const readOptions = {
...options,
offset: notifications.length - options.offset,
limit: options.limit - unread.length,
};
try {
const read = await this.getNotificationsWithStatus(AddonNotificationsGetReadType.READ, readOptions);
newNotifications = unread.concat(read);
} catch (error) {
if (unread.length <= 0) {
throw error;
}
}
}
}
return {
notifications: newNotifications.slice(0, originalLimit),
canLoadMore: newNotifications.length > originalLimit,
};
}
/**
* Get notifications from site.
*
* @param read True if should get read notifications, false otherwise.
* @param offset Position of the first notification to get.
* @param options Other options.
* @return Promise resolved with notifications.
*/
async getNotifications(
read: boolean,
offset: number,
options?: AddonNotificationsGetNotificationsOptions,
): Promise<AddonNotificationsGetMessagesMessageFormatted[]> {
options = options || {};
protected async getNotificationsWithStatus(
read: AddonNotificationsGetReadType,
options: AddonNotificationsGetNotificationsOptions = {},
): Promise<AddonNotificationsNotificationMessageFormatted[]> {
options.offset = options.offset || 0;
options.limit = options.limit || AddonNotificationsProvider.LIST_LIMIT;
this.logger.debug(`Get ${(read ? 'read' : 'unread')} notifications from ${offset}. Limit: ${options.limit}`);
const typeText = read === AddonNotificationsGetReadType.READ ?
'read' :
(read === AddonNotificationsGetReadType.UNREAD ? 'unread' : 'read and unread');
this.logger.debug(`Get ${typeText} notifications from ${options.offset}. Limit: ${options.limit}`);
const site = await CoreSites.getSite(options.siteId);
const data: AddonNotificationsGetMessagesWSParams = {
useridto: site.getUserId(),
useridfrom: 0,
type: 'notifications',
read: !!read,
read: read,
newestfirst: true,
limitfrom: offset,
limitfrom: options.offset,
limitnum: options.limit,
};
const preSets: CoreSiteWSPreSets = {
@ -191,78 +256,7 @@ export class AddonNotificationsProvider {
const notifications = response.messages;
return this.formatNotificationsData(notifications, read);
}
/**
* Get notifications from site using the new WebService.
*
* @param offset Position of the first notification to get.
* @param options Other options.
* @return Promise resolved with notifications and if can load more.
*/
async getPopupNotifications(
offset: number,
options?: AddonNotificationsGetNotificationsOptions,
): Promise<{notifications: AddonNotificationsPopupNotificationFormatted[]; canLoadMore: boolean}> {
options = options || {};
options.limit = options.limit || AddonNotificationsProvider.LIST_LIMIT;
this.logger.debug(`Get popup notifications from ${offset}. Limit: ${options.limit}`);
const site = await CoreSites.getSite(options.siteId);
const data: AddonNotificationsPopupGetPopupNotificationsWSParams = {
useridto: site.getUserId(),
newestfirst: true,
offset,
limit: options.limit + 1, // Get one more to calculate canLoadMore.
};
const preSets: CoreSiteWSPreSets = {
cacheKey: this.getNotificationsCacheKey(),
...CoreSites.getReadingStrategyPreSets(options.readingStrategy), // Include reading strategy preSets.
};
// Get notifications.
const response = await site.read<AddonNotificationsGetPopupNotificationsResult>(
'message_popup_get_popup_notifications',
data,
preSets,
);
const notifications = await this.formatNotificationsData(response.notifications.slice(0, options.limit));
return {
canLoadMore: response.notifications.length > options.limit,
notifications,
};
}
/**
* Get read notifications from site.
*
* @param offset Position of the first notification to get.
* @param options Other options.
* @return Promise resolved with notifications.
*/
getReadNotifications(
offset: number,
options?: AddonNotificationsGetNotificationsOptions,
): Promise<AddonNotificationsGetMessagesMessageFormatted[]> {
return this.getNotifications(true, offset, options);
}
/**
* Get unread notifications from site.
*
* @param offset Position of the first notification to get.
* @param options Other options.
* @return Promise resolved with notifications.
*/
getUnreadNotifications(
offset: number,
options?: AddonNotificationsGetNotificationsOptions,
): Promise<AddonNotificationsGetMessagesMessageFormatted[]> {
return this.getNotifications(false, offset, options);
return this.formatNotificationsData(notifications);
}
/**
@ -272,22 +266,27 @@ export class AddonNotificationsProvider {
* @param siteId Site ID. If not defined, use current site.
* @return Promise resolved with the message notifications count.
*/
async getUnreadNotificationsCount(userId?: number, siteId?: string): Promise<number> {
async getUnreadNotificationsCount(userId?: number, siteId?: string): Promise<number | string> {
const site = await CoreSites.getSite(siteId);
userId = userId || site.getUserId();
const params: AddonNotificationsPopupGetUnreadPopupNotificationCountWSParams = {
useridto: userId,
};
const preSets: CoreSiteWSPreSets = {
getFromCache: false,
emergencyCache: false,
saveToCache: false,
typeExpected: 'number',
};
// @since 4.0
if (site.wsAvailable('core_message_get_unread_notification_count')) {
// @todo
}
// Fallback call
try {
return await site.read<number>('message_popup_get_unread_popup_notification_count', params, preSets);
const unread = await this.getNotificationsWithStatus(AddonNotificationsGetReadType.UNREAD, {
limit: AddonNotificationsProvider.LIST_LIMIT,
siteId,
});
if (unread.length === AddonNotificationsProvider.LIST_LIMIT) {
// Maybe there are more notifications, include a '+';
return unread.length + '+';
}
return unread.length;
} catch {
// Return no messages if the call fails.
return 0;
@ -427,7 +426,7 @@ export type AddonNotificationsGetMessagesWSParams = {
useridto: number; // The user id who received the message, 0 for any user.
useridfrom?: number; // The user id who send the message, 0 for any user. -10 or -20 for no-reply or support user.
type?: string; // Type of message to return, expected values are: notifications, conversations and both.
read?: boolean; // True for getting read messages, false for unread.
read?: AddonNotificationsGetReadType; // 0=unread, 1=read. @since 4.0 it also accepts 2=both.
newestfirst?: boolean; // True for ordering by newest first, false for oldest first.
limitfrom?: number; // Limit from.
limitnum?: number; // Limit number.
@ -437,14 +436,14 @@ export type AddonNotificationsGetMessagesWSParams = {
* Data returned by core_message_get_messages WS.
*/
export type AddonNotificationsGetMessagesWSResponse = {
messages: AddonNotificationsGetMessagesMessage[];
messages: AddonNotificationsNotificationMessage[];
warnings?: CoreWSExternalWarning[];
};
/**
* Message data returned by core_message_get_messages.
*/
export type AddonNotificationsGetMessagesMessage = {
export type AddonNotificationsNotificationMessage = {
id: number; // Message id.
useridfrom: number; // User from id.
useridto: number; // User to id.
@ -464,70 +463,14 @@ export type AddonNotificationsGetMessagesMessage = {
component?: string; // @since 3.7. The component that generated the notification.
eventtype?: string; // @since 3.7. The type of notification.
customdata?: string; // @since 3.7. Custom data to be passed to the message processor.
iconurl?: string; // @since 4.0. Icon URL, only for notifications.
};
/**
* Message data returned by core_message_get_messages with some calculated data.
*/
export type AddonNotificationsGetMessagesMessageFormatted =
Omit<AddonNotificationsGetMessagesMessage, 'customdata'> & AddonNotificationsNotificationCalculatedData;
/**
* Params of message_popup_get_popup_notifications WS.
*/
export type AddonNotificationsPopupGetPopupNotificationsWSParams = {
useridto: number; // The user id who received the message, 0 for current user.
newestfirst?: boolean; // True for ordering by newest first, false for oldest first.
limit?: number; // The number of results to return.
offset?: number; // Offset the result set by a given amount.
};
/**
* Result of WS message_popup_get_popup_notifications.
*/
export type AddonNotificationsGetPopupNotificationsResult = {
notifications: AddonNotificationsPopupNotification[];
unreadcount: number; // The number of unread message for the given user.
};
/**
* Notification returned by message_popup_get_popup_notifications.
*/
export type AddonNotificationsPopupNotification = {
id: number; // Notification id (this is not guaranteed to be unique within this result set).
useridfrom: number; // User from id.
useridto: number; // User to id.
subject: string; // The notification subject.
shortenedsubject: string; // The notification subject shortened with ellipsis.
text: string; // The message text formated.
fullmessage: string; // The message.
fullmessageformat: number; // Fullmessage format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN).
fullmessagehtml: string; // The message in html.
smallmessage: string; // The shorten message.
contexturl: string; // Context URL.
contexturlname: string; // Context URL link name.
timecreated: number; // Time created.
timecreatedpretty: string; // Time created in a pretty format.
timeread: number; // Time read.
read: boolean; // Notification read status.
deleted: boolean; // Notification deletion status.
iconurl: string; // URL for notification icon.
component?: string; // The component that generated the notification.
eventtype?: string; // The type of notification.
customdata?: string; // @since 3.7. Custom data to be passed to the message processor.
};
/**
* Notification returned by message_popup_get_popup_notifications.
*/
export type AddonNotificationsPopupNotificationFormatted =
Omit<AddonNotificationsPopupNotification, 'customdata'> & AddonNotificationsNotificationCalculatedData;
/**
* Any kind of notification that can be retrieved.
*/
export type AddonNotificationsAnyNotification =
AddonNotificationsPopupNotificationFormatted | AddonNotificationsGetMessagesMessageFormatted;
export type AddonNotificationsNotificationMessageFormatted =
Omit<AddonNotificationsNotificationMessage, 'customdata'> & AddonNotificationsNotificationCalculatedData;
/**
* Result of WS core_message_get_user_notification_preferences.
@ -552,13 +495,6 @@ export type AddonNotificationsNotificationCalculatedData = {
customdata?: Record<string, unknown>; // Parsed custom data.
};
/**
* Params of message_popup_get_unread_popup_notification_count WS.
*/
export type AddonNotificationsPopupGetUnreadPopupNotificationCountWSParams = {
useridto: number; // The user id who received the message, 0 for any user.
};
/**
* Params of core_message_mark_all_notifications_as_read WS.
*/
@ -585,8 +521,18 @@ export type CoreMessageMarkNotificationReadWSResponse = {
};
/**
* Options to pass to getNotifications and getPopupNotifications.
* Options to pass to getNotifications.
*/
export type AddonNotificationsGetNotificationsOptions = CoreSitesCommonWSOptions & {
offset?: number; // Offset to use. Defaults to 0.
limit?: number; // Number of notifications to get. Defaults to LIST_LIMIT.
};
/**
* Constants to get either read, unread or both notifications.
*/
export enum AddonNotificationsGetReadType {
UNREAD = 0,
READ = 1,
BOTH = 2,
}

1
src/core/classes/site.ts
View File

@ -86,6 +86,7 @@ export class CoreSite {
'3.9': 2020061500,
'3.10': 2020110900,
'3.11': 2021051700,
'4.0': 2021100300, // @todo [4.0] replace with right value when released. Using a tmp value to be able to test new things.
};
// Possible cache update frequencies.