のぶのぶWiki-WebSylpheed

XOOPSモジュール化への道

nobunobu, 通りすがりさん — 2007-04-22T21:44:51+09:00

Prev
WebSylpheed
Next
XOOPSモジュール化への道
発端
XOOPS用のメールモジュールは、WebMailやsqMailなどが既にある。但し、
WebMail
かなりXOOPSとの親和性が高くなってきているが、POP3のみに対応している。
sqMail
IMAP用のSquirrelMailのXOOPSモジュールだが、あくまでも、XOOPSの中で表示できるというだけで、モジュール内でメールアカウントにログインし直す必要があったりする。
我が家では、既にIMAPのサーバを立ち上げて自動フォルダー分類なども行っているため、IMAP対応のWebMailシステムが必要となってくる。現在は、PCではSquirrelMail、携帯からはWebSylpheedの拡張版にさらに独自拡張した物を使用しているが、XOOPS中にメールシステムも統合したいので、仕組みが簡単なWebSylpheedを元にしてXOOPSモジュール化に挑戦したいと考えた。以降に、そのモジュール化作業を元にして、XOOPSのモジュール開発の方法を少しずつ記録していく事とする。
作業記録
第１ステップ・単純な組込 New!
コメント
うぉ〜〜　激しく期待です(^^;;　　私はXOOPSモジュールで新着チェックをしてIMPに飛んでいるので(^^)v -- shin0211 2004-05-02 (日) 18:11:34
乞う、ご期待！っと言いたいところなんですけど、３ヶ月間手付かずなもんで・・・・・・ -- nobunobu 2004-05-02 (日) 19:07:27
Prev
Home
Next
WebSylpheed
Up
WebSylpheed/XOOPSモジュール化への道/第１ステップ・単純な組込

XOOPSモジュール化への道/第１ステップ・単純な組込

nobunobu, 通りすがりさん — 2007-04-22T21:43:52+09:00

Prev
WebSylpheed

第１ステップ・単純な組込
まずは、既存PHPプログラムのXOOPSモジュール化の定石である、単純なモジュール化に着手。
作業記録
1.初期配置
WebSylpheedのディレクトリーを、XOOPSのmodulesディレクトリ下にディレクトリ毎コピーを行う。
2.XOOPSのヘッダーフッターの組み込み。
htmlページをを生成するPHPプログラムソースを以下の手順で修正する。 1)XOOPSヘッダの組み込み。対象のPHPファイルを開いて、ページにタグが出力されるロジックよりも前に、
include("../../mainfile.php");
include(XOOPS_ROOT_PATH."/header.php");
OpenTable();
を挿入する。また、タグが出力されるロジックよりも後に、
CloseTable();
include(XOOPS_ROOT_PATH."/footer.php");
を挿入する。 2)html出力部分の修正。通常、PHPでhtmlを出力するにあたっては、最低限

表示されるコンテンツ本体

という構造で出力を行うが、XOOPSのモジュールは、上記のコンテンツ本体のみを生成して、その他の出力はXOOPS本体に任せる事となるため。などを出力している部分を削除する。
3. xoops_vesrion.phpの作成
XOOPSモジュールの情報を記述するファイル、xoops_vesrion.phpを作成する。今回は最低限のモジュール化なので、以下のようになる。
$modversion['name'] = 'WebSylpheed';
$modversion['version'] = "0.1";
$modversion['description'] = 'WebSylpheedモジュール';
$modversion['official'] = "no";
$modversion['dirname'] = "websylpheed";
// Admin things
$modversion['hasAdmin'] = 0;
$modversion['adminmenu'] = "";
// Menu
$modversion['hasMain'] = 1;
?>
4.インストール＆テスト
ここまでで、最低限の作業が完了したので、XOOPSの管理者メニューでモジュールのインストールを行う。インストールが終わると、メインメニューにWebSylpheedというのが追加されているはずなので稼働テストを行う。
5.微調整
おそらく、いろいろな制約から、そのままではきちんと稼働しない場合があるので、症状にしたがって、修正を行う。今回のWebSylpheedでは、以下の修正を行う事によって、とりあえず一通りの動作がおこなえる様になった。
ソースの文字コード変換
WebSylpheedは、i-modeでも表示が可能なようにソースもShiftJISでエンコードされていたため、 EUCにコード変換を行った。
Register Global Off対応
WebSylpheedは、元々はPHP3の時代に開発された事もあって、Register Global Off対応がされていなかった。よって、そのままでは画面間のパラメータの受け渡しがうまくいかなかったので、HTTP_GET_VARSや HTTP_POST_VARSなどを使って、パラメータを取得するロジックを追加した。 WebSylpheedの場合には、session.inc.php(元々はsession.lib)の中の先頭部分に、以下のロジックを追加
foreach($HTTP_POST_VARS as $key => $value) {
eval("\$"."$key = \"$value\";");
}
foreach($HTTP_GET_VARS as $key => $value) {
eval("\$"."$key = \"$value\";");
}
6.最終確認
上記修正後、再度稼働テストを行う。
以上で、とりあえずXOOPSの中でWebSylpheedがモジュールとして動くようになった。今後のToDoとしては、
メールアカウント情報のDBへの投入と管理
Adminメニューの追加
アドレス帳の他のモジュールとの共用化
新着メールブロック等の追加
IMAPフォルダーのキャッシュ保存
画面推移のシンプル化（携帯用の為画面展開階層が深い）
出力HTMLのCSS対応とSmarty Template化
添付ファイル、HTMLメール対応などを予定している。（何時になったら出来る事やら・・・・・）これらが、完了する頃には元のプログラムで生きているのはIMAP関連のロジックだけになっていると思うのでもはや、WebSylpheedとは呼べなくなっていると思う。
参考文献
Keiko269-XOOPSちょっとカスタマイズ編(１) : 簡易モジュール
Prev
Home

WebSylpheed/XOOPSモジュール化への道
Up

WebSylpheed

nobunobu, 通りすがりさん — 2007-02-22T08:28:01+09:00

WebSylpheed
WebSylpheedとは
株式会社グッデイが公開しているオープンソースのiモード対応のWebメーラ。
WebSylpheed
オリジナル
WebSylpheed改良版 by Kazuhiko Iwama
PHP4.0.6 への対応（文字コード・拡張子も変わっています）
日本語フォルダへの対応
マルチパート対応
文字数制限への簡易対応（i-mode, J-SKY 等を自動認識します）
ログイン管理部の分離
パスワード保存ＵＲＬに user-id/passwd を使わないように変更
表示項目のカスタマイズ対応
ＤＢアクセス部の分離と MySQL への対応
ＤＢを利用しない設定を追加
personal folder への対応
UID を使ってサーバにアクセスするように変更
メールアドレスのドメイン名を指定できるよう変更
新着・既読・削除済みメールに応じた表示に対応
INBOX での削除済みメールの非表示対応
設定ファイルの分離
include で読み込むファイルを設定ファイルを除き *.lib にファイル名を統一
半角カナでの表示に対応（ソースコードを ShiftJIS に変更しています）
メール送信時に X-Mailer ヘッダをつけるようした
おまけのメールチェックプログラムの追加
全バージョンからのバグ修正各種(^^)
その他、あるはずだけど忘れた(_o_)
WebSylpheed 改良版のちょっと改造版 by setter@reset.jp
件名/送信者などをドロップダウンに
J-PHONE/3.0 の場合、TEXT フィールドの MAXLENGTH を 64 に
ログを残す
WebSylpheed拡張版 by Keita Morikawa
IMAPサーバーの選択機能（パスワード保存対応）
メールの削除機能（簡易削除）
その他改良版で気付いた不具合の修正
WebSylpheed改良版の独自改造版 by のぶのぶ未公開
細かな画面遷移の変更
i-modeからのメールなどでのSubject文字化け対応
i-modeでメール本文閲覧時に文字数制限を超えたときに次ページでの表示を可能に
Agentを判別して、携帯アクセスの場合には全角->半角などの圧縮処理を実施
メール本文中のhttp://〜などのリンクを有効に
メール削除を可能に
IMAPサーバが１サーバで複数ドメイン管理して場合への対応
目次
XOOPSモジュール化への道 New!
第１ステップ・単純な組込 New!