~ubuntu-branches/ubuntu/quantal/python-django/quantal-security

      user.

    * Messages: A simple way to queue messages for given users.

 

Installation

============

 

 

    1. Put ``'django.contrib.auth'`` and ``'django.contrib.contenttypes'`` in

       your :setting:`INSTALLED_APPS` setting.

       :mod:`django.contrib.auth` depends on :mod:`django.contrib.contenttypes`.)

    2. Run the command ``manage.py syncdb``.

 

        Required. 30 characters or fewer. Alphanumeric characters only

        (letters, digits and underscores).

 

    .. attribute:: models.User.first_name

 

        Optional. 30 characters or fewer.

    .. attribute:: models.User.is_active

 

        Boolean. Designates whether this user account should be considered

 

 

    .. attribute:: models.User.is_superuser

 

        :meth:`~django.contrib.auth.models.User.set_unusable_password()` has

        been called for this user.

 

 

        Returns a list of permission strings that the user has, through his/her

        groups.

 

 

        Returns a list of permission strings that the user has, both through

        group and user permissions.

 

 

        Returns ``True`` if the user has the specified permission, where perm is

 

        Returns ``True`` if the user has each of the specified permissions,

        ``"<app label>.<permission codename>"``. If the user is inactive,

        this method will always return ``False``.

 

    .. method:: models.User.has_module_perms(package_name)

 

        Returns ``True`` if the user has any permissions in the given package

    .. method:: models.UserManager.create_user(username, email, password=None)

 

        Creates, saves and returns a :class:`~django.contrib.auth.models.User`.

 

        If no password is provided,

        :meth:`~django.contrib.auth.models.User.set_unusable_password()` will

Changing passwords

~~~~~~~~~~~~~~~~~~

 

 

.. code-block:: python

 

provides a method to specify a site-specific related model -- termed a "user

profile" -- for this purpose.

 

 

To indicate that this model is the user profile model for a given site, fill in

the setting :setting:`AUTH_PROFILE_MODULE` with a string consisting of the

 

        from django.contrib.auth.decorators import login_required

 

        @login_required

        def my_view(request):

 

    :func:`~django.contrib.auth.decorators.login_required` also takes an

    optional ``redirect_field_name`` parameter. Example::

 

 

        from django.contrib.auth.decorators import login_required

 

        @login_required(redirect_field_name='redirect_to')

        def my_view(request):

 

    :func:`~django.contrib.auth.decorators.login_required` does the following:

 

 

    (r'^accounts/login/$', 'django.contrib.auth.views.login'),

 

 

    Here's what ``django.contrib.auth.views.login`` does:

 

    starting point. It assumes you have a :file:`base.html` template that

    defines a ``content`` block:

 

 

        {% extends "base.html" %}

 

        <p>Your username and password didn't match. Please try again.</p>

        {% endif %}

 

        <table>

        <tr>

            <td>{{ form.username.label_tag }}</td>

 

        {% endblock %}

 

    .. _forms documentation: ../forms/

    .. _site framework docs: ../sites/

 

        * ``login_url``: The URL of the login page to redirect to. This will

          default to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.

 

 

    Allows a user to change their password.

 

        * ``post_change_redirect``: The URL to redirect to after a successful

          password change.

 

    **Template context:**

 

        * ``form``: The password change form.

          :file:`registration/password_reset_email.html` if not supplied.

 

        * ``password_reset_form``: Form that will be used to set the password.

 

        * ``token_generator``: Instance of the class to check the password. This

          will default to ``default_token_generator``, it's an instance of

``polls.can_vote``::

 

    def my_view(request):

            return HttpResponse("You can't vote in this poll.")

        # ...

 

 

        from django.contrib.auth.decorators import user_passes_test

 

        def my_view(request):

 

    We're using this particular test as a relatively simple example. However,

    if you just want to test whether a permission is available to a user, you

    can use the :func:`~django.contrib.auth.decorators.permission_required()`

    decorator, described later in this document.

 

    :func:`~django.contrib.auth.decorators.user_passes_test` takes a required

    argument: a callable that takes a

    :class:`~django.contrib.auth.models.User` object and returns ``True`` if

    optional ``login_url`` argument, which lets you specify the URL for your

    login page (:setting:`settings.LOGIN_URL <LOGIN_URL>` by default).

 

 

        from django.contrib.auth.decorators import user_passes_test

 

        @user_passes_test(lambda u: u.has_perm('polls.can_vote'), login_url='/login/')

        def my_view(request):

 

The permission_required decorator

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 

        from django.contrib.auth.decorators import permission_required

 

        def my_view(request):

 

    As for the :meth:`User.has_perm` method, permission names take the form

    ``"<app label>.<permission codename>"`` (i.e. ``polls.can_vote`` for a

 

        from django.contrib.auth.decorators import permission_required

 

        def my_view(request):

 

    As in the :func:`~decorators.login_required` decorator, ``login_url``

    defaults to :setting:`settings.LOGIN_URL <LOGIN_URL>`.

    def limited_object_detail(*args, **kwargs):

        return object_detail(*args, **kwargs)

 

Permissions

===========

 

permissions for new models each time you run :djadmin:`manage.py syncdb

<syncdb>`.

 

.. _custom-permissions:

 

Custom permissions

   Technically, these variables are only made available in the template context

   if you use :class:`~django.template.context.RequestContext` *and* your

   :setting:`TEMPLATE_CONTEXT_PROCESSORS` setting contains

 

Users

-----

instance or an :class:`~django.contrib.auth.models.AnonymousUser` instance, is

stored in the template variable ``{{ user }}``:

 

 

    {% if user.is_authenticated %}

        <p>Welcome, {{ user.username }}. Thanks for logging in.</p>

 

Thus, you can check permissions in template ``{% if %}`` statements:

 

 

    {% if perms.foo %}

        <p>You have permission to do something in the foo app.</p>

Messages

========

 

The message system is a lightweight way to queue messages for given users.

 

A message is associated with a :class:`~django.contrib.auth.models.User`.

:ref:`template context <ref-templates-api>` as the template variable

``{{ messages }}``. Here's an example of template code that displays messages:

 

 

    {% if messages %}

    <ul>

    </ul>

    {% endif %}

 

 

Finally, note that this messages framework only works with users in the user

database. To send messages to anonymous users, use the

 

.. _authentication-backends:

 

the ``auth_permission`` table most of the time.

 

.. _django/contrib/auth/backends.py: http://code.djangoproject.com/browser/django/trunk/django/contrib/auth/backends.py