Cookieログイン

今回は、ログイン画面でよくみかけるクッキーログインの機能を使ってみます。

CakePHPには、Cookieコンポーネントがあります。(PHPのsetcookieメソッドのラッパー)メソッドはwriteとreadです。わかりやすい。
ログイン時に、「ログインしたまま」というチェックボックスをつけてログインしてきたユーザのクッキーをwriteして、次回そのユーザが訪問した際に、クッキーをreadして自動的にログインさせます。

Cookieコンポーネントの使用

var $components = array(
    'Cookie',
}

使用する際は、コントローラ内でコンポーネントを読み込んで下さい。

writeメソッド (クッキーをつくる)

ログイン画面にチェックボックスを用意します。今回は、remember_meにします。以下は、Userモデルのusernameとpasswordという前提にしていますので、異なる場合は置き換えて下さい。

public function login() {
    if (!empty($this->data) ) {
        // ログイン OK
        if ($this->Auth->login()) {
            // remember_meがチェックされている場合
            if ($this->data['User']['remember_me']){
                // cookieへの書き込みにremember_meを除外
                unset( $this->request->data['User']['remember_me']);
                $cookie = $this->request->data;
                // cookie書き込み
                $this->Cookie->write( 'Auth', $cookie, true, '+2 weeks');

            // remember_meがチェックされていない場合
            } else {
            }
            // リダイレクト
            return $this->redirect( $this->Auth->redirect());

        // ログイン NG
        } else {
            $this->Session->setFlash( 'Invalid username or password');
        }
    }
}

これで、CakeCookie['Auth']['User']という名前で保存されます。

readメソッド (クッキーをつかう)

ログイン画面にアクセスした際に、$keyをもとにクッキーのデータをリードして、その値でログインを試みます。

function login(){
    if (empty($this->data) ) {
        // cookie 有り
        if ($this->Cookie->check('Auth')) {
            // cookieをログイン用データに書き込み
            $this->request->data = $this->Cookie->read('Auth');
            // ログイン OK
            if ($this->Auth->login()) {
                // ログインリダイレクト
                return $this->redirect( $this->Auth->redirect());
            // ログイン NG
            } else {
                // coockie削除
                $this->Cookie->delete('Auth');    //    クッキー削除
            }
        // cookie 無し
        } else {
            // ログイン画面表示
        }
    }
}

$this->Cookie->read('Auth')の中身を確認すると、以下のようになっており、ログイン処理に使用するUserデータそのものになっているはずです。

Array
(
    [User] => Array
        (
            [username] => ユーザ名
            [password] => パスワード
        )
)

deleteメソッド (削除する)

Cookieの中身を削除します。Cookieの内容でログインできない場合は、deleteしてください。そうしないと堂々巡りになります。(上記) また、ログアウト時もdeleteして下さい。

public function logout() {
    $this->Cookie->delete('Auth');
    return $this->redirect( $this->Auth->logout());
}

destroyメソッド

Cookieそのものを破棄します。違いは、deleteはcookieの値を指定して削除できるのに対し、destroyはごっそり消します。

Cookieコンポーネントの変数

現在の設定は、$this->log($this->Cookie, LOG_DEBUG)などで確認してみて下さい。

function beforeFilter() {
    $this->Cookie->name = 'baker_id';              // クッキー名‘baker_id’
    $this->Cookie->time = 3600;                    // 有効期間=>1時間
    $this->Cookie->path = '/bakers/preferences/';  // /bakers/preferences/
    $this->Cookie->domain = 'example.com';         // example.comドメイン
    $this->Cookie->secure = true;                  // HTTPSの場合のみ送信
    $this->Cookie->key = 'qSI232qs*&sXOw!';
}

Session用のCookieのキー名を変更する

Session用のクッキーを格納するキー名はデフォルトでは、"CAKEPHP"になっています。必須ではないですが、変更してみます。core.phpに

/* - `Session.cookie` - The name of the cookie to use. Defaults to 'CAKEPHP' */
    Configure::write( 'Session.cookie', 'NAMEOFKEY');

今回は、クッキーデータの扱い方法をログインに例にとって投稿してみました。

Related

ログインに追加の条件を付与する「scope」 Cookieログイン Sessionコンポーネント ユーザ登録(仮登録・メール・本登録) ユーザ登録(仮登録・メール・本登録) selectボックスを実装 バリデーションエラーメッセージの取得 多言語サイト向けに翻訳ファイルを使って翻訳を行う