2021-09-29 10:06:10 +02:00

555 lines
19 KiB
TypeScript

// (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, OnDestroy, OnInit } from '@angular/core';
import { IonRefresher } from '@ionic/angular';
import { AlertOptions } from '@ionic/core';
import {
AddonCalendar,
AddonCalendarEventToDisplay,
AddonCalendarProvider,
} from '../../services/calendar';
import { AddonCalendarHelper } from '../../services/calendar-helper';
import { AddonCalendarOffline } from '../../services/calendar-offline';
import { AddonCalendarSync, AddonCalendarSyncEvents, AddonCalendarSyncProvider } from '../../services/calendar-sync';
import { CoreApp } from '@services/app';
import { CoreEventObserver, CoreEvents } from '@singletons/events';
import { CoreDomUtils } from '@services/utils/dom';
import { CoreTextUtils } from '@services/utils/text';
import { CoreSites } from '@services/sites';
import { CoreLocalNotifications } from '@services/local-notifications';
import { CoreCourse } from '@features/course/services/course';
import { CoreTimeUtils } from '@services/utils/time';
import { CoreGroups } from '@services/groups';
import { Network, NgZone, Translate } from '@singletons';
import { Subscription } from 'rxjs';
import { CoreNavigator } from '@services/navigator';
import { CoreUtils } from '@services/utils/utils';
import { AddonCalendarReminderDBRecord } from '../../services/database/calendar';
import { ActivatedRoute } from '@angular/router';
import { CoreConstants } from '@/core/constants';
import { CoreLang } from '@services/lang';
/**
* Page that displays a single calendar event.
*/
@Component({
selector: 'page-addon-calendar-event',
templateUrl: 'event.html',
styleUrls: ['event.scss'],
})
export class AddonCalendarEventPage implements OnInit, OnDestroy {
protected eventId!: number;
protected siteHomeId: number;
protected editEventObserver: CoreEventObserver;
protected syncObserver: CoreEventObserver;
protected manualSyncObserver: CoreEventObserver;
protected onlineObserver: Subscription;
protected currentSiteId: string;
eventLoaded = false;
notificationFormat?: string;
notificationMin?: string;
notificationMax?: string;
notificationTimeText?: string;
event?: AddonCalendarEventToDisplay;
courseId?: number;
courseName = '';
groupName?: string;
courseUrl = '';
notificationsEnabled = false;
moduleUrl = '';
categoryPath = '';
currentTime?: number;
defaultTime = 0;
reminders: AddonCalendarReminderDBRecord[] = [];
canEdit = false;
hasOffline = false;
isOnline = false;
syncIcon = CoreConstants.ICON_LOADING; // Sync icon.
monthNames?: string[];
constructor(
protected route: ActivatedRoute,
) {
this.notificationsEnabled = CoreLocalNotifications.isAvailable();
this.siteHomeId = CoreSites.getCurrentSiteHomeId();
this.currentSiteId = CoreSites.getCurrentSiteId();
// Check if site supports editing. No need to check allowed types, event.canedit already does it.
this.canEdit = AddonCalendar.canEditEventsInSite();
// Listen for event edited. If current event is edited, reload the data.
this.editEventObserver = CoreEvents.on(AddonCalendarProvider.EDIT_EVENT_EVENT, (data) => {
if (data && data.eventId == this.eventId) {
this.eventLoaded = false;
this.refreshEvent(true, false);
}
}, this.currentSiteId);
// Refresh data if this calendar event is synchronized automatically.
this.syncObserver = CoreEvents.on(
AddonCalendarSyncProvider.AUTO_SYNCED,
this.checkSyncResult.bind(this, false),
this.currentSiteId,
);
// Refresh data if calendar events are synchronized manually but not by this page.
this.manualSyncObserver = CoreEvents.on(
AddonCalendarSyncProvider.MANUAL_SYNCED,
this.checkSyncResult.bind(this, true),
this.currentSiteId,
);
// Refresh online status when changes.
this.onlineObserver = Network.onChange().subscribe(() => {
// Execute the callback in the Angular zone, so change detection doesn't stop working.
NgZone.run(() => {
this.isOnline = CoreApp.isOnline();
});
});
}
protected async initReminders(): Promise<void> {
if (this.notificationsEnabled) {
this.monthNames = CoreLang.getMonthNames();
this.reminders = await AddonCalendar.getEventReminders(this.eventId);
this.defaultTime = await AddonCalendar.getDefaultNotificationTime() * 60;
// Calculate format to use.
this.notificationFormat =
CoreTimeUtils.fixFormatForDatetime(CoreTimeUtils.convertPHPToMoment(
Translate.instant('core.strftimedatetime'),
));
}
}
/**
* View loaded.
*/
ngOnInit(): void {
try {
this.eventId = CoreNavigator.getRequiredRouteNumberParam('id');
} catch (error) {
CoreDomUtils.showErrorModal(error);
CoreNavigator.back();
return;
}
this.syncIcon = CoreConstants.ICON_LOADING;
this.fetchEvent();
this.initReminders();
}
/**
* Fetches the event and updates the view.
*
* @param sync Whether it should try to synchronize offline events.
* @param showErrors Whether to show sync errors to the user.
* @return Promise resolved when done.
*/
async fetchEvent(sync = false, showErrors = false): Promise<void> {
let deleted = false;
this.isOnline = CoreApp.isOnline();
if (sync) {
// Try to synchronize offline events.
try {
const result = await AddonCalendarSync.syncEvents();
if (result.warnings && result.warnings.length) {
CoreDomUtils.showErrorModal(result.warnings[0]);
}
if (result.deleted && result.deleted.indexOf(this.eventId) != -1) {
// This event was deleted during the sync.
deleted = true;
}
if (result.updated) {
// Trigger a manual sync event.
result.source = 'event';
CoreEvents.trigger(
AddonCalendarSyncProvider.MANUAL_SYNCED,
result,
this.currentSiteId,
);
}
} catch (error) {
if (showErrors) {
CoreDomUtils.showErrorModalDefault(error, 'core.errorsync', true);
}
}
}
if (deleted) {
return;
}
try {
// Get the event data.
const event = await AddonCalendar.getEventById(this.eventId);
this.event = await AddonCalendarHelper.formatEventData(event);
try {
const offlineEvent = AddonCalendarHelper.formatOfflineEventData(
await AddonCalendarOffline.getEvent(this.eventId),
);
// There is offline data, apply it.
this.hasOffline = true;
this.event = Object.assign(this.event, offlineEvent);
} catch {
// No offline data.
this.hasOffline = false;
}
this.currentTime = CoreTimeUtils.timestamp();
this.notificationMin = CoreTimeUtils.userDate(this.currentTime * 1000, 'YYYY-MM-DDTHH:mm', false);
this.notificationMax = CoreTimeUtils.userDate(
(this.event!.timestart + this.event!.timeduration) * 1000,
'YYYY-MM-DDTHH:mm',
false,
);
// Reset some of the calculated data.
this.categoryPath = '';
this.courseName = '';
this.courseUrl = '';
this.moduleUrl = '';
if (this.event!.moduleIcon) {
// It's a module event, translate the module name to the current language.
const name = CoreCourse.translateModuleName(this.event!.modulename || '');
if (name.indexOf('core.mod_') === -1) {
this.event!.modulename = name;
}
// Get the module URL.
this.moduleUrl = this.event!.url || '';
}
const promises: Promise<void>[] = [];
const courseId = this.event.courseid;
if (courseId != this.siteHomeId) {
// If the event belongs to a course, get the course name and the URL to view it.
if (this.event.course) {
this.courseId = this.event.course.id;
this.courseName = this.event.course.fullname;
this.courseUrl = this.event.course.viewurl;
}
}
// If it's a group event, get the name of the group.
if (courseId && this.event.groupid) {
promises.push(CoreGroups.getUserGroupsInCourse(courseId).then((groups) => {
const group = groups.find((group) => group.id == this.event!.groupid);
this.groupName = group ? group.name : '';
return;
}).catch(() => {
// Error getting groups, just don't show the group name.
this.groupName = '';
}));
}
if (this.event.iscategoryevent && this.event.category) {
this.categoryPath = this.event.category.nestedname;
}
if (this.event.location) {
// Build a link to open the address in maps.
this.event.location = CoreTextUtils.decodeHTML(this.event.location);
this.event.encodedLocation = CoreTextUtils.buildAddressURL(this.event.location);
}
// Check if event was deleted in offine.
promises.push(AddonCalendarOffline.isEventDeleted(this.eventId).then((deleted) => {
this.event!.deleted = deleted;
return;
}));
// Re-calculate the formatted time so it uses the device date.
promises.push(AddonCalendar.getCalendarTimeFormat().then(async (timeFormat) => {
this.event!.formattedtime = await AddonCalendar.formatEventTime(this.event!, timeFormat);
return;
}));
await Promise.all(promises);
} catch (error) {
CoreDomUtils.showErrorModalDefault(error, 'addon.calendar.errorloadevent', true);
}
this.eventLoaded = true;
this.syncIcon = CoreConstants.ICON_SYNC;
}
/**
* Add a reminder for this event.
*/
async addNotificationTime(): Promise<void> {
if (this.notificationTimeText && this.event && this.event.id) {
let notificationTime = CoreTimeUtils.convertToTimestamp(this.notificationTimeText);
const currentTime = CoreTimeUtils.timestamp();
const minute = Math.floor(currentTime / 60) * 60;
// Check if the notification time is in the same minute as we are, so the notification is triggered.
if (notificationTime >= minute && notificationTime < minute + 60) {
notificationTime = currentTime + 1;
}
await AddonCalendar.addEventReminder(this.event, notificationTime);
this.reminders = await AddonCalendar.getEventReminders(this.eventId);
this.notificationTimeText = undefined;
}
}
/**
* Cancel the selected notification.
*
* @param id Reminder ID.
* @param e Click event.
*/
async cancelNotification(id: number, e: Event): Promise<void> {
e.preventDefault();
e.stopPropagation();
try {
await CoreDomUtils.showDeleteConfirm();
const modal = await CoreDomUtils.showModalLoading('core.deleting', true);
try {
await AddonCalendar.deleteEventReminder(id);
this.reminders = await AddonCalendar.getEventReminders(this.eventId);
} catch (error) {
CoreDomUtils.showErrorModalDefault(error, 'Error deleting reminder');
} finally {
modal.dismiss();
}
} catch {
// Ignore errors.
}
}
/**
* Refresh the data.
*
* @param refresher Refresher.
* @param done Function to call when done.
* @param showErrors Whether to show sync errors to the user.
* @return Promise resolved when done.
*/
async doRefresh(refresher?: IonRefresher, done?: () => void, showErrors= false): Promise<void> {
if (!this.eventLoaded) {
return;
}
await this.refreshEvent(true, showErrors).finally(() => {
refresher?.complete();
done && done();
});
}
/**
* Refresh the event.
*
* @param sync Whether it should try to synchronize offline events.
* @param showErrors Whether to show sync errors to the user.
* @return Promise resolved when done.
*/
async refreshEvent(sync = false, showErrors = false): Promise<void> {
this.syncIcon = CoreConstants.ICON_LOADING;
const promises: Promise<void>[] = [];
promises.push(AddonCalendar.invalidateEvent(this.eventId));
promises.push(AddonCalendar.invalidateTimeFormat());
await CoreUtils.allPromisesIgnoringErrors(promises);
await this.fetchEvent(sync, showErrors);
}
/**
* Open the page to edit the event.
*/
openEdit(): void {
CoreNavigator.navigateToSitePath(`/calendar/edit/${this.eventId}`);
}
/**
* Delete the event.
*/
async deleteEvent(): Promise<void> {
if (!this.event) {
return;
}
const title = Translate.instant('addon.calendar.deleteevent');
const options: AlertOptions = {};
let message: string;
if (this.event.eventcount > 1) {
// It's a repeated event.
message = Translate.instant(
'addon.calendar.confirmeventseriesdelete',
{ $a: { name: this.event.name, count: this.event.eventcount } },
);
options.inputs = [
{
type: 'radio',
name: 'deleteall',
checked: true,
value: false,
label: Translate.instant('addon.calendar.deleteoneevent'),
},
{
type: 'radio',
name: 'deleteall',
checked: false,
value: true,
label: Translate.instant('addon.calendar.deleteallevents'),
},
];
} else {
// Not repeated, display a simple confirm.
message = Translate.instant('addon.calendar.confirmeventdelete', { $a: this.event.name });
}
let deleteAll = false;
try {
deleteAll = await CoreDomUtils.showConfirm(message, title, undefined, undefined, options);
} catch {
// User canceled.
return;
}
const modal = await CoreDomUtils.showModalLoading('core.sending', true);
try {
const sent = await AddonCalendar.deleteEvent(this.event.id, this.event.name, deleteAll);
if (sent) {
// Event deleted, invalidate right days & months.
try {
await AddonCalendarHelper.refreshAfterChangeEvent(this.event, deleteAll ? this.event.eventcount : 1);
} catch {
// Ignore errors.
}
}
// Trigger an event.
CoreEvents.trigger(AddonCalendarProvider.DELETED_EVENT_EVENT, {
eventId: this.eventId,
sent: sent,
}, CoreSites.getCurrentSiteId());
if (sent) {
CoreDomUtils.showToast('addon.calendar.eventcalendareventdeleted', true, 3000);
// Event deleted, close the view.
CoreNavigator.back();
} else {
// Event deleted in offline, just mark it as deleted.
this.event.deleted = true;
}
} catch (error) {
CoreDomUtils.showErrorModalDefault(error, 'Error deleting event.');
}
modal.dismiss();
}
/**
* Undo delete the event.
*/
async undoDelete(): Promise<void> {
if (!this.event) {
return;
}
const modal = await CoreDomUtils.showModalLoading('core.sending', true);
try {
await AddonCalendarOffline.unmarkDeleted(this.event.id);
// Trigger an event.
CoreEvents.trigger(AddonCalendarProvider.UNDELETED_EVENT_EVENT, {
eventId: this.eventId,
}, CoreSites.getCurrentSiteId());
this.event.deleted = false;
} catch (error) {
CoreDomUtils.showErrorModalDefault(error, 'Error undeleting event.');
}
modal.dismiss();
}
/**
* Check the result of an automatic sync or a manual sync not done by this page.
*
* @param isManual Whether it's a manual sync.
* @param data Sync result.
*/
protected checkSyncResult(isManual: boolean, data: AddonCalendarSyncEvents): void {
if (!data) {
return;
}
if (data.deleted && data.deleted.indexOf(this.eventId) != -1) {
CoreDomUtils.showToast('addon.calendar.eventcalendareventdeleted', true, 3000);
// Event was deleted, close the view.
CoreNavigator.back();
} else if (data.events && (!isManual || data.source != 'event')) {
const event = data.events.find((ev) => ev.id == this.eventId);
if (event) {
this.eventLoaded = false;
this.refreshEvent();
}
}
}
/**
* Page destroyed.
*/
ngOnDestroy(): void {
this.editEventObserver?.off();
this.syncObserver?.off();
this.manualSyncObserver?.off();
this.onlineObserver?.unsubscribe();
}
}