Project

General

Profile

Download (10.9 KB) Statistics
| Branch: | Tag: | Revision:

calebasse / calebasse / cbv.py @ f6b61eaf

1
from datetime import datetime
2
from dateutil.relativedelta import relativedelta
3

    
4
from django import forms
5
from django.views.generic import list as list_cbv, edit, base, detail
6
from django.shortcuts import get_object_or_404
7
from django.http import Http404, HttpResponseRedirect
8
from django.core.urlresolvers import resolve
9
from django.core.exceptions import ImproperlyConfigured
10

    
11
from calebasse.ressources.models import Service
12

    
13
HOME_SERVICE_COOKIE = 'home-service'
14

    
15
class ReturnToObjectMixin(object):
16
    def get_success_url(self):
17
        return '../#object-' + str(self.object.pk)
18

    
19
class ServiceFormMixin(object):
20
    def get_form_kwargs(self):
21
        kwargs = super(ServiceFormMixin, self).get_form_kwargs()
22
        kwargs['service'] = self.service
23
        return kwargs
24

    
25
class ServiceViewMixin(object):
26
    service = None
27
    date = None
28
    popup = False
29

    
30
    def dispatch(self, request, **kwargs):
31
        self.popup = request.GET.get('popup')
32
        if 'service' in kwargs:
33
            self.service = get_object_or_404(Service, slug=kwargs['service'])
34
        if 'date' in kwargs:
35
            try:
36
                self.date = datetime.strptime(kwargs.get('date'),
37
                        '%Y-%m-%d').date()
38
            except (TypeError, ValueError):
39
                raise Http404
40
        result = super(ServiceViewMixin, self).dispatch(request, **kwargs)
41
        if self.service:
42
            result.set_cookie(HOME_SERVICE_COOKIE, self.service.slug,
43
                    max_age=3600*24*365, httponly=True)
44
        return result
45

    
46
    def get_context_data(self, **kwargs):
47
        context = super(ServiceViewMixin, self).get_context_data(**kwargs)
48
        context['url_name'] = resolve(self.request.path).url_name
49
        context['popup'] = self.popup
50
        if self.service is not None:
51
            context['service'] = self.service.slug
52
            context['service_name'] = self.service.name
53

    
54
        if self.date is not None:
55
            context['date'] = self.date
56
            context['previous_day'] = self.date + relativedelta(days=-1)
57
            context['next_day'] = self.date + relativedelta(days=1)
58
            context['previous_month'] = self.date + relativedelta(months=-1)
59
            context['next_month'] = self.date + relativedelta(months=1)
60
        return context
61

    
62
class TemplateView(ServiceViewMixin, base.TemplateView):
63
    pass
64

    
65
class AppTemplateFirstMixin(object):
66
    def get_template_names(self):
67
        names = []
68
        model = getattr(self, 'model', None)
69
        if not model:
70
            model = self.queryset.model
71
        if model is not None:
72
           opts = model._meta
73
           names.append("%s/%s%s.html" % (opts.app_label, opts.object_name.lower(), self.template_name_suffix))
74
           names.append("%s/%s.html" % (opts.app_label, self.template_name_suffix.strip('_')))
75
        if getattr(self, 'template_name', None):
76
            names.append(self.template_name)
77
        return names
78

    
79
class ModelNameMixin(object):
80
    def get_context_data(self, **kwargs):
81
        ctx = super(ModelNameMixin, self).get_context_data(**kwargs)
82
        ctx['model_verbose_name_plural'] = self.model._meta.verbose_name_plural
83
        ctx['model_verbose_name'] = self.model._meta.verbose_name
84
        return ctx
85

    
86
class ListView(AppTemplateFirstMixin, ModelNameMixin, ServiceViewMixin,
87
        list_cbv.ListView):
88
    def get_context_data(self, **kwargs):
89
        ctx = super(AppTemplateFirstMixin, self).get_context_data(**kwargs)
90
        ctx.update(super(ModelNameMixin, self).get_context_data(**kwargs))
91
        ctx.update(super(ServiceViewMixin, self).get_context_data(**kwargs))
92
        ctx.update(super(list_cbv.ListView, self).get_context_data(**kwargs))
93
        if self.request.GET.get('new_id'):
94
            ctx['new_id'] = int(self.request.GET.get('new_id'))
95
        return ctx
96

    
97
class CreateView(AppTemplateFirstMixin, ModelNameMixin, ServiceViewMixin,
98
        edit.CreateView):
99
    pass
100

    
101

    
102
class DeleteView(AppTemplateFirstMixin,
103
        ModelNameMixin, ServiceViewMixin, edit.DeleteView):
104
    pass
105

    
106

    
107
class UpdateView(AppTemplateFirstMixin,
108
        ModelNameMixin, ServiceViewMixin, edit.UpdateView):
109
    pass
110

    
111
class FormView(ServiceViewMixin, edit.FormView):
112
    pass
113

    
114
class ContextMixin(object):
115
    """
116
    A default context mixin that passes the keyword arguments received by
117
    get_context_data as the template context.
118
    """
119

    
120
    def get_context_data(self, **kwargs):
121
        if 'view' not in kwargs:
122
            kwargs['view'] = self
123
        return kwargs
124

    
125
class MultiFormMixin(ContextMixin):
126
    """
127
    A mixin that provides a way to show and handle multiple forms in a request.
128
    """
129

    
130
    initial = {}
131
    initials = {}
132
    forms_classes = None
133
    success_url = None
134

    
135
    def get_prefixes(self):
136
        return self.forms_classes.keys()
137

    
138
    def get_initial(self, prefix):
139
        """
140
        Returns the initial data to use for forms on this view.
141
        """
142
        return self.initials.get(prefix, self.initial).copy()
143

    
144
    def get_form_class(self, prefix):
145
        """
146
        Returns the form class to use in this view
147
        """
148
        return self.forms_classes[prefix]
149

    
150
    def get_form(self, form_class, prefix):
151
        """
152
        Returns an instance of the form to be used in this view.
153
        """
154
        return form_class(**self.get_form_kwargs(prefix))
155

    
156
    def get_current_prefix(self):
157
        """
158
        Returns the current prefix by parsing first keys in POST
159
        """
160
        keys = self.request.POST.keys() or self.request.FILES.keys()
161
        for key in keys:
162
            if '-' in key:
163
                return key.split('-', 1)[0]
164
        return None
165

    
166
    def get_forms(self):
167
        """
168
        Returns the dictionnary of forms instances
169
        """
170
        form_instances = {}
171
        for prefix in self.get_prefixes():
172
            form_instances[prefix] = self.get_form(self.get_form_class(prefix), prefix)
173
        return form_instances
174

    
175
    def get_form_kwargs(self, prefix):
176
        """
177
        Returns the keyword arguments for instantiating the form.
178
        """
179
        kwargs = {'initial': self.get_initial(prefix),
180
                  'prefix': prefix }
181
        if self.request.method in ('POST', 'PUT') \
182
                and prefix == self.get_current_prefix():
183
            kwargs.update({
184
                'data': self.request.POST,
185
                'files': self.request.FILES,
186
            })
187
        return kwargs
188

    
189
    def get_success_url(self):
190
        """
191
        Returns the supplied success URL.
192
        """
193
        if self.success_url:
194
            url = self.success_url
195
        else:
196
            raise ImproperlyConfigured(
197
                "No URL to redirect to. Provide a success_url.")
198
        return url
199

    
200
    def form_valid(self, forms):
201
        """
202
        If the form is valid, redirect to the supplied URL.
203
        """
204
        return HttpResponseRedirect(self.get_success_url())
205

    
206
    def form_invalid(self, forms):
207
        """
208
        If the form is invalid, re-render the context data with the
209
        data-filled form and errors.
210
        """
211
        return self.render_to_response(self.get_context_data(forms=forms))
212

    
213
class MultiModelFormMixin(MultiFormMixin, detail.SingleObjectMixin):
214
    """
215
    A mixin that provides a way to show and handle multiple forms or modelforms
216
    in a request.
217
    """
218

    
219
    def get_form_kwargs(self, prefix):
220
        """
221
        Returns the keyword arguments for instantiating the form.
222
        """
223
        kwargs = super(MultiModelFormMixin, self).get_form_kwargs(prefix)
224
        if issubclass(self.get_form_class(prefix), forms.ModelForm):
225
            kwargs.update({'instance': self.object})
226
        return kwargs
227

    
228
    def get_success_url(self):
229
        """
230
        Returns the supplied URL.
231
        """
232
        if self.success_url:
233
            url = self.success_url % self.object.__dict__
234
        else:
235
            try:
236
                url = self.object.get_absolute_url()
237
            except AttributeError:
238
                raise ImproperlyConfigured(
239
                    "No URL to redirect to.  Either provide a url or define"
240
                    " a get_absolute_url method on the Model.")
241
        return url
242

    
243
    def form_valid(self, form):
244
        """
245
        If the form is valid, save the associated model.
246
        """
247
        form = form[self.get_current_prefix()]
248
        if hasattr(form, 'save'):
249
            if isinstance(form, forms.ModelForm):
250
                self.object = form.save(commit=commit)
251
            else:
252
                form.save()
253
        return super(MultiModelFormMixin, self).form_valid(form)
254

    
255
    def get_context_data(self, **kwargs):
256
        """
257
        If an object has been supplied, inject it into the context with the
258
        supplied context_object_name name.
259
        """
260
        context = {}
261
        if self.object:
262
            context['object'] = self.object
263
            context_object_name = self.get_context_object_name(self.object)
264
            if context_object_name:
265
                context[context_object_name] = self.object
266
        context.update(kwargs)
267
        return super(MultiModelFormMixin, self).get_context_data(**context)
268

    
269
class ProcessMultiFormView(base.View):
270
    """
271
    A mixin that renders a form on GET and processes it on POST.
272
    """
273
    def get(self, request, *args, **kwargs):
274
        """
275
        Handles GET requests and instantiates a blank version of the form.
276
        """
277
        forms = self.get_forms()
278
        return self.render_to_response(self.get_context_data(forms=forms))
279

    
280
    def post(self, request, *args, **kwargs):
281
        """
282
        Handles POST requests, instantiating a form instance with the passed
283
        POST variables and then checked for validity.
284
        """
285
        forms = self.get_forms()
286
        prefix = self.get_current_prefix()
287
        if forms[prefix].is_valid():
288
            return self.form_valid(forms)
289
        else:
290
            return self.form_invalid(forms)
291

    
292
    # PUT is a valid HTTP verb for creating (with a known URL) or editing an
293
    # object, note that browsers only support POST for now.
294
    def put(self, *args, **kwargs):
295
        return self.post(*args, **kwargs)
296

    
297
class BaseMultiFormView(MultiFormMixin, ProcessMultiFormView):
298
    """
299
    A base view for displaying multiple forms
300
    """
301

    
302
class MultiFormView(base.TemplateResponseMixin, BaseMultiFormView):
303
    """
304
    A base view for displaying multiple forms, and rendering a template reponse.
305
    """
306

    
307
class BaseMultiUpdateView(MultiModelFormMixin, ProcessMultiFormView):
308
    """
309
    Base view for updating an existing object.
310

    
311
    Using this base class requires subclassing to provide a response mixin.
312
    """
313
    def get(self, request, *args, **kwargs):
314
        self.object = self.get_object()
315
        return super(BaseMultiUpdateView, self).get(request, *args, **kwargs)
316

    
317
    def post(self, request, *args, **kwargs):
318
        self.object = self.get_object()
319
        return super(BaseMultiUpdateView, self).post(request, *args, **kwargs)
320

    
321
class MultiUpdateView(AppTemplateFirstMixin,
322
        detail.SingleObjectTemplateResponseMixin, BaseMultiUpdateView):
323
    """
324
    View for updating an object,
325
    with a response rendered by template.
326
    """
327
    template_name_suffix = '_form'
(3-3/13)