src/p4l/decorators.py
author ymh <ymh.work@gmail.com>
Thu, 06 Nov 2014 02:08:12 +0100
changeset 176 a343992c55fd
parent 145 7c6fe1dab213
permissions -rw-r--r--
Added tag V00.08 for changeset 1ff6533ba75d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
145
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
# Copyright IRI (c) 2013
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
# contact@iri.centrepompidou.fr
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
# This software is governed by the CeCILL-B license under French law and
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
# abiding by the rules of distribution of free software.  You can  use, 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
# modify and/ or redistribute the software under the terms of the CeCILL-B
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
# license as circulated by CEA, CNRS and INRIA at the following URL
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
# "http://www.cecill.info". 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
# As a counterpart to the access to the source code and  rights to copy,
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
# modify and redistribute granted by the license, users are provided only
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
# with a limited warranty  and the software's author,  the holder of the
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
# economic rights,  and the successive licensors  have only  limited
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
# liability. 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
# In this respect, the user's attention is drawn to the risks associated
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
# with loading,  using,  modifying and/or developing or reproducing the
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
# software by the user in light of its specific status of free software,
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
# that may mean  that it is complicated to manipulate,  and  that  also
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
# therefore means  that it is reserved for developers  and  experienced
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
# professionals having in-depth computer knowledge. Users are therefore
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
# encouraged to load and test the software's suitability as regards their
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
# requirements in conditions enabling the security of their systems and/or 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
# data to be ensured and,  more generally, to use and operate it in the 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
# same conditions as regards security. 
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
# The fact that you are presently reading this means that you have had
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
# knowledge of the CeCILL-B license and that you accept its terms.
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
#
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
from django.contrib.auth import REDIRECT_FIELD_NAME
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
'''
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
Created on Oct 10, 2013
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
@author: ymh
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
'''
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
from django.contrib.auth.decorators import user_passes_test
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
def is_staff(function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None):
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
    """
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
    Decorator for views that checks that the user is logged in, redirecting
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
    to the log-in page if necessary.
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
    """
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
    actual_decorator = user_passes_test(
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
        lambda u: u.is_staff,
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
        login_url=login_url,
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
        redirect_field_name=redirect_field_name
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
    )
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
    if function:
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
        return actual_decorator(function)
7c6fe1dab213 Add a screen in the admin to launch commands. Fix bug #4 (https://github.com/IRI-Research/plan4learning/issues/4).
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
    return actual_decorator