/* Copyright (C) 2004-2005 SKYRIX Software AG This file is part of OpenGroupware.org. OGo is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. OGo 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 OGo; see the file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #import "SOGoTaskObject.h" #import #import #import #import #import #import #import #import #import "SOGoAptMailNotification.h" #import "common.h" #import "NSArray+Appointments.h" @interface SOGoTaskObject (PrivateAPI) - (NSString *)homePageURLForPerson:(iCalPerson *)_person; - (void)sendEMailUsingTemplateNamed:(NSString *)_pageName forOldTask:(iCalToDo *)_newApt andNewTask:(iCalToDo *)_oldApt toAttendees:(NSArray *)_attendees; - (void)sendInvitationEMailForTask:(iCalToDo *)_task toAttendees:(NSArray *)_attendees; - (void)sendTaskUpdateEMailForOldTask:(iCalToDo *)_oldApt newTask:(iCalToDo *)_newApt toAttendees:(NSArray *)_attendees; - (void)sendAttendeeRemovalEMailForTask:(iCalToDo *)_task toAttendees:(NSArray *)_attendees; - (void)sendTaskDeletionEMailForTask:(iCalToDo *)_task toAttendees:(NSArray *)_attendees; @end @implementation SOGoTaskObject static NSString *mailTemplateDefaultLanguage = nil; + (void)initialize { NSUserDefaults *ud; static BOOL didInit = NO; if (didInit) return; didInit = YES; ud = [NSUserDefaults standardUserDefaults]; mailTemplateDefaultLanguage = [[ud stringForKey:@"SOGoDefaultLanguage"] retain]; if (!mailTemplateDefaultLanguage) mailTemplateDefaultLanguage = @"French"; } /* accessors */ - (iCalToDo *) task { return [self firstTaskFromCalendar: [self calendar]]; } /* iCal handling */ - (NSArray *)attendeeUIDsFromTask:(iCalToDo *)_task { AgenorUserManager *um; NSMutableArray *uids; NSArray *attendees; unsigned i, count; NSString *email, *uid; if (![_task isNotNull]) return nil; if ((attendees = [_task attendees]) == nil) return nil; count = [attendees count]; uids = [NSMutableArray arrayWithCapacity:count + 1]; um = [AgenorUserManager sharedUserManager]; /* add organizer */ email = [[_task organizer] rfc822Email]; if ([email isNotNull]) { uid = [um getUIDForEmail:email]; if ([uid isNotNull]) { [uids addObject:uid]; } else [self logWithFormat:@"Note: got no uid for organizer: '%@'", email]; } /* add attendees */ for (i = 0; i < count; i++) { iCalPerson *person; person = [attendees objectAtIndex:i]; email = [person rfc822Email]; if (![email isNotNull]) continue; uid = [um getUIDForEmail:email]; if (![uid isNotNull]) { [self logWithFormat:@"Note: got no uid for email: '%@'", email]; continue; } if (![uids containsObject:uid]) [uids addObject:uid]; } return uids; } /* raw saving */ - (NSException *)primarySaveContentString:(NSString *)_iCalString { return [super saveContentString:_iCalString]; } - (NSException *)primaryDelete { return [super delete]; } /* folder management */ - (id)lookupHomeFolderForUID:(NSString *)_uid inContext:(id)_ctx { // TODO: what does this do? lookup the home of the organizer? return [[self container] lookupHomeFolderForUID:_uid inContext:_ctx]; } - (NSArray *)lookupCalendarFoldersForUIDs:(NSArray *)_uids inContext:(id)_ctx { return [[self container] lookupCalendarFoldersForUIDs:_uids inContext:_ctx]; } /* store in all the other folders */ - (NSException *)saveContentString:(NSString *)_iCal inUIDs:(NSArray *)_uids { NSEnumerator *e; id folder; NSException *allErrors = nil; id ctx; ctx = [[WOApplication application] context]; e = [[self lookupCalendarFoldersForUIDs:_uids inContext:ctx] objectEnumerator]; while ((folder = [e nextObject]) != nil) { NSException *error; SOGoTaskObject *task; if (![folder isNotNull]) /* no folder was found for given UID */ continue; task = [folder lookupName:[self nameInContainer] inContext:ctx acquire:NO]; if ([task isKindOfClass: [NSException class]]) { [self logWithFormat:@"Note: an exception occured finding '%@' in folder: %@", [self nameInContainer], folder]; [self logWithFormat:@"the exception reason was: %@", [(NSException *) task reason]]; continue; } if (![task isNotNull]) { [self logWithFormat:@"Note: did not find '%@' in folder: %@", [self nameInContainer], folder]; continue; } if ((error = [task primarySaveContentString:_iCal]) != nil) { [self logWithFormat:@"Note: failed to save iCal in folder: %@", folder]; // TODO: make compound allErrors = error; } } return allErrors; } - (NSException *)deleteInUIDs:(NSArray *)_uids { NSEnumerator *e; id folder; NSException *allErrors = nil; id ctx; ctx = [[WOApplication application] context]; e = [[self lookupCalendarFoldersForUIDs:_uids inContext:ctx] objectEnumerator]; while ((folder = [e nextObject])) { NSException *error; SOGoTaskObject *task; task = [folder lookupName:[self nameInContainer] inContext:ctx acquire:NO]; if (![task isNotNull]) { [self logWithFormat:@"Note: did not find '%@' in folder: %@", [self nameInContainer], folder]; continue; } if ([task isKindOfClass: [NSException class]]) { [self logWithFormat:@"Exception: %@", [(NSException *) task reason]]; continue; } if ((error = [task primaryDelete]) != nil) { [self logWithFormat:@"Note: failed to delete in folder: %@", folder]; // TODO: make compound allErrors = error; } } return allErrors; } - (iCalToDo *) firstTaskFromCalendar: (iCalCalendar *) aCalendar { iCalToDo *task; NSArray *tasks; tasks = [aCalendar childrenWithTag: @"vtodo"]; if ([tasks count]) task = (iCalToDo *) [[tasks objectAtIndex: 0] groupWithClass: [iCalToDo class]]; else task = nil; return task; } /* "iCal multifolder saves" */ - (NSException *) saveContentString: (NSString *) _iCal baseSequence: (int) _v { /* Note: we need to delete in all participants folders and send iMIP messages for all external accounts. Steps: - fetch stored content - parse old content - check if sequence matches (or if 0=ignore) - extract old attendee list + organizer (make unique) - parse new content (ensure that sequence is increased!) - extract new attendee list + organizer (make unique) - make a diff => new, same, removed - write to new, same - delete in removed folders - send iMIP mail for all folders not found */ // AgenorUserManager *um; // iCalCalendar *calendar; // iCalToDo *oldApt, *newApt; // // iCalToDoChanges *changes; // iCalPerson *organizer; // NSString *oldContent, *uid; // NSArray *uids, *props; // NSMutableArray *attendees, *storeUIDs, *removedUIDs; NSException *storeError, *delError; // BOOL updateForcesReconsider; // updateForcesReconsider = NO; // if ([_iCal length] == 0) { // return [NSException exceptionWithHTTPStatus:400 /* Bad Request */ // reason:@"got no iCalendar content to store!"]; // } // um = [AgenorUserManager sharedUserManager]; // /* handle old content */ // oldContent = [self iCalString]; /* if nil, this is a new task */ // if ([oldContent length] == 0) // { // /* new task */ // [self debugWithFormat:@"saving new task: %@", _iCal]; // oldApt = nil; // } // else // { // calendar = [iCalCalendar parseSingleFromSource: oldContent]; // oldApt = [self firstTaskFromCalendar: calendar]; // } // /* compare sequence if requested */ // if (_v != 0) { // // TODO // } // /* handle new content */ // calendar = [iCalCalendar parseSingleFromSource: _iCal]; // newApt = [self firstTaskFromCalendar: calendar]; // if (newApt == nil) { // return [NSException exceptionWithHTTPStatus:400 /* Bad Request */ // reason:@"could not parse iCalendar content!"]; // } // /* diff */ // changes = [iCalToDoChanges changesFromEvent: oldApt // toEvent: newApt]; // uids = [um getUIDsForICalPersons:[changes deletedAttendees] // applyStrictMapping:NO]; // removedUIDs = [NSMutableArray arrayWithArray:uids]; // uids = [um getUIDsForICalPersons:[newApt attendees] // applyStrictMapping:NO]; // storeUIDs = [NSMutableArray arrayWithArray:uids]; // props = [changes updatedProperties]; // /* detect whether sequence has to be increased */ // if ([changes hasChanges]) // [newApt increaseSequence]; // /* preserve organizer */ // organizer = [newApt organizer]; // uid = [um getUIDForICalPerson:organizer]; // if (uid) { // if (![storeUIDs containsObject:uid]) // [storeUIDs addObject:uid]; // [removedUIDs removeObject:uid]; // } // /* organizer might have changed completely */ // if (oldApt && ([props containsObject: @"organizer"])) { // uid = [um getUIDForICalPerson:[oldApt organizer]]; // if (uid) { // if (![storeUIDs containsObject:uid]) { // if (![removedUIDs containsObject:uid]) { // [removedUIDs addObject:uid]; // } // } // } // } // [self debugWithFormat:@"UID ops:\n store: %@\n remove: %@", // storeUIDs, removedUIDs]; // /* if time did change, all participants have to re-decide ... // * ... exception from that rule: the organizer // */ // if (oldApt != nil && // ([props containsObject:@"startDate"] || // [props containsObject:@"endDate"] || // [props containsObject:@"duration"])) // { // NSArray *ps; // unsigned i, count; // ps = [newApt attendees]; // count = [ps count]; // for (i = 0; i < count; i++) { // iCalPerson *p; // p = [ps objectAtIndex:i]; // if (![p hasSameEmailAddress:organizer]) // [p setParticipationStatus:iCalPersonPartStatNeedsAction]; // } // _iCal = [[newApt parent] versitString]; // updateForcesReconsider = YES; // } // /* perform storing */ storeError = [self primarySaveContentString: _iCal]; // storeError = [self saveContentString:_iCal inUIDs:storeUIDs]; // delError = [self deleteInUIDs:removedUIDs]; // TODO: make compound if (storeError != nil) return storeError; // if (delError != nil) return delError; /* email notifications */ // attendees = [NSMutableArray arrayWithArray:[changes insertedAttendees]]; // [attendees removePerson:organizer]; // [self sendInvitationEMailForTask:newApt // toAttendees:attendees]; // if (updateForcesReconsider) { // attendees = [NSMutableArray arrayWithArray:[newApt attendees]]; // [attendees removeObjectsInArray:[changes insertedAttendees]]; // [attendees removePerson:organizer]; // [self sendTaskUpdateEMailForOldTask:oldApt // newTask:newApt // toAttendees:attendees]; // } // attendees = [NSMutableArray arrayWithArray:[changes deletedAttendees]]; // [attendees removePerson: organizer]; // if ([attendees count]) { // iCalToDo *canceledApt; // canceledApt = [newApt copy]; // [(iCalCalendar *) [canceledApt parent] setMethod: @"cancel"]; // [self sendAttendeeRemovalEMailForTask:canceledApt // toAttendees:attendees]; // [canceledApt release]; // } return nil; } - (NSException *)deleteWithBaseSequence:(int)_v { /* Note: We need to delete in all participants folders and send iMIP messages for all external accounts. Delete is basically identical to save with all attendees and the organizer being deleted. Steps: - fetch stored content - parse old content - check if sequence matches (or if 0=ignore) - extract old attendee list + organizer (make unique) - delete in removed folders - send iMIP mail for all folders not found */ iCalToDo *task; NSArray *removedUIDs; NSMutableArray *attendees; /* load existing content */ task = [self task]; /* compare sequence if requested */ if (_v != 0) { // TODO } removedUIDs = [self attendeeUIDsFromTask:task]; /* send notification email to attendees excluding organizer */ attendees = [NSMutableArray arrayWithArray:[task attendees]]; [attendees removePerson:[task organizer]]; /* flag task as being canceled */ [(iCalCalendar *) [task parent] setMethod: @"cancel"]; [task increaseSequence]; /* remove all attendees to signal complete removal */ [task removeAllAttendees]; /* send notification email */ [self sendTaskDeletionEMailForTask:task toAttendees:attendees]; /* perform */ return [self deleteInUIDs:removedUIDs]; } - (NSException *)saveContentString:(NSString *)_iCalString { return [self saveContentString:_iCalString baseSequence:0]; } - (NSException *)changeParticipationStatus:(NSString *)_status inContext:(id)_ctx { iCalToDo *task; iCalPerson *p; NSString *newContent; NSException *ex; NSString *myEMail; // TODO: do we need to use SOGoTask? (prefer iCalToDo?) task = [self task]; if (task == nil) { return [NSException exceptionWithHTTPStatus:500 /* Server Error */ reason:@"unable to parse task record"]; } myEMail = [[_ctx activeUser] email]; if ((p = [task findParticipantWithEmail:myEMail]) == nil) { return [NSException exceptionWithHTTPStatus:404 /* Not Found */ reason:@"user does not participate in this " @"task"]; } [p setPartStat:_status]; newContent = [[task parent] versitString]; // TODO: send iMIP reply mails? // [task release]; task = nil; if (newContent == nil) { return [NSException exceptionWithHTTPStatus:500 /* Server Error */ reason:@"Could not generate iCalendar data ..."]; } if ((ex = [self saveContentString:newContent]) != nil) { // TODO: why is the exception wrapped? return [NSException exceptionWithHTTPStatus:500 /* Server Error */ reason:[ex reason]]; } return nil /* means: no error */; } /* message type */ - (NSString *)outlookMessageClass { return @"IPM.Task"; } /* EMail Notifications */ - (NSString *)homePageURLForPerson:(iCalPerson *)_person { static AgenorUserManager *um = nil; static NSString *baseURL = nil; NSString *uid; if (!um) { WOContext *ctx; NSArray *traversalObjects; um = [[AgenorUserManager sharedUserManager] retain]; /* generate URL from traversal stack */ ctx = [[WOApplication application] context]; traversalObjects = [ctx objectTraversalStack]; if ([traversalObjects count] >= 1) { baseURL = [[[traversalObjects objectAtIndex:0] baseURLInContext:ctx] retain]; } else { [self warnWithFormat:@"Unable to create baseURL from context!"]; baseURL = @"http://localhost/"; } } uid = [um getUIDForEmail:[_person rfc822Email]]; if (!uid) return nil; return [NSString stringWithFormat:@"%@%@", baseURL, uid]; } - (void)sendEMailUsingTemplateNamed:(NSString *)_pageName forOldTask:(iCalToDo *)_oldApt andNewTask:(iCalToDo *)_newApt toAttendees:(NSArray *)_attendees { NSString *pageName; iCalPerson *organizer; NSString *cn, *sender, *iCalString; NGSendMail *sendmail; WOApplication *app; unsigned i, count; if (![_attendees count]) return; // another job neatly done :-) /* sender */ organizer = [_newApt organizer]; cn = [organizer cnWithoutQuotes]; if (cn) { sender = [NSString stringWithFormat:@"%@ <%@>", cn, [organizer rfc822Email]]; } else { sender = [organizer rfc822Email]; } /* generate iCalString once */ iCalString = [[_newApt parent] versitString]; /* get sendmail object */ sendmail = [NGSendMail sharedSendMail]; /* get WOApplication instance */ app = [WOApplication application]; /* generate dynamic message content */ count = [_attendees count]; for (i = 0; i < count; i++) { iCalPerson *attendee; NSString *recipient; SOGoAptMailNotification *p; NSString *subject, *text, *header; NGMutableHashMap *headerMap; NGMimeMessage *msg; NGMimeBodyPart *bodyPart; NGMimeMultipartBody *body; attendee = [_attendees objectAtIndex:i]; /* construct recipient */ cn = [attendee cn]; if (cn) { recipient = [NSString stringWithFormat:@"%@ <%@>", cn, [attendee rfc822Email]]; } else { recipient = [attendee rfc822Email]; } /* create page name */ // TODO: select user's default language? pageName = [NSString stringWithFormat:@"SOGoAptMail%@%@", mailTemplateDefaultLanguage, _pageName]; /* construct message content */ p = [app pageWithName:pageName inContext:[WOContext context]]; [p setNewApt: _newApt]; [p setOldApt: _oldApt]; [p setHomePageURL:[self homePageURLForPerson:attendee]]; [p setViewTZ: [self userTimeZone: cn]]; subject = [p getSubject]; text = [p getBody]; /* construct message */ headerMap = [NGMutableHashMap hashMapWithCapacity:5]; /* NOTE: multipart/alternative seems like the correct choice but * unfortunately Thunderbird doesn't offer the rich content alternative * at all. Mail.app shows the rich content alternative _only_ * so we'll stick with multipart/mixed for the time being. */ [headerMap setObject:@"multipart/mixed" forKey:@"content-type"]; [headerMap setObject:sender forKey:@"From"]; [headerMap setObject:recipient forKey:@"To"]; [headerMap setObject:[NSCalendarDate date] forKey:@"date"]; [headerMap setObject:subject forKey:@"Subject"]; msg = [NGMimeMessage messageWithHeader:headerMap]; /* multipart body */ body = [[NGMimeMultipartBody alloc] initWithPart:msg]; /* text part */ headerMap = [NGMutableHashMap hashMapWithCapacity:1]; [headerMap setObject:@"text/plain; charset=utf-8" forKey:@"content-type"]; bodyPart = [NGMimeBodyPart bodyPartWithHeader:headerMap]; [bodyPart setBody:[text dataUsingEncoding:NSUTF8StringEncoding]]; /* attach text part to multipart body */ [body addBodyPart:bodyPart]; /* calendar part */ header = [NSString stringWithFormat:@"text/calendar; method=%@;" @" charset=utf-8", [(iCalCalendar *) [_newApt parent] method]]; headerMap = [NGMutableHashMap hashMapWithCapacity:1]; [headerMap setObject:header forKey:@"content-type"]; bodyPart = [NGMimeBodyPart bodyPartWithHeader:headerMap]; [bodyPart setBody:[iCalString dataUsingEncoding:NSUTF8StringEncoding]]; /* attach calendar part to multipart body */ [body addBodyPart:bodyPart]; /* attach multipart body to message */ [msg setBody:body]; [body release]; /* send the damn thing */ [sendmail sendMimePart:msg toRecipients:[NSArray arrayWithObject:[attendee rfc822Email]] sender:[organizer rfc822Email]]; } } - (void)sendInvitationEMailForTask:(iCalToDo *)_task toAttendees:(NSArray *)_attendees { if (![_attendees count]) return; // another job neatly done :-) [self sendEMailUsingTemplateNamed:@"Invitation" forOldTask:nil andNewTask:_task toAttendees:_attendees]; } - (void)sendTaskUpdateEMailForOldTask:(iCalToDo *)_oldApt newTask:(iCalToDo *)_newApt toAttendees:(NSArray *)_attendees { if (![_attendees count]) return; [self sendEMailUsingTemplateNamed:@"Update" forOldTask:_oldApt andNewTask:_newApt toAttendees:_attendees]; } - (void) sendAttendeeRemovalEMailForTask:(iCalToDo *)_task toAttendees:(NSArray *)_attendees { if (![_attendees count]) return; [self sendEMailUsingTemplateNamed:@"Removal" forOldTask:nil andNewTask:_task toAttendees:_attendees]; } - (void) sendTaskDeletionEMailForTask: (iCalToDo *) _task toAttendees: (NSArray *) _attendees { if (![_attendees count]) return; [self sendEMailUsingTemplateNamed:@"Deletion" forOldTask:nil andNewTask:_task toAttendees:_attendees]; } - (NSString *) davContentType { return @"text/calendar"; } @end /* SOGoTaskObject */