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

MOBILE-3633 notifications: Implement notification preferences

Browse Source
This commit is contained in:
Dani Palou 2021-01-12 10:38:34 +01:00
parent fdbecff03e
commit 881858e9d6
17 changed files with 699 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/addons/addons.module.ts
View File

@ -21,6 +21,7 @@ import { AddonUserProfileFieldModule } from './userprofilefield/userprofilefield
import { AddonBadgesModule } from './badges/badges.module';
import { AddonCalendarModule } from './calendar/calendar.module';
import { AddonNotificationsModule } from './notifications/notifications.module';
import { AddonMessageOutputModule } from './messageoutput/messageoutput.module';
@NgModule({
imports: [
@ -31,6 +32,7 @@ import { AddonNotificationsModule } from './notifications/notifications.module';
AddonFilterModule,
AddonUserProfileFieldModule,
AddonNotificationsModule,
AddonMessageOutputModule,
],
})
export class AddonsModule {}

5
src/addons/notifications/notifications-lazy.module.ts
View File

@ -16,6 +16,7 @@ import { Injector, NgModule } from '@angular/core';
import { RouterModule, ROUTES, Routes } from '@angular/router';
import { buildTabMainRoutes } from '@features/mainmenu/mainmenu-tab-routing.module';
import { AddonNotificationsSettingsHandlerService } from './services/handlers/settings';
function buildRoutes(injector: Injector): Routes {
return [
@ -23,6 +24,10 @@ function buildRoutes(injector: Injector): Routes {
path: 'list',
loadChildren: () => import('./pages/list/list.module').then(m => m.AddonNotificationsListPageModule),
},
{
path: AddonNotificationsSettingsHandlerService.PAGE_NAME,
loadChildren: () => import('./pages/settings/settings.module').then(m => m.AddonNotificationsSettingsPageModule),
},
...buildTabMainRoutes(injector, {
redirectTo: 'list',
pathMatch: 'full',

9
src/addons/notifications/notifications.module.ts
View File

@ -18,10 +18,13 @@ import { Routes } from '@angular/router';
import { CoreCronDelegate } from '@services/cron';
import { CoreMainMenuDelegate } from '@features/mainmenu/services/mainmenu-delegate';
import { CoreMainMenuRoutingModule } from '@features/mainmenu/mainmenu-routing.module';
import { CoreMainMenuTabRoutingModule } from '@features/mainmenu/mainmenu-tab-routing.module';
import { CorePushNotificationsDelegate } from '@features/pushnotifications/services/push-delegate';
import { CoreSettingsDelegate } from '@features/settings/services/settings-delegate';
import { AddonNotificationsMainMenuHandler, AddonNotificationsMainMenuHandlerService } from './services/handlers/mainmenu';
import { AddonNotificationsCronHandler } from './services/handlers/cron';
import { AddonNotificationsPushClickHandler } from './services/handlers/push-click';
import { AddonNotificationsSettingsHandler } from './services/handlers/settings';
const routes: Routes = [
{
@ -31,7 +34,10 @@ const routes: Routes = [
];
@NgModule({
imports: [CoreMainMenuRoutingModule.forChild({ children: routes })],
imports: [
CoreMainMenuRoutingModule.forChild({ children: routes }),
CoreMainMenuTabRoutingModule.forChild(routes),
],
exports: [CoreMainMenuRoutingModule],
providers: [
{
@ -42,6 +48,7 @@ const routes: Routes = [
CoreMainMenuDelegate.instance.registerHandler(AddonNotificationsMainMenuHandler.instance);
CoreCronDelegate.instance.register(AddonNotificationsCronHandler.instance);
CorePushNotificationsDelegate.instance.registerClickHandler(AddonNotificationsPushClickHandler.instance);
CoreSettingsDelegate.instance.registerHandler(AddonNotificationsSettingsHandler.instance);
},
},
],

1
src/addons/notifications/pages/list/list.module.ts
View File

@ -36,7 +36,6 @@ const routes: Routes = [
IonicModule,
TranslateModule.forChild(),
CoreSharedModule,
// CoreComponentsModule,
AddonNotificationsComponentsModule,
],
declarations: [

115
src/addons/notifications/pages/settings/settings.html Normal file
View File

@ -0,0 +1,115 @@
<ion-header>
<ion-toolbar>
<ion-buttons slot="start">
<ion-back-button [attr.aria-label]="'core.back' | translate"></ion-back-button>
</ion-buttons>
<ion-title>{{ 'addon.notifications.notifications' | translate }}</ion-title>
<ion-buttons slot="end">
</ion-buttons>
</ion-toolbar>
</ion-header>
<core-navbar-buttons slot="end">
<core-context-menu>
<core-context-menu-item *ngFor="let handler of processorHandlers" [priority]="handler.priority"
[content]="handler.label | translate" (action)="openExtraPreferences(handler)" [iconAction]="handler.icon">
</core-context-menu-item>
</core-context-menu>
</core-navbar-buttons>
<ion-content>
<ion-refresher slot="fixed" [disabled]="!preferencesLoaded || !notifPrefsEnabled" (ionRefresh)="refreshPreferences($event)">
<ion-refresher-content pullingText="{{ 'core.pulltorefresh' | translate }}"></ion-refresher-content>
</ion-refresher>
<core-loading [hideUntil]="preferencesLoaded">
<!-- If notification preferences aren't enabled, show only the notification sound setting. -->
<ion-item *ngIf="canChangeSound && !notifPrefsEnabled">
<ion-label>{{ 'addon.notifications.playsound' | translate }}</ion-label>
<ion-toggle [(ngModel)]="notificationSound" (ngModelChange)="changeNotificationSound(notificationSound)"></ion-toggle>
</ion-item>
<ng-container *ngIf="notifPrefsEnabled">
<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-item>
<ion-item class="ion-text-wrap" *ngIf="canChangeSound">
<ion-label>{{ 'addon.notifications.playsound' | translate }}</ion-label>
<ion-toggle [(ngModel)]="notificationSound" (ngModelChange)="changeNotificationSound(notificationSound)">
</ion-toggle>
</ion-item>
</ion-card>
<!-- Show processor selector. -->
<ion-select *ngIf="preferences && preferences.processors && preferences.processors.length > 0"
[ngModel]="currentProcessor!.name" (ngModelChange)="changeProcessor($event)" interface="action-sheet"
class="core-button-select">
<ion-select-option *ngFor="let processor of preferences.processors" [value]="processor.name">
{{ processor.displayname }}
</ion-select-option>
</ion-select>
<ion-card list *ngFor="let component of components" class="ion-margin-top">
<ion-item-divider class="ion-text-wrap">
<ion-grid class="ion-no-padding">
<ion-row class="ion-no-padding">
<ion-col class="ion-no-padding">{{ component.displayname }}</ion-col>
<ion-col size="2" class="ion-text-center ion-no-padding ion-hide-md-down">
{{ 'core.settings.loggedin' | translate }}
</ion-col>
<ion-col size="2" class="ion-text-center ion-no-padding ion-hide-md-down">
{{ 'core.settings.loggedoff' | translate }}
</ion-col>
</ion-row>
</ion-grid>
</ion-item-divider>
<ng-container *ngFor="let notification of component.notifications">
<!-- Tablet view -->
<ion-grid class="ion-text-wrap ion-hide-md-down addon-notifications-table-content">
<ion-row class="ion-align-items-center">
<ion-col class="ion-margin-horizontal">{{ notification.displayname }}</ion-col>
<ion-col size="2" class="ion-text-center" *ngFor="let state of ['loggedin', 'loggedoff']">
<!-- If notifications enabled, show toggle. -->
<ion-spinner [hidden]="!preferences!.enableall ||
!(notification.processorsByName[currentProcessor!.name][state] &&
notification.processorsByName[currentProcessor!.name][state].updating)">
</ion-spinner>
<ion-toggle *ngIf="preferences!.enableall && !notification.processorsByName[currentProcessor!.name].locked"
[(ngModel)]="notification.processorsByName[currentProcessor!.name][state].checked"
(ngModelChange)="changePreference(notification, state)"
[disabled]="notification.processorsByName[currentProcessor!.name][state].updating">
</ion-toggle>
<span class="text-gray"
*ngIf="preferences!.enableall && notification.processorsByName[currentProcessor!.name].locked">
{{'core.settings.locked' | translate }}
</span>
<!-- If notifications are disabled, show "Disabled" instead of toggle. -->
<span *ngIf="!preferences!.enableall">{{ 'core.settings.disabled' | translate }}</span>
</ion-col>
</ion-row>
</ion-grid>
<!-- Phone view -->
<ion-list-header class="ion-text-wrap ion-no-margin ion-hide-md-up">
{{ notification.displayname }}
</ion-list-header>
<!-- If notifications enabled, show toggles. If disabled, show "Disabled" instead of toggle. -->
<ion-item *ngFor="let state of ['loggedin', 'loggedoff']" class="ion-text-wrap ion-hide-md-up" lines="none">
<ion-label>{{ 'core.settings.' + state | translate }}</ion-label>
<ion-spinner slot="end" *ngIf="preferences!.enableall && (notification.processorsByName[currentProcessor!.name][state] &&
notification.processorsByName[currentProcessor!.name][state].updating)">
</ion-spinner>
<ion-toggle slot="end" *ngIf="preferences!.enableall && !notification.processorsByName[currentProcessor!.name].locked"
[(ngModel)]="notification.processorsByName[currentProcessor!.name][state].checked"
(ngModelChange)="changePreference(notification, state)"
[disabled]="notification.processorsByName[currentProcessor!.name][state].updating">
</ion-toggle>
<span slot="end" *ngIf="preferences!.enableall && notification.processorsByName[currentProcessor!.name].locked" class="text-gray">
{{'core.settings.locked' | translate }}
</span>
<ion-note slot="end" *ngIf="!preferences!.enableall">{{ 'core.settings.disabled' | translate }}</ion-note>
</ion-item>
</ng-container>
</ion-card>
</ng-container>
</core-loading>
</ion-content>

46
src/addons/notifications/pages/settings/settings.module.ts Normal file
View File

@ -0,0 +1,46 @@
// (C) Copyright 2015 Moodle Pty Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
import { FormsModule } from '@angular/forms';
import { RouterModule, Routes } from '@angular/router';
import { IonicModule } from '@ionic/angular';
import { TranslateModule } from '@ngx-translate/core';
import { CoreSharedModule } from '@/core/shared.module';
import { AddonNotificationsSettingsPage } from './settings';
const routes: Routes = [
{
path: '',
component: AddonNotificationsSettingsPage,
},
];
@NgModule({
imports: [
RouterModule.forChild(routes),
CommonModule,
FormsModule,
IonicModule,
TranslateModule.forChild(),
CoreSharedModule,
],
declarations: [
AddonNotificationsSettingsPage,
],
exports: [RouterModule],
})
export class AddonNotificationsSettingsPageModule {}

5
src/addons/notifications/pages/settings/settings.scss Normal file
View File

@ -0,0 +1,5 @@
:host {
.addon-notifications-table-content ion-row {
min-height: 35px;
}
}

308
src/addons/notifications/pages/settings/settings.ts Normal file
View File

@ -0,0 +1,308 @@
// (C) Copyright 2015 Moodle Pty Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { Component, OnInit, OnDestroy } from '@angular/core';
import { IonRefresher, NavController } from '@ionic/angular';
import { CoreConfig } from '@services/config';
import { CoreLocalNotifications } from '@services/local-notifications';
import { CoreSites } from '@services/sites';
import { CoreDomUtils } from '@services/utils/dom';
import { CoreUtils } from '@services/utils/utils';
import { CoreUser } from '@features/user/services/user';
import { AddonMessageOutputDelegate, AddonMessageOutputHandlerData } from '@addons/messageoutput/services/messageoutput-delegate';
import { CoreConstants } from '@/core/constants';
import { CoreError } from '@classes/errors/error';
import { CoreEventNotificationSoundChangedData, CoreEvents } from '@singletons/events';
import {
AddonNotifications,
AddonNotificationsPreferencesProcessor,
AddonNotificationsPreferencesNotificationProcessorState,
} from '../../services/notifications';
import {
AddonNotificationsHelper,
AddonNotificationsPreferencesComponentFormatted,
AddonNotificationsPreferencesFormatted,
AddonNotificationsPreferencesNotificationFormatted,
AddonNotificationsPreferencesProcessorFormatted,
} from '@addons/notifications/services/notifications-helper';
import { CoreNavHelper } from '@services/nav-helper';
// import { CoreSplitViewComponent } from '@components/split-view/split-view';
/**
* Page that displays notifications settings.
*/
@Component({
selector: 'page-addon-notifications-settings',
templateUrl: 'settings.html',
styleUrls: ['settings.scss'],
})
export class AddonNotificationsSettingsPage implements OnInit, OnDestroy {
preferences?: AddonNotificationsPreferencesFormatted;
components?: AddonNotificationsPreferencesComponentFormatted[];
currentProcessor?: AddonNotificationsPreferencesProcessor;
preferencesLoaded = false;
notificationSound = false;
notifPrefsEnabled: boolean;
canChangeSound: boolean;
processorHandlers: AddonMessageOutputHandlerData[] = [];
protected updateTimeout?: number;
constructor(
protected navCtrl: NavController,
// @Optional() protected svComponent: CoreSplitViewComponent,
) {
this.notifPrefsEnabled = AddonNotifications.instance.isNotificationPreferencesEnabled();
this.canChangeSound = CoreLocalNotifications.instance.canDisableSound();
}
/**
* Component being initialized.
*/
async ngOnInit(): Promise<void> {
if (this.canChangeSound) {
this.notificationSound = await CoreConfig.instance.get<boolean>(CoreConstants.SETTINGS_NOTIFICATION_SOUND, true);
}
if (this.notifPrefsEnabled) {
this.fetchPreferences();
} else {
this.preferencesLoaded = true;
}
}
/**
* Fetches preferences data.
*
* @return Resolved when done.
*/
protected async fetchPreferences(): Promise<void> {
try {
const preferences = await AddonNotifications.instance.getNotificationPreferences();
if (!this.currentProcessor) {
// Initialize current processor. Load "Mobile" (airnotifier) if available.
this.currentProcessor = AddonNotificationsHelper.instance.getProcessor(preferences.processors, 'airnotifier');
}
if (!this.currentProcessor) {
// Shouldn't happen.
throw new CoreError('No processor found');
}
preferences.enableall = !preferences.disableall;
this.preferences = AddonNotificationsHelper.instance.formatPreferences(preferences);
this.loadProcessor(this.currentProcessor);
} catch (error) {
CoreDomUtils.instance.showErrorModal(error);
} finally {
this.preferencesLoaded = true;
}
}
/**
* Load a processor.
*
* @param processor Processor object.
*/
protected loadProcessor(processor: AddonNotificationsPreferencesProcessorFormatted): void {
if (!processor) {
return;
}
this.currentProcessor = processor;
this.processorHandlers = [];
this.components = AddonNotificationsHelper.instance.getProcessorComponents(
processor.name,
this.preferences?.components || [],
);
if (!processor.hassettings || !processor.supported) {
return;
}
const handlerData = AddonMessageOutputDelegate.instance.getDisplayData(processor);
if (handlerData) {
this.processorHandlers.push(handlerData);
}
}
/**
* Update preferences after a certain time. The purpose is to store the updated data, it won't be reflected in the view.
*/
protected updatePreferencesAfterDelay(): void {
// Cancel pending updates.
clearTimeout(this.updateTimeout);
this.updateTimeout = window.setTimeout(() => {
this.updateTimeout = undefined;
this.updatePreferences();
}, 5000);
}
/**
* Update preferences. The purpose is to store the updated data, it won't be reflected in the view.
*
* @return Promise resolved when done.
*/
protected async updatePreferences(): Promise<void> {
await CoreUtils.instance.ignoreErrors(AddonNotifications.instance.invalidateNotificationPreferences());
await AddonNotifications.instance.getNotificationPreferences();
}
/**
* The selected processor was changed.
*
* @param name Name of the selected processor.
*/
changeProcessor(name: string): void {
const processor = this.preferences!.processors.find((processor) => processor.name == name);
if (processor) {
this.loadProcessor(processor);
}
}
/**
* Refresh the list of preferences.
*
* @param refresher Refresher.
*/
async refreshPreferences(refresher?: CustomEvent<IonRefresher>): Promise<void> {
try {
await CoreUtils.instance.ignoreErrors(AddonNotifications.instance.invalidateNotificationPreferences());
await this.fetchPreferences();
} finally {
refresher?.detail.complete();
}
}
/**
* Open extra preferences.
*
* @param handlerData
*/
openExtraPreferences(handlerData: AddonMessageOutputHandlerData): void {
// Decide which navCtrl to use. If this page is inside a split view, use the split view's master nav.
// @todo const navCtrl = this.svComponent ? this.svComponent.getMasterNav() : this.navCtrl;
CoreNavHelper.instance.goInCurrentMainMenuTab(handlerData.page, handlerData.pageParams);
}
/**
* Change the value of a certain preference.
*
* @param notification Notification object.
* @param state State name, ['loggedin', 'loggedoff'].
* @return Promise resolved when done.
*/
async changePreference(notification: AddonNotificationsPreferencesNotificationFormatted, state: string): Promise<void> {
const processor = notification.processorsByName?.[this.currentProcessor?.name || ''];
if (!processor) {
return;
}
const processorState: ProcessorStateFormatted = processor[state];
const preferenceName = notification.preferencekey + '_' + processorState.name;
let value: string | undefined;
notification.processors.forEach((processor) => {
if (processor[state].checked) {
if (!value) {
value = processor.name;
} else {
value += ',' + processor.name;
}
}
});
if (!value) {
value = 'none';
}
processorState.updating = true;
try {
await CoreUser.instance.updateUserPreference(preferenceName, value);
// Update the preferences since they were modified.
this.updatePreferencesAfterDelay();
} catch (error) {
// Show error and revert change.
CoreDomUtils.instance.showErrorModal(error);
processor[state].checked = !processor[state].checked;
} finally {
processorState.updating = false;
}
}
/**
* Enable all notifications changed.
*
* @param enable Whether to enable or disable.
* @return Promise resolved when done.
*/
async enableAll(enable?: boolean): Promise<void> {
const modal = await CoreDomUtils.instance.showModalLoading('core.sending', true);
try {
CoreUser.instance.updateUserPreferences([], !enable);
// Update the preferences since they were modified.
this.updatePreferencesAfterDelay();
} catch (error) {
// Show error and revert change.
CoreDomUtils.instance.showErrorModal(error);
this.preferences!.enableall = !this.preferences!.enableall;
} finally {
modal.dismiss();
}
}
/**
* Change the notification sound setting.
*
* @param enabled True to enable the notification sound, false to disable it.
*/
async changeNotificationSound(enabled: boolean): Promise<void> {
await CoreUtils.instance.ignoreErrors(CoreConfig.instance.set(CoreConstants.SETTINGS_NOTIFICATION_SOUND, enabled ? 1 : 0));
const siteId = CoreSites.instance.getCurrentSiteId();
CoreEvents.trigger<CoreEventNotificationSoundChangedData>(CoreEvents.NOTIFICATION_SOUND_CHANGED, { enabled }, siteId);
CoreLocalNotifications.instance.rescheduleAll();
}
/**
* Page destroyed.
*/
ngOnDestroy(): void {
// If there is a pending action to update preferences, execute it right now.
if (this.updateTimeout) {
clearTimeout(this.updateTimeout);
this.updatePreferences();
}
}
}
/**
* State in notification processor in notification preferences component with some calculated data.
*/
type ProcessorStateFormatted = AddonNotificationsPreferencesNotificationProcessorState & {
updating?: boolean; // Calculated in the app. Whether the state is being updated.
};

2
src/addons/notifications/services/handlers/cron.ts
View File

@ -24,7 +24,7 @@ import { AddonNotifications, AddonNotificationsProvider } from '../notifications
/**
* Notifications cron handler.
*/
@Injectable()
@Injectable({ providedIn: 'root' })
export class AddonNotificationsCronHandlerService implements CoreCronHandler {
name = 'AddonNotificationsCronHandler';

2
src/addons/notifications/services/handlers/push-click.ts
View File

@ -27,7 +27,7 @@ import { AddonNotifications, AddonNotificationsProvider } from '../notifications
/**
* Handler for non-messaging push notifications clicks.
*/
@Injectable()
@Injectable({ providedIn: 'root' })
export class AddonNotificationsPushClickHandlerService implements CorePushNotificationsClickHandler {
name = 'AddonNotificationsPushClickHandler';

60
src/addons/notifications/services/handlers/settings.ts Normal file
View File

@ -0,0 +1,60 @@
// (C) Copyright 2015 Moodle Pty Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { Injectable } from '@angular/core';
import { CoreLocalNotifications } from '@services/local-notifications';
import { makeSingleton } from '@singletons';
import { CoreSettingsHandler, CoreSettingsHandlerData } from '@features/settings/services/settings-delegate';
import { AddonNotifications } from '../notifications';
import { AddonNotificationsMainMenuHandlerService } from './mainmenu';
/**
* Notifications settings handler.
*/
@Injectable({ providedIn: 'root' })
export class AddonNotificationsSettingsHandlerService implements CoreSettingsHandler {
static readonly PAGE_NAME = 'settings';
name = 'AddonNotifications';
priority = 500;
/**
* Check if the handler is enabled on a site level.
*
* @return Whether or not the handler is enabled on a site level.
*/
async isEnabled(): Promise<boolean> {
// Preferences or notification sound setting available.
return CoreLocalNotifications.instance.isAvailable() || AddonNotifications.instance.isNotificationPreferencesEnabled();
}
/**
* Returns the data needed to render the handler.
*
* @return Data needed to render the handler.
*/
getDisplayData(): CoreSettingsHandlerData {
return {
icon: 'fas-bell',
title: 'addon.notifications.notifications',
page: AddonNotificationsMainMenuHandlerService.PAGE_NAME + '/' + AddonNotificationsSettingsHandlerService.PAGE_NAME,
class: 'addon-notifications-settings-handler',
};
}
}
export class AddonNotificationsSettingsHandler extends makeSingleton(AddonNotificationsSettingsHandlerService) {}

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

@ -15,11 +15,18 @@
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';
@ -29,6 +36,28 @@ import {
@Injectable({ providedIn: 'root' })
export class AddonNotificationsHelperProvider {
/**
* Format preferences data.
*
* @param preferences Preferences to format.
* @return Formatted preferences.
*/
formatPreferences(preferences: AddonNotificationsPreferences): AddonNotificationsPreferencesFormatted {
const formattedPreferences: AddonNotificationsPreferencesFormatted = preferences;
formattedPreferences.processors.forEach((processor) => {
processor.supported = AddonMessageOutputDelegate.instance.hasHandler(processor.name, true);
});
formattedPreferences.components.forEach((component) => {
component.notifications.forEach((notification) => {
notification.processorsByName = CoreUtils.instance.arrayToObject(notification.processors, 'name');
});
});
return formattedPreferences;
}
/**
* Get some notifications. It will try to use the new WS if available.
*
@ -82,6 +111,101 @@ export class AddonNotificationsHelperProvider {
};
}
/**
* Get a certain processor from a list of processors.
*
* @param processors List of processors.
* @param name Name of the processor to get.
* @param fallback True to return first processor if not found, false to not return any. Defaults to true.
* @return Processor.
*/
getProcessor(
processors: AddonNotificationsPreferencesProcessor[],
name: string,
fallback: boolean = true,
): AddonNotificationsPreferencesProcessor | undefined {
if (!processors || !processors.length) {
return;
}
const processor = processors.find((processor) => processor.name == name);
if (processor) {
return processor;
}
// Processor not found, return first if requested.
if (fallback) {
return processors[0];
}
}
/**
* Return the components and notifications that have a certain processor.
*
* @param processorName Name of the processor to filter.
* @param components Array of components.
* @return Filtered components.
*/
getProcessorComponents(
processorName: string,
components: AddonNotificationsPreferencesComponentFormatted[],
): AddonNotificationsPreferencesComponentFormatted[] {
const result: AddonNotificationsPreferencesComponentFormatted[] = [];
components.forEach((component) => {
// Check if the component has any notification with this processor.
const notifications: AddonNotificationsPreferencesNotificationFormatted[] = [];
component.notifications.forEach((notification) => {
const processor = notification.processorsByName?.[processorName];
if (processor) {
// Add the notification.
notifications.push(notification);
}
});
if (notifications.length) {
// At least 1 notification added, add the component to the result.
result.push({
displayname: component.displayname,
notifications,
});
}
});
return result;
}
}
export class AddonNotificationsHelper extends makeSingleton(AddonNotificationsHelperProvider) {}
/**
* Preferences with some calculated data.
*/
export type AddonNotificationsPreferencesFormatted = Omit<AddonNotificationsPreferences, 'processors'|'components'> & {
processors: AddonNotificationsPreferencesProcessorFormatted[]; // Config form values.
components: AddonNotificationsPreferencesComponentFormatted[]; // Available components.
};
/**
* Preferences component with some calculated data.
*/
export type AddonNotificationsPreferencesComponentFormatted = Omit<AddonNotificationsPreferencesComponent, 'notifications'> & {
notifications: AddonNotificationsPreferencesNotificationFormatted[]; // List of notificaitons for the component.
};
/**
* Preferences notification with some calculated data.
*/
export type AddonNotificationsPreferencesNotificationFormatted = AddonNotificationsPreferencesNotification & {
processorsByName?: Record<string, AddonNotificationsPreferencesNotificationProcessor>; // Calculated in the app.
};
/**
* Preferences processor with some calculated data.
*/
export type AddonNotificationsPreferencesProcessorFormatted = AddonNotificationsPreferencesProcessor & {
supported?: boolean; // Calculated in the app. Whether the processor is supported in the app.
};

3
src/core/features/settings/pages/site/site.ts
View File

@ -26,6 +26,7 @@ import { CoreSettingsHelper, CoreSiteSpaceUsage } from '../../services/settings-
import { CoreApp } from '@services/app';
import { CoreSiteInfo } from '@classes/site';
import { Translate } from '@singletons';
import { CoreNavHelper } from '@services/nav-helper';
/**
* Page that displays the list of site settings pages.
@ -182,7 +183,7 @@ export class CoreSitePreferencesPage implements OnInit, OnDestroy {
openHandler(page: string, params?: Params): void {
this.selectedPage = page;
// this.splitviewCtrl.push(page, params);
this.router.navigate([page], { relativeTo: this.route, queryParams: params });
CoreNavHelper.instance.goInCurrentMainMenuTab(page, params);
}
/**

59
src/core/features/settings/services/settings-helper.ts
View File

@ -184,66 +184,23 @@ export class CoreSettingsHelperProvider {
* @param name Name of the processor to get.
* @param fallback True to return first processor if not found, false to not return any. Defaults to true.
* @return Processor.
* @todo typings
* @deprecated since 3.9.5. This function has been moved to AddonNotificationsHelperProvider.
*/
getProcessor(processors: any[], name: string, fallback: boolean = true): any {
if (!processors || !processors.length) {
return;
}
const processor = processors.find((processor) => processor.name == name);
if (processor) {
return processor;
}
// Processor not found, return first if requested.
if (fallback) {
return processors[0];
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
getProcessor(processors: unknown[], name: string, fallback: boolean = true): undefined {
return;
}
/**
* Return the components and notifications that have a certain processor.
*
* @param processor Name of the processor to filter.
* @param processorName Name of the processor to filter.
* @param components Array of components.
* @return Filtered components.
* @todo
* @deprecated since 3.9.5. This function has been moved to AddonNotificationsHelperProvider.
*/
getProcessorComponents(processor: string, components: any[]): any[] {
return processor? components : [];
/*
const result = [];
components.forEach((component) => {
// Create a copy of the component with an empty list of notifications.
const componentCopy = CoreUtils.instance.clone(component);
componentCopy.notifications = [];
component.notifications.forEach((notification) => {
let hasProcessor = false;
for (let i = 0; i < notification.processors.length; i++) {
const proc = notification.processors[i];
if (proc.name == processor) {
hasProcessor = true;
notification.currentProcessor = proc;
break;
}
}
if (hasProcessor) {
// Add the notification.
componentCopy.notifications.push(notification);
}
});
if (componentCopy.notifications.length) {
// At least 1 notification added, add the component to the result.
result.push(componentCopy);
}
});
return result;*/
getProcessorComponents(processorName: string, components: unknown[]): unknown[] {
return components;
}
/**

8
src/core/singletons/events.ts
View File

@ -263,3 +263,11 @@ export type CoreEventFormActionData = CoreEventSiteData & {
form: HTMLElement; // Form element.
online?: boolean; // Whether the data was sent to server or not. Only when submitting.
};
/**
* Data passed to NOTIFICATION_SOUND_CHANGED event.
*/
export type CoreEventNotificationSoundChangedData = CoreEventSiteData & {
enabled: boolean;
};

5
src/theme/app.scss
View File

@ -167,6 +167,11 @@ ion-toolbar {
--border-color: var(--ion-color-danger);
}
// Extra text colors.
.text-gray {
color: var(--gray-dark);
}
// Card styles
// Message cards.

1
src/theme/variables.scss
View File

@ -91,6 +91,7 @@
--ion-text-color: #3a3a3a;
--ion-text-color-rgb: 58,58,58;
--ion-card-color: var(--ion-text-color);
ion-content {
--background: var(--gray-light);