/* * This file is part of buteo-sync-plugins package * * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). * Copyright (C) 2013 - 2021 Jolla Ltd. * * Contact: Sateesh Kavuri * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public License * version 2.1 as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA * */ #include "CalendarStorage.h" #include #include #include "SimpleItem.h" #include "SyncMLCommon.h" #include "SyncMLConfig.h" #include "SyncMLPluginLogging.h" // @todo: Because CalendarMaemo does not support batched operations ( or it does // but we can't use it as we cannot retrieve the id's of committed items ), // batched operations are currently done in series. const char* CTCAPSFILENAME11 = "CTCaps_calendar_11.xml"; const char* CTCAPSFILENAME12 = "CTCaps_calendar_12.xml"; CalendarStorage::CalendarStorage( const QString& aPluginName ) : Buteo::StoragePlugin(aPluginName) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); iCommitNow = true; iStorageType = VCALENDAR_FORMAT; } CalendarStorage::~CalendarStorage() { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); } bool CalendarStorage::init( const QMap& aProperties ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); iProperties = aProperties; // Use remote name (e.g. bt name) as notebook name. if (iProperties.contains(Buteo::KEY_REMOTE_NAME)) { qCDebug(lcSyncMLPlugin) << "Using remote name as notebook name"; iProperties[NOTEBOOKNAME] = iProperties.value(Buteo::KEY_REMOTE_NAME); } else if( iProperties.value( NOTEBOOKNAME ).isEmpty() ) { qCWarning(lcSyncMLPlugin) << NOTEBOOKNAME << " property not found" << "for calendar storage, using default of" << DEFAULT_NOTEBOOK_NAME; iProperties[NOTEBOOKNAME] = DEFAULT_NOTEBOOK_NAME; } qCDebug(lcSyncMLPlugin) << "Initializing calendar, notebook name:" << iProperties[NOTEBOOKNAME]; if( !iCalendar.init( iProperties[NOTEBOOKNAME], iProperties[Buteo::KEY_UUID] ) ) { return false; } if( iProperties[CALENDAR_FORMAT] == CALENDAR_FORMAT_ICAL ) { qCDebug(lcSyncMLPlugin) << "The calendar storage is using icalendar format"; iStorageType = ICALENDAR_FORMAT; iProperties[STORAGE_DEFAULT_MIME_PROP] = "text/calendar"; iProperties[STORAGE_DEFAULT_MIME_VERSION_PROP] = "2.0"; } else { qCDebug(lcSyncMLPlugin) << "The calendar storage is using vcalendar format"; iStorageType = VCALENDAR_FORMAT; } iProperties[STORAGE_SYNCML_CTCAPS_PROP_11] = getCtCaps( CTCAPSFILENAME11 ); iProperties[STORAGE_SYNCML_CTCAPS_PROP_12] = getCtCaps( CTCAPSFILENAME12 ); return true; } bool CalendarStorage::uninit() { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); return iCalendar.uninit(); } bool CalendarStorage::getAllItems( QList& aItems ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving all calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllIncidences( incidences ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve all calendar events and todo's"; return false; } retrieveItems( incidences, aItems ); qCDebug(lcSyncMLPlugin) << "Found" << aItems.count() << "items"; return true; } bool CalendarStorage::getAllItemIds( QList& aItemIds ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving all calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllIncidences( incidences ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve all calendar events and todo's"; return false; } retrieveIds( incidences, aItemIds ); qCDebug(lcSyncMLPlugin) << "Found" << aItemIds.count() << "items"; return true; } bool CalendarStorage::getNewItems( QList& aNewItems, const QDateTime& aTime ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving new calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllNew( incidences, normalizeTime( aTime ) ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve new calendar events and todo's"; return false; } retrieveItems( incidences, aNewItems ); qCDebug(lcSyncMLPlugin) << "Found" << aNewItems.count() << "new items"; return true; } bool CalendarStorage::getNewItemIds( QList& aNewItemIds, const QDateTime& aTime ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving new calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllNew( incidences, normalizeTime( aTime ) ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve new calendar events and todo's"; return false; } retrieveIds( incidences, aNewItemIds ); qCDebug(lcSyncMLPlugin) << "Found" << aNewItemIds.count() << "new items"; return true; } bool CalendarStorage::getModifiedItems( QList& aModifiedItems, const QDateTime& aTime ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving modified calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllModified( incidences, normalizeTime( aTime ) ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve modified calendar events and todo's"; return false; } retrieveItems( incidences, aModifiedItems ); qCDebug(lcSyncMLPlugin) << "Found" << aModifiedItems.count() << "modified items"; return true; } bool CalendarStorage::getModifiedItemIds( QList& aModifiedItemIds, const QDateTime& aTime ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving modified calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllModified( incidences, normalizeTime( aTime ) ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve modified calendar events and todo's"; return false; } retrieveIds( incidences, aModifiedItemIds ); qCDebug(lcSyncMLPlugin) << "Found" << aModifiedItemIds.count() << "modified items"; return true; } bool CalendarStorage::getDeletedItemIds( QList& aDeletedItemIds, const QDateTime& aTime ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); qCDebug(lcSyncMLPlugin) << "Retrieving deleted calendar events and todo's"; KCalendarCore::Incidence::List incidences; if( !iCalendar.getAllDeleted( incidences, normalizeTime( aTime ) ) ) { qCDebug(lcSyncMLPlugin) << "Could not retrieve deleted calendar events and todo's"; return false; } retrieveIds( incidences, aDeletedItemIds ); qCDebug(lcSyncMLPlugin) << "Found" << aDeletedItemIds.count() << "deleted items"; return true; } Buteo::StorageItem* CalendarStorage::newItem() { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); return new SimpleItem(); } QList CalendarStorage::getItems( const QStringList& aItemIdList ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); KCalendarCore::Incidence::List incidences; KCalendarCore::Incidence::Ptr item; QList items; QStringListIterator itr( aItemIdList ); while( itr.hasNext() ) { //TODO Does calendar backend support batch fetch, check! QString id = itr.next(); item = iCalendar.getIncidence( id ); if( item ) { incidences.append( item ); } else { qCWarning(lcSyncMLPlugin) << "Could not find item " << id; } } retrieveItems( incidences, items ); return items; } Buteo::StorageItem* CalendarStorage::getItem( const QString& aItemId ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); KCalendarCore::Incidence::Ptr item = iCalendar.getIncidence( aItemId ); if( item ) { return retrieveItem( item ); } else { qCWarning(lcSyncMLPlugin) << "Could not find item:" << aItemId; return NULL; } } CalendarStorage::OperationStatus CalendarStorage::addItem( Buteo::StorageItem& aItem ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); KCalendarCore::Incidence::Ptr item = generateIncidence( aItem ); if( !item ) { qCWarning(lcSyncMLPlugin) << "Item has invalid format"; return STATUS_INVALID_FORMAT; } if( !iCalendar.addIncidence( item, iCommitNow ) ) { qCWarning(lcSyncMLPlugin) << "Could not add item"; // no need to delete item as item is owned by backend return STATUS_ERROR; } if (item->recurrenceId().isValid()) { QString reccurId = QString(ID_SEPARATOR).append(item->recurrenceId().toString()); aItem.setId( item->uid().append(reccurId) ); } else { aItem.setId( item->uid() ); } qCDebug(lcSyncMLPlugin) << "Item successfully added:" << aItem.getId(); return STATUS_OK; } QList CalendarStorage::addItems( const QList& aItems ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QList results; // Disable auto commit as this is a batch add iCommitNow = false; for( int i = 0; i < aItems.count(); ++i ) { results.append( addItem( *aItems[i] ) ); } //Do a batch commit now if( iCalendar.commitChanges() ) { qCDebug(lcSyncMLPlugin) << "Items successfully added"; } iCommitNow = true; return results; } CalendarStorage::OperationStatus CalendarStorage::modifyItem( Buteo::StorageItem& aItem ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); KCalendarCore::Incidence::Ptr item = generateIncidence( aItem ); if( !item ) { qCWarning(lcSyncMLPlugin) << "Item has invalid format"; return STATUS_INVALID_FORMAT; } if( !iCalendar.modifyIncidence( item, aItem.getId(), iCommitNow ) ) { qCWarning(lcSyncMLPlugin) << "Could not replace item:" << aItem.getId(); // no need to delete item as item is owned by backend return STATUS_ERROR; } qCDebug(lcSyncMLPlugin) << "Item successfully replaced:" << aItem.getId(); // modifyIncidence doesn't take ownership of the item, need to delete it. item.clear(); return STATUS_OK; } QList CalendarStorage::modifyItems( const QList& aItems ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QList results; // Disable auto commit as this is a batch add iCommitNow = false; for( int i = 0; i < aItems.count(); ++i ) { results.append( modifyItem( *aItems[i] ) ); } //Do a batch commit now if( iCalendar.commitChanges() ) { qCDebug(lcSyncMLPlugin) << "Items successfully modified"; } iCommitNow = true; return results; } CalendarStorage::OperationStatus CalendarStorage::deleteItem( const QString& aItemId ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); CalendarBackend::ErrorStatus error = iCalendar.deleteIncidence( aItemId); CalendarStorage::OperationStatus status = mapErrorStatus(error); return status; } QList CalendarStorage::deleteItems( const QList& aItemIds ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QList results; for( int i = 0; i < aItemIds.count(); ++i ) { results.append( deleteItem( aItemIds[i] ) ); } return results; } KCalendarCore::Incidence::Ptr CalendarStorage::generateIncidence( Buteo::StorageItem& aItem ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); KCalendarCore::Incidence::Ptr incidence; QByteArray itemData; if( !aItem.read( 0, aItem.getSize(), itemData ) ) { qCWarning(lcSyncMLPlugin) << "Could not read item data"; return incidence; } QString data = QString::fromUtf8( itemData.data() ); // we are getting a temporary incidence from the calendar if( iStorageType == VCALENDAR_FORMAT ) { incidence = iCalendar.getIncidenceFromVcal( data ); } else { incidence = iCalendar.getIncidenceFromIcal( data ); } return incidence; } void CalendarStorage::retrieveItems( KCalendarCore::Incidence::List& aIncidences, QList& aItems ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); for( int i = 0; i < aIncidences.count(); ++i ) { Buteo::StorageItem* item = retrieveItem( aIncidences[i] ); aItems.append( item ); } } Buteo::StorageItem* CalendarStorage::retrieveItem( KCalendarCore::Incidence::Ptr& aIncidence ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QString data; if(iStorageType == VCALENDAR_FORMAT) { data = iCalendar.getVCalString( aIncidence ); } else { data = iCalendar.getICalString( aIncidence); } Buteo::StorageItem* item = newItem(); QString iId = aIncidence->uid(); if (aIncidence->recurrenceId().isValid()) { QString reccurId = QString(ID_SEPARATOR).append(aIncidence->recurrenceId().toString()); iId.append(reccurId); } item->setId(iId); item->write( 0, data.toUtf8() ); item->setType(iProperties[STORAGE_DEFAULT_MIME_PROP]); return item; } void CalendarStorage::retrieveIds( KCalendarCore::Incidence::List& aIncidences, QList& aIds ) { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); for( int i = 0; i < aIncidences.count(); ++i ) { QString iID = aIncidences[i]->uid(); if (aIncidences[i]->recurrenceId().isValid()) { QString reccurId = QString(ID_SEPARATOR).append(aIncidences[i]->recurrenceId().toString()); iID = iID.append(reccurId); } aIds.append( iID ); } } QDateTime CalendarStorage::normalizeTime( const QDateTime& aTime ) const { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QDateTime normTime = aTime; QTime time = aTime.time(); time.setHMS( time.hour(), time.minute(), time.second(), 0 ); normTime.setTime( time ); normTime = normTime.toUTC(); return normTime; } QByteArray CalendarStorage::getCtCaps( const QString& aFilename ) const { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); QFile ctCapsFile( SyncMLConfig::getXmlDataPath() + aFilename ); QByteArray ctCaps; if( ctCapsFile.open(QIODevice::ReadOnly)) { ctCaps = ctCapsFile.readAll(); ctCapsFile.close(); } else { qCWarning(lcSyncMLPlugin) << "Failed to open CTCaps file for calendar storage:" << aFilename; } return ctCaps; } CalendarStorage::OperationStatus CalendarStorage::mapErrorStatus\ (const CalendarBackend::ErrorStatus &aCalenderError) const { FUNCTION_CALL_TRACE(lcSyncMLPluginTrace); CalendarStorage::OperationStatus iStorageStatus = STATUS_OK; switch(aCalenderError) { case CalendarBackend::STATUS_OK: iStorageStatus = STATUS_OK; break; case CalendarBackend::STATUS_ITEM_DUPLICATE: iStorageStatus = STATUS_DUPLICATE; break; case CalendarBackend::STATUS_ITEM_NOT_FOUND: iStorageStatus = STATUS_NOT_FOUND; break; case CalendarBackend::STATUS_GENERIC_ERROR: iStorageStatus = STATUS_ERROR; break; default: iStorageStatus = STATUS_ERROR; break; } return iStorageStatus; } Buteo::StoragePlugin* CalendarStoragePluginLoader::createPlugin(const QString& aPluginName) { return new CalendarStorage(aPluginName); }