323 lines
12 KiB
TypeScript
323 lines
12 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 { Injectable } from '@angular/core';
|
||
|
|
import { CoreSyncBaseProvider } from '@classes/base-sync';
|
||
|
|
import { CoreApp } from '@services/app';
|
||
|
|
import { CoreEvents } from '@singletons/events';
|
||
|
|
import { CoreSites } from '@services/sites';
|
||
|
|
import { CoreUtils } from '@services/utils/utils';
|
||
|
|
import {
|
||
|
|
AddonCalendar,
|
||
|
|
AddonCalendarEvent,
|
||
|
|
AddonCalendarProvider,
|
||
|
|
AddonCalendarSubmitCreateUpdateFormDataWSParams,
|
||
|
|
} from './calendar';
|
||
|
|
import { AddonCalendarOffline } from './calendar-offline';
|
||
|
|
import { AddonCalendarHelper } from './calendar-helper';
|
||
|
|
import { makeSingleton, Translate } from '@singletons';
|
||
|
|
import { CoreError } from '@classes/errors/error';
|
||
|
|
import { CoreSync } from '@services/sync';
|
||
|
|
import { CoreTextUtils } from '@services/utils/text';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Service to sync calendar.
|
||
|
|
*/
|
||
|
|
@Injectable({ providedIn: 'root' })
|
||
|
|
export class AddonCalendarSyncProvider extends CoreSyncBaseProvider<AddonCalendarSyncEvents> {
|
||
|
|
|
||
|
|
static readonly AUTO_SYNCED = 'addon_calendar_autom_synced';
|
||
|
|
static readonly MANUAL_SYNCED = 'addon_calendar_manual_synced';
|
||
|
|
static readonly SYNC_ID = 'calendar';
|
||
|
|
|
||
|
|
constructor() {
|
||
|
|
super('AddonCalendarSync');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Try to synchronize all events in a certain site or in all sites.
|
||
|
|
*
|
||
|
|
* @param siteId Site ID to sync. If not defined, sync all sites.
|
||
|
|
* @param force Wether to force sync not depending on last execution.
|
||
|
|
* @return Promise resolved if sync is successful, rejected if sync fails.
|
||
|
|
*/
|
||
|
|
async syncAllEvents(siteId?: string, force?: boolean): Promise<void> {
|
||
|
|
await this.syncOnSites('all calendar events', this.syncAllEventsFunc.bind(this, [force]), siteId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sync all events on a site.
|
||
|
|
*
|
||
|
|
* @param siteId Site ID to sync.
|
||
|
|
* @param force Wether to force sync not depending on last execution.
|
||
|
|
* @return Promise resolved if sync is successful, rejected if sync fails.
|
||
|
|
*/
|
||
|
|
protected async syncAllEventsFunc(siteId: string, force?: boolean): Promise<void> {
|
||
|
|
const result = await (force ? this.syncEvents(siteId) : this.syncEventsIfNeeded(siteId));
|
||
|
|
|
||
|
|
if (result && result.updated) {
|
||
|
|
// Sync successful, send event.
|
||
|
|
CoreEvents.trigger<AddonCalendarSyncEvents>(AddonCalendarSyncProvider.AUTO_SYNCED, result, siteId);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sync a site events only if a certain time has passed since the last time.
|
||
|
|
*
|
||
|
|
* @param siteId Site ID. If not defined, current site.
|
||
|
|
* @return Promise resolved when the events are synced or if it doesn't need to be synced.
|
||
|
|
*/
|
||
|
|
async syncEventsIfNeeded(siteId?: string): Promise<void> {
|
||
|
|
siteId = siteId || CoreSites.instance.getCurrentSiteId();
|
||
|
|
|
||
|
|
const needed = await this.isSyncNeeded(AddonCalendarSyncProvider.SYNC_ID, siteId);
|
||
|
|
|
||
|
|
if (needed) {
|
||
|
|
await this.syncEvents(siteId);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Synchronize all offline events of a certain site.
|
||
|
|
*
|
||
|
|
* @param siteId Site ID. If not defined, current site.
|
||
|
|
* @return Promise resolved if sync is successful, rejected otherwise.
|
||
|
|
*/
|
||
|
|
async syncEvents(siteId?: string): Promise<AddonCalendarSyncEvents> {
|
||
|
|
siteId = siteId || CoreSites.instance.getCurrentSiteId();
|
||
|
|
|
||
|
|
if (this.isSyncing(AddonCalendarSyncProvider.SYNC_ID, siteId)) {
|
||
|
|
// There's already a sync ongoing for this site, return the promise.
|
||
|
|
return this.getOngoingSync(AddonCalendarSyncProvider.SYNC_ID, siteId)!;
|
||
|
|
}
|
||
|
|
|
||
|
|
this.logger.debug('Try to sync calendar events for site ' + siteId);
|
||
|
|
|
||
|
|
// Get offline events.
|
||
|
|
const syncPromise = this.performSyncEvents(siteId);
|
||
|
|
|
||
|
|
return this.addOngoingSync(AddonCalendarSyncProvider.SYNC_ID, syncPromise, siteId);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sync user preferences of a site.
|
||
|
|
*
|
||
|
|
* @param siteId Site ID to sync.
|
||
|
|
* @param Promise resolved if sync is successful, rejected if sync fails.
|
||
|
|
*/
|
||
|
|
protected async performSyncEvents(siteId: string): Promise<AddonCalendarSyncEvents> {
|
||
|
|
const result: AddonCalendarSyncEvents = {
|
||
|
|
warnings: [],
|
||
|
|
events: [],
|
||
|
|
deleted: [],
|
||
|
|
toinvalidate: [],
|
||
|
|
updated: false,
|
||
|
|
};
|
||
|
|
|
||
|
|
let eventIds: number[] = [];
|
||
|
|
try {
|
||
|
|
eventIds = await AddonCalendarOffline.instance.getAllEventsIds(siteId);
|
||
|
|
} catch {
|
||
|
|
// No offline data found.
|
||
|
|
}
|
||
|
|
|
||
|
|
if (eventIds.length > 0) {
|
||
|
|
if (!CoreApp.instance.isOnline()) {
|
||
|
|
// Cannot sync in offline.
|
||
|
|
throw new CoreError('Cannot sync while offline');
|
||
|
|
}
|
||
|
|
|
||
|
|
const promises = eventIds.map((eventId) => this.syncOfflineEvent(eventId, result, siteId));
|
||
|
|
|
||
|
|
await CoreUtils.instance.allPromises(promises);
|
||
|
|
|
||
|
|
if (result.updated) {
|
||
|
|
|
||
|
|
// Data has been sent to server. Now invalidate the WS calls.
|
||
|
|
const promises = [
|
||
|
|
AddonCalendar.instance.invalidateEventsList(siteId),
|
||
|
|
AddonCalendarHelper.instance.refreshAfterChangeEvents(result.toinvalidate, siteId),
|
||
|
|
];
|
||
|
|
|
||
|
|
await CoreUtils.instance.ignoreErrors(Promise.all(promises));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Sync finished, set sync time.
|
||
|
|
await CoreUtils.instance.ignoreErrors(this.setSyncTime(AddonCalendarSyncProvider.SYNC_ID, siteId));
|
||
|
|
|
||
|
|
// All done, return the result.
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Synchronize an offline event.
|
||
|
|
*
|
||
|
|
* @param eventId The event ID to sync.
|
||
|
|
* @param result Object where to store the result of the sync.
|
||
|
|
* @param siteId Site ID. If not defined, current site.
|
||
|
|
* @return Promise resolved if sync is successful, rejected otherwise.
|
||
|
|
*/
|
||
|
|
protected async syncOfflineEvent(eventId: number, result: AddonCalendarSyncEvents, siteId?: string): Promise<void> {
|
||
|
|
|
||
|
|
// Verify that event isn't blocked.
|
||
|
|
if (CoreSync.instance.isBlocked(AddonCalendarProvider.COMPONENT, eventId, siteId)) {
|
||
|
|
this.logger.debug('Cannot sync event ' + eventId + ' because it is blocked.');
|
||
|
|
|
||
|
|
throw Translate.instance.instant(
|
||
|
|
'core.errorsyncblocked',
|
||
|
|
{ $a: Translate.instance.instant('addon.calendar.calendarevent') },
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
// First of all, check if the event has been deleted.
|
||
|
|
try {
|
||
|
|
const data = await AddonCalendarOffline.instance.getDeletedEvent(eventId, siteId);
|
||
|
|
// Delete the event.
|
||
|
|
try {
|
||
|
|
await AddonCalendar.instance.deleteEventOnline(data.id, !!data.repeat, siteId);
|
||
|
|
|
||
|
|
result.updated = true;
|
||
|
|
result.deleted.push(eventId);
|
||
|
|
|
||
|
|
// Event sent, delete the offline data.
|
||
|
|
const promises: Promise<void>[] = [];
|
||
|
|
|
||
|
|
promises.push(AddonCalendarOffline.instance.unmarkDeleted(eventId, siteId));
|
||
|
|
promises.push(AddonCalendarOffline.instance.deleteEvent(eventId, siteId).catch(() => {
|
||
|
|
// Ignore errors, maybe there was no edit data.
|
||
|
|
}));
|
||
|
|
|
||
|
|
// We need the event data to invalidate it. Get it from local DB.
|
||
|
|
promises.push(AddonCalendar.instance.getEventFromLocalDb(eventId, siteId).then((event) => {
|
||
|
|
result.toinvalidate.push({
|
||
|
|
id: event.id,
|
||
|
|
repeatid: event.repeatid,
|
||
|
|
timestart: event.timestart,
|
||
|
|
repeated: data?.repeat ? (event as AddonCalendarEvent).eventcount || 1 : 1,
|
||
|
|
});
|
||
|
|
|
||
|
|
return;
|
||
|
|
}).catch(() => {
|
||
|
|
// Ignore errors.
|
||
|
|
}));
|
||
|
|
|
||
|
|
await Promise.all(promises);
|
||
|
|
} catch (error) {
|
||
|
|
|
||
|
|
if (!CoreUtils.instance.isWebServiceError(error)) {
|
||
|
|
// Local error, reject.
|
||
|
|
throw error;
|
||
|
|
}
|
||
|
|
|
||
|
|
// The WebService has thrown an error, this means that the event cannot be created. Delete it.
|
||
|
|
result.updated = true;
|
||
|
|
|
||
|
|
const promises: Promise<void>[] = [];
|
||
|
|
|
||
|
|
promises.push(AddonCalendarOffline.instance.unmarkDeleted(eventId, siteId));
|
||
|
|
promises.push(AddonCalendarOffline.instance.deleteEvent(eventId, siteId).catch(() => {
|
||
|
|
// Ignore errors, maybe there was no edit data.
|
||
|
|
}));
|
||
|
|
|
||
|
|
await Promise.all(promises);
|
||
|
|
// Event deleted, add a warning.
|
||
|
|
result.warnings.push(Translate.instance.instant('core.warningofflinedatadeleted', {
|
||
|
|
component: Translate.instance.instant('addon.calendar.calendarevent'),
|
||
|
|
name: data.name,
|
||
|
|
error: CoreTextUtils.instance.getErrorMessageFromError(error),
|
||
|
|
}));
|
||
|
|
}
|
||
|
|
|
||
|
|
return;
|
||
|
|
} catch {
|
||
|
|
// Not deleted.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Not deleted. Now get the event data.
|
||
|
|
const event = await AddonCalendarOffline.instance.getEvent(eventId, siteId);
|
||
|
|
|
||
|
|
// Try to send the data.
|
||
|
|
const data: AddonCalendarSubmitCreateUpdateFormDataWSParams = Object.assign(
|
||
|
|
CoreUtils.instance.clone(event),
|
||
|
|
{
|
||
|
|
description: {
|
||
|
|
text: event.description || '',
|
||
|
|
format: 1,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
); // Clone the object because it will be modified in the submit function.
|
||
|
|
|
||
|
|
try {
|
||
|
|
const newEvent = await AddonCalendar.instance.submitEventOnline(eventId > 0 ? eventId : 0, data, siteId);
|
||
|
|
|
||
|
|
result.updated = true;
|
||
|
|
result.events.push(newEvent);
|
||
|
|
|
||
|
|
// Add data to invalidate.
|
||
|
|
const numberOfRepetitions = data.repeat ? data.repeats :
|
||
|
|
(data.repeateditall && newEvent.repeatid ? newEvent.eventcount : 1);
|
||
|
|
|
||
|
|
result.toinvalidate.push({
|
||
|
|
id: newEvent.id,
|
||
|
|
repeatid: newEvent.repeatid,
|
||
|
|
timestart: newEvent.timestart,
|
||
|
|
repeated: numberOfRepetitions || 1,
|
||
|
|
});
|
||
|
|
|
||
|
|
// Event sent, delete the offline data.
|
||
|
|
return AddonCalendarOffline.instance.deleteEvent(event.id!, siteId);
|
||
|
|
|
||
|
|
} catch (error) {
|
||
|
|
if (!CoreUtils.instance.isWebServiceError(error)) {
|
||
|
|
// Local error, reject.
|
||
|
|
throw error;
|
||
|
|
}
|
||
|
|
|
||
|
|
// The WebService has thrown an error, this means that the event cannot be created. Delete it.
|
||
|
|
result.updated = true;
|
||
|
|
|
||
|
|
await AddonCalendarOffline.instance.deleteEvent(event.id!, siteId);
|
||
|
|
// Event deleted, add a warning.
|
||
|
|
result.warnings.push(Translate.instance.instant('core.warningofflinedatadeleted', {
|
||
|
|
component: Translate.instance.instant('addon.calendar.calendarevent'),
|
||
|
|
name: event.name,
|
||
|
|
error: CoreTextUtils.instance.getErrorMessageFromError(error),
|
||
|
|
}));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
export class AddonCalendarSync extends makeSingleton(AddonCalendarSyncProvider) {}
|
||
|
|
|
||
|
|
export type AddonCalendarSyncEvents = {
|
||
|
|
warnings: string[];
|
||
|
|
events: AddonCalendarEvent[];
|
||
|
|
deleted: number[];
|
||
|
|
toinvalidate: AddonCalendarSyncInvalidateEvent[];
|
||
|
|
updated: boolean;
|
||
|
|
source?: string; // Added on pages.
|
||
|
|
day?: number; // Added on day page.
|
||
|
|
month?: number; // Added on day page.
|
||
|
|
year?: number; // Added on day page.
|
||
|
|
};
|
||
|
|
|
||
|
|
export type AddonCalendarSyncInvalidateEvent = {
|
||
|
|
id: number;
|
||
|
|
repeatid?: number;
|
||
|
|
timestart: number;
|
||
|
|
repeated: number;
|
||
|
|
};
|