CI框架源代碼閱讀筆記6 擴展鉤子 Hook.php
比如，在系統開啟hook的條件下（config.php中$config[‘enable_hooks‘] = TRUE;）。通過加入特定的鉤子，能夠讓系統在特定的時刻觸發特定的腳本：
$hook[‘post_system‘] = array( ‘class‘ => ‘frameLog‘, ‘function‘ => ‘postLog‘, ‘filename‘ => ‘post_system.php‘, ‘filepath‘ => ‘hooks‘, );
上述鉤子定義了一個post_system的鉤子。用於在終於的頁面渲染之後的腳本處理（參數的含義能夠參考後面或者手冊。這裏臨時不做很多其它解釋）。
那麽問題來了：
- 鉤子是什麽？
- CI中支持的鉤子有哪些？
- CI中鉤子是怎樣實現的？
我們一步步來看。
1. 鉤子是什麽
百度百科上對於鉤子的定義是：
鉤子實際上是一個處理消息的程序段，通過系統調用。把它掛入系統。每當特定的消息發出，在沒有到達目的窗體前，鉤子程序就先捕獲該消息，亦即鉤子函數先得到控制權。這時鉤子函數即能夠加工處理（改變）該消息。也能夠不作處理而繼續傳遞該消息。還能夠強制結束消息的傳遞。
從上述定義我們能夠看出幾點：
- 鉤子是一種事件驅動模式。它的核心自然是事件（CI中pre_system，pre_controller等都是特定的事件）。
- 既然是事件驅動，那麽必定要包括最重要的兩個步驟: (1)、事件註冊。對於Hook而言，就是指Hook鉤子的掛載。(2).事件觸發。
在特定的時間點call特定的鉤子，運行對應的鉤子程序。
- 既然是事件驅動。那麽也應該支持統一掛鉤點的多個註冊事件。
- 啟動Hook鉤子之後，程序的流程可能會發生變化，且鉤子之間可能有相互調用的可能性，假設處理不當，會有死循環的可能性。同一時候，鉤子的啟用使得程序在一定程度上變得復雜，難以調試。
2. CI中提前定義鉤子
CI中提供了7個可用的預設掛鉤點,各自是：
pre_system:
pre_controller：調用控制器之前的鉤子，路由與安全性檢查已經完成
post_controller_constructor：控制器實例化之後，不論什麽方法調用之前
post_controller：控制器全然執行之後
display_override：重寫display
cache_override :重寫緩存
post_system：終於的頁面發送到client之後
3. CI中鉤子的實現
CI中鉤子的核心功能是由Hook組件完畢的，先看該組件的類圖：
當中：
enabled: 鉤子功能是否開啟的標誌。
hooks :保存系統中啟用的鉤子列表
in_progress:之後我們會看到，這個標誌位用於防止鉤子之間的互相調用而導致的死循環。
_construct是Hook組件的構造函數，這當中調用了_initialize來完畢初始化的工作
_call_hook: 調用_run_hook來call指定的鉤子程序。
之前CodeIgniter.php中我們已經看到。_call_hook是實際提供給外部調用的接口。
_run_hook: 實際運行鉤子程序的函數
在開始之前，我們先貼出提前定義鉤子的結構。
這個結構可能會貫穿在源碼的始終，因而我們有必要知道該結構的參數含義。
$hook[‘xx‘] = array( ‘class‘ => ‘xx‘, //鉤子調用的類名。能夠為空 ‘function‘ => ‘xx‘,//鉤子調用的函數名 ‘filename‘ => ‘xx‘,//該鉤子的文件名稱 ‘filepath‘ => ‘xx‘,//鉤子的文件夾 ‘params‘ => ‘xx‘//傳遞給鉤子的參數 );
1）. 鉤子組件初始化
_initialize函數用於鉤子組件的初始化，該函數主要完畢的工作有：
(1) 檢查配置文件裏hook功能是否被啟用。這須要載入Config(配置管理組件)：
$CFG =& load_class(‘Config‘, ‘core‘);
if ($CFG->item(‘enable_hooks‘) == FALSE)
{
return;
}
(2) 載入定義的hook列表
相同，你能夠設定不同的ENVIRONMENT啟用不同的hook，假設有的話，優先載入ENVRIONMENT下的hook:
if (defined(‘ENVIRONMENT‘) AND is_file(APPPATH.‘config/‘.ENVIRONMENT.‘/hooks.php‘))
{
include(APPPATH.‘config/‘.ENVIRONMENT.‘/hooks.php‘);
}
elseif (is_file(APPPATH.‘config/hooks.php‘))
{
include(APPPATH.‘config/hooks.php‘);
}
(3) Hook的檢查。假設未設置不論什麽hook，或者設置的hook格式錯誤，則不作不論什麽處理，直接退出：
if ( ! isset($hook) OR ! is_array($hook))
{
return;
}經過initialize之後，Hook::hooks中存儲了已經定義的hook列表：
$this->hooks =& $hook;
2. Call指定的鉤子
_call_hook是主程序中直接調用的接口。該接口基本的工作有：
(1). 檢查鉤子是否被啟用，以及call的鉤子是否被提前定義（假設未啟用或者call的鉤子不存在。則直接返回）：
if ( ! $this->enabled OR ! isset($this->hooks[$which]))
{
return FALSE;
}
(2). 檢查同一個掛鉤點是否啟用了多個鉤子，假設有。則依次運行之：
if (isset($this->hooks[$which][0]) AND is_array($this->hooks[$which][0]))
{
foreach ($this->hooks[$which] as $val)
{
$this->_run_hook($val);
}
}
(3). 否則。僅僅有一個鉤子。運行它
else
{
$this->_run_hook($this->hooks[$which]);
}
_run_hook是實際運行hook的函數。
3. run運行特定的鉤子程序
_run_hook函數是hook的實際運行者。該函數接收一個提前定義的hook數組作為參數。實現例如以下：
(1). 假設傳遞的參數壓根就不是數組（自然也就不是有效的hook），那麽直接返回：
if ( ! is_array($data))
{
return FALSE;
}
(2). 檢查hook運行狀態。
in_progress用於標誌當前hook的運行狀態。這個參數的主要作用，是防止hook之間的相互調用而導致的死循環。
if ($this->in_progress == TRUE)
{
return;
}
(3). Hook的合法性檢查。
為了方便講述，我們再次提出一個提前定義的hook須要的參數：
$hook[‘xx‘] = array( ‘class‘ => ‘xx‘, //鉤子調用的類名，能夠為空 ‘function‘ => ‘xx‘,//鉤子調用的函數名 ‘filename‘ => ‘xx‘,//該鉤子的文件名稱 ‘filepath‘ => ‘xx‘,//鉤子的文件夾 ‘params‘ => ‘xx‘//傳遞給鉤子的參數 );
當中class和params是可選參數，其它3個參數為必選參數。假設不提供，則因為無法準確定位到hook程序，僅僅能直接返回：
if ( ! isset($data[‘filepath‘]) OR ! isset($data[‘filename‘]))
{
return FALSE;
}
$filepath = APPPATH.$data[‘filepath‘].‘/‘.$data[‘filename‘];
if ( ! file_exists($filepath))
{
return FALSE;
}
(4). 到這裏。已經基本確認鉤子程序的位置了，這裏有兩種情況：
a. 提前定義的hook中class參數為空。表明使用的是過程式的調用方式。則直接運行hook文件裏的function xxx
b. class參數不為空，提供的是面向對象的方式，則實際的鉤子程序是$class->$function .相同，假設既沒有設置class，也沒有設置function參數，則無法運行hook。直接返回：
$class = FALSE;
$function = FALSE;
$params = ‘‘;
/* 獲取 hook class */
if (isset($data[‘class‘]) AND $data[‘class‘] != ‘‘)
{
$class = $data[‘class‘];
}
/* 獲取 hook function */
if (isset($data[‘function‘]))
{
$function = $data[‘function‘];
}
/* 獲取傳遞的 hook 參數 */
if (isset($data[‘params‘]))
{
$params = $data[‘params‘];
}
/* 假設class和function都不存在，則無法定位hook程序，直接返回 */
if ($class === FALSE AND $function === FALSE)
{
return FALSE;
}
(5). 設置運行標誌in_progress。並運行上述兩種情況下的hook:
/* 面向對象的設置方式 */
if ($class !== FALSE)
{
if ( ! class_exists($class))
{
require($filepath);
}
$HOOK = new $class;
$HOOK->$function($params);
}
else
{
if ( ! function_exists($function))
{
require($filepath);
}
$function($params);
}
最後，別忘了在hook運行完之後，設置標識位in_progress為false，並返回運行成功的標誌：
$this->in_progress = FALSE; return TRUE;
Hook組件的完整源代碼：
<?php if ( ! defined(‘BASEPATH‘)) exit(‘No direct script access allowed‘); class CI_Hooks { /** * Determines wether hooks are enabled * * @var bool */ var $enabled = FALSE; /** * List of all hooks set in config/hooks.php * */ var $hooks = array(); /** * Determines wether hook is in progress, used to prevent infinte loops * */ var $in_progress = FALSE; /** * Constructor */ function __construct() { $this->_initialize(); log_message(‘debug‘, "Hooks Class Initialized"); } /** * Initialize the Hooks Preferences * * @access private * @return void */ function _initialize() { $CFG =& load_class(‘Config‘, ‘core‘); // If hooks are not enabled in the config file // there is nothing else to do if ($CFG->item(‘enable_hooks‘) == FALSE) { return; } if (defined(‘ENVIRONMENT‘) AND is_file(APPPATH.‘config/‘.ENVIRONMENT.‘/hooks.php‘)) { include(APPPATH.‘config/‘.ENVIRONMENT.‘/hooks.php‘); } elseif (is_file(APPPATH.‘config/hooks.php‘)) { include(APPPATH.‘config/hooks.php‘); } if ( ! isset($hook) OR ! is_array($hook)) { return; } $this->hooks =& $hook; $this->enabled = TRUE; } /** * Call Hook * * Calls a particular hook * * @access private * @param string the hook name * @return mixed */ function _call_hook($which = ‘‘) { if ( ! $this->enabled OR ! isset($this->hooks[$which])) { return FALSE; } if (isset($this->hooks[$which][0]) AND is_array($this->hooks[$which][0])) { foreach ($this->hooks[$which] as $val) { $this->_run_hook($val); } } else { $this->_run_hook($this->hooks[$which]); } return TRUE; } /** * Run Hook * * Runs a particular hook * * @access private * @param array the hook details * @return bool */ function _run_hook($data) { if ( ! is_array($data)) { return FALSE; } // If the script being called happens to have the same hook call within it a loop can happen if ($this->in_progress == TRUE) { return; } if ( ! isset($data[‘filepath‘]) OR ! isset($data[‘filename‘])) { return FALSE; } $filepath = APPPATH.$data[‘filepath‘].‘/‘.$data[‘filename‘]; if ( ! file_exists($filepath)) { return FALSE; } $class = FALSE; $function = FALSE; $params = ‘‘; if (isset($data[‘class‘]) AND $data[‘class‘] != ‘‘) { $class = $data[‘class‘]; } if (isset($data[‘function‘])) { $function = $data[‘function‘]; } if (isset($data[‘params‘])) { $params = $data[‘params‘]; } if ($class === FALSE AND $function === FALSE) { return FALSE; } $this->in_progress = TRUE; // Call the requested class and/or function if ($class !== FALSE) { if ( ! class_exists($class)) { require($filepath); } $HOOK = new $class; $HOOK->$function($params); } else { if ( ! function_exists($function)) { require($filepath); } $function($params); } $this->in_progress = FALSE; return TRUE; } }
參考文獻
1. http://codeigniter.org.cn/user_guide/general/hooks.html 手冊
2. http://itopic.org/codeigniter-hook.html
3. http://codeigniter.org.cn/forums/thread-4947-1-1.html 鉤子實現的Layout
CI框架源代碼閱讀筆記6 擴展鉤子 Hook.php