-
Notifications
You must be signed in to change notification settings - Fork 41
/
previews.py
222 lines (177 loc) · 6.83 KB
/
previews.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
import logging
import os
from base64 import b64encode
from collections import namedtuple
from email.header import decode_header
from django.conf.urls.defaults import include, patterns, url
from django.core.urlresolvers import reverse
from django.http import Http404
from django.utils.datastructures import SortedDict
from django.utils.importlib import import_module
from django.utils.module_loading import module_has_submodule
from django.views.generic.simple import direct_to_template
from mailviews.helpers import should_use_staticfiles
from mailviews.utils import split_docstring, unimplemented
logger = logging.getLogger(__name__)
URL_NAMESPACE = 'mailviews'
ModulePreviews = namedtuple('ModulePreviews', ('module', 'previews'))
def maybe_decode_header(header):
"""
Decodes an encoded 7-bit ASCII header value into it's actual value.
"""
value, encoding = decode_header(header)[0]
if encoding:
return value.decode(encoding)
else:
return value
class PreviewSite(object):
def __init__(self):
self.__previews = {}
def __iter__(self):
"""
Returns an iterator of :class:`ModulePreviews` tuples, sorted by module nae.
"""
for module in sorted(self.__previews.keys()):
previews = ModulePreviews(module, sorted(self.__previews[module].values(), key=str))
yield previews
def register(self, cls):
"""
Adds a preview to the index.
"""
preview = cls(site=self)
logger.debug('Registering %r with %r', preview, self)
index = self.__previews.setdefault(preview.module, {})
index[cls.__name__] = preview
@property
def urls(self):
urlpatterns = patterns('',
url(regex=r'^$',
view=self.list_view,
name='list'),
url(regex=r'^(?P<module>.+)/(?P<preview>.+)/$',
view=self.detail_view,
name='detail'),
)
if not should_use_staticfiles():
urlpatterns += patterns('',
url(regex=r'^static/(?P<path>.*)$',
view='django.views.static.serve',
kwargs={
'document_root': os.path.join(os.path.dirname(__file__), 'static'),
},
name='static'),
)
return include(urlpatterns, namespace=URL_NAMESPACE)
def list_view(self, request):
"""
Returns a list view response containing all of the registered previews.
"""
return direct_to_template(request, 'mailviews/previews/list.html', {
'site': self,
})
def detail_view(self, request, module, preview):
"""
Looks up a preview in the index, returning a detail view response.
"""
try:
return self.__previews[module][preview].detail_view(request)
except KeyError:
raise Http404 # The provided module/preview does not exist in the index.
class Preview(object):
#: The message view class that will be instantiated to render the preview
#: message. This must be defined by subclasses.
message_view = property(unimplemented)
#: The subset of headers to show in the preview panel.
headers = ('Subject', 'From', 'To')
#: The title of this email message to use in the previewer. If not provided,
#: this will default to the name of the message view class.
verbose_name = None
#: A form class that will be used to customize the instantiation behavior
# of the message view class.
form_class = None
#: The template that will be rendered for this preview.
template_name = 'mailviews/previews/detail.html'
def __init__(self, site):
self.site = site
def __unicode__(self):
return self.verbose_name or self.message_view.__name__
@property
def module(self):
return '%s' % self.message_view.__module__
@property
def description(self):
"""
A longer description of this preview that is used in the preview index.
If not provided, this defaults to the first paragraph of the underlying
message view class' docstring.
"""
return getattr(split_docstring(self.message_view), 'summary', None)
@property
def url(self):
"""
The URL to access this preview.
"""
return reverse('%s:detail' % URL_NAMESPACE, kwargs={
'module': self.module,
'preview': type(self).__name__,
})
def get_message_view(self, request, **kwargs):
return self.message_view(**kwargs)
def detail_view(self, request):
"""
Renders the message view to a response.
"""
context = {
'preview': self,
}
kwargs = {}
if self.form_class:
if request.GET:
form = self.form_class(data=request.GET)
else:
form = self.form_class()
context['form'] = form
if not form.is_bound or not form.is_valid():
return direct_to_template(request, 'mailviews/previews/detail.html', context)
kwargs.update(form.get_message_view_kwargs())
message_view = self.get_message_view(request, **kwargs)
message = message_view.render_to_message()
raw = message.message()
headers = SortedDict((header, maybe_decode_header(raw[header])) for header in self.headers)
context.update({
'message': message,
'subject': message.subject,
'body': message.body,
'headers': headers,
'raw': raw.as_string(),
})
alternatives = getattr(message, 'alternatives', [])
try:
html = next(alternative[0] for alternative in alternatives
if alternative[1] == 'text/html')
context.update({
'html': html,
'escaped_html': b64encode(html.encode('utf-8')),
})
except StopIteration:
pass
return direct_to_template(request, self.template_name, context)
def autodiscover():
"""
Imports all available previews classes.
"""
from django.conf import settings
for application in settings.INSTALLED_APPS:
module = import_module(application)
if module_has_submodule(module, 'emails'):
emails = import_module('%s.emails' % application)
try:
import_module('%s.emails.previews' % application)
except ImportError:
# Only raise the exception if this module contains previews and
# there was a problem importing them. (An emails module that
# does not contain previews is not an error.)
if module_has_submodule(emails, 'previews'):
raise
#: The default preview site.
site = PreviewSite()