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
|
"""
Views for generating ical feeds.
"""
from datetime import datetime
from calendar import timegm
from inspect import signature
from django.http import HttpResponse, Http404
from django.core.exceptions import ObjectDoesNotExist
from django.contrib.syndication.views import Feed
from django.utils.http import http_date
from django_ical import feedgenerator
__all__ = ("ICalFeed",)
# Extra fields added to the Feed object
# to support ical
FEED_EXTRA_FIELDS = ("method", "product_id", "timezone")
# Extra fields added to items (events) to
# support ical
ICAL_EXTRA_FIELDS = [
"timestamp", # dtstamp
"created", # created
"start_datetime", # dtstart
"end_datetime", # dtend
"transparency", # transp
"location", # location
"geolocation", # latitude;longitude
"organizer", # email, cn, and role
"rrule", # rrule
"exrule", # exrule
"rdate", # rdate
"exdate", # exdate
"status", # CONFIRMED|TENTATIVE|CANCELLED
"attendee", # list of attendees
"valarm", # list of icalendar.Alarm objects
]
class ICalFeed(Feed):
"""
iCalendar Feed
Existing Django syndication feeds
:title: X-WR-CALNAME
:description: X-WR-CALDESC
:item_guid: UID
:item_title: SUMMARY
:item_description: DESCRIPTION
:item_link: URL
:item_updateddate: LAST-MODIFIED
Extension fields
:method: METHOD
:timezone: X-WR-TIMEZONE
:item_class: CLASS
:item_timestamp: DTSTAMP
:item_created: CREATED
:item_start_datetime: DTSTART
:item_end_datetime: DTEND
:item_transparency: TRANSP
:item_attendee: ATTENDEE
:item_valarm: VALARM
"""
feed_type = feedgenerator.DefaultFeed
def __call__(self, request, *args, **kwargs):
"""
Copied from django.contrib.syndication.views.Feed
Supports file_name as a dynamic attr.
"""
try:
obj = self.get_object(request, *args, **kwargs)
except ObjectDoesNotExist:
raise Http404("Feed object does not exist.")
feedgen = self.get_feed(obj, request)
response = HttpResponse(content_type=feedgen.mime_type)
if hasattr(self, "item_pubdate") or hasattr(self, "item_updateddate"):
# if item_pubdate or item_updateddate is defined for the feed, set
# header so as ConditionalGetMiddleware is able to send 304 NOT MODIFIED
response["Last-Modified"] = http_date(
timegm(feedgen.latest_post_date().utctimetuple())
)
feedgen.write(response, "utf-8")
filename = self._get_dynamic_attr("file_name", obj)
if filename:
response["Content-Disposition"] = 'attachment; filename="%s"' % filename
return response
def _get_dynamic_attr(self, attname, obj, default=None):
"""
Copied from django.contrib.syndication.views.Feed (v1.7.1)
"""
try:
attr = getattr(self, attname)
except AttributeError:
return default
if callable(attr):
num_args = len(signature(attr).parameters)
if num_args == 0:
return attr()
if num_args == 1:
return attr(obj)
raise TypeError(
"Number of arguments to _get_dynamic_attr needs to be 0 or 1"
)
return attr
# NOTE: Not used by icalendar but required
# by the Django syndication framework.
link = ""
def method(self, obj): # pylint: disable=unused-argument
return "PUBLISH"
def feed_extra_kwargs(self, obj):
kwargs = {}
for field in FEED_EXTRA_FIELDS:
val = self._get_dynamic_attr(field, obj)
if val:
kwargs[field] = val
return kwargs
def item_timestamp(self, obj): # pylint: disable=unused-argument
return datetime.now()
def item_extra_kwargs(self, item):
kwargs = {}
for field in ICAL_EXTRA_FIELDS:
val = self._get_dynamic_attr("item_" + field, item)
if val:
kwargs[field] = val
return kwargs
|
