How to use the next generation XooNIps

Size: px

Start display at page:

Download "How to use the next generation XooNIps"

ありさうづき
7 years ago
Views:

1 XooNIpsプラットフォーム基盤システムの実装と拡張理化学研究所脳科学総合研究センター神経情報基盤センター奥村嘉宏 2015 年 7 月 16 日 Brain Atlas Hackathon 2015 ブレインアトラスアイデアソン

2 XooNIps とはインターネット上で多様な電子データ(ファイル,URL, 書籍論文等 )をメタデータと供に共有を図るためのWebデータベース基盤システム運用ポリシー設定 XooNIps 概観詳細表示一覧表示ファイルダウンロード 2

3 システム概要アカウントを持つユーザデータの登録公開を行う検索閲覧登録ユーザ検索閲覧インデックスツリー編集アイテム登録編集外部 DB メタデータ交換個人利用個人領域個人領域個人領域インデックスツリーインデックスツリーアイテム情報インデックスツリーアイテムデータファイル情報アイテムデータファイル情報電子ファイルアイテム公開公開承認データ公開公開領域インデックスツリーアイテム情報電子ファイル自動生成自動生成メタデータ情報ランキング情報研究者情報検索閲覧通常のユーザデータを閲覧するアイテム共有検索閲覧共有承認グループ共有グループ共有領域グループ共有領域グループ共有インデックスツリー領域インデックスツリーアイテム情報インデックスツリーアイテムデータファイル情報アイテムデータファイル情報電子ファイルインデックスツリー編集インデックスツリー編集アカウント情報編集グループメンバー管理グループ管理システム設定ユーザ情報アカウント情報グループ情報システム情報サイトポリシーアクセスログ自動生成アカウント申請アカウント承認ユーザ管理インポートエクスポートゲストサイト全体のシステムの設定を行うアクセスログ解析サイトポリシー設定グループ共有情報を管理するグループ管理者モデレータシステム管理者公開する情報やサイトのユーザ情報を管理する 3

4 XOOPS Cube Legacy ベースシステム構築運用コストの削減無償利用可能なオープンソースソフトウェア容易な機能拡張 XOOPS の既存モジュールと組み合わせて多種多彩なサイトを構築可能デザインの変更 XOOPS のテーマを変更することでレイアウトなどの概観を自由に変更可能 XOOPS General Modules Web browser PHP Apache Data Item type XooNIps Module Legacy (XOOPS 互換レイヤー) XOOPS Cube RDBMS (MySQL) User Interface Web Application Database 4

5 XooNIps と XOOPS Cube Legacy XooNIpsはXOOPS Cube Legacy(XCL)というCMSの上に実装されたモジュール XooNIpsを導入することにより追加される機能ユーザ管理機能を拡張メタデータとファイル管理インデックスによる整理とアクセス権の制御承認のためのワークフロー外部システム連携のためのAPIなどなど最新版では上記を基盤となるXCLの仕組みを活用して機能ごとに複数のモジュールに分割して実装一つの見方として XooNIpsとは上記の機能を持つCMSであると捉えてもらったほうがわかりやすいかもプラットフォーム基盤システム XooNIps XCL + XooNIps 機能追加モジュール群 5

6 ここでは XOOPS Cube Legacy の仕組みを中心に紹介 XooNIps の機能を実装する上で XCL の仕組みは重要 Webブラウザで操作できる機能にはあまり触れずにその裏側を覗き見る 6

7 XOOPS Cube Legacy 7

8 主なディレクトリ構成 html/: Webからアクセスできる領域 index.php: サイトトップ mainfile.php:サイト設定ファイル theme/:サイトテーマ images/, uploads/ common/, js/ : 静的データ用フォルダ kernel/, include/, language/: XOOPSシステム関連フォルダ(XOOPS 互換性のために残存 ) core/, preload/: XOOPS Cube システム関連フォルダ modules/: モジュール群 legacy/, legacyrender/, stdcache/, user/:legacy XOOPS 互換レイヤー実体 profile/, message/ : Legacy で追加されたモジュール xoonips/ : XooNIps モジュール xworkflow/ : 承認ワークフロー rest/ : XooNIps REST API (その他割愛 ) xoops_trust_path/: Webから直接アクセスできないところ cache/, libs/, settings/, templates_c/ :システム関連ファイル (XCL 2.2~) modules/: モジュール群 (XOOPS_TRUST_PATH 対応モジュールの本体を配置 ) xoonips/ : XooNIps モジュール本体 xworkflow/ : 承認ワークフロー本体 rest/ : XooNIps REST API 本体 (その他割愛 ) html 側にはブラウザで直接アクセスするファイルのみ配置アクセスされたら xoops_trust_path 側の本体を呼び出す 8

9 サイトテーマサイト全体の配置やCSSなどのデザインを決める左カラム中央カラム( 中央 ) 中央カラム( 左 ) 中央カラム( 右 ) 右カラム左カラム中央カラム中央右カラム各モジュールの機能単位の全ての出力は並び順と共にいずれかに属す左右 html/themes/ 以下に配置し設定画面から利用するテーマを選ぶ 9

10 モジュールテンプレートモジュールの画面出力の際の見た目を定義テンプレートの仕組みを利用するか否かはモジュールの実装による機能の出力やさらにその構成要素単位で存在 html/modules/{modname}/templates/*.html モジュールインストール時にDBの中にdefaultテンプレートセットとして複製される独自のテンプレートセットを作成可能で設定画面から利用するテンプレートセットを選択できる管理画面からDBに複製された各テンプレートを編集できるテンプレートファイル本体を書き換えなくてもよい XoopsTpl : Smarty エンジンの派生クラスで実装テンプレートの中に PHP のコードを埋め込めるのでレンダリングの際に独自の処理を実行可能 10

データの永続化 XOOPS DataMapperパターンモデル(データ)とデータベースの間をとりなす仕組み XoopsObject:モデル基底クラス一連のデータの名前型属性 ( 必須データ長など) 値などを保持 get(), set() で値を出し入れ継承して各モデルを扱うクラスを定義 XoopsUser,

11 データの永続化 XOOPS DataMapperパターンモデル(データ)とデータベースの間をとりなす仕組み XoopsObject:モデル基底クラス一連のデータの名前型属性 ( 必須データ長など) 値などを保持 get(), set() で値を出し入れ継承して各モデルを扱うクラスを定義 XoopsUser, XoopsGroup, XoopsMembership など Name Type Required Length Value uid INT true 10 桁 1 uname STRING true 32 文字 admin XoopsObjectHandler:マッパー基底クラス( 実質インターフェースのみ) データベースと XoopsObject を結びつける create(), get(), insert(), delete() で出し入れ継承して上記モデルを操作するマッパークラスを定義 XoopsUserHandler, XoopsGroupHandler など 11

12 データの永続化 XOOPS Cube Legacy 互換性のために古いORMは残すモデルとDB 内テーブルを1:1で結びつける際の典型的なSQL 処理を基底クラスとして実装することで派生クラスの実装を容易かつ安全に 12

13 データの永続化サンプルコード例えばユーザ管理管理番号 1 番のアカウントID(uname)と表示名 (name)を取得 $userhandler = xoops_gethandler( user ); $userid = 1; $userobj = $userhandler->get ($userid); $uname = $userobj->get( uname ); $name = $userobj->get( name ); ユーザの名前を変更 $userobj->set( name, 神経基盤太郎 ); $userhandler->insert ($userobj, true); user を操作するマッパーハンドラを取得通常 POSTの時しかDBに書き込めないが true だとGETの時にも強制的に書き込む userobj にDB 内のユーザテーブルの主キーとなる管理番号が指定されているため insert () は新規追加ではなくて更新処理となる 13

14 Action Frame Action Formを統一的にコントロールするMVCな仕組み例 : html/modules/user/index.php 1. システムの初期化 2. ActionFrame を生成 3. ActionFrame に実行したい処理名 (アクション)を設定 4. XOOPS Cube の MVC コントローラに登録 5. XOOPS Cube の MVC コントローラ実行 require_once "../../mainfile.php"; require_once XOOPS_ROOT_PATH. "/header.php"; require_once XOOPS_MODULE_PATH. "/user/class/actionframe.class.php"; $root =& XCube_Root::getSingleton(); $actionname = isset($_get['action'])? trim($_get['action']) : "UserList"; $modulerunner = new User_ActionFrame(false); $modulerunner->setactionname($actionname); $root->mcontroller->mexecute->add(array(&$modulerunner, 'execute')); $root->mcontroller->execute(); require_once XOOPS_ROOT_PATH. "/footer.php"; 14

15 Action Frame execute 動作概念 1. 操作対象となるオブジェクトを用意 2. 設定された処理名 (アクション)に対応するAction Formの準備 3. DB 内の既存のデータをオブジェクトへ読み込み 4. GETだったら入力フォームを表示 5. POSTだったら前のページから送信されたデータを取得 6. 取得したデータをチェック 7. エラーだったら入力フォームをエラー内容と一緒に表示 8. エラーでなければ取得した値をオブジェクトに反映 9. オブジェクトをDBに保存

16 Action Frame って XooNIps では旧版 : 3.4 系 Action Frameを使ってない html/modules/xoonips/ 以下の各ファイルでDB 読み込みフォームリクエスト値取得条件分岐表示等のプロシージャをそれぞれ実装新版 : 4.0 系一部の処理は Action Frame 化 xoops_trust_path/modules/xoonips/actions, xoops_trust_path/modules/xoonips/admin/actions 以下に ActonFormをそれぞれ実装その他処理実体をクラス化してあるもののやっていることは3.4 系と似たような動作 16

17 プリロード mainfile.php 内のシステム初期化プロセス途中 (common 処理実行時 )に呼び出される( 右リスト) 自動的にプリロードファイルが読み込まれ特定のタイミングで実行される読み込み直後 : prefilter データベース起動後 : preblockfilter 初期化の最終段階 :postfilter 大別して2 種類サイトプリロード:システム全体で利用可能 html/preload/ モジュールプリロード:モジュールが有効な時のみ html/modules/{module}/preload/ 1. サイトプリロードの読み込み 2. prefilter の実行 3. エラーハンドラの初期化 4. 全体の環境の初期化 5. ロガーの初期化 6. データベースへの接続 7. 言語の初期化 8. テキストフィルタの初期化 9. 一般設定の初期化 10. htmlヘッダ等のスクリプト初期化 11. デバッガの初期化 12. インターフェイスクラスの読み込み 13. モジュールプリロードの読み込み 14. preblockfilter の実行 15. セッションの初期化 16. ユーザの初期化 17. モジュールの初期化 18. postfilterの実行 17

18 プリロード例 : 特定の接続元のログインを遮断 html/preload/denyloginfromnijc.class.php <?php class DenyLoginFromNIJC extends XCube_ActionFilter { public function postfilter() { $userid = Legacy_Utils::getUid(); if ($userid!= UID_GUEST && $_SERVER["REMOTE_ADDR"] == " ") die("go away!"); } } 18

19 デリゲート特定の処理実行の一部を他のプログラムに委譲するための仕組み特定のイベントのフックと実行 $delegate = new XCube_Delegate(); $event = MyDelegate.Hook.Event ; $delegate->register($event); 1 イベントの登録 $callbackfunction = function() { // something to do.. }; $root = XCube_Root::getSingleton(); $root->mdelegatemanager->add($event, $callbackfunction, XCUBE_DELEGATE_PRIORITY_FIRST); 2 イベントへのコールバック関数の登録 ( 実行優先度最高 ) $delegate->call(); 3 イベントの実行 19

20 プリロードとデリゲート XCLで利用されている登録済みイベントは100 以上! 右表 :ほんの一例プリロード実行時 preblockfilter 等コールバック関数登録メイン処理実行時イベント登録 ( 遅延登録 ) イベント呼び出しモジュール間を渡る処理の連携疎な結合 Legacypage.Register.Access Legacypage.Search.Access Legacypage.Top.Access Legacypage.User.Access Legacypage.Userinfo.Access Legacypage.Viewpmsg.Access Site.CheckLogin Site.CheckLogin.Fail Site.CheckLogin.Success Site.JQuery.AddFunction Site.Logout Site.Logout.Fail Site.Logout.Success 20

21 デリゲート利用例 : 承認機能ユーザ登録 XooNIps Private 領域公開申請 Public / Group 領域承認モデレータグループ管理者 XCL 2.2 で進捗管理のためのデリゲートインターフェースが定義 Legacy_Workflow.AddItem : 新規に承認タスクを追加 Legacy_Workflow.DeleteItem : 登録されている承認タスクを削除 Legacy_Workflow.GetHistory : 承認履歴を取得 Legacy_WorkflowClient.GetClientList : 待ち受けたいワークフロー種類一覧を返す Legacy_WorkflowClient.UpdateStatus : 対象のワークフローの状態を更新 21

22 承認機能 :Xworkflowモジュール承認機能を実現するモジュール対象ワークフロー別に承認者を多段で設定可能 XooNIpsにおける対象ワークフローユーザ承認,アイテム公開,アイテム公開取り下げグループ作成,グループ削除,グループ公開グループ参加,グループ脱退,など承認者特定のユーザグループグループ管理者多段承認ステップ標準インターフェースの実装なためXooNIps 以外のワークフローでも管理可能 22

23 承認機能 : 申請から承認まで 2 公開インデックスに登録 (Pending 状態 ) 8 状態ステータスを公開に 4 3の内容をタスク一覧へ登録進捗管理開始 6 審査結果を履歴に追加全員の審査が完了したら7へ 3 デリゲート実行 /タスク登録 Legacy_Workflow.AddItem XooNIps Xworkflow 1 アイテムを公開インデックスへ登録公開申請 7 デリゲート実行 / 状態更新 Legacy_WorkflowClient.UpdateStatus 5 査読審査承認ユーザモデレータグループ管理者 23

24 まとめ XooNIpsサイトを拡張するためには XOOPS Cube Legacyの仕組みを知れば意外と拡張方法が豊富なことに気付くテンプレートで機能要素単位の見た目を変更デリゲート使えば簡単に特定の処理だけをフックできるプリロードはどこからでも呼ばれるので何でもできる実際にXooNIpsではユーザ管理機能を拡張するために標準のuser モジュールの管理画面の一部をこれで乗っ取っているオリジナルのソースコードを改変しなくても済む XooNIpsは発展途上全てが ActionFrame で綺麗に実装されているわけではないがアクションを新規追加するのは簡単 (かも) 新しくアクション用ファイルを追加して配置すればいい新バージョンは動作実績が少ないので人柱が欲しい 24

25 引用元参考文献など 1. XOOPS Cube Legacy デベロッパーズバイブル Marijuana( 宇津木おさむ) chatnoir( 内水はるか),2007,ソフトバンククリエイティブ 2. XOOPS Cube Legacy でつくる最強のCMSサイト鈴木宗人, 2008, ソーテック 3. XOOPS Cube 日本公式サイト 4. XOOPS WikiPedia 5. XOOPSのデータ永続化アーキテクチャの概要 6. XOOPSの起動処理順序 7. XOOPS Cubeのプリロードとデリゲートの解説 25

26 ありがとうございました 26

KINGSOFT Office 2016 動作環境対応日本語版版共通利用上記動作以上以上空容量以上他接続環境推奨必要 2

KINGSOFT Office 2016 動作環境対応日本語版版共通利用上記動作以上以上空容量以上他接続環境推奨必要 2 目次動作環境特長方法方法起動終了方法方法操作方法使方使方使方詳細設定使方 KINGSOFT Office 2016 動作環境対応日本語版版共通利用上記動作以上以上空容量以上他接続環境推奨必要 2 KINGSOFT Office 2016 特長主特長以