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 #include "iCalRecurrenceCalculator.h"
23 #include <NGExtensions/NGCalendarDateRange.h>
24 #include "iCalRecurrenceRule.h"
25 #include "NSCalendarDate+ICal.h"
33 @interface iCalRecurrenceCalculator (PrivateAPI)
34 - (NSCalendarDate *)lastInstanceStartDate;
36 - (unsigned)offsetFromSundayForJulianNumber:(long)_jn;
37 - (unsigned)offsetFromSundayForWeekDay:(iCalWeekDay)_weekDay;
38 - (unsigned)offsetFromSundayForCurrentWeekStart;
40 - (iCalWeekDay)weekDayForJulianNumber:(long)_jn;
43 @implementation iCalRecurrenceCalculator
45 static Class NSCalendarDateClass = Nil;
46 static Class iCalRecurrenceRuleClass = Nil;
47 static Class dailyCalcClass = Nil;
48 static Class weeklyCalcClass = Nil;
49 static Class monthlyCalcClass = Nil;
50 static Class yearlyCalcClass = Nil;
53 static BOOL didInit = NO;
58 NSCalendarDateClass = [NSCalendarDate class];
59 iCalRecurrenceRuleClass = [iCalRecurrenceRule class];
61 dailyCalcClass = NSClassFromString(@"iCalDailyRecurrenceCalculator");
62 weeklyCalcClass = NSClassFromString(@"iCalWeeklyRecurrenceCalculator");
63 monthlyCalcClass = NSClassFromString(@"iCalMonthlyRecurrenceCalculator");
64 yearlyCalcClass = NSClassFromString(@"iCalYearlyRecurrenceCalculator");
69 + (id)recurrenceCalculatorForRecurrenceRule:(iCalRecurrenceRule *)_rrule
70 withFirstInstanceCalendarDateRange:(NGCalendarDateRange *)_range
72 return [[[self alloc] initWithRecurrenceRule:_rrule
73 firstInstanceCalendarDateRange:_range] autorelease];
76 /* complex calculation convenience */
78 + (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r
79 firstInstanceCalendarDateRange:(NGCalendarDateRange *)_fir
80 recurrenceRules:(NSArray *)_rRules
81 exceptionRules:(NSArray *)_exRules
82 exceptionDates:(NSArray *)_exDates
85 iCalRecurrenceCalculator *calc;
86 NSMutableArray *ranges;
87 NSMutableArray *exDates;
88 unsigned i, count, rCount;
90 ranges = [NSMutableArray array];
91 count = [_rRules count];
92 for (i = 0; i < count; i++) {
95 rule = [_rRules objectAtIndex:i];
96 if (![rule isKindOfClass:iCalRecurrenceRuleClass])
97 rule = [iCalRecurrenceRule recurrenceRuleWithICalRepresentation:rule];
99 calc = [self recurrenceCalculatorForRecurrenceRule:rule
100 withFirstInstanceCalendarDateRange:_fir];
101 rs = [calc recurrenceRangesWithinCalendarDateRange:_r];
102 [ranges addObjectsFromArray:rs];
108 /* test if any exceptions do match */
109 count = [_exRules count];
110 for (i = 0; i < count; i++) {
113 rule = [_exRules objectAtIndex:i];
114 if (![rule isKindOfClass:iCalRecurrenceRuleClass])
115 rule = [iCalRecurrenceRule recurrenceRuleWithICalRepresentation:rule];
117 calc = [self recurrenceCalculatorForRecurrenceRule:rule
118 withFirstInstanceCalendarDateRange:_fir];
119 rs = [calc recurrenceRangesWithinCalendarDateRange:_r];
120 [ranges removeObjectsInArray:rs];
126 /* exception dates */
128 count = [_exDates count];
129 if (!count) return ranges;
131 /* sort out exDates not within range */
133 exDates = [NSMutableArray arrayWithCapacity:count];
134 for (i = 0; i < count; i++) {
137 exDate = [_exDates objectAtIndex:i];
138 if (![exDate isKindOfClass:NSCalendarDateClass]) {
139 exDate = [NSCalendarDate calendarDateWithICalRepresentation:exDate];
141 if ([_r containsDate:exDate])
142 [exDates addObject:exDate];
145 /* remove matching exDates from ranges */
147 count = [exDates count];
148 if (!count) return ranges;
150 rCount = [ranges count];
151 for (i = 0; i < count; i++) {
152 NSCalendarDate *exDate;
153 NGCalendarDateRange *r;
156 exDate = [exDates objectAtIndex:i];
157 for (k = 0; k < rCount; k++) {
160 rIdx = (rCount - k) - 1;
161 r = [ranges objectAtIndex:rIdx];
162 if ([r containsDate:exDate]) {
163 [ranges removeObjectAtIndex:rIdx];
165 break; /* this is safe because we know that ranges don't overlap */
175 - (id)initWithRecurrenceRule:(iCalRecurrenceRule *)_rrule
176 firstInstanceCalendarDateRange:(NGCalendarDateRange *)_range
178 iCalRecurrenceFrequency freq;
179 Class calcClass = Nil;
181 freq = [_rrule frequency];
182 if (freq == iCalRecurrenceFrequenceDaily)
183 calcClass = dailyCalcClass;
184 else if (freq == iCalRecurrenceFrequenceWeekly)
185 calcClass = weeklyCalcClass;
186 else if (freq == iCalRecurrenceFrequenceMonthly)
187 calcClass = monthlyCalcClass;
188 else if (freq == iCalRecurrenceFrequenceYearly)
189 calcClass = yearlyCalcClass;
192 if (calcClass == Nil)
195 self = [[calcClass alloc] init];
196 ASSIGN(self->rrule, _rrule);
197 ASSIGN(self->firstRange, _range);
204 [self->firstRange release];
205 [self->rrule release];
211 - (unsigned)offsetFromSundayForJulianNumber:(long)_jn {
212 return (unsigned)((int)(_jn + 1.5)) % 7;
215 - (unsigned)offsetFromSundayForWeekDay:(iCalWeekDay)_weekDay {
219 case iCalWeekDaySunday: offset = 0; break;
220 case iCalWeekDayMonday: offset = 1; break;
221 case iCalWeekDayTuesday: offset = 2; break;
222 case iCalWeekDayWednesday: offset = 3; break;
223 case iCalWeekDayThursday: offset = 4; break;
224 case iCalWeekDayFriday: offset = 5; break;
225 case iCalWeekDaySaturday: offset = 6; break;
226 default: offset = 0; break;
231 - (unsigned)offsetFromSundayForCurrentWeekStart {
232 return [self offsetFromSundayForWeekDay:[self->rrule weekStart]];
235 - (iCalWeekDay)weekDayForJulianNumber:(long)_jn {
239 day = [self offsetFromSundayForJulianNumber:_jn];
241 case 0: weekDay = iCalWeekDaySunday; break;
242 case 1: weekDay = iCalWeekDayMonday; break;
243 case 2: weekDay = iCalWeekDayTuesday; break;
244 case 3: weekDay = iCalWeekDayWednesday; break;
245 case 4: weekDay = iCalWeekDayThursday; break;
246 case 5: weekDay = iCalWeekDayFriday; break;
247 case 6: weekDay = iCalWeekDaySaturday; break;
248 default: weekDay = iCalWeekDaySunday; break; /* keep compiler happy */
255 - (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r {
256 return nil; /* subclass responsibility */
258 - (BOOL)doesRecurrWithinCalendarDateRange:(NGCalendarDateRange *)_range {
261 ranges = [self recurrenceRangesWithinCalendarDateRange:_range];
262 return (ranges == nil || [ranges count] == 0) ? NO : YES;
265 - (NGCalendarDateRange *)firstInstanceCalendarDateRange {
266 return self->firstRange;
269 - (NGCalendarDateRange *)lastInstanceCalendarDateRange {
270 NSCalendarDate *start, *end;
272 if ((start = [self lastInstanceStartDate]) == nil)
275 end = [start addTimeInterval:[self->firstRange duration]];
276 return [NGCalendarDateRange calendarDateRangeWithStartDate:start
280 - (NSCalendarDate *)lastInstanceStartDate {
281 NSCalendarDate *until;
284 NOTE: this is horribly inaccurate and doesn't even consider the use
285 of repeatCount. It MUST be implemented by subclasses properly!
286 However, it does the trick for SOGo 1.0 - that's why it's left here.
288 if ((until = [self->rrule untilDate]) != nil)
294 @end /* iCalRecurrenceCalculator */