読者です 読者をやめる 読者になる 読者になる

tanaka's Programming Memo

プログラミングについてのメモ。

Laravel+Sentinelで、ユーザー管理を実装する

Laravelの認証や認可にSentinelを組み込んだのであれば、ユーザーの役割(ロール)や権限(パーミッション)機能を使えるようにしたいところです。

そこで、管理者によるユーザー管理、ロールとパーミッションによる権限の管理をするコントローラーやビューを作成します。

前提

  • こちらの記事に続けて実装
  • 管理をシンプルにするために、パーミッションはロールにのみ割り当てて、ユーザーに個別に割り当てる機能は設けない
  • ユーザー関連の機能は以下の通り
    • ユーザー一覧の表示(Administrator/Moderator)
    • ユーザーの新規作成(Administrator/Moderator)
    • ユーザーの編集(Administrator)
      • ロールの切り替え
    • ユーザーの削除(Administrator)
  • ロール関連の機能は以下の通り
    • ロールの新規作成
    • ロールの編集
      • 権限の追加、編集、削除
    • ロールの削除
  • 権限チェック用のミドルウェアを用意する
    • 指定のロールの時にパス
    • 指定の権限の時にパス
  • 管理者は、設定で指定のメールアドレスでも指定できるようにする

管理者のメールアドレスを設定

ユーザー登録をしただけでは、ロールが設定されないので管理ができません。そこで、.envに管理者メールアドレスを定義して、ユーザーがそのメールアドレスだった場合は管理者として扱うようにします。

  • config/app.php をエディターで開く
  • 以下を追加
    // 管理者用EMailアドレスがあれば設定
    'admin_email' => env('ADMIN_EMAIL', ''),
  • .env をエディターで開く
  • 以下を追加。メールアドレスは適宜変更のこと
ADMIN_EMAIL=your@emai.com

以上で、 config('app.admin_email') とすると、管理者用のメールアドレスが確認できます。これを管理者チェック用のミドルウェアに組み込みます。

このメールアドレスのユーザーは、すべての操作を可能にします。

ログイン時にロールを割り当て

ログインしたのが管理者の時、ロールが作られているのかのチェックと、ロールが管理者に割り当てられているかのチェックを行います。いずれもまだの場合は設定を行います。ロールや権限の初期設定のためのデフォルトデータをコンフィグファイルにまとめておきましょう。

ロール関連の設定を作成

  • config/roles.php を新規作成して、エディターで開く
  • とりあえず、AdministratorとModeratorを定義しておく。権限は必要に合わせて変更の事
<?php
/**
 * ロール用の設定ファイル
 * @copyright 2016 YuTanaka@AmuseOne
 */

return [
    "default_roles" => [
        "default_admin_roles" => [
            "name" => "Administrator",
            "slug" => "admin",
            "permissions" => [
                "user.create" => true,
                "user.delete" => true,
                "user.view" => true,
                "user.update" => true,
                "role.create" => true,
                "role.delete" => true,
                "role.view" => true,
                "role.update" => true,
            ]
        ],
        "default_moderator" => [
            "name" => "Moderator",
            "slug" => "moderator",
            "permissions" => [
                "user.create" => true,
                "user.delete" => false,
                "user.view" => true,
                "user.update" => false,
                "role.create" => false,
                "role.delete" => false,
                "role.view" => false,
                "role.update" => false,
            ]
        ]
    ]
];

管理者メールの時の処理

SentinelControllerのログイン時の処理に、今回の処理を組み込みます。作業の前に、ロールや権限の確認方法を調べておきます。

ログインユーザーのロールの確認

現在ログインしているユーザーが特定のロールかを確認するには、 Sentinel::inRole('ロールのslug') でチェックします。ログインしていない場合は、 ErrorException が発生するので、try-catchで対応するか、事前にログインチェックをします。

if (Sentinel::inRole('slug')) {
    // ユーザーはslugのロールを持ちます
}
ログインユーザーのパーミッションの確認

パーミッションをチェックするには、ユーザーのインターフェースを取得して、必要に応じて次の2つの方法を利用します。複数のパーミッションを全て満たすかを判定するには、 $user->hasAccess() でチェックします。どれか一つでも有効であれば良い場合は、 $user->hasAnyAccess() でチェックします。

$user = Sentinel::check();
if ($user->hasAccess(['user.create', 'user.delete'])) {
    // ユーザーの作成と削除、どちらもできる場合の処理
}

if ($user->hasAnyAccess(['user.create', 'user.delete'])) {
    // ユーザーの作成、または、削除ができる場合の処理
}

以上を活用して、ロールをチェックして、必要な処理を加えます。

ロールのセットアップと管理者の割り当て処理

  • app/Http/Controllers/Sentinel/SentinelController.php をエディターで開く
  • クラスに以下の関数を追加
    /**
     * 管理者のメールアドレスチェックをして、管理者の時で、ロールがない時は、
     * ロールを整える
     * @return bool true=作成した / false=何もしない
     */
    private function checkAdminMailRoles(Request $request) {
        if (strcmp($request['email'], config('app.admin_email')) !== 0) {
            return false;
        }

        // ロールがあるかを確認する
        if (!Sentinel::findRoleBySlug('admin')) {
            // ロールがないので、作成する
            $defs = config('roles.default_roles');
            foreach($defs as $k => $v)
            {
                // ロールがなければ作成
                $role = Sentinel::findRoleByName($defs[$k]['name']);
                if (!$role) {
                    Sentinel::getRoleRepository()->createModel()->create($defs[$k]);
                }
                else {
                    // ロールがある場合は、更新
                    $role->permissions = $defs[$k]['permissions'];
                    $role->save();
                }
            }
        }

        // 管理者のメール。管理者ロールが割り当てられている場合は何もしない
        if (Sentinel::inRole('admin')) {
            return false;
        }

        // ユーザーにadminロールを設定する
        $role = Sentinel::findRoleBySlug('admin');
        $role->users()->attach($this->userInterface);
        return true;
    }
  • 次に、これをログイン処理内で呼び出す。login()メソッドの最後である return redirect($this->redirectTo); の前の行に、以下の関数呼び出しを追加する
        // ロールのチェック
        $this->checkAdminMailRoles($request);

以上で、管理者メールに設定したユーザーでログインすると、初期のロールと、 ユーザーに管理者ロール(Administrator)が割り当てられます。

メニューの追加

管理者としてログインしている時は、「ユーザー管理」と「ロール管理」。モデレーターとしてログインしている時は、「ユーザー」メニューを表示するようにします。

  • resources/views/layouts/app.blade.php をエディターで開く
  • Homeメニューが描かれている Left Side Of Navbar 欄を探して、以下のように修正
                <!-- Left Side Of Navbar -->
                <ul class="nav navbar-nav">
                    <li><a href="{{ url('/home') }}">Home</a></li>
                    @if (Sentinel::check())
                        @if (Sentinel::inRole('admin'))
                            <li><a href="{{ url('users')}}">ユーザー管理</a></li>
                            <li><a href="{{ url('roles')}}">ロール管理</a></li>
                        @elseif (Sentinel::inRole('moderator'))
                            <li><a href="{{ url('users')}}">ユーザー管理</a></li>
                        @endif
                    @endif
                </ul>

                <!-- Right Side Of Navbar -->

以上で動作確認すると、管理者でログインすると画面上部にユーザー管理とロール管理メニューが表示され、ログインしていなかったり、管理者じゃないユーザーがログインしても、メニューが表示されないことが確認できます。

ユーザー管理を作成

ユーザーについて、いわゆるCRUD(作成=Create、表示=Read、情報変更=Update、削除=Delete)操作を一通り実装します。また、ロールの変更機能もつけます。

作成をページ最上部、その下に編集可能な一覧を表示して、情報更新、削除ボタンを配置するようなビューを作成します。

情報の登録、あるいは更新、削除、それぞれ、確認画面も用意します。

編集不可の場合は、disabledを設定します。

コントローラーの作成

CRUD操作を実装するためのコントローラーを作成する場合は、Laravel artisanのresourceフラグを利用すると便利です。(HTTP Controllers - Laravel - The PHP Framework For Web Artisans)

ユーザーコントローラーを作成して、ルートを追加します。

  • ターミナルでプロジェクトフォルダーから以下のコマンドを実行
php artisan make:controller Sentinel/UserController --resource
  • app/Http/routes.php をエディターで開く
  • 適当な場所に以下の行を追加して、usersに関連するルートを設定
Route::resource('users', 'Sentinel/UserController');

以上で、以下のような一般的なルートが自動的に定義されます。各ルートにアクセスすれば、コントローラーが呼ばれるようになりました。

メソッド パス 呼び出すメソッド名 ルート名 内容 備考
GET /users index users.index ユーザー一覧を表示
GET /users/create create users.create ユーザーの新規登録画面を表示 未使用
POST /users store users.store ユーザーの登録処理
GET /users/{users} show users.show 指定のユーザーの情報を表示 確認画面として利用
GET /users/{users}/edit edit users.edit 指定のユーザーの編集画面を表示 ビューは一覧のものを返す
PUT/PATCH /users/{users} update users.update 指定のユーザーの情報を更新
DELETE /users/{users} destroy users.destroy 指定のユーザーを削除

上記のうち、 users.createは一覧とくっつけるので使用しない。

カスタマイズも可能で、方法は公式ドキュメントにあります。

Usersビューの作成

方針など

ビューを作成しますが、HTMLのフォームはPUTやPATCH、DELETEメソッドが送信できません。そこで、隠し要素にメソッドの種類を渡すことで解決します。以下はPUTを行う例です。

<input type="hidden" name="_method" value="PUT">

ユーザーの登録、編集、ユーザー一覧をまとめたビューを作成します。渡される引数によって、初期値や表示を変更しますが、基本的には1つのビューで対応します。ログインしていない時は事前に弾くので対応不要です。

条件判断は、ロールは $role にslug名を入れて、処理は $routename にルート名を入れて引数に渡すことで判断することにします。

入力欄をパーツ化

ユーザーの登録情報は既にありますので、その中身を使い回せるようにしましょう。

  • resources/views/parts/entry-user.blade.php を作成して、エディターで開く
  • resources/views/auth/register.blade.php をエディターで開く
  • 以下の部分を register.blade.php から切り取って、 entry-user.blade.php に貼り付ける
<div class="form-group{{ $errors->has('name') ? ' has-error' : '' }}">
    <label for="name" class="col-md-4 control-label">Name</label>

    <div class="col-md-6">
        <input id="name" type="text" class="form-control" name="name" value="{{ old('name') }}">

        @if ($errors->has('name'))
            <span class="help-block">
                <strong>{{ $errors->first('name') }}</strong>
            </span>
        @endif
    </div>
</div>

<div class="form-group{{ $errors->has('email') ? ' has-error' : '' }}">
    <label for="email" class="col-md-4 control-label">E-Mail Address</label>

    <div class="col-md-6">
        <input id="email" type="email" class="form-control" name="email" value="{{ old('email') }}">

        @if ($errors->has('email'))
            <span class="help-block">
                <strong>{{ $errors->first('email') }}</strong>
            </span>
        @endif
    </div>
</div>

<div class="form-group{{ $errors->has('password') ? ' has-error' : '' }}">
    <label for="password" class="col-md-4 control-label">Password</label>

    <div class="col-md-6">
        <input id="password" type="password" class="form-control" name="password">

        @if ($errors->has('password'))
            <span class="help-block">
                <strong>{{ $errors->first('password') }}</strong>
            </span>
        @endif
    </div>
</div>

<div class="form-group{{ $errors->has('password_confirmation') ? ' has-error' : '' }}">
    <label for="password-confirm" class="col-md-4 control-label">Confirm Password</label>

    <div class="col-md-6">
        <input id="password-confirm" type="password" class="form-control" name="password_confirmation">

        @if ($errors->has('password_confirmation'))
            <span class="help-block">
                <strong>{{ $errors->first('password_confirmation') }}</strong>
            </span>
        @endif
    </div>
</div>
  • register.blade.php の切り取った場所に、以下を入力して、パーツを読み込ませる
                        @include('parts.entry-user')

以上ができたら、ユーザー登録画面( http://0.0.0.0:8080/register )を表示して、正常に以前と同じものが表示されればOKです。

ユーザー新規登録のパネルを作成

ユーザー管理画面を作成して、新規登録のための場所に、上記のパーツを読み込ませましょう。

  • resources/views/sentinel/users.blade.php を作成して、エディターで開く
  • 以下のコードを作成
@extends('layouts.app')

@section('content')
<div class="container">
    <div class="row">
        <div class="col-md-12">

            @if ($role=="admin")

            <form class="col" role="form" method="POST" action="{{url('users')}}">
                {{ csrf_field() }}

                <div class="panel panel-default">
                    <div class="panel-heading">ユーザー新規登録</div>
                    <div class="panel-body">

                        @include('parts.entry-user')

                    </div>
                </div>
            </form>
            @endif

            <table class="table table-striped table-bordered table-hover">
                <thead>
                    <tr>
                        <th>
                            ユーザー名
                        </th>
                        <th>
                            メールアドレス
                        </th>
                        <th>
                            ロール
                        </th>
                        <th colspan='2'>
                            操作
                        </th>
                    </tr>
                </thead>
                <tbody>
                </tbody>
            </table>

        </div>
    </div>
</div>
<input type="hidden" name="_method" value="">
@endsection

ユーザーの新規登録と、一覧表示するブロックを定義して、新規登録の中に先ほどパーツ化した parts.entry-user ビューの呼び出しを加えました。また、新規登録は管理者のみの機能なので、 $role が'admin'の時のみ表示するようにしてあります。

テスト用のルート

簡単にテストできるように、テスト用のルートを作成します。ビューが完成したら削除します。

  • app/Http/routes.php をエディターで開く
  • 以下のルートを追加
// TODO: 動作確認が終わったら削除する
Route::get('test/{role}/{routename}', function($role, $routename){
    return view('sentinel.users',
    [
        'role' => $role,
        'method' => $routename,
        'roles' => Sentinel::getRoleRepository()->all(),
        'users' => Sentinel::getUserRepository()->all()
    ]);
});

http://0.0.0.0:8080/test/admin/index にアクセスすると、管理者がユーザー画面を開いた想定で、ビューを呼び出します。また、$rolesにロールの一覧、usersにユーザーの一覧を渡します。

以下をそれぞれ呼び出して、表示内容の変化を確認してください。まだ、渡されたロールやユーザーを表示する機能は組み込んでいませんので、見出しが表示されれば成功です。

ロールの選択ビュー

ユーザーごとに、ロールを設定するためのチェックボックスを表示するBladeのビューを作ります。この機能は新規登録でも、一覧でも、どちらでも利用できるので、使い回せるように作ります。

呼び出すときは、$rolesと、対象のユーザーデータ、ユーザーが保持しているロールを $user に渡します。新規登録の場合はまだユーザーはないので false を渡します。

渡されたユーザーが有効な場合、各ロールを保持しているかどうかをチェックします。ユーザーが該当するロールを持っているかは $user->inRoll('slug名')でチェックできます。

  • resouces/views/parts/role-select.blade.php を作成して、エディターで開く
  • 以下のコードを追加する
<div class="checkbox">
    @foreach($roles as $rl)
    <label class="checkbox-inline" for="">
        <input type="checkbox"
            name="user_{{$userid=$user ? $user->id : 'new'}}_role_{{$rl->id}}"
            id="user_{{$userid}}_role_{{$rl->id}}"
            @if ($user)
                @if ($user->inRole($rl->slug))
                    checked="true"
                @endif
            @elseif (old('user_'.$userid.'_role_'.$rl->id) == "on")
                checked="true"
            @endif
            >
        {{$rl->name}}
    </label>
    @endforeach
</div>

上記のBladeファイルと、ユーザー新規ボタンをユーザービューに追加します。

  • resources/view/sentinel/users.blade.php をエディターで開く
  • ユーザー新規登録のブロックを以下のように修正する
            @if ($role=="admin")

            <form class="col" role="form" method="POST" action="{{url('users')}}">
                {{ csrf_field() }}

                <div class="panel panel-default">
                    <div class="panel-heading">ユーザー新規登録</div>
                    <div class="panel-body">

                        @include('parts.entry-user')

                        <div class="form-group">
                            <div class="col-md-6 col-md-offset-4 help-block">
                            *パスワードを省略すると自動生成します。
                            </div>
                        </div>

                        <div class="form-group">
                            <label for="cb_user_new" class="col-md-4 control-label">ロール</label>
                            <div class="col-md-6" id="cb_user_new">
                                @include('parts.role-select', ['user' => false, 'roles' => $roles])
                            </div>
                        </div>

                        <div class="form-group">
                            <div class="col-md-6 col-md-offset-4">
                                <button type="submit" class="btn btn-primary">
                                    <i class="fa fa-btn fa-user"></i> ユーザー登録
                                </button>
                            </div>
                        </div>

                    </div>
                </div>
            </form>

            @endif

以上で、ロールのチェックと、ユーザーの新規登録ボタンが追加されました。これで新規登録部分のビューは完成です。

ユーザー一覧ビュー

ユーザー一覧には以下の項目を表示します。

  • ユーザー名(first_name)
  • メールアドレス(email)
  • ロール(チェックボックスで示す)
  • 変更ボタン
  • 削除ボタン

パスワードは本人が[forgot password]で対応できるので、管理者は関与しないことにします。

変更時、削除時は、BootstrapのモーダルJavaScriptを使って、実行前に確認画面を表示します。

データ変更はPUT、削除はDELETEメソッドを利用します。BladeでPUTを実行するには、以下のように書きます。

<form action="{{ url('アクションURL') }}" method="POST">
{{ csrf_field() }}
{{ method_field('PUT') }}
<button type='submit'>PUT実行</button
</form>

以下に、一覧表示をするためのBladeコードを示します。

  • resources/views/sentinel/users.blade.php をエディターで開く
  • あらかじめ作成してあったユーザー一覧のテーブルの、<tbody>〜</tbody>を以下のように変更する
                <tbody>
                    @foreach($users as $user)
                        <tr>
                            <form action="{{ url('users/'.$user->id) }}" method="POST">
                                {{ csrf_field() }}
                                {{ method_field('PUT') }}

                                <td>
                                    <input type="text" name="user_{{$user->id}}_name" id="user_{{$user->id}}_name" value="{{$user->first_name}}" maxlength='255' size='20'>
                                </td>
                                <td>
                                    <input type="text" name="user_{{$user->id}}_email" id="user_{{$user->id}}_email" value="{{$user->email}}" maxlength='255' size='30'>
                                </td>
                                <td>
                                    @include('parts.role-select', ['user' => $user, 'roles' => $roles])
                                </td>
                                <td>
                                    <!-- Button trigger modal -->
                                    <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#modalUpdate-{{$user->id}}">
                                        <i class="fa fa-btn fa-refresh"></i>変更
                                    </button>

                                    <!-- 更新モーダル-->
                                    <div class="modal fade" id="modalUpdate-{{$user->id}}" tabindex="-1" role="dialog">
                                      <div class="modal-dialog">
                                        <div class="modal-content">
                                          <div class="modal-header">
                                            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
                                            <h4 class="modal-title">ユーザー情報を変更しますか?</h4>
                                          </div>

                                          <div class="modal-footer">
                                              <button type="submit" id="update-{{ $user->id }}" class="btn btn-primary">
                                                  <i class="fa fa-btn fa-check"></i>  はい
                                              </button>
                                              <button type="button" class="btn btn-default" data-dismiss="modal">
                                                  <i class="fa fa-btn fa-close"></i>いいえ</button>

                                          </div>
                                        </div><!-- /.modal-content -->
                                      </div><!-- /.modal-dialog -->
                                    </div><!-- /.modal -->
                                </td>
                            </form>

                            <td>
                                <button type="button" class="btn btn-danger" data-toggle="modal" data-target="#modalDelete-{{$user->id}}">
                                    <i class="fa fa-btn fa-trash"></i>削除
                                </button>
                                <!-- 削除モーダル-->
                                <div class="modal fade" id="modalDelete-{{$user->id}}" tabindex="-1" role="dialog">
                                  <div class="modal-dialog">
                                    <div class="modal-content">
                                      <div class="modal-header">
                                        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
                                        <h4 class="modal-title">指定のユーザーを削除しますか?</h4>
                                      </div>
                                      <div class="modal-body">
                                          {{$user->first_name}} : {{$user->email}}
                                      </div>
                                      <div class="modal-footer">
                                          <form action="{{ url('users/'.$user->id) }}" method="POST">
                                              {{ csrf_field() }}
                                              {{ method_field('DELETE') }}

                                              <button type="submit" id="update-{{ $user->id }}" class="btn btn-primary">
                                                  <i class="fa fa-btn fa-check"></i>  はい
                                              </button>
                                              <button type="button" class="btn btn-default" data-dismiss="modal">
                                                  <i class="fa fa-btn fa-close"></i>いいえ</button>
                                          </form>

                                      </div>
                                    </div><!-- /.modal-content -->
                                  </div><!-- /.modal-dialog -->
                                </div><!-- /.modal -->

                            </td>
                        </tr>
                    @endforeach
                </tbody>

情報の変更をするには、古い情報と新しい情報を比較表示したり、変更がない場合はボタンが押せないなどの処理も欲しいところです。新旧のデータの比較はLaravelのold()関数を使えばできますが、ルートが増え、サーバーへのアクセスが発生するのであまりスマートな形になりません。Reactなどでフロントエンド側を作成した方が良さそうです。今回は、WebAPIと最低限のビューを揃えるだけにして、フロントエンドの構築は省きます。

拡張Userモデルの作成

Sentinelのデフォルトのユーザーモデルでは、ユーザーが持つ全てのロールをチェックしません。また、メールアドレスで管理者権限をチェックする機能も追加したいので、拡張したユーザーモデルを作成することにします。

UserExモデルの作成

新しいユーザーモデルであるUserExを作成します。このモデルには、 hasAccessRoles() という関数を追加します。使い方はhasAccess([パーミッションのリスト])と同様ですが、メールアドレスが管理者の場合は全てのアクセスを許可する機能と、このユーザーが持っている全てのロールのパーミッションをチェックする機能を持たせます。

  • ターミナルから、以下を実行
php artisan make:model UserEx
  • app/UserEx.php をエディターで開く
  • 以下のように書き換える
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Cartalyst\Sentinel\Users\EloquentUser;

class UserEx extends EloquentUser
{
    /**
     * 指定のパーミッションにアクセスできるかを確認する
     * @param array or string チェックするパーミッション名。
     */
    public function hasAccessRoles($args) {
        // 管理者メールアドレスチェック
        if ($this->email === config('app.admin_email')) return true;

        // 全てのロールでチェック
        foreach ($this->roles as $role) {
            if ($role->hasAccess($args)) {
                return true;
            }
        }
        return false;
    }
}

モデルの変更

Sentinelが参照するモデルを新しいものに差し替えます。

  • config/cartalyst.sentinel.php をエディターで開く
  • 'users'の宣言を以下のように修正
'users' => [

        'model' => 'App\UserEx',

    ],

以上で、新しく作成したUserExにモデルが差し代わり、 hasAccessRoles()が使えるようになりました。

管理者によるユーザー登録

ユーザー管理画面からのユーザー登録を実装します。

ミドルウェアの作成

ユーザー登録は、 user.create 権限を持つユーザーしか実行できません。処理する前に、その処理が実行可能かをチェックしたり、処理の後に事後処理をしたい場合に使うのがミドルウェア(Middleware)です。

Sentinelの権限チェックを利用して、ログインしているユーザーが指定のパーミッションを持っているかをチェックするミドルウェア Permission を作成します。

  • 以下をターミナルで実行して、Permissionという名前の新しいミドルウェアを作成
php artisan make:middleware Permission
  • app/Http/Kernel.php をエディターで開く
  • $routeMiddlewareの配列に、以下を追加する
        'permission' => \App\Http\Middleware\Permission::class,
  • app/Http/Middleware/Permission.php をエディターで開く
  • 以下のように修正する
<?php

namespace App\Http\Middleware;

use Closure;
use Sentinel;
use Redirect;

class Permission
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string $permission チェックするパーミッション
     * @return mixed
     */
    public function handle($request, Closure $next, $permission)
    {
        if (($user=Sentinel::check()) && $user->hasAccessRoles($permission)) {
            return $next($request);
        }
        return Redirect::back()->withInput()->withErrors(['permission' => trans('sentinel.permission_denied')]);
    }
}

以上で、権限チェック用のパーミッションの作成ができました。引数 $permission でチェックしたいパーミッションを指定できるので、このミドルウェア1つあれば、簡単な権限チェックは全て実行することができます。

これを UserController.phpコンストラクターに追加します。ミドルウェアの適用は、exceptだと指定の関数を外し、onlyだと指定の関数のみに適用させます。今回は個別に設定するので、 only を使います。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • 以下のuseを追加
use Sentinel;
use Redirect;
    /**
     * コンストラクター
     * 処理に権限チェックのミドルウェアを設定
     */
    public function __construct() {
        $this->middleware('permission:user.create', [
            'only' => [
                'store'
            ]
        ]);
    }

権限がない時のためのエラー文言を設定します。

  • resources/lang/ja/sentinel.php をエディターで開く
  • 以下を追加
    'permission_denied' => '権限がありません。',

エラーのビューをJavaScriptやその他の文言に対応できるように修正します。

  • resources/views/common/errors.blade.php をエディターで開く
  • 以下のように修正する
<!-- resources/views/common/errors.blade.php -->

<!-- Form Error List -->
<div id="error-block" class="alert alert-danger" @if (count($errors) == 0) style="display: none;" @endif >
    <strong>以下のエラーが発生しました。</strong>
    <br>
    <ul id="error-list">
        @foreach ($errors->all() as $error)
            <li>{{ $error }}</li>
        @endforeach
    </ul>
</div>

ユーザー管理画面に、エラー表示領域を追加します。

  • resources/views/sentinel/users.blade.php をエディターで開く
  • ファイルの先頭から、以下のようになる位置にエラーブロックをincludeする
@extends('layouts.app')

@section('content')
<div class="container">
    <div class="row">
        <div class="col-md-12">

            @include('common.errors')

エラーが発生した時は、 Redirect::back()->withErros([]); でリターンすれば、上記の領域にエラーが表示されます。

以上で完了です。管理者以外でログインしたり、ログインしない状態で、 http://0.0.0.0:8080/test/admin/test にアクセスして、ユーザー登録をしようとすると権限がないとエラーが表示されて、処理がキャンセルされます。管理者でログインした状態で同様に操作すると、権限チェックに通るので処理が先に進みます。ただし、まだこの先を作っていないので白い画面が表示されるだけですが、それで成功です。

登録処理の実装

権限のチェックができたので、あとは実際にデータを登録する処理を追加します。必要な設定を追加します。

  • config/app.php をエディターで開く
  • 以下の設定を追加
    // 管理者名
    'admin_name' => env('ADMIN_NAME', '管理者'),

    // 自動生成するパスワードの長さ
    'password_generate_length' => 8,

メッセージを追加します。

  • resources/lang/ja/sentinel.php をエディターで開く
  • 以下の設定を追加
    'user_regist_subject' => 'ユーザー登録完了',
    'user_regist_done' => 'ユーザーの登録を完了しました。登録情報を管理者メールアドレスに送信しました。',

登録した内容をメールで管理者に登録するので、メールが使えるようにuseをつけます。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • 以下のuseを追加
use Mail;
  • あらかじめ作成されている store 関数を探して、以下のように処理を追加する
    public function store(Request $request)
    {
        // バリデーション
        $this->validate($request, [
           // nameは必須で、255文字まで
           'name' => 'required|max:255',
           // emailは必須で、emailの形式で、255文字までで、usersテーブル内でユニーク
           'email' => 'required|email|max:255|unique:users',
           // passwordは必須で、6文字以上255文字以下で、確認欄と一致する必要がある
           'password' => 'between:6,255|confirmed',
       ]);

       // パスワードが無指定の場合は、自動生成する
       $pass = $request->password;
       if (empty($pass)) {
           $pass = str_random(config('app.password_generate_length'));
       }

       // DBに登録
       $credentials = [
           'first_name' => $request['name'],
           'email' => $request['email'],
           'password' => $pass,
       ];
       $user = Sentinel::registerAndActivate($credentials);

       // ロールを設定する
       $roles = [];
       $rolenames = "";
       $allroles = Sentinel::getRoleRepository()->all();
       foreach($allroles as $role) {
            if ($request['user_new_role_'.$role->id] == "on") {
                $role->users()->attach($user);
                if (mb_strlen($rolenames) > 0) {
                    $rolenames .= ", ";
                }
                $rolenames .= $role->name;
            }
       }

       // メールで送信する
       $this->sendMail([
           'toemail' => config('app.admin_email'),
           'toname' => config('app.admin_name'),
           'subject' => trans('sentinel.user_regist_subject'),
           'blade' => 'sentinel.emails.user-regist-done',
           'args' => [
               'name' => $request['name'],
               'email' => $request['email'],
               'password' => $pass,
               'roles' => $rolenames,
           ]
       ]);

       // メールを確認して、承認してからログインすることを表示するページへ
       return redirect('users')->with('info', trans('sentinel.user_regist_done'));
    }
  • メールを簡単に送信するための関数も追加
    /**
     * 指定の内容でメールを送信する
     * @param array $params 送信データの連想配列
     * 'toemail' 宛先メールアドレス
     * 'toname' 宛先名
     * 'subject' メール件名
     * 'blade' 本文のテンプレート名
     * 'args' bladeに渡す連想配列
     */
    public function sendMail($params) {
        Mail::send($params['blade'], ['args' => $params['args']], function($m) use ($params) {
            $m->from(config('app.activation_from'), config('app.appname'));
            $m->to($params['toemail'], $params['toname'])->subject($params['subject']);
        });
    }

処理が完了した時のメッセージが表示できるように、情報の表示欄をユーザー一覧ビューに追加します。まずは、情報を表示するためのビューのパーツを作成します。

  • resources/views/parts/info.blade.php を作成して、エディターで開く
  • 以下のコードを追加
@if (session('info') || isset($info))
<div class="alert alert-info">
    @if (session('info'))
        @if (is_array(session('info')))
            <ul>
            @foreach(session('info') as $ln)
                <li>{{$ln}}</li>
            @endforeach
            </ul>
        @else
            {{ session('info') }}
        @endif
    @endif
    @if (isset($info))
        {{ $info }}
    @endif
</div>
@endif
  • resources/views/sentinel/users.blade.php をエディターで開く
  • エラーの表示欄の上に以下を追加
@include('parts.info')

メールの雛形となるビューを作成します。

  • resources/views/sentinel/emails/user-regist-done.blade.php をエディターで開く
  • 以下を追加
以下の通り、ユーザーを登録しました。<br>
<br>
ユーザー名
  {{ $args['name'] }}<br>
メールアドレス
  {{ $args['email']}}<br>
パスワード
  {{ $args['password']}}<br>
ロール
  {{ $args['roles']}}<br>
<br>
<br>
--------<br>
[{{config('app.appname')}}]システムメール<br>
*本メールは送信専用のものです。返信には使えません。<br>
<br>

以上で管理者によるユーザー登録処理が完成です。 http://0.0.0.0:8080/test/admin/test でアクセスして、新規ユーザーの情報を入れて登録すると、実際にユーザーが登録されて、登録したユーザーの情報がメールで届くようになります。

一覧表示ルートの作成

ユーザーの登録ができるようになりましたので、実際のユーザー一覧のルートを組み込みます。

権限のチェック

ユーザー一覧の表示は、 user.view 権限を持つユーザーのみが可能なので、 UserController にミドルウェアを追加します。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • __construct()関数内に、以下を追加
        $this->middleware('permission:user.view', [
            'only' => [
                'index'
            ]
        ]);

ユーザー一覧を表示

一覧表示のためのコードをindexメソッドに追加します。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • 定義済みのindex()メソッドを探して、以下のようにコードを追加する
    public function index()
    {
        $user = Sentinel::check();

        return view('sentinel.users',
        [
            'role' => count($user->roles)==0 ? 'guest' : $user->roles[0]->slug,
            'roles' => Sentinel::getRoleRepository()->all(),
            'users' => Sentinel::getUserRepository()->all()
        ]);
    }

以上で、管理者やモデレーターユーザーを登録して、それぞれのユーザーでログインすれば、ユーザー管理ボタンを押してユーザー一覧を表示することができるようになりました。

ユーザーの削除

ユーザーを削除するボタンを機能させます。

権限のチェック

user.delete権限を持つユーザーだけに実行させるので、そのためのミドルウェアを追加します。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • __construct()関数内に、以下を追加
        $this->middleware('permission:user.delete', [
            'only' => [
                'destroy'
            ]
        ]);

削除に関連するメッセージの追加

ユーザーが見つからなかった時のエラーメッセージと、削除が完了した報告のメッセージを追加します。

  • resources/lang/ja/sentinel.php をエディターで開く
  • 以下のメッセージを追加
    'user_not_found' => '指定のユーザーが見つかりませんでした。',
    'user_delete_done' => '指定のユーザーを削除しました。',

削除処理を実装

UserControllerのdestroyメソッドに、指定のユーザーを削除するためのコードを実装します。ユーザーと関連するロールの設定は、リレーションを設定しているので自動的に削除されます。該当するユーザーだけ削除すれば良いので楽です。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • 予め作成されている destroy() メソッドを探して、以下のように書き換える
    public function destroy($id)
    {
        // ユーザーを検索
        $user = Sentinel::findById($id);
        if (!$user) {
            // 手動でアクセスした場合はユーザーが見つからない可能性があるので、チェックをしておく
            return Redirect::back()->withInput()->withErrors(['user_not_found' => trans('sentinel.user_not_found')]);
        }

        // 削除実行
        $user->delete();

        // 削除完了メッセージを添えて元のページに戻る
        return Redirect::back()->with(['info' => trans('sentinel.user_delete_done')]);
    }
}

更新処理

ユーザー管理の最後に、登録済みのユーザーの名前やメールアドレス、ロールの変更処理を実装します。

権限のチェック

user.update権限を持つユーザーだけに実行させるので、そのためのミドルウェアを追加します。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • __construct()関数内に、以下を追加
        $this->middleware('permission:user.update', [
            'only' => [
                'update'
            ]
        ]);

メッセージの追加

処理に伴うメッセージを追加します。

  • resources/lang/ja/sentinel.php をエディターで開く
  • 以下のメッセージを追加する
    'detach_role' => 'ロールを外しました。',
    'attach_role' => 'ロールを設定しました。',

更新処理を実装

UserControllerのupdate()メソッドに、更新処理を実装します。

  • app/Http/Controllers/Sentinel/UserController.php をエディターで開く
  • あらかじめ作成されている update()メソッドを探して、以下のようにコードを追加する
    public function update(Request $request, $id)
    {
        // ユーザーを検索
        $user = Sentinel::findById($id);
        if (!$user) {
            // 手動でアクセスした場合はユーザーが見つからない可能性があるので、チェックをしておく
            return Redirect::back()->withInput()->withErrors(['user_not_found' => trans('sentinel.user_not_found')]);
        }

        // 更新したデータがあれば更新する
        $userid = 'user_'.$id."_";
        $changed = [];
        if ((!empty($request[$userid.'name'])) && ($user->first_name !== $request[$userid.'name'])) {
            $changed['name_changed'] = $user->first_name." > ".$request[$userid.'name'];
            $user->first_name = $request[$userid.'name'];
        }
        if ((!empty($request[$userid.'email'])) && ($user->email !== $request[$userid.'email'])) {
            $changed['email_changed'] = $user->email." > ".$request[$userid.'email'];
            $user->email = $request[$userid.'email'];
        }

        if (count($changed) > 0)
        {
            $user->save();
        }

        // ロールのチェック
        $nowroles = "";
        foreach(Sentinel::getRoleRepository()->all() as $role) {
            $idxinrole = $userid.'role_'.$role->id;
            $inrole = (!empty($request[$idxinrole] && ($request[$idxinrole]==="on")));
            $nowrole = $user->inRole($role->slug);
            if ($nowrole && !$inrole) {
                // ロールを外す
                $changed['role_detach'.$role->id] = $role->name.trans('sentinel.detach_role');
                $role->users()->detach($user);
            }
            else if (!$nowrole && $inrole) {
                // ロールを設定
                $changed['role_attach'.$role->id] = $role->name.trans('sentinel.attach_role');
                $role->users()->attach($user);
            }
        }

        // 結果を表示して戻る
        return Redirect::back()->withInput()->with(['info' => $changed]);
    }

以上で、ユーザー管理画面は完成です。

app/Http/routes.phpに定義した Route::get('test/{role}/{routename}'・・・) のルートは不要になりましたので、削除してください。


ロールの管理はこちら