Friction River Software - CakePHP5入門【CakePHP5実用編⑫】入室制限

Ａ子

現時点では、誰でもチャットルームに入室できて、かつ発言も可能なわけだけどさ

限られた人だけが入室できるように、改良したいんだよね

Ｃ菜

それは～

１．原則として誰でも入室できるけど、指定した人については例外的に入室できないようにする
２．原則としてチャットルーム作成者以外を入室できないようにしておいて、指定した人だけは例外的に入室できるようにする

のどちらでしょうか～？

Ａ子

あー、私のイメージ的には２番だったんだけど、１番もありかもね

Ｂ美

１番を「原則許可（Allオール Allowアラウ）」、２番を「原則拒否（Allオール Denyディナイ）」と呼ぶことにして、どちらも実装すれば良いんじゃない？

チャットルームの作成時や編集の際に、どちらにするかを選択できるようにして…

Ｃ菜

それ良いと思います～

「chat_rooms」テーブルに「原則許可」と「原則拒否」の種別を格納する項目を追加しましょう～

Ａ子

んじゃ、「chat_rooms」テーブルに追加するのは「access_policy」という項目にしよう

create table chat_rooms (
    id int auto_increment primary key,
    theme varchar(255) not null,
    admin_id int not null,
    delete_flag int not null,
    access_policy int,
    created datetime,
    modified datetime,
    foreign key(admin_id) references users(id)
) charset=utf8mb4;

Ｃ菜

そこに格納する値については、以下のように定数化しましょう～

define("ALL_ALLOW", 1); //原則許可
define("ALL_DENY", 2); //原則拒否

で、どうでしょうか～？

Ｂ美

ふむ、良いんじゃない？

それじゃ、次は「例外」を格納するテーブルね

Ａ子

うーんと「exceptions」テーブルって名前にしようか

create table exceptions (
    id int auto_increment primary key,
    chat_room_id int not null,
    user_id int not null,
    access_policy int,
    created datetime,
    modified datetime,
    foreign key(chat_room_id) references chat_rooms(id),
    foreign key(user_id) references users(id)
) charset=utf8mb4;

今回は、きちんとCakePHPの命名規則に沿った名付けにしてるよ

具体的には、外部キーである「chat_room_id」と「user_id」って、「参照先のテーブル名の単数形＋'_id'」にしてるからね
（【CakePHP5実用編④】を参照）

Ｃ菜

あっ、しかもこれって「クロステーブル」になっているような～？

チャットルームとユーザの関係（カーディナリティ）って、「多対多」になりますもんね～
（【コラム⑩】を参照）

Ｂ美

二人ともこれまでの経験（と知識）が生かされているようで、ほんと頼もしいわね

それじゃ、さっそくデータベースの修正からやってみなさい

Ａ子

うん
まずは「chat_rooms」テーブルの修正からだね

mysql -u root -p chatdb[Enter]

ALTER TABLE chat_rooms
ADD access_policy int AFTER delete_flag;[Enter]

Ｃ菜

「exceptions」テーブルについても、さきほどの「CREATE TABLE」文をコピペして実行しますね～

Ａ子

んじゃ、「exceptions」テーブルを「bake model」したあと、キャッシュクリアについても実行しておこう

cd html/authapp[Enter]
bin/cake bake model exceptions[Enter]
bin/cake cache clear_all[Enter]

Ｂ美

あ、一点だけ口を出させてもらうわよ

「src/Model/Entity」の中にある「ChatRoom.php」だけど、$_accessibleの中に以下の一文を追加しておきなさいね

'access_policy' => true,

Ｃ菜

なぜでしょうか～？

Ｂ美

「src/Controller」の中にある「ChatRoomsController.php」の「add」メソッドや「edit」メソッドを特に変更しなくてすむように…かな

この記述が無いと、HTMLフォームの中に「アクセスポリシーのラジオボタン」を追加しても、それが無視されちゃうからね
（「ChatRoomsController.php」を修正しても良いんだけど、面倒くさい（苦笑））

Ａ子

よし！
そんじゃ、まずは「config」の中にある「const.php」に定数を追加することからだね

define("ALL_ALLOW", 1); //原則許可
define("ALL_DENY", 2); //原則拒否
define("POLICY_NAME", ["-", "原則許可", "原則拒否"]);

Ｃ菜

それをふまえて「templates/ChatRooms」の中にある「add.php」「edit.php」「view.php」を修正してみました～

あ、「新規作成」時のデフォルト値については、「原則許可」にしてますよ～

Ａ子

うん、良い感じだね

テストしてみたけど、全く問題なかったよ

Ｂ美

問題は、クロステーブルである「exceptions」テーブルの処理なのよね

できるだけ自動化したい（レコード操作をCakePHPに任せたい）から、Modelモデル側のファイルを修正するのが王道のやり方なんだけど、私としてはあまりそれに頼りたくない
（というか、お勧めしない）

Ｃ菜

なぜですか～？

Ｂ美

うまく動かなかったり、エラーが出たときにその原因がよく分からないからよ

「belongsToMany」を使いこなせる人も割といるみたいだけどね

Ａ子

びろんぐすとぅめにぃ？

何それ？

Ｂ美

Modelモデルである「UsersTable.php」や「ChatRoomsTable.php」に記述することで、「多対多」の処理を自動化することができる魔法のキーワードよ（笑）

私には使いこなせないけど…（苦笑）

Ｃ菜

Ｂ美部長でダメなら、私たちには無理っぽいですね～

Ａ子

ふむ

それじゃ、どうすんの？

Ｂ美

いや、普通に（今まで通り）実装するだけよ

まずは「templates/ChatRooms」の中にある「add.php」を修正してみましょう

Ｃ菜

「ChatRoomsController.php」のほうでユーザの一覧を取得して、それを「$users」という形で使えるようにするんですよね～？

Ｂ美

そういうこと

自分自身を一覧の中に表示しないってことと、チェックボックスが配列になってるってことがポイントね
（お試しユーザにマークを付けるってこともやってるけど…）

Ａ子

「ChatRoomsController.php」については、私に任せてよ

まずはテーブルのフェッチからだね

private $Users;
private $Exceptions;

public function initialize(): void
{
    parent::initialize();

    $this->Users = $this->fetchTable('Users');
    $this->Exceptions = $this->fetchTable('Exceptions');
}

んで、「add」メソッドはこんな感じでどうかな？

public function add()
{
    $this->checkGuest();

    //ユーザの一覧を取得
    $users = $this->Users->find()->all();

    $chatRoom = $this->ChatRooms->newEmptyEntity();
    if ($this->request->is('post')) {
        $chatRoom = $this->ChatRooms->patchEntity($chatRoom, $this->request->getData());
        if ($this->ChatRooms->save($chatRoom)) {

            //例外ユーザの追加
            $exception_users = $this->request->getData('exception_users');
            if (!empty($exception_users)) {
                foreach ($exception_users as $user_id) {
                    $exception = $this->Exceptions->newEmptyEntity();
                    $exception->chat_room_id = $chatRoom->id;
                    $exception->user_id = $user_id;
                    $exception->access_policy = $chatRoom->access_policy;
                    $this->Exceptions->save($exception);
                }
            }

            $this->Flash->success(__('チャットルームを作成しました。'));

            return $this->redirect(['action' => 'index']);
        }
        $this->Flash->error(__('チャットルームの作成に失敗しました。'));
    }
    $this->set(compact('chatRoom', 'users'));
}

配列として渡されてきたチェックボックスの値（ユーザID）を「exceptions」テーブルに格納していくだけなんだけどね

Ｃ菜

「templates/ChatRooms」の中にある「edit.php」ですけど、さきほどの「add.php」を参考にして作ってみました～
（ほとんど流用ですけど～）

ポイントはチェックボックスのチェック状態をデータベースから反映させることですね～

Ａ子

ん？
その中にある「$exceptions」って？

Ｃ菜

「ChatRoomsController.php」の「edit」メソッドの中で、こう取得するです～

$exceptions = $this->Exceptions->find()->where(['chat_room_id' => $id])->all()->extract('user_id')->toList();

ポイントは「user_id」の値だけをリスト（配列）化していることですね～

Ａ子

ふむ、なるほどね
だったら「edit」メソッドはこんな感じになるかな？

public function edit($id = null)
{
    $this->checkGuest();

    $chatRoom = $this->ChatRooms->get($id, contain: []);

    //管理人でなければリダイレクト
    if ($chatRoom->admin_id != $this->identity->id) {
        return $this->redirect(['action' => 'index']);
    }

    //ユーザの一覧を取得
    $users = $this->Users->find()->all();

    //このチャットルームに紐づく例外ユーザを検索し、そのユーザIDのみを配列として取得する
    $exceptions = $this->Exceptions->find()->where(['chat_room_id' => $id])->all()->extract('user_id')->toList();

    if ($this->request->is(['patch', 'post', 'put'])) {
        $chatRoom = $this->ChatRooms->patchEntity($chatRoom, $this->request->getData());
        if ($this->ChatRooms->save($chatRoom)) {

            //例外ユーザの削除及び追加
            $this->Exceptions->deleteAll(['chat_room_id' => $id]);
            $exception_users = $this->request->getData('exception_users');
            if (!empty($exception_users)) {
                foreach ($exception_users as $user_id) {
                    $exception = $this->Exceptions->newEmptyEntity();
                    $exception->chat_room_id = $id;
                    $exception->user_id = $user_id;
                    $exception->access_policy = $chatRoom->access_policy;
                    $this->Exceptions->save($exception);
                }
            }

            $this->Flash->success(__('チャットルーム情報を更新しました。'));

            return $this->redirect(['action' => 'index']);
        }
        $this->Flash->error(__('チャットルーム情報の更新に失敗しました。'));
    }
    $this->set(compact('chatRoom', 'users', 'exceptions'));
}

ポイントとしては、このチャットルームの例外リストを全て削除してから、新たに挿入（新規作成）していることだね
（更新処理を行うより分かりやすいと思うんだけど…）

Ｂ美

良いわね
（てか、なかなかやるわね…口には出さないけど）

それじゃ、最後は「ChatController.php」ね
この中の「index」メソッドで、チャットルームに入室できるかどうかを検証してみなさい

Ａ子

OK
えーっと、「exceptions」テーブルの中に、アクセスしてきたユーザの「ユーザID」があるかどうかを調べれば良いんだよね

で、「原則許可」のときにレコードが存在すればアクセス禁止にして、「原則拒否」のときに存在するならアクセスを許可すれば良いのか…

「initialize」メソッド内で「exceptions」テーブルをフェッチするのは当然として、「index」メソッド内にこういう記述を行えば良いと思う

$chat_room = $this->ChatRooms->find()->where(['id' => $room_id])->first();
if ($chat_room->admin_id != $this->identity->id) {
    //例外リストに記載があるか
    $ex_count = $this->Exceptions->find()->where(['chat_room_id' => $room_id, 'user_id' => $this->identity->id])->count();

    if ($chat_room->access_policy == ALL_ALLOW) {
        //原則許可
        if ($ex_count > 0) {
            //ログインユーザが例外リストに入っている場合、アクセス拒否
            $this->Flash->error(__('このチャットルームに入室する権利がありません。'));

            return $this->redirect(['controller' => 'ChatRooms', 'action' => 'index']);
        }
    } else if ($chat_room->access_policy == ALL_DENY) {
        //原則拒否
        if ($ex_count == 0) {
            //ログインユーザが例外リストに入っていない場合、アクセス拒否
            $this->Flash->error(__('このチャットルームに入室する権利がありません。'));

            return $this->redirect(['controller' => 'ChatRooms', 'action' => 'index']);
        }
    }
}

えっと、2行目のif文で「作成者」は無条件で入室できるようにしてるよ
あと、4行目で「exceptions」テーブル内に、入室しようとするユーザのレコードがあるかどうかを調べてるから…

Ｂ美

うーん、特に問題は見当たらないわね

Ｃ菜

あっ、そうだ～
ついでと言っては何ですが、「templates/ChatRooms」の中にある「index.php」と「view.php」内の表記を少しだけ変更しましょう～

具体的には「管理人」という文言を「作成者」に変更するです～
（ユーザ権限としての「管理者」と、チャットルーム作成者としての「管理人」がごっちゃになりそうなので～）