diff options
Diffstat (limited to 'objectapp/views/decorators.py')
| -rw-r--r-- | objectapp/views/decorators.py | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/objectapp/views/decorators.py b/objectapp/views/decorators.py new file mode 100644 index 0000000..cdc7203 --- /dev/null +++ b/objectapp/views/decorators.py @@ -0,0 +1,151 @@ + +# Copyright (c) 2011, 2012 Free Software Foundation + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + + +# This project incorporates work covered by the following copyright and permission notice: + +# Copyright (c) 2009, Julien Fache +# All rights reserved. + +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: + +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of the author nor the names of other +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. + +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +# OF THE POSSIBILITY OF SUCH DAMAGE. + +# Copyright (c) 2011, 2012 Free Software Foundation + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + + +"""Decorators for objectapp.views""" +from functools import wraps + +from django.template import RequestContext +from django.contrib.auth.views import login +from django.shortcuts import redirect +from django.shortcuts import get_object_or_404 +from django.shortcuts import render_to_response +from django.template.loader import get_template +from django.template import TemplateDoesNotExist +from django.views.decorators.csrf import csrf_protect +from django.views.decorators.cache import never_cache + + +def update_queryset(view, queryset, + queryset_parameter='queryset'): + """Decorator around views based on a queryset + passed in parameter, who will force the update + of the queryset before executing the view. + Related to issue http://code.djangoproject.com/ticket/8378""" + + @wraps(view) + def wrapper(*args, **kwargs): + """Regenerate the queryset before passing it to the view.""" + kwargs[queryset_parameter] = queryset() + return view(*args, **kwargs) + + return wrapper + + +@csrf_protect +@never_cache +def password(request, gbobject): + """Displays the password form and handle validation + by setting the valid password in a cookie.""" + error = False + if request.method == 'POST': + if request.POST.get('password') == gbobject.password: + request.session[ + 'objectapp_gbobject_%s_password' % gbobject.pk] = gbobject.password + return redirect(gbobject) + error = True + return render_to_response('objectapp/password.html', {'error': error}, + context_instance=RequestContext(request)) + + +def protect_gbobject(view): + """Decorator performing a security check if needed + around the generic.date_based.gbobject_detail view + and specify the template used to render the gbobject""" + + @wraps(view) + def wrapper(*ka, **kw): + """Do security check and retrieve the template""" + request = ka[0] + gbobject = get_object_or_404(kw['queryset'], slug=kw['slug'], + creation_date__year=kw['year'], + creation_date__month=kw['month'], + creation_date__day=kw['day']) + + if gbobject.login_required and not request.user.is_authenticated(): + return login(request, 'objectapp/login.html') + if gbobject.password and gbobject.password != \ + request.session.get('objectapp_gbobject_%s_password' % gbobject.pk): + return password(request, gbobject) + kw['template_name'] = gbobject.template + return view(*ka, **kw) + + return wrapper + + +def template_name_for_gbobject_queryset_filtered(model_type, model_name): + """Return a custom template name for views + returning a queryset of Gbobject filtered by another model.""" + template_name_list = ( + 'objectapp/%s/%s/gbobject_list.html' % (model_type, model_name), + 'objectapp/%s/%s_gbobject_list.html' % (model_type, model_name), + 'objectapp/%s/gbobject_list.html' % model_type, + 'objectapp/gbobject_list.html') + + for template_name in template_name_list: + try: + get_template(template_name) + return template_name + except TemplateDoesNotExist: + continue |