forked from thauber/django-schedule
-
Notifications
You must be signed in to change notification settings - Fork 0
/
events.py
441 lines (386 loc) · 17.2 KB
/
events.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# -*- coding: utf-8 -*-
from django.contrib.contenttypes import generic
from django.db import models
from django.db.models import Q
from django.contrib.auth.models import User
from django.contrib.contenttypes.models import ContentType
from django.core.urlresolvers import reverse
from django.template.defaultfilters import date
from django.utils.translation import ugettext, ugettext_lazy as _
import datetime
from dateutil import rrule
from schedule.models.rules import Rule
from schedule.models.calendars import Calendar
from schedule.utils import OccurrenceReplacer
class EventManager(models.Manager):
def get_for_object(self, content_object, distinction=None, inherit=True):
return EventRelation.objects.get_events_for_object(content_object, distinction, inherit)
class Event(models.Model):
'''
This model stores meta data for a date. You can relate this data to many
other models.
'''
start = models.DateTimeField(_("start"))
end = models.DateTimeField(_("end"),help_text=_("The end time must be later than the start time."))
title = models.CharField(_("title"), max_length = 255)
description = models.TextField(_("description"), null = True, blank = True)
creator = models.ForeignKey(User, null = True, verbose_name=_("creator"))
created_on = models.DateTimeField(_("created on"), default = datetime.datetime.now)
rule = models.ForeignKey(Rule, null = True, blank = True, verbose_name=_("rule"), help_text=_("Select '----' for a one time only event."))
end_recurring_period = models.DateTimeField(_("end recurring period"), null = True, blank = True, help_text=_("This date is ignored for one time only events."))
calendar = models.ForeignKey(Calendar)
objects = EventManager()
class Meta:
verbose_name = _('event')
verbose_name_plural = _('events')
app_label = 'schedule'
def __unicode__(self):
date_format = u'l, %s' % ugettext("DATE_FORMAT")
return ugettext('%(title)s: %(start)s-%(end)s') % {
'title': self.title,
'start': date(self.start, date_format),
'end': date(self.end, date_format),
}
def get_absolute_url(self):
return reverse('event', args=[self.id])
def create_relation(self, obj, distinction = None):
"""
Creates a EventRelation between self and obj.
"""
EventRelation.objects.create_relation(self, obj, distinction)
def get_occurrences(self, start, end):
"""
>>> rule = Rule(frequency = "MONTHLY", name = "Monthly")
>>> rule.save()
>>> event = Event(rule=rule, start=datetime.datetime(2008,1,1), end=datetime.datetime(2008,1,2))
>>> event.rule
<Rule: Monthly>
>>> occurrences = event.get_occurrences(datetime.datetime(2008,1,24), datetime.datetime(2008,3,2))
>>> ["%s to %s" %(o.start, o.end) for o in occurrences]
['2008-02-01 00:00:00 to 2008-02-02 00:00:00', '2008-03-01 00:00:00 to 2008-03-02 00:00:00']
Ensure that if an event has no rule, that it appears only once.
>>> event = Event(start=datetime.datetime(2008,1,1,8,0), end=datetime.datetime(2008,1,1,9,0))
>>> occurrences = event.get_occurrences(datetime.datetime(2008,1,24), datetime.datetime(2008,3,2))
>>> ["%s to %s" %(o.start, o.end) for o in occurrences]
[]
"""
persisted_occurrences = self.occurrence_set.all()
occ_replacer = OccurrenceReplacer(persisted_occurrences)
occurrences = self._get_occurrence_list(start, end)
final_occurrences = []
for occ in occurrences:
# replace occurrences with their persisted counterparts
if occ_replacer.has_occurrence(occ):
p_occ = occ_replacer.get_occurrence(
occ)
# ...but only if they are within this period
if p_occ.start < end and p_occ.end >= start:
final_occurrences.append(p_occ)
else:
final_occurrences.append(occ)
# then add persisted occurrences which originated outside of this period but now
# fall within it
final_occurrences += occ_replacer.get_additional_occurrences(start, end)
return final_occurrences
def get_rrule_object(self):
if self.rule is not None:
params = self.rule.get_params()
frequency = 'rrule.%s' % self.rule.frequency
return rrule.rrule(eval(frequency), dtstart=self.start, **params)
def _create_occurrence(self, start, end=None):
if end is None:
end = start + (self.end - self.start)
return Occurrence(event=self,start=start,end=end, original_start=start, original_end=end)
def get_occurrence(self, date):
rule = self.get_rrule_object()
if rule:
next_occurrence = rule.after(date, inc=True)
else:
next_occurrence = self.start
if next_occurrence == date:
try:
return Occurrence.objects.get(event = self, original_start = date)
except Occurrence.DoesNotExist:
return self._create_occurrence(next_occurrence)
def _get_occurrence_list(self, start, end):
"""
returns a list of occurrences for this event from start to end.
"""
difference = (self.end - self.start)
if self.rule is not None:
occurrences = []
if self.end_recurring_period and self.end_recurring_period < end:
end = self.end_recurring_period
rule = self.get_rrule_object()
o_starts = rule.between(start-difference, end, inc=True)
for o_start in o_starts:
o_end = o_start + difference
occurrences.append(self._create_occurrence(o_start, o_end))
return occurrences
else:
# check if event is in the period
if self.start < end and self.end >= start:
return [self._create_occurrence(self.start)]
else:
return []
def _occurrences_after_generator(self, after=None):
"""
returns a generator that produces unpresisted occurrences after the
datetime ``after``.
"""
if after is None:
after = datetime.datetime.now()
rule = self.get_rrule_object()
if rule is None:
if self.end > after:
yield self._create_occurrence(self.start, self.end)
raise StopIteration
date_iter = iter(rule)
difference = self.end - self.start
while True:
o_start = date_iter.next()
if o_start > self.end_recurring_period:
raise StopIteration
o_end = o_start + difference
if o_end > after:
yield self._create_occurrence(o_start, o_end)
def occurrences_after(self, after=None):
"""
returns a generator that produces occurrences after the datetime
``after``. Includes all of the persisted Occurrences.
"""
occ_replacer = OccurrenceReplacer(self.occurrence_set.all())
generator = self._occurrences_after_generator(after)
while True:
next = generator.next()
yield occ_replacer.get_occurrence(next)
class EventRelationManager(models.Manager):
'''
>>> EventRelation.objects.all().delete()
>>> CalendarRelation.objects.all().delete()
>>> data = {
... 'title': 'Test1',
... 'start': datetime.datetime(2008, 1, 1),
... 'end': datetime.datetime(2008, 1, 11)
... }
>>> Event.objects.all().delete()
>>> event1 = Event(**data)
>>> event1.save()
>>> data['title'] = 'Test2'
>>> event2 = Event(**data)
>>> event2.save()
>>> user1 = User(username='alice')
>>> user1.save()
>>> user2 = User(username='bob')
>>> user2.save()
>>> event1.create_relation(user1, 'owner')
>>> event1.create_relation(user2, 'viewer')
>>> event2.create_relation(user1, 'viewer')
'''
# Currently not supported
# Multiple level reverse lookups of generic relations appears to be
# unsupported in Django, which makes sense.
#
# def get_objects_for_event(self, event, model, distinction=None):
# '''
# returns a queryset full of instances of model, if it has an EventRelation
# with event, and distinction
# >>> event = Event.objects.get(title='Test1')
# >>> EventRelation.objects.get_objects_for_event(event, User, 'owner')
# [<User: alice>]
# >>> EventRelation.objects.get_objects_for_event(event, User)
# [<User: alice>, <User: bob>]
# '''
# if distinction:
# dist_q = Q(eventrelation__distinction = distinction)
# else:
# dist_q = Q()
# ct = ContentType.objects.get_for_model(model)
# return model.objects.filter(
# dist_q,
# eventrelation__content_type = ct,
# eventrelation__event = event
# )
def get_events_for_object(self, content_object, distinction=None, inherit=True):
'''
returns a queryset full of events, that relate to the object through, the
distinction
If inherit is false it will not consider the calendars that the events
belong to. If inherit is true it will inherit all of the relations and
distinctions that any calendar that it belongs to has, as long as the
relation has inheritable set to True. (See Calendar)
>>> event = Event.objects.get(title='Test1')
>>> user = User.objects.get(username = 'alice')
>>> EventRelation.objects.get_events_for_object(user, 'owner', inherit=False)
[<Event: Test1: Tuesday, Jan. 1, 2008-Friday, Jan. 11, 2008>]
If a distinction is not declared it will not vet the relations based on
distinction.
>>> EventRelation.objects.get_events_for_object(user, inherit=False)
[<Event: Test1: Tuesday, Jan. 1, 2008-Friday, Jan. 11, 2008>, <Event: Test2: Tuesday, Jan. 1, 2008-Friday, Jan. 11, 2008>]
Now if there is a Calendar
>>> calendar = Calendar(name = 'MyProject')
>>> calendar.save()
And an event that belongs to that calendar
>>> event = Event.objects.get(title='Test2')
>>> calendar.events.add(event)
If we relate this calendar to some object with inheritable set to true,
that relation will be inherited
>>> user = User.objects.get(username='bob')
>>> cr = calendar.create_relation(user, 'viewer', True)
>>> EventRelation.objects.get_events_for_object(user, 'viewer')
[<Event: Test1: Tuesday, Jan. 1, 2008-Friday, Jan. 11, 2008>, <Event: Test2: Tuesday, Jan. 1, 2008-Friday, Jan. 11, 2008>]
'''
ct = ContentType.objects.get_for_model(type(content_object))
if distinction:
dist_q = Q(eventrelation__distinction = distinction)
cal_dist_q = Q(calendar__calendarrelation__distinction = distinction)
else:
dist_q = Q()
cal_dist_q = Q()
if inherit:
inherit_q = Q(
cal_dist_q,
calendar__calendarrelation__object_id = content_object.id,
calendar__calendarrelation__content_type = ct,
calendar__calendarrelation__inheritable = True,
)
else:
inherit_q = Q()
event_q = Q(dist_q, Q(eventrelation__object_id=content_object.id),Q(eventrelation__content_type=ct))
return Event.objects.filter(inherit_q|event_q)
def change_distinction(self, distinction, new_distinction):
'''
This function is for change the a group of eventrelations from an old
distinction to a new one. It should only be used for managerial stuff.
It is also expensive so it should be used sparingly.
'''
for relation in self.filter(distinction = distinction):
relation.distinction = new_distinction
relation.save()
def create_relation(self, event, content_object, distinction=None):
"""
Creates a relation between event and content_object.
See EventRelation for help on distinction.
"""
ct = ContentType.objects.get_for_model(type(content_object))
object_id = content_object.id
er = EventRelation(
content_type = ct,
object_id = object_id,
event = event,
distinction = distinction,
content_object = content_object
)
er.save()
return er
class EventRelation(models.Model):
'''
This is for relating data to an Event, there is also a distinction, so that
data can be related in different ways. A good example would be, if you have
events that are only visible by certain users, you could create a relation
between events and users, with the distinction of 'visibility', or
'ownership'.
event: a foreign key relation to an Event model.
content_type: a foreign key relation to ContentType of the generic object
object_id: the id of the generic object
content_object: the generic foreign key to the generic object
distinction: a string representing a distinction of the relation, User could
have a 'veiwer' relation and an 'owner' relation for example.
DISCLAIMER: while this model is a nice out of the box feature to have, it
may not scale well. If you use this keep that in mindself.
'''
event = models.ForeignKey(Event, verbose_name=_("event"))
content_type = models.ForeignKey(ContentType)
object_id = models.IntegerField()
content_object = generic.GenericForeignKey('content_type', 'object_id')
distinction = models.CharField(_("distinction"), max_length = 20, null=True)
objects = EventRelationManager()
class Meta:
verbose_name = _("event relation")
verbose_name_plural = _("event relations")
app_label = 'schedule'
def __unicode__(self):
return u'%s(%s)-%s' % (self.event.title, self.distinction, self.content_object)
class Occurrence(models.Model):
event = models.ForeignKey(Event, verbose_name=_("event"))
title = models.CharField(_("title"), max_length=255, blank=True, null=True)
description = models.TextField(_("description"), blank=True, null=True)
start = models.DateTimeField(_("start"))
end = models.DateTimeField(_("end"))
cancelled = models.BooleanField(_("cancelled"), default=False)
original_start = models.DateTimeField(_("original start"))
original_end = models.DateTimeField(_("original end"))
class Meta:
verbose_name = _("occurrence")
verbose_name_plural = _("occurrences")
app_label = 'schedule'
def __init__(self, *args, **kwargs):
super(Occurrence, self).__init__(*args, **kwargs)
if self.title is None:
self.title = self.event.title
if self.description is None:
self.description = self.event.description
def moved(self):
return self.original_start != self.start or self.original_end != self.end
moved = property(moved)
def move(self, new_start, new_end):
self.start = new_start
self.end = new_end
self.save()
def cancel(self):
self.cancelled = True
self.save()
def uncancel(self):
self.cancelled = False
self.save()
def get_absolute_url(self):
if self.pk is not None:
return reverse('occurrence', kwargs={'occurrence_id': self.pk,
'event_id': self.event.id})
return reverse('occurrence_by_date', kwargs={
'event_id': self.event.id,
'year': self.start.year,
'month': self.start.month,
'day': self.start.day,
'hour': self.start.hour,
'minute': self.start.minute,
'second': self.start.second,
})
def get_cancel_url(self):
if self.pk is not None:
return reverse('cancel_occurrence', kwargs={'occurrence_id': self.pk,
'event_id': self.event.id})
return reverse('cancel_occurrence_by_date', kwargs={
'event_id': self.event.id,
'year': self.start.year,
'month': self.start.month,
'day': self.start.day,
'hour': self.start.hour,
'minute': self.start.minute,
'second': self.start.second,
})
def get_edit_url(self):
if self.pk is not None:
return reverse('edit_occurrence', kwargs={'occurrence_id': self.pk,
'event_id': self.event.id})
return reverse('edit_occurrence_by_date', kwargs={
'event_id': self.event.id,
'year': self.start.year,
'month': self.start.month,
'day': self.start.day,
'hour': self.start.hour,
'minute': self.start.minute,
'second': self.start.second,
})
def __unicode__(self):
return ugettext("%(start)s to %(end)s") % {
'start': self.start,
'end': self.end,
}
def __cmp__(self, other):
rank = cmp(self.start, other.start)
if rank == 0:
return cmp(self.end, other.end)
return rank
def __eq__(self, other):
return self.event == other.event and self.original_start == other.original_start and self.original_end == other.original_end