Project

General

Profile

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

calebasse / calebasse / cbv.py @ 76974b6f

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

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

    
26

    
27
class ServiceViewMixin(object):
28
    service = None
29
    date = None
30
    popup = False
31

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

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

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

    
64

    
65
class TemplateView(ServiceViewMixin, base.TemplateView):
66
    pass
67

    
68

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

    
83

    
84
class ModelNameMixin(object):
85
    def get_context_data(self, **kwargs):
86
        ctx = super(ModelNameMixin, self).get_context_data(**kwargs)
87
        ctx['model_verbose_name_plural'] = self.model._meta.verbose_name_plural
88
        ctx['model_verbose_name'] = self.model._meta.verbose_name
89
        return ctx
90

    
91

    
92
class ListView(AppTemplateFirstMixin, ModelNameMixin, ServiceViewMixin,
93
        list_cbv.ListView):
94
    def get_context_data(self, **kwargs):
95
        ctx = super(AppTemplateFirstMixin, self).get_context_data(**kwargs)
96
        ctx.update(super(ModelNameMixin, self).get_context_data(**kwargs))
97
        ctx.update(super(ServiceViewMixin, self).get_context_data(**kwargs))
98
        ctx.update(super(list_cbv.ListView, self).get_context_data(**kwargs))
99
        if self.request.GET.get('new_id'):
100
            ctx['new_id'] = int(self.request.GET.get('new_id'))
101
        return ctx
102

    
103
class M2MFormMixin(object):
104
    '''Alos save Many2Many relations for model forms if needed.'''
105
    def form_valid(self, form):
106
        res = super(M2MFormMixin, self).form_valid(form)
107
        if hasattr(form, 'save_m2m'):
108
            form.save_m2m()
109
        return res
110

    
111

    
112
class CreateView(M2MFormMixin, AppTemplateFirstMixin, ModelNameMixin, ServiceViewMixin,
113
        edit.CreateView):
114
    pass
115

    
116

    
117
class DeleteView(AppTemplateFirstMixin,
118
        ModelNameMixin, ServiceViewMixin, edit.DeleteView):
119
    pass
120

    
121

    
122
class UpdateView(M2MFormMixin, AppTemplateFirstMixin,
123
        ModelNameMixin, ServiceViewMixin, edit.UpdateView):
124
    pass
125

    
126

    
127
class FormView(ServiceViewMixin, edit.FormView):
128
    pass
129

    
130

    
131
class ContextMixin(object):
132
    """
133
    A default context mixin that passes the keyword arguments received by
134
    get_context_data as the template context.
135
    """
136

    
137
    def get_context_data(self, **kwargs):
138
        if 'view' not in kwargs:
139
            kwargs['view'] = self
140
        return kwargs
141

    
142

    
143
class MultiFormMixin(ContextMixin):
144
    """
145
    A mixin that provides a way to show and handle multiple forms in a request.
146
    """
147

    
148
    initial = {}
149
    initials = {}
150
    forms_classes = None
151
    success_url = None
152

    
153
    def get_prefixes(self):
154
        return self.forms_classes.keys()
155

    
156
    def get_initial(self, prefix):
157
        """
158
        Returns the initial data to use for forms on this view.
159
        """
160
        return self.initials.get(prefix, self.initial).copy()
161

    
162
    def get_form_class(self, prefix):
163
        """
164
        Returns the form class to use in this view
165
        """
166
        return self.forms_classes[prefix]
167

    
168
    def get_form(self, form_class, prefix):
169
        """
170
        Returns an instance of the form to be used in this view.
171
        """
172
        return form_class(**self.get_form_kwargs(prefix))
173

    
174
    def get_current_prefix(self):
175
        """
176
        Returns the current prefix by parsing first keys in POST
177
        """
178
        keys = self.request.POST.keys() or self.request.FILES.keys()
179
        for key in keys:
180
            if '-' in key:
181
                return key.split('-', 1)[0]
182
        return None
183

    
184
    def get_forms(self):
185
        """
186
        Returns the dictionnary of forms instances
187
        """
188
        form_instances = {}
189
        for prefix in self.get_prefixes():
190
            form_instances[prefix] = self.get_form(self.get_form_class(prefix), prefix)
191
        return form_instances
192

    
193
    def get_form_kwargs(self, prefix):
194
        """
195
        Returns the keyword arguments for instantiating the form.
196
        """
197
        kwargs = {'initial': self.get_initial(prefix),
198
                  'prefix': prefix }
199
        if self.request.method in ('POST', 'PUT') \
200
                and prefix == self.get_current_prefix():
201
            kwargs.update({
202
                'data': self.request.POST,
203
                'files': self.request.FILES,
204
            })
205
        return kwargs
206

    
207
    def get_success_url(self):
208
        """
209
        Returns the supplied success URL.
210
        """
211
        if self.success_url:
212
            url = self.success_url
213
        else:
214
            raise ImproperlyConfigured(
215
                "No URL to redirect to. Provide a success_url.")
216
        return url
217

    
218
    def form_valid(self, forms):
219
        """
220
        If the form is valid, redirect to the supplied URL.
221
        """
222
        return HttpResponseRedirect(self.get_success_url())
223

    
224
    def form_invalid(self, forms):
225
        """
226
        If the form is invalid, re-render the context data with the
227
        data-filled form and errors.
228
        """
229
        return self.render_to_response(self.get_context_data(forms=forms))
230

    
231

    
232
class MultiModelFormMixin(MultiFormMixin, detail.SingleObjectMixin):
233
    """
234
    A mixin that provides a way to show and handle multiple forms or modelforms
235
    in a request.
236
    """
237

    
238
    def get_form_kwargs(self, prefix):
239
        """
240
        Returns the keyword arguments for instantiating the form.
241
        """
242
        kwargs = super(MultiModelFormMixin, self).get_form_kwargs(prefix)
243
        if issubclass(self.get_form_class(prefix), forms.ModelForm):
244
            kwargs.update({'instance': self.object})
245
        return kwargs
246

    
247
    def get_success_url(self):
248
        """
249
        Returns the supplied URL.
250
        """
251
        if self.success_url:
252
            url = self.success_url % self.object.__dict__
253
        else:
254
            try:
255
                url = self.object.get_absolute_url()
256
            except AttributeError:
257
                raise ImproperlyConfigured(
258
                    "No URL to redirect to.  Either provide a url or define"
259
                    " a get_absolute_url method on the Model.")
260
        return url
261

    
262
    def form_valid(self, form):
263
        """
264
        If the form is valid, save the associated model.
265
        """
266
        form = form[self.get_current_prefix()]
267
        if hasattr(form, 'save'):
268
            if isinstance(form, forms.ModelForm):
269
                self.object = form.save()
270
            else:
271
                form.save()
272
        if hasattr(form, 'save_m2m'): # save many2many relations
273
            form.save_m2m()
274
        return super(MultiModelFormMixin, self).form_valid(form)
275

    
276
    def get_context_data(self, **kwargs):
277
        """
278
        If an object has been supplied, inject it into the context with the
279
        supplied context_object_name name.
280
        """
281
        context = {}
282
        if self.object:
283
            context['object'] = self.object
284
            context_object_name = self.get_context_object_name(self.object)
285
            if context_object_name:
286
                context[context_object_name] = self.object
287
        context.update(kwargs)
288
        return super(MultiModelFormMixin, self).get_context_data(**context)
289

    
290

    
291
class ProcessMultiFormView(base.View):
292
    """
293
    A mixin that renders a form on GET and processes it on POST.
294
    """
295
    def get(self, request, *args, **kwargs):
296
        """
297
        Handles GET requests and instantiates a blank version of the form.
298
        """
299
        forms = self.get_forms()
300
        return self.render_to_response(self.get_context_data(forms=forms))
301

    
302
    def post(self, request, *args, **kwargs):
303
        """
304
        Handles POST requests, instantiating a form instance with the passed
305
        POST variables and then checked for validity.
306
        """
307
        forms = self.get_forms()
308
        prefix = self.get_current_prefix()
309
        if forms[prefix].is_valid():
310
            return self.form_valid(forms)
311
        else:
312
            return self.form_invalid(forms)
313

    
314
    # PUT is a valid HTTP verb for creating (with a known URL) or editing an
315
    # object, note that browsers only support POST for now.
316
    def put(self, *args, **kwargs):
317
        return self.post(*args, **kwargs)
318

    
319

    
320
class BaseMultiFormView(MultiFormMixin, ProcessMultiFormView):
321
    """
322
    A base view for displaying multiple forms
323
    """
324

    
325

    
326
class MultiFormView(base.TemplateResponseMixin, BaseMultiFormView):
327
    """
328
    A base view for displaying multiple forms, and rendering a template reponse.
329
    """
330

    
331

    
332
class BaseMultiUpdateView(MultiModelFormMixin, ProcessMultiFormView):
333
    """
334
    Base view for updating an existing object.
335

    
336
    Using this base class requires subclassing to provide a response mixin.
337
    """
338
    def get(self, request, *args, **kwargs):
339
        self.object = self.get_object()
340
        return super(BaseMultiUpdateView, self).get(request, *args, **kwargs)
341

    
342
    def post(self, request, *args, **kwargs):
343
        self.object = self.get_object()
344
        return super(BaseMultiUpdateView, self).post(request, *args, **kwargs)
345

    
346

    
347
class MultiUpdateView(AppTemplateFirstMixin,
348
        detail.SingleObjectTemplateResponseMixin, BaseMultiUpdateView):
349
    """
350
    View for updating an object,
351
    with a response rendered by template.
352
    """
353
    template_name_suffix = '_form'
(3-3/13)