ソフトウェアエンジニアの技術ブログ：Software engineer tech blog

– authのユーザ登録(/register)の項目をカスタマイズする
–> デフォルトのカラムに対し、usersテーブルにrole_id(admin/subscriber)が追加されており、authのユーザ登録(/register)でも、role_idのradioボタンを追加して登録できるようにしたい

### usersテーブル

Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->integer('role_id')->nullable();
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });

### register.blade.php

/resources/views/auth/register.blade.php

<div class="card-body">
　　　　<form method="POST" action="{{ route('register') }}">
       @csrf
　　　　// 省略
<div class="col-md-6">
        <div class="form-inline">
            <div class="form-check">
                <input id="role_id" type="radio" class="form-control mr-1 @error('role_id') is-invalid @enderror" name="role_id" value="1" required autocomplete="off" checked>
                <label class="form-check-label mr-3" type="radio">Administrator</label>
            </div>
            
            <div class="form-check">
                <input id="role_id" type="radio" class="form-control mr-1 @error('role_id') is-invalid @enderror" name="role_id" value="2" required autocomplete="off">
                <label class="form-check-label mr-3" type="radio">Subscriber</label>
            </div>
        </div>

        @error('role_id')
            <span class="invalid-feedback" role="alert">
                <strong>{{ $message }}</strong>
            </span>
        @enderror
    </div>
</div>
　　　　// 省略
　　　　</form>
</div>

### RegisterController.php
app/Http/Controllers/Auth/RegisterController.php

protected function validator(array $data)
    {
        return Validator::make($data, [
            'name' => ['required', 'string', 'max:255'],
            'role_id' => ['required'],
            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
            'password' => ['required', 'string', 'min:8', 'confirmed'],
        ]);
    }

    /**
     * Create a new user instance after a valid registration.
     *
     * @param  array  $data
     * @return \App\User
     */
    protected function create(array $data)
    {
        return User::create([
            'name' => $data['name'],
            'role_id' => $data['role_id'],
            'email' => $data['email'],
            'password' => Hash::make($data['password']),
        ]);
    }

### User.php

protected $fillable = [
        'name', 'email', 'role_id', 'password',
    ];

mysql> select * from users;

$dataとしてPOSTされたデータをcreateしている。
よく編集されるページなのか、RegisterController.phpは非常に分かりやすい構造になっています。

ログイン時のsessionの扱いについて見てみましょう。

### laravel session
login画面にアクセスすると、tokenに加え、laravel_sessionのcookieが付与されます。
– ログイン前

– ログイン後

### cookiの設定
app/config/session.php
-> デフォルトでは120分、ブラウザを閉じても保存されたまま
-> セッションが切れると、ユーザ認証は不可能になる

'lifetime' => env('SESSION_LIFETIME', 120),
'expire_on_close' => false,

### Remember meにcheckを入れてログイン
– ログイン前

– ログイン後
-> remember_web_* のcookieが新たに発行されている
-> remember_web_*があれば、１２０分で、laravel_sessionが切れても、ログオフしない限り5年間ログインなしでアクセス可能になる。

remember meを実装するかどうかは、サービス内容やセキュリティポリシーによるので、よく考えて検討した方が良さそうです。自分以外のパソコンや端末からログインする機会は、割と溢れてますからね。

### login.blade.php
resources/views/auth/login.blade.php
-> 一応、login_cp.blade.phpでコピーを取っておきます。
-> 日本語化しながら、何が書かれているのか確認していきます。

<form method="POST" action="{{ route('login') }}">
                        @csrf

                        <div class="form-group row">
                            <label for="email" class="col-md-4 col-form-label text-md-right">{{ __('メールアドレス') }}</label>

                            <div class="col-md-6">
                                <input id="email" type="email" class="form-control @error('email') is-invalid @enderror" name="email" value="{{ old('email') }}" required autocomplete="email" autofocus>

                                @error('email')
                                    <span class="invalid-feedback" role="alert">
                                        <strong>{{ $message }}</strong>
                                    </span>
                                @enderror
                            </div>
                        </div>

                        <div class="form-group row">
                            <label for="password" class="col-md-4 col-form-label text-md-right">{{ __('パスワード') }}</label>

                            <div class="col-md-6">
                                <input id="password" type="password" class="form-control @error('password') is-invalid @enderror" name="password" required autocomplete="current-password">

                                @error('password')
                                    <span class="invalid-feedback" role="alert">
                                        <strong>{{ $message }}</strong>
                                    </span>
                                @enderror
                            </div>
                        </div>

                        <div class="form-group row">
                            <div class="col-md-6 offset-md-4">
                                <div class="form-check">
                                    <input class="form-check-input" type="checkbox" name="remember" id="remember" {{ old('remember') ? 'checked' : '' }}>

                                    <label class="form-check-label" for="remember">
                                        {{ __('ログイン状態を記憶') }}
                                    </label>
                                </div>
                            </div>
                        </div>

                        <div class="form-group row mb-0">
                            <div class="col-md-8 offset-md-4">
                                <button type="submit" class="btn btn-primary">
                                    {{ __('ログイン') }}
                                </button>

                                @if (Route::has('password.request'))
                                    <a class="btn btn-link" href="{{ route('password.request') }}">
                                        {{ __('パスワードを忘れた方はこちら') }}
                                    </a>
                                @endif
                            </div>
                        </div>
                    </form>

– FormはPostメソッドで、actionはroute(‘login’)
– メールのnameはemail
– パスワードのnameはpassword
– remember meのnameはremember
– パスワード再発行のリンク先はroute(‘password.request’)
– エラー時には、input formにis-invalidのclassを付けている

### エラーメッセージの日本語化
config/app.php

'locale' => 'ja',

resources/lang/ja/auth.php
※en/auth.phpをコピー。ログインのエラーメッセージはvalidation.phpとは異なるので注意が必要

    // 'failed' => 'These credentials do not match our records.',
    // 'throttle' => 'Too many login attempts. Please try again in :seconds seconds.',
    'failed' => '認証情報が記録と一致しません。',
    'throttle' => 'ログイン試行が規定回数を超えました。:seconds秒後に再開できます。',

$ php artisan config:cache

同様に、resources/views/auth/passwordsのemail, resetと、resources/lang/ja/のpasswordsを編集していきます。
verify.blade.phpと/passwords/confirm.blade.phpは、laravel5.7系から実装された、Email Verification機能。必要に応じて実装。

### デフォルト
routes/web.php

Auth::routes();

ルーティングの設定
vendor/laravel/framework/src/Illuminate/Routing/Router.php

public function auth(array $options = [])
    {
        // Authentication Routes...
        $this->get('login', 'Auth\LoginController@showLoginForm')->name('login');
        $this->post('login', 'Auth\LoginController@login');
        $this->post('logout', 'Auth\LoginController@logout')->name('logout');

        // Registration Routes...
        if ($options['register'] ?? true) {
            $this->get('register', 'Auth\RegisterController@showRegistrationForm')->name('register');
            $this->post('register', 'Auth\RegisterController@register');
        }

        // Password Reset Routes...
        if ($options['reset'] ?? true) {
            $this->resetPassword();
        }

        // Password Confirmation Routes...
        if ($options['confirm'] ??
            class_exists($this->prependGroupNamespace('Auth\ConfirmPasswordController'))) {
            $this->confirmPassword();
        }

        // Email Verification Routes...
        if ($options['verify'] ?? false) {
            $this->emailVerification();
        }
    }

Registrationをコメントアウト

// Registration Routes...
        // if ($options['register'] ?? true) {
        //     $this->get('register', 'Auth\RegisterController@showRegistrationForm')->name('register');
        //     $this->post('register', 'Auth\RegisterController@register');
        // }

すると、/register のURLが無効化され、/registerを叩くと、404と表示されるようになる。

### デフォルト設定
– 試行回数: 5回
– ロック時間 : 45 seconds

app/Http/Controllers/Auth/LoginController.php

protected $maxAttempts = 5;
protected $decayMinutes = 5;

▼ログイン機能の実装
/vendor/laravel/framework/src/Illuminate/Foundation/Auth/ThrottlesLogins.php

### メール本文テンプレート作成
resources/views/mail/passwordreset.blade.php

<body>
	<h1>パスワードリセット</h1>
	<p>以下のボタンを押下し、パスワードリセットの手続きを行ってください。</p>
	<p id="button">
		<a href="{{ $reset_url }}">パスワードリセット</a>
	</p>
</body>

### 通知クラス
$ php artisan make:notification PasswordResetNotification
app/Notifications/PasswordResetNotification.php が生成される

    public $token;
    protected $title = 'パスワードリセット通知'
    /**
     * Create a new notification instance.
     *
     * @return void
     */
    public function __construct($token)
    {
        //
        $this->token = $token;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    //テンプレートとテンプレートに渡す引数
    public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject($this->title)
                    ->view(
                        'mail.passwordreset',
                        [
                            'reset_url' => url('password/reset', $this->token),
                        ]);
    }

    /**
     * Get the array representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)
    {
        return [
            //
        ];
    }

### User.php

use App\Notifications\PasswordResetNotification;
public function sendPasswordResetNotification($token){
        $this->notify(new PasswordResetNotification($token));
    }

sendPasswordResetNotificationのオーバーライドはcontrollerではなく、Userモデルで行う。

デフォルトだとログアウト処理では、’/'(ルート)に遷移する

### view

<form id="logout-form" action="{{ route('logout') }}" method="POST" name="logout">
        @csrf
   <a href="javascript:document.logout.submit()">ログアウト</a>
</form>

### LoginController.php
app/Http/Controllers/Auth/LoginController.php
->/hogeに遷移

use Illuminate\Support\Facades\Auth;
public function logout(Request $request){
        Auth::logout();

        $this->guard()->logout();

        $request->session()->invalidate();

        return $this->loggedOut($request) ?: redirect('/hoge'); 
    }