PHPのテクメモ

Xoopsには標準でモジュールへのアクセス権限設定機能が用意されている。複雑でないアクセス権限（例えば管理機能と公開機能に単純に分けられるような）であれば、この機能で十分まかなえる。これはモジュールを作成する際のお作法として、管理者機能はadminというサブディレクトリ内にファイルを配置すればよいからだ（つまりadminディレクトリ内かどうかで判断しているだけだ・・・多分）。
上記以外の権限チェック、つまり管理者かどうかというチェックではなく、例えば登録ユーザか否かのようなチェックや、あらかじめ許可されたグループに登録されたユーザか否か、というようなチェックが必要な場合は、スクリプト毎にアクセス権のチェックをしてやる必要がある。
地道にデータベースにSQLを発行してチェックしてもいいわけだが、諸々用意されているものを使うほうが簡単でいい。ここではその便利な方法を、既存モジュールから列挙してみた（既存モジュールの「フォーラム」を参照した）。

bool $xoopsUser->isAdmin($xoopsModule->mid())

$xoopsModule->mid()はモジュール管理番号を返し、それを引数としている$xoospUser->isAdmin()はアクセスしてきたユーザが、当該番号のモジュールに対して管理者権限をもっているかどうか、をチェックしてくれる。

bool check_priv_forum_auth($xoopsUser->uid(), $_POST[‘forum’], true)
bool is_moderator($forum, $xoopsUser->uid())

上記はそれぞれ専用の関数を用意し、それらの関数内ではデータベースに対してSQLを発行しているようだ。

つまり結局アクセス権のチェックは以下の二つの関数、モジュールの一般設定で設定する$xoopsModuleConfig（設定されていれば）、およびとデータベースへのSQLの発行などでチェックするということになりそうだ。
$xoopsModule->mid()
$xoospUser->isAdmin()

XoopsといえどもプログラムはPHPだから難しいわけではない。基本的にXoopsのお作法に則ったアクセス権の管理さえ出来れば、モジュールを作成するのは何も難しいことはない、ということになる。

ここまでくればハックが必要なモジュール（白扇など）をのぞけば大抵の機能を作ることが出来るようになるだろう。

さて、edituserhook.phpを読んでいく。
$allowed_requests、$stop_reason_extrasの記述はregisterhook.phpと同じ。
次にuidの取得。ここでは「編集」なので、この画面を使用する人は当然ログインしているわけだからuidを取得できるわけだ。

設定ファイルを読み込んだ後、$xxxxxx_optionsの設定はフォームで使用される選択式設問用のオプション値の準備だ。
次は処理振り分け用の設定（$op）。$opが設定されていなければ’editprofile’を設定する（フォームを表示するため）。
それから各種設定を変数へ格納する。

ここからが本格的な処理になる。
最初のif節はpostで送られてきた情報を、あらかじめ設定された$allowed_requestsと比較して変数に格納していく。

そして次のif節。実際の保存処理に移るわけだが、if節の中の最初の処理はエラーチェック。エラーがあったらもう一度フォームを表示することになる。
実際の保存処理はきわめて簡単だ。あらかじめ用意された関数を使えばよい。具体的には以下の記述。

$edituser =& $member_handler->getUser($uid);
$edituser->setVar(‘url’,$allowed_requests[‘url’],true);
・
・
・
$member_handler->insertUser($edituser);

これでOK。後付で追加した項目は都度UPDATE構文で処理する。
最後の部分はフォームの表示だけ、となる。

minihakuはこれで全てだ。ユーザ情報の表示（userinfohook.php）はプログラムこそ用意されて入るが中身は空。つまり一度はhookをかけるが、何もせずXoop標準の処理に戻して、デフォルトの表示方法をとっているようだ。

もちろん自分でプログラムを作成して、userinfohook.phpに記述しておけば独自の表示処理をかませることが出来る。無論テンプレートも別途用意してやる必要があるわけだが・・・。

minihakuを読んでみて、Xoopsのことがずいぶん理解できたような気がする。以降の新規モジュール作成の際にはきっと役立つだろう。
これから仕様決め。今月中に形を作りたいものだ。

ユーザ情報の編集は以下のファイルから構成される
・include/config.php
・include/edituserhook.php
・templates/minihaku_edituser.html

設定ファイルとテンプレートはよしとして、プログラム本体「edituserhook.php」を見ていく。
ここでまず最初に知っておく必要がある事項についてメモすることにする。
Xoopsでは初回登録時の入力項目と、編集時の項目とは違う。違うというのは正しくないが、編集時には情報を追加できるのだ（もともと登録しておける項目はたくさんあるが、初回登録時は必要最低限の部分のみ）。

必要なものもあれば、必要ないものもあるし、決まりきっていて入力してもらう必要もないものもある。いずれにしても処理方法を検討する上で、このリストは重要だ。
ただし編集時に入力する「ユーザ名を1年間クッキーに保存する」という設定。これはDBに保存されない。単にクッキーに保存しておくだけ、ということだろう。

さて、プログラムの行数も多くない。がんばって読んでいくことにする。

registerhook.phpの登録処理ルーチン付近を見てみることにする（「REGISTER STAGE」から下あたり）。
まず最初のif節。登録フォームでsubmitされたときの処理だ。ここでは入力値のチェックがおこなわれている。チェックする項目はユーザ名とメールアドレス、それにパスワードだ。エラーがあると、そのエラーは変数$stop_reasonにセットされる（後で使う）。
次のif節。ここでは実際の登録処理をおこなう。このif節は登録フォームでsubmitされ、かつ上述の$stop_reasonに値がセットされていないときに処理をする（つまり入力内容にエラーがなかったとき）。ここでは$stop_reason_extrasという変数もチェックしているのだが、これはおそらく追加で設定した項目について、独自にエラーチェックルーチンを書け、ということのようだ。
そして粛々と登録処理があり、$member_handler->insertUser($newuser)で登録が完了する。この時点ではデフォルトの項目のみが登録される。
次に追加で設定した項目データの登録となる。上記登録完了でセットされたuidを取得し、データベースを更新、という形式で登録処理が実行される。
次は自動的に所属させるグループの設定。複数のグループに登録させることが出来る。ここの$auto_belong_groupsはconfig.phpで設定された変数だ。
次が$xoopsConfigUser[‘activation_type’]の設定次第で分岐処理。おそらく「0」は確認メールを送る通常処理、「1」は即時登録、「2」は管理者にアクくティベーションのためのメールを送信する処理だ。
そして最後はユーザ登録のnotifyメールの送信処理となる。

とりあえず全部読めた。次はedituserhook.phpを見ていくとしよう。

minihakuの拡張、まず「登録」から。
基本的にこれは以下の3ファイルから構成されているようだ。
・include/config.php
・include/registerhook.php
・templates/minihaku_register.html

もちろん設定ファイルの読み込み等があるので、別ファイルも関連するがそれは割愛。上記のうちconfig.phpは、登録フォームで追加すべき項目を設定する（config.dist.phpからrenameして使用）。このファイルはもちろん編集でも使用することになる。
結局このファイルでは、入力項目の設定、入力値のチェック、編集時の初期値をDBから取得、なんて処理が書かれている。手動で作業する場合はこれを編集・追記するわけだ。目指すはここの自動化（もちろんテンプレートも自動的に変更されることを目指す）。
registerhook.phpはプログラムの主要部分。今回は最初ということでフォームの表示部分のみを見ることにする。最初のところは受け取りたい変数の初期化だ。ここも自動化する必要がある。途中の大部分は実際の登録処理なので、とりあえず省略（後日検討）。フォームの表示は最後のほうの「FORM STAGE」以下の部分だ。
最初にheaderを読み込む。次にフォームの情報をセットし、またconfig.phpで追加された情報もここでセットされる。そして最後にfooterの読み込み。それだけ。これをDB化すればいいということになる。まぁ、簡単ではあるが、実際作業するのは多少手間であることは間違いない。
あとはテンプレートminihaku_register.htmlを適宜修正する必要がある。ちなみにminihakuでは、項目名は既存の設定ファイルを流用する形になっている。これではまずいのでここもDB化していくことになる。

今回いろいろ試行錯誤していて覚えたXoopsのお作法。テンプレートファイルを編集しても、それでは直接反映されない。いったんXoopsの管理者権限を取得し、モジュールのアップデートを実行することでようやくテンプレートが反映される。これは、Xoopsのモジュールではテンプレートの内容はDBに書き込まれ、それがコンパイルされてtemplates_cディレクトリに保存されているからだ。なんでそんな面倒なことになっているのかわからないけれど・・・。まずは少しめどがついた。
次回は実際の登録ルーチンを見ていくことにする。