source: branches/version-2_13-dev/data/class/helper/SC_Helper_Plugin.php @ 22810

Revision 22810, 12.2 KB checked in by Seasoft, 7 years ago (diff)

#2241 (プラグイン機構の自殺を阻止)

  • r22808 を差し戻し。正しく動作させるには、改訂がコアに及ぶため。
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2013 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * プラグインのヘルパークラス.
26 *
27 * @package Helper
28 * @version $Id$
29 */
30class SC_Helper_Plugin
31{
32    // プラグインのインスタンスの配列.
33    var $arrPluginInstances = array();
34    // プラグインのアクションの配列.
35    var $arrRegistedPluginActions = array();
36    // プラグインのIDの配列.
37    var $arrPluginIds = array();
38    // HeadNaviブロックの配列
39    var $arrHeadNaviBlocsByPlugin = array();
40
41    /**
42     * 有効なプラグインのロード. プラグインエンジンが有効になっていない場合は
43     * プラグインエンジン自身のインストール処理を起動する
44     *
45     * @return void
46     */
47    function load($plugin_activate_flg = true)
48    {
49
50        if (!defined('CONFIG_REALFILE') || !file_exists(CONFIG_REALFILE)) return; // インストール前
51        if (GC_Utils_Ex::isInstallFunction()) return; // インストール中
52        if ($plugin_activate_flg === false) return;
53        // 有効なプラグインを取得
54        $arrPluginDataList = SC_Plugin_Util_Ex::getEnablePlugin();
55        // pluginディレクトリを取得
56        $arrPluginDirectory = SC_Plugin_Util_Ex::getPluginDirectory();
57        foreach ($arrPluginDataList as $arrPluginData) {
58            // プラグイン本体ファイル名が取得したプラグインディレクトリ一覧にある事を確認
59            if (array_search($arrPluginData['plugin_code'], $arrPluginDirectory) !== false) {
60                $plugin_file_path = PLUGIN_UPLOAD_REALDIR . $arrPluginData['plugin_code'] . '/' . $arrPluginData['class_name'] . '.php';
61                // プラグイン本体ファイルが存在しない場合
62                if (!file_exists($plugin_file_path)) {
63                    // エラー出力
64                    $msg = 'プラグイン本体ファイルが存在しない。当該プラグインを無視して続行する。';
65                    $msg .= 'ファイル=' . var_export($plugin_file_path, true) . '; ';
66                    trigger_error($msg, E_USER_WARNING);
67                    // 次のプラグインへ続行
68                    continue 1;
69                }
70                // プラグイン本体ファイルをrequire.
71                require_once $plugin_file_path;
72
73                // プラグインのインスタンス生成.
74                $objPlugin = new $arrPluginData['class_name']($arrPluginData);
75                // メンバ変数にプラグインのインスタンスを登録.
76                $this->arrPluginInstances[$arrPluginData['plugin_id']] = $objPlugin;
77                $this->arrPluginIds[] = $arrPluginData['plugin_id'];
78                // ローカルフックポイントの登録.
79                $this->registerLocalHookPoint($objPlugin, $arrPluginData['priority']);
80                // スーパーフックポイントの登録.
81                $this->registerSuperHookPoint($objPlugin, HOOK_POINT_PREPROCESS, 'preProcess', $arrPluginData['priority']);
82                $this->registerSuperHookPoint($objPlugin, HOOK_POINT_PROCESS, 'process', $arrPluginData['priority']);
83            }
84        }
85    }
86
87    /**
88     * SC_Helper_Plugin オブジェクトを返す(Singletonパターン)
89     *
90     * @return object SC_Helper_Pluginオブジェクト
91     */
92    static function getSingletonInstance($plugin_activate_flg = true)
93    {
94        if (!isset($GLOBALS['_SC_Helper_Plugin_instance'])) {
95            // プラグインのローダーがDB接続を必要とするため、
96            // SC_Queryインスタンス生成後のみオブジェクトを生成する。
97            require_once CLASS_EX_REALDIR . 'SC_Query_Ex.php';
98            if (is_null(SC_Query_Ex::getPoolInstance())) {
99                return false;
100            }
101
102            $GLOBALS['_SC_Helper_Plugin_instance'] = new SC_Helper_Plugin_Ex();
103            $GLOBALS['_SC_Helper_Plugin_instance']->load($plugin_activate_flg);
104        }
105        return $GLOBALS['_SC_Helper_Plugin_instance'];
106    }
107
108    /**
109     * プラグイン実行
110     *
111     * @param string $hook_point フックポイント
112     * @param array  $arrArgs    コールバック関数へ渡す引数
113     * @return void
114     */
115    function doAction($hook_point, $arrArgs = array())
116    {
117        if (is_array($arrArgs) === false) {
118            array(&$arrArgs);
119        }
120
121        if ($hook_point == 'loadClassFileChange') {
122            $arrSaveArgs = $arrArgs;
123            $arrClassName = array();
124            $arrClassPath = array();
125        }
126
127        if (array_key_exists($hook_point, $this->arrRegistedPluginActions)
128            && is_array($this->arrRegistedPluginActions[$hook_point])) {
129
130            krsort($this->arrRegistedPluginActions[$hook_point]);
131            foreach ($this->arrRegistedPluginActions[$hook_point] as $arrFuncs) {
132
133                foreach ($arrFuncs as $func) {
134                    if (!is_null($func['function'])) {
135                        if ($hook_point == 'loadClassFileChange') {
136                            $classname = $arrSaveArgs[0];
137                            $classpath = $arrSaveArgs[1];
138                            $arrTempArgs = array(&$classname, &$classpath);
139
140                            call_user_func_array($func['function'], $arrTempArgs);
141
142                            if ($classname !== $arrSaveArgs[0]) {
143                                $arrClassName[] = $classname;
144                                $arrClassPath[] = $classpath;
145                            }
146                        } else {
147                            call_user_func_array($func['function'], $arrArgs);
148                        }
149                    }
150                }
151            }
152
153            if ($hook_point == 'loadClassFileChange') {
154                if (count($arrClassName) > 0) {
155                    $arrArgs[0] = $arrClassName;
156                    $arrArgs[1] = $arrClassPath;
157                }
158            }
159        }
160    }
161
162    /**
163     * スーパーフックポイントを登録します.
164     *
165     * @param Object $objPlugin プラグインのインスタンス
166     * @param string $hook_point スーパーフックポイント
167     * @param string $function_name 実行する関数名
168     * @param string $priority 実行順
169     */
170    function registerSuperHookPoint($objPlugin, $hook_point, $function_name, $priority)
171    {
172        // スーパープラグイン関数を定義しているかを検証.
173        if (method_exists($objPlugin, $function_name) === true) {
174            // アクションの登録
175            $this->addAction($hook_point, array($objPlugin, $function_name), $priority);
176        }
177    }
178
179    /**
180     * ローカルフックポイントを登録します.
181     *
182     * @param Object $objPlugin プラグインのインスタンス
183     * @param string $priority 実行順
184     */
185    function registerLocalHookPoint($objPlugin, $priority)
186    {
187        // ローカルプラグイン関数を定義しているかを検証.
188        if (method_exists($objPlugin, 'register') === true) {
189            // アクションの登録(プラグイン側に記述)
190            $objPluginHelper =& SC_Helper_Plugin::getSingletonInstance();
191            $objPlugin->register($objPluginHelper, $priority);
192        }
193    }
194
195    /**
196     * プラグイン コールバック関数を追加する
197     *
198     * @param string   $hook_point フックポイント名
199     * @param callback $function   コールバック関数名
200     * @param string   $priority   同一フックポイント内での実行優先度
201     * @return boolean 成功すればtrue
202     */
203    function addAction($hook_point, $function, $priority = 0)
204    {
205        if (!is_callable($function)) {
206            // TODO エラー処理; コール可能な形式ではありません
207        }
208        $idx = $this->makeActionUniqueId($hook_point, $function, $priority);
209        $this->arrRegistedPluginActions[$hook_point][$priority][$idx] = array('function' => $function);
210        return true;
211    }
212
213    /**
214     * コールバック関数を一意に識別するIDの生成
215     *
216     * @param string   $hook_point フックポイント名
217     * @param callback $function   コールバック関数名
218     * @param integer  $priority   同一フックポイント内での実行優先度
219     * @return string コールバック関数を一意に識別するID
220     */
221    function makeActionUniqueId($hook_point, $function, $priority)
222    {
223        static $filter_id_count = 0;
224
225        if (is_string($function)) {
226            return $function;
227        }
228
229        if (is_object($function)) {
230            $function = array($function, '');
231        } else {
232            $function = (array) $function;
233        }
234
235        if (is_object($function[0])) {
236            if (function_exists('spl_object_hash')) {
237                return spl_object_hash($function[0]) . $function[1];
238            } else {
239                $obj_idx = get_class($function[0]).$function[1];
240                if ( false === $priority)
241                    return false;
242                $obj_idx .= isset($this->arrRegistedPluginActions[$hook_point][$priority])
243                         ? count((array)$this->arrRegistedPluginActions[$hook_point][$priority])
244                         : $filter_id_count;
245                $function[0]->wp_filter_id = $filter_id_count;
246                ++$filter_id_count;
247
248                return $obj_idx;
249            }
250        } else if (is_string($function[0])) {
251            return $function[0].$function[1];
252        }
253    }
254
255    /**
256     * ブロックの配列から有効でないpluginのブロックを除外して返します.
257     *
258     * @param array $arrBlocs プラグインのインストールディレクトリ
259     * @return array $arrBlocsサイトルートからメディアディレクトリへの相対パス
260     */
261    function getEnableBlocs($arrBlocs)
262    {
263        foreach ($arrBlocs as $key => $value) {
264            // 有効なpluginのブロック以外.
265            if (!in_array($value['plugin_id'] , $this->arrPluginIds)) {
266                // 通常ブロック以外.
267                if ($value['plugin_id'] != '') {
268                    // ブロック配列から削除する
269                    unset ($arrBlocs[$key]);
270                }
271            }
272        }
273        return $arrBlocs;
274    }
275
276   /**
277     * テンプレートのヘッダに追加するPHPのURLをセットする
278     *
279     * @param string $url PHPファイルのURL
280     * @return void
281     */
282    function setHeadNavi($url)
283    {
284        $this->arrHeadNaviBlocsByPlugin[$url] = TARGET_ID_HEAD;
285    }
286
287    /**
288     * PHPのURLをテンプレートのヘッダに追加する
289     *
290     * @param array|null $arrBlocs  配置情報を含めたブロックの配列
291     * @return void
292     */
293    function setHeadNaviBlocs(&$arrBlocs)
294    {
295        foreach ($this->arrHeadNaviBlocsByPlugin as $key => $value) {
296            $arrBlocs[] = array(
297                'target_id' =>$value,
298                'php_path' => $key
299            );
300        }
301    }
302
303    /**
304     * Utility function to set a hook point.
305     *
306     * @param string    $hook_point  hook point
307     * @param array     $arrArgs     argument passing to callback function
308     * @param boolean   $plugin_activate_flg
309     * @return void
310     */
311    public static function hook($hook_point, $arrArgs = array(), $plugin_activate_flg = PLUGIN_ACTIVATE_FLAG)
312    {
313        $objPlugin = SC_Helper_Plugin::getSingletonInstance($plugin_activate_flg);
314        $objPlugin->doAction($hook_point, $arrArgs);
315    }
316}
Note: See TracBrowser for help on using the repository browser.