2 Copyright (C) 2004-2005 SKYRIX Software AG
4 This file is part of SOPE.
6 SOPE is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Lesser General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with SOPE; see the file COPYING. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #import <NGExtensions/NSCalendarDate+misc.h>
23 #import <NGExtensions/NGCalendarDateRange.h>
24 #import <NGExtensions/NSNull+misc.h>
25 #import <NGExtensions/NSObject+Logs.h>
27 #import "iCalRecurrenceRule.h"
28 #import "NSCalendarDate+ICal.h"
31 #import "iCalRecurrenceCalculator.h"
38 @interface iCalRecurrenceCalculator (PrivateAPI)
39 - (NSCalendarDate *)lastInstanceStartDate;
41 - (unsigned)offsetFromSundayForJulianNumber:(long)_jn;
42 - (unsigned)offsetFromSundayForWeekDay:(iCalWeekDay)_weekDay;
43 - (unsigned)offsetFromSundayForCurrentWeekStart;
45 - (iCalWeekDay)weekDayForJulianNumber:(long)_jn;
48 @implementation iCalRecurrenceCalculator
50 static Class NSCalendarDateClass = Nil;
51 static Class iCalRecurrenceRuleClass = Nil;
52 static Class dailyCalcClass = Nil;
53 static Class weeklyCalcClass = Nil;
54 static Class monthlyCalcClass = Nil;
55 static Class yearlyCalcClass = Nil;
58 static BOOL didInit = NO;
63 NSCalendarDateClass = [NSCalendarDate class];
64 iCalRecurrenceRuleClass = [iCalRecurrenceRule class];
66 dailyCalcClass = NSClassFromString(@"iCalDailyRecurrenceCalculator");
67 weeklyCalcClass = NSClassFromString(@"iCalWeeklyRecurrenceCalculator");
68 monthlyCalcClass = NSClassFromString(@"iCalMonthlyRecurrenceCalculator");
69 yearlyCalcClass = NSClassFromString(@"iCalYearlyRecurrenceCalculator");
74 + (id)recurrenceCalculatorForRecurrenceRule:(iCalRecurrenceRule *)_rrule
75 withFirstInstanceCalendarDateRange:(NGCalendarDateRange *)_range
77 return [[[self alloc] initWithRecurrenceRule:_rrule
78 firstInstanceCalendarDateRange:_range] autorelease];
81 /* complex calculation convenience */
83 + (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r
84 firstInstanceCalendarDateRange:(NGCalendarDateRange *)_fir
85 recurrenceRules:(NSArray *)_rRules
86 exceptionRules:(NSArray *)_exRules
87 exceptionDates:(NSArray *)_exDates
90 iCalRecurrenceCalculator *calc;
91 NSMutableArray *ranges;
92 NSMutableArray *exDates;
93 unsigned i, count, rCount;
95 ranges = [NSMutableArray arrayWithCapacity:64];
97 for (i = 0, count = [_rRules count]; i < count; i++) {
100 rule = [_rRules objectAtIndex:i];
101 if (![rule isKindOfClass:iCalRecurrenceRuleClass])
102 rule = [iCalRecurrenceRule recurrenceRuleWithICalRepresentation:rule];
104 calc = [self recurrenceCalculatorForRecurrenceRule:rule
105 withFirstInstanceCalendarDateRange:_fir];
106 rs = [calc recurrenceRangesWithinCalendarDateRange:_r];
107 [ranges addObjectsFromArray:rs];
110 if ([ranges count] == 0)
113 /* test if any exceptions do match */
115 for (i = 0, count = [_exRules count]; i < count; i++) {
118 rule = [_exRules objectAtIndex:i];
119 if (![rule isKindOfClass:iCalRecurrenceRuleClass])
120 rule = [iCalRecurrenceRule recurrenceRuleWithICalRepresentation:rule];
122 calc = [self recurrenceCalculatorForRecurrenceRule:rule
123 withFirstInstanceCalendarDateRange:_fir];
124 rs = [calc recurrenceRangesWithinCalendarDateRange:_r];
125 [ranges removeObjectsInArray:rs];
128 if (![ranges isNotEmpty])
131 /* exception dates */
133 if ((count = [_exDates count]) == 0)
136 /* sort out exDates not within range */
138 exDates = [NSMutableArray arrayWithCapacity:count];
139 for (i = 0; i < count; i++) {
142 exDate = [_exDates objectAtIndex:i];
143 if (![exDate isKindOfClass:NSCalendarDateClass])
144 exDate = [NSCalendarDate calendarDateWithICalRepresentation:exDate];
146 if ([_r containsDate:exDate])
147 [exDates addObject:exDate];
150 /* remove matching exDates from ranges */
152 if ((count = [exDates count]) == 0)
155 for (i = 0, rCount = [ranges count]; i < count; i++) {
156 NSCalendarDate *exDate;
157 NGCalendarDateRange *r;
160 exDate = [exDates objectAtIndex:i];
161 for (k = 0; k < rCount; k++) {
164 rIdx = (rCount - k) - 1;
165 r = [ranges objectAtIndex:rIdx];
166 if ([r containsDate:exDate]) {
167 [ranges removeObjectAtIndex:rIdx];
169 break; /* this is safe because we know that ranges don't overlap */
179 - (id)initWithRecurrenceRule:(iCalRecurrenceRule *)_rrule
180 firstInstanceCalendarDateRange:(NGCalendarDateRange *)_range
182 iCalRecurrenceFrequency freq;
183 Class calcClass = Nil;
185 freq = [_rrule frequency];
186 if (freq == iCalRecurrenceFrequenceDaily)
187 calcClass = dailyCalcClass;
188 else if (freq == iCalRecurrenceFrequenceWeekly)
189 calcClass = weeklyCalcClass;
190 else if (freq == iCalRecurrenceFrequenceMonthly)
191 calcClass = monthlyCalcClass;
192 else if (freq == iCalRecurrenceFrequenceYearly)
193 calcClass = yearlyCalcClass;
195 [self errorWithFormat:@"unsupported rrule frequency: %@", _rrule];
201 [self autorelease]; // TODO: why autorelease?
202 if (calcClass == Nil)
205 if ((self = [[calcClass alloc] init]) != nil) {
206 self->rrule = [_rrule retain];
207 self->firstRange = [_range retain];
213 [self->firstRange release];
214 [self->rrule release];
220 - (unsigned)offsetFromSundayForJulianNumber:(long)_jn {
221 return (unsigned)((int)(_jn + 1.5)) % 7;
224 - (unsigned)offsetFromSundayForWeekDay:(iCalWeekDay)_weekDay {
228 case iCalWeekDaySunday: offset = 0; break;
229 case iCalWeekDayMonday: offset = 1; break;
230 case iCalWeekDayTuesday: offset = 2; break;
231 case iCalWeekDayWednesday: offset = 3; break;
232 case iCalWeekDayThursday: offset = 4; break;
233 case iCalWeekDayFriday: offset = 5; break;
234 case iCalWeekDaySaturday: offset = 6; break;
235 default: offset = 0; break;
240 - (unsigned)offsetFromSundayForCurrentWeekStart {
241 return [self offsetFromSundayForWeekDay:[self->rrule weekStart]];
244 - (iCalWeekDay)weekDayForJulianNumber:(long)_jn {
248 day = [self offsetFromSundayForJulianNumber:_jn];
250 case 0: weekDay = iCalWeekDaySunday; break;
251 case 1: weekDay = iCalWeekDayMonday; break;
252 case 2: weekDay = iCalWeekDayTuesday; break;
253 case 3: weekDay = iCalWeekDayWednesday; break;
254 case 4: weekDay = iCalWeekDayThursday; break;
255 case 5: weekDay = iCalWeekDayFriday; break;
256 case 6: weekDay = iCalWeekDaySaturday; break;
258 [self errorWithFormat:@"got unexpected weekday: %d", day];
259 weekDay = iCalWeekDaySunday;
260 break; /* keep compiler happy */
267 - (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r{
268 return nil; /* subclass responsibility */
270 - (BOOL)doesRecurrWithinCalendarDateRange:(NGCalendarDateRange *)_range {
273 ranges = [self recurrenceRangesWithinCalendarDateRange:_range];
274 return (ranges == nil || [ranges count] == 0) ? NO : YES;
277 - (NGCalendarDateRange *)firstInstanceCalendarDateRange {
278 return self->firstRange;
281 - (NGCalendarDateRange *)lastInstanceCalendarDateRange {
282 NSCalendarDate *start, *end;
284 if ((start = [self lastInstanceStartDate]) == nil)
287 end = [start addTimeInterval:[self->firstRange duration]];
288 return [NGCalendarDateRange calendarDateRangeWithStartDate:start
292 - (NSCalendarDate *)lastInstanceStartDate {
293 NSCalendarDate *until;
296 NOTE: this is horribly inaccurate and doesn't even consider the use
297 of repeatCount. It MUST be implemented by subclasses properly!
298 However, it does the trick for SOGo 1.0 - that's why it's left here.
300 if ((until = [self->rrule untilDate]) != nil)
306 @end /* iCalRecurrenceCalculator */