Love web applications » Djangoのユーザー認証機能を利用する

こんにちは。相変わらず暑い日が続きますね。お盆休みということで更新をお休みしていましたが、再開します。

さて今日はDjangoで、ユーザー認証を行う方法について書いておきます。 注：Djangoはv1.6です

Samples＠GitHub

編集前のプロジェクト：before
編集後のプロジェクト：after

特定ページアクセス時にユーザー認証を求めるように設定する

特定のページにユーザー認証保護をかけます。Djangoにはユーザー認証用のツールが用意されています。settings.pyのINSTALLED_APPSにデフォルトでは次のアプリが含まれているはずなので、有無を確認しておきます。

'django.contrib.auth'

もし無ければ追記すればOKです。

トップページにユーザー認証保護をかける

まずは、トップページにユーザー認証保護をかけてみます。下記4ファイルを記述していきます。

settings.py

ログインURLを指定する１行を追加します。

urls.py

ログインURLを、urlpatternsに追加します。また、myapp.views.index.pageを開くときにユーザー認証を求めるよう設定します。

login.py

myapp/view/login.pyを新規作成して、ログイン処理を記述します。

login.html

ユーザー名とパスワード入力を求める画面を表示するテンプレートです。

{% extends "base.html" %} {% block title_html %} User login form {% endblock %} {% block article_content %} {% if user.is_authenticated %}  <h1>You are connected.</h1> <p>Your email : {{ user.email }}</p> <p><a href="/">Return to home</a></p> {% else %}  <h1>User login form</h1> <form method="post" action="{{ user_login }}"> {% csrf_token %} <table> {{ form.as_table }} </table> <input type="submit" class="button" value="Login" /> </form> {% endif %} {% endblock %}# -*- Coding: utf-8 -*- from django.shortcuts import render, redirect from django import forms from django.contrib.auth import authenticate, login def page(request): if request.POST: form = Login_form(request.POST) if form.is_valid(): username = request.POST['username'] password = request.POST['password'] user = authenticate(username=username, password=password) if user is not None: if user.is_active: login(request, user) if request.GET.get('next') is not None: # Redirect to a success page. return redirect(request.GET['next']) # New form when not the request is get. else: form = Login_form() return render(request, 'jp/login.html', {'form' : form}) class Login_form(forms.Form): username = forms.CharField(label="User name") password = forms.CharField(label="Password", widget=forms.PasswordInput) def clean(self): cleaned_data = super(Login_form, self).clean() username = self.cleaned_data.get('username') password = self.cleaned_data.get('password') if not authenticate(username=username, password=password): raise forms.ValidationError("Wrong user name or passwsord") return self.cleaned_data# Authentification LOGIN_URL = 'user_login'from django.contrib.auth.decorators import login_required from django.views.generic import TemplateView urlpatterns = patterns('', url(r'^login/$','myapp.views.login.page', name="user_login"), url(r'^$', login_required(TemplateView.as_view(template_name='jp/index.html')), name="index"), #url(r'^$', 'myapp.views.index.page', name="index"), url(r'^admin/', include(admin.site.urls)), )

ここまで実装してからサーバーを実行し、http://127.0.0.1:8000にアクセスすると、自動的に/login/にリダイレクトされてユーザー認証を求める画面が表示されます。

South実行時に入力したユーザー名＆パスワードを入力すれば、トップページが表示されます。

ログアウト機能を実装する

続いてログアウト処理を実装します。下記４点を実装します。

urls.py

ログアウトURLを追加します。

login.py

myapp/view/loout.pyを新規作成して、ログアウト処理を記述します。

login.html

ログアウト処理が成功した後で表示する画面のテンプレートです。

index.html

ログイン・ログアウトへのリンクを追加します。

{% extends "base.html" %} {% block title_html %} Django Test Page {% endblock %} {% block h1 %} Hello world {% endblock %} {% block article_content %} <p>Welcome to Django world!</p> <p><a href="login">Your Account</a></p> <p><a href="logout">Logout</a></p> {% endblock %}{% extends "base.html" %} {% block title_html %} Logout {% endblock %} {% block h1 %} Logout successful. {% endblock %} {% block article_content %} <p><a href="/">Return to home</a></p> {% endblock %}# -*- Coding: utf-8 -*- from django.shortcuts import render from django.contrib.auth import logout def page(request): logout(request) return render(request, 'jp/logout.html')urlpatterns = patterns('', url(r'^logout/$', 'myapp.views.logout.page', name="user_logout"), #...other urls. )

ユーザー追加機能を実装する

続いてユーザー追加機能を実装してみます。上で作成したサンプルを改変してトップページにかけた認証保護を外します。トップページには

ログイン
ログアウト
ユーザー追加

の３メニューを表示します。ユーザー追加ページにはユーザー認証を求めるようにし、つまり既存のログインユーザーが新たなユーザーを作成できるような仕様にしてみます。

{% extends "base.html" %} {% block title_html %} Add user form {% endblock %} {% block h1 %} Add user form {% endblock %} {% block article_content %} <form method="post" action="{{ add_user }}"> {% csrf_token %} <table> {{ form.as_table }} </table> <input type="submit" class="button" value="Login" /> </form> <p><a href="/">Return to home</p> {% endblock %}# -*- Coding: utf-8 -*- from django.shortcuts import render, redirect from django.contrib.auth.models import User from django import forms from django.contrib.auth.decorators import login_required @login_required def page(request): if request.POST: form = MyUserCreationForm(request.POST) if form.is_valid(): username = request.POST['username'] password = request.POST['password'] email = request.POST['email'] new_user = User.objects.create_user(username = username, email = email, password=password) new_user.is_active = True new_user.save() return render(request, 'jp/add_user_successful.html') else: form = MyUserCreationForm() return render(request, 'jp/add_user.html', {'form' : form}) class MyUserCreationForm(forms.Form): username = forms.CharField(label = "User name") password = forms.CharField(label = "Password", widget = forms.PasswordInput) password_bis = forms.CharField(label = "Password", widget = forms.PasswordInput) email = forms.EmailField(label = "Email") def clean(self): cleaned_data = super(MyUserCreationForm, self).clean() username = self.cleaned_data.get('username') password = self.cleaned_data.get('password') password_bis = self.cleaned_data.get('password_bis') if password and password_bis and password != password_bis: raise forms.ValidationError("Passwords are not identical.") user_check = User.objects.filter(username = username).exists() if user_check: raise forms.ValidationError("Duplicate user name!") return self.cleaned_data{% extends "base.html" %} {% block title_html %} Add user successful {% endblock %} {% block h1 %} Add user successful {% endblock %} {% block article_content %} <p><a href="/">Return to home</p> {% endblock %}{% extends "base.html" %} {% block title_html %} Django Test Page {% endblock %} {% block h1 %} Hello world {% endblock %} {% block article_content %} <p>Welcome to Django world!</p> <p><a href="login">Your Account</a></p> <p><a href="logout">Logout</a></p> <p><a href="add_user">Add new user</a></p> {% endblock %}from django.conf.urls import patterns, include, url from django.contrib.auth.decorators import login_required #from django.views.generic import TemplateView from django.contrib import admin admin.autodiscover() urlpatterns = patterns('', url (r'^add_user/$', 'myapp.views.add_user.page', name="add_user"), url(r'^logout/$', 'myapp.views.logout.page', name="user_logout"), url(r'^login/$', 'myapp.views.login.page', name="user_login"), #url(r'^$', login_required(TemplateView.as_view(template_name='jp/index.html')), name="index"), url(r'^$', 'myapp.views.index.page', name="index"), url(r'^admin/', include(admin.site.urls)), )

ここではユーザー認証の要否を判断する方法を変更してみました。

最初に使った方法はurls.pyのurlパターンを次のように記述することで実現していました。login_required()でテンプレート呼び出し関数を囲んで書く方法です。

url(r'^$', login_required(TemplateView.as_view(template_name='jp/index.html')), name="index"),

でも、ユーザー認証を求めるページが増えると面倒ですよね。もっとお手軽に書く方法があります。viewファイルのdef直前に下記１行を追加します。

@login_required

同様に、他のページに認証をかける場合も@login_requiredを挿入すれば認証機能が働きます。すなわち、ログアウト時に該当ページにアクセスすると、ログインページに自動的にリダイレクトされるようになります。

ちょっと長いエントリーになりましたが、今日は以上です！