source: branches/version-2_12-dev/data/class/pages/admin/ownersstore/LC_Page_Admin_OwnersStore.php @ 21794

Revision 21794, 38.9 KB checked in by adachi, 9 years ago (diff)

#1782 plugin_infoフォーマット対応, フックポイントの自動登録対応

  • 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-2011 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// {{{ requires
25require_once CLASS_EX_REALDIR . 'page_extends/admin/LC_Page_Admin_Ex.php';
26
27/**
28 * オーナーズストア:プラグイン管理 のページクラス.
29 *
30 * @package Page
31 * @author LOCKON CO.,LTD.
32 * @version $Id$
33 */
34class LC_Page_Admin_OwnersStore extends LC_Page_Admin_Ex {
35
36    // }}}
37    // {{{ functions
38
39    /**
40     * Page を初期化する.
41     *
42     * @return void
43     */
44    function init() {
45        parent::init();
46        $this->tpl_mainpage = 'ownersstore/plugin.tpl';
47        $this->tpl_subno    = 'index';
48        $this->tpl_mainno   = 'ownersstore';
49        $this->tpl_maintitle = 'オーナーズストア';
50        $this->tpl_subtitle = 'プラグイン管理';
51    }
52
53    /**
54     * Page のプロセス.
55     *
56     * @return void
57     */
58    function process() {
59        $this->action();
60        $this->sendResponse();
61    }
62
63    /**
64     * Page のアクション.
65     *
66     * @return void
67     */
68    function action() {
69        // パラメーター管理クラス
70        $objFormParam = new SC_FormParam_Ex();
71        $mode = $this->getMode();
72        // パラメーター情報の初期化
73        $this->initParam($objFormParam, $mode);
74        $objFormParam->setParam($_POST);
75
76        $mode = $this->getMode();
77
78        switch ($mode) {
79            // インストール
80            case 'install':
81                $file_key = 'plugin_file';
82                $this->arrErr = $this->checkUploadFile($file_key);
83                if ($this->isError($this->arrErr) === false) {
84                    $upload_file = $_FILES[$file_key];
85                    $upload_file_file_name = $upload_file['name'];
86                    // インストール処理.
87                    $this->arrErr = $this->installPlugin($upload_file_file_name, 'plugin_file');
88                    if ($this->isError($this->arrErr) === false) {
89                        // コンパイルファイルのクリア処理
90                        SC_Utils_Ex::clearCompliedTemplate();
91                        $this->tpl_onload = "alert('プラグインをインストールしました。');";
92                    }
93                }
94                break;
95            // 削除
96            case 'uninstall':
97                // エラーチェック
98                $this->arrErr = $objFormParam->checkError();
99                if ($this->isError($this->arrErr) === false) {
100                    $plugin_id = $objFormParam->getValue('plugin_id');
101                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
102                    $this->arrErr = $this->uninstallPlugin($plugin);
103                    if ($this->isError($this->arrErr) === false) {
104                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
105                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
106                        // コンパイルファイルのクリア処理
107                        SC_Utils_Ex::clearCompliedTemplate();
108                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] ."を削除しました。');";
109                    }
110                }
111                break;
112            // 有効化
113            case 'enable':
114
115                // エラーチェック
116                $this->arrErr = $objFormParam->checkError();
117                if ($this->isError($this->arrErr) === false) {
118                    $plugin_id = $objFormParam->getValue('plugin_id');
119                    // プラグイン取得.
120                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
121                    $this->arrErr = $this->enablePlugin($plugin);
122                    if ($this->isError($this->arrErr) === false) {
123                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
124                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
125                        // コンパイルファイルのクリア処理
126                        SC_Utils_Ex::clearCompliedTemplate();
127                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] . "を有効にしました。');";
128                    }
129                }
130                break;
131            // 無効化
132            case 'disable':
133                // エラーチェック
134                $this->arrErr = $objFormParam->checkError();
135                if ($this->isError($this->arrErr) === false) {
136                    $plugin_id = $objFormParam->getValue('plugin_id');
137                    // プラグイン取得.
138                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
139                    $this->arrErr = $this->disablePlugin($plugin);
140                    if ($this->isError($this->arrErr) === false) {
141                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
142                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
143                        // コンパイルファイルのクリア処理
144                        SC_Utils_Ex::clearCompliedTemplate();
145                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] . "を無効にしました。');";
146                    }
147                }
148                break;
149            // アップデート.
150            case 'update':
151                // エラーチェック
152                $this->arrErr = $objFormParam->checkError();
153                if ($this->isError($this->arrErr) === false) {
154                    $target_plugin_code = $objFormParam->getValue('plugin_code'); // アップデート対象のプラグインコード
155                    $this->arrErr = $this->checkUploadFile($target_plugin_code);
156
157                    if ($this->isError($this->arrErr) === false) {
158                        $update_plugin_file = $_FILES[$target_plugin_code];
159                        $update_plugin_file_name = $update_plugin_file['name']; // アップデートファイルのファイル名.
160                        // インストール処理.
161                        $target_plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($target_plugin_code);
162                        $this->arrErr = $this->updatePlugin($target_plugin, $update_plugin_file_name, $target_plugin_code);
163                        if ($this->isError($this->arrErr) === false) {
164                            // コンパイルファイルのクリア処理
165                            SC_Utils_Ex::clearCompliedTemplate();
166                            $this->tpl_onload = "alert('プラグインをアップデートしました。');";
167                        }
168                    }
169                }
170                break;
171            // 優先度.
172            case 'priority':
173                // エラーチェック
174                $arrErr = $objFormParam->checkError();
175                $plugin_id = $objFormParam->getValue('plugin_id');
176                if ($this->isError($arrErr) === false) {
177                    // 優先度の更新
178                    $priority = $objFormParam->getValue('priority');
179                    $this->updatePriority($plugin_id, $priority);
180                    // コンパイルファイルのクリア処理
181                    SC_Utils_Ex::clearCompliedTemplate();
182                } else {
183                    // エラーメッセージを詰め直す.
184                    $this->arrErr['priority'][$plugin_id] = $arrErr['priority'];
185                }
186
187                break;
188            default:
189                break;
190        }
191        // DBからプラグイン情報を取得
192        $plugins = SC_Plugin_Util_Ex::getAllPlugin();
193
194        foreach ($plugins as $key => $plugin) {
195            // 設定ファイルがあるかを判定.
196            $plugins[$key]['config_flg'] = $this->isContainsFile(PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'], 'config.php');
197            if ($plugins[$key]['enable'] === PLUGIN_ENABLE_TRUE) {
198                // 競合するプラグインがあるかを判定.
199                $plugins[$key]['conflict_message']= $this->checkConflictPlugin($plugin['plugin_id']);
200            }
201        }
202        $this->plugins = $plugins;
203    }
204
205    /**
206     * デストラクタ.
207     *
208     * @return void
209     */
210    function destroy() {
211        parent::destroy();
212    }
213
214    /**
215     * パラメーター初期化.
216     *
217     * @param SC_FormParam_Ex $objFormParam
218     * @param string $mode モード
219     * @return void
220     */
221    function initParam(&$objFormParam, $mode) {
222        $objFormParam->addParam('mode', 'mode', INT_LEN, '', array('ALPHA_CHECK', 'MAX_LENGTH_CHECK'));
223        $objFormParam->addParam('plugin_id', 'plugin_id', INT_LEN, '', array('NUM_CHECK', 'MAX_LENGTH_CHECK'));
224        $objFormParam->addParam('plugin_code', 'plugin_code', MTEXT_LEN, '', array('ALNUM_CHECK', 'MAX_LENGTH_CHECK'));
225        if ($mode === 'priority') {
226            $objFormParam->addParam('優先度', 'priority', INT_LEN, '', array('EXIST_CHECK', 'NUM_CHECK', 'MAX_LENGTH_CHECK'));
227        }
228    }
229
230    /**
231     * ファイルパラメーター初期化.
232     *
233     * @param SC_UploadFile_Ex $objUpFile SC_UploadFileのインスタンス.
234     * @param string $key 登録するキー.
235     * @return void
236     */
237    function initUploadFile(&$objUpFile, $key) {
238        $objUpFile->addFile('プラグインファイル', $key, explode(',', PLUGIN_EXTENSION), FILE_SIZE, true, 0, 0, false);
239    }
240
241    /**
242     * ファイルが指定されている事をチェックします.
243     *
244     * @param string $file ファイル
245     * @param string $file_key ファイルキー
246     * @return array エラー情報を格納した連想配列.
247     */
248    function checkUploadFile($file_key) {
249        $objErr = new SC_CheckError_Ex();
250        // 拡張子チェック
251        $objErr->doFunc(array('プラグインファイル', $file_key, explode(',', PLUGIN_EXTENSION)), array('FILE_EXT_CHECK'));
252        // ファイルサイズチェック
253        $objErr->doFunc(array('プラグインファイル', $file_key, FILE_SIZE), array('FILE_SIZE_CHECK'));
254        // ファイル名チェック
255        $objErr->doFunc(array('プラグインファイル', $file_key), array('FILE_NAME_CHECK'));
256
257        return $objErr->arrErr;
258    }
259
260    /**
261     * 既にインストールされているプラグインかを判定します.
262     *
263     * @param string $plugin_code プラグインコード
264     * @return boolean インストール済の場合true インストールされていない場合false
265     */
266    function isInstalledPlugin($plugin_code) {
267        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($plugin_code);
268        if (!empty($plugin)) {
269            return true;
270        }
271        return false;
272    }
273
274    /**
275     * ファイル名からプラグインコードを取得する.
276     *
277     * ファイル名を「.」で配列に分解.
278     * 配列内から拡張子として格納される可能性のある「tar」「gz」を除外すし、再度結合する.
279     *
280     * @param string $file_name ファイル名
281     * @return string $plugin_code プラグインコード.
282     */
283    function getPluginCode($file_name) {
284        // 分解
285        $array_ext = explode('.', $file_name);
286        $array_file_name = array_diff($array_ext, array('tar','gz'));
287        // 結合
288        $plugin_code = implode('.', $array_file_name);
289        return $plugin_code;
290    }
291
292    /**
293     * プラグイン保存ディレクトリのパスを取得する.
294     *
295     * @param string $plugin_code プラグインコード
296     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
297     */
298    function getPluginDir($plugin_code) {
299        $plugin_dir_path = PLUGIN_UPLOAD_REALDIR . $plugin_code . '/';
300        return $plugin_dir_path;
301    }
302
303    /**
304     * プラグインHTMLディレクトリのパスを取得する.
305     *
306     * @param string $plugin_code プラグインコード
307     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
308     */
309    function getHtmlPluginDir($plugin_code) {
310        $plugin_dir_path = PLUGIN_HTML_REALDIR . $plugin_code . '/';
311        return $plugin_dir_path;
312    }
313
314    /**
315     * プラグインファイルのパスを取得する.
316     *
317     * @param string $plugin_code プラグインコード
318     * @return string $plugin_file_path クラスファイルのパス.
319     */
320    function getPluginFilePath($plugin_code) {
321        $plugin_file_path = $this->getPluginDir($plugin_code) . $plugin_code . '.php';
322        return $plugin_file_path;
323    }
324
325    /**
326     * プラグインをインストールします.
327     *
328     * @param string $plugin_code プラグインコード.
329     * @param string $key キー.
330     * @return array エラー情報を格納した連想配列.
331     */
332    function installPlugin($upload_file_file_name, $key) {
333
334        $arrErr = array();
335        // ファイルをチェックし一時展開用ディレクトリに展開します.
336        $arrErr = $this->unpackPluginFile($upload_file_file_name, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $key);
337        if ($this->isError($arrErr) === true) {
338            return $arrErr;
339        }
340        // plugin_infoを読み込み.
341        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR . 'plugin_info.php', $key);
342        if ($this->isError($arrErr) === true) {
343            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
344            return $arrErr;
345        }
346
347        // リフレクションオブジェクトを生成.
348        $objReflection = new ReflectionClass('plugin_info');
349        $arrPluginInfo = $this->getPluginInfo($objReflection);
350        // プラグインクラスに必須となるパラメータが正常に定義されているかチェックします.
351        $arrErr = $this->checkPluginConstants($objReflection, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
352        if ($this->isError($arrErr) === true) {
353            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
354            return $arrErr;
355        }
356
357        // プラグインコード
358        $plugin_code = $arrPluginInfo['PLUGIN_CODE'];
359        // プラグイン名
360        $plugin_name = $arrPluginInfo['PLUGIN_NAME'];
361
362        // 既にインストールされていないかを判定.
363        if ($this->isInstalledPlugin($plugin_code) === true) {
364            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
365            $arrErr['plugin_file'] = '※ ' . $plugin_name . 'は既にインストールされています。<br/>';
366            return $arrErr;
367        }
368
369        // プラグイン情報をDB登録
370        if ($this->registerData($arrPluginInfo) === false) {
371            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
372            $arrErr['plugin_file'] = '※ DB登録に失敗しました。<br/>';
373            return $arrErr;
374        }
375
376        // プラグイン保存ディレクトリを作成し、一時展開用ディレクトリから移動します.
377        $plugin_dir_path = PLUGIN_UPLOAD_REALDIR . $plugin_code . '/';
378        $this->makeDir($plugin_dir_path);
379        SC_Utils_Ex::copyDirectory(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin_dir_path);
380
381        // プラグイン情報を取得
382        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($plugin_code);
383
384        // クラスファイルを読み込み.
385        $plugin_class_file_path = $plugin_dir_path . $plugin['class_name'] . '.php';
386        $arrErr = $this->requirePluginFile($plugin_class_file_path, $key);
387        if ($this->isError($arrErr) === true) {
388            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id']);
389            return $arrErr;
390        }
391        // プラグインhtmlディレクトリ作成
392        $plugin_html_dir = PLUGIN_HTML_REALDIR . $plugin_code;
393        $this->makeDir($plugin_html_dir);
394
395        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'install');
396        if ($this->isError($arrErr) === true) {
397            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id'], $plugin_html_dir);
398            return $arrErr;
399        }
400
401        // 不要なファイルの削除
402        SC_Helper_FileManager_EX::deleteFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, false);
403        return $arrErr;
404    }
405
406    /**
407     * ロールバック処理
408     * インストール失敗時などに不要な一時ファイルを削除します.
409     *
410     * @param string $temp_dir インストール・アップデート時の一時展開用ディレクトリのパス.
411     * @param string $plugin_id プラグインID.
412     * @param string $plugin_html_dir プラグイン毎に生成されるhtmlディレクトリのパス.
413     */
414    function rollBack($temp_dir, $plugin_id = '', $plugin_html_dir ='') {
415        // 一時ディレクトリを削除.
416        SC_Helper_FileManager_Ex::deleteFile($temp_dir, false);
417        // DBからプラグイン情報を削除
418        if (empty($plugin_id) === false) {
419            SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
420        }
421        // htmlディレクトリを削除
422        if (empty($plugin_html_dir) === false) {
423            SC_Helper_FileManager_Ex::deleteFile($plugin_html_dir, true);
424        }
425    }
426
427    /**
428     * プラグイン情報を取得します.
429     *
430     * @param ReflectionClass $objReflection
431     * @return array プラグイン情報の配列
432     */
433    function getPluginInfo(ReflectionClass $objReflection) {
434        $arrStaticProps = $objReflection->getStaticProperties();
435        $arrConstants   = $objReflection->getConstants();
436
437        $arrPluginInfoKey = array(
438            'PLUGIN_CODE',
439            'PLUGIN_NAME',
440            'CLASS_NAME',
441            'PLUGIN_VERSION',
442            'COMPLIANT_VERSION',
443            'AUTHOR',
444            'DESCRIPTION',
445            'PLUGIN_SITE_URL',
446            'AUTHOR_SITE_URL',
447            'HOOK_POINTS',
448        );
449        $arrPluginInfo = array();
450        foreach ($arrPluginInfoKey as $key) {
451            // クラス変数での定義を優先
452            if (isset($arrStaticProps[$key])) {
453                $arrPluginInfo[$key] = $arrStaticProps[$key];
454            // クラス変数定義がなければ, クラス定数での定義を読み込み.
455            } elseif ($arrConstants[$key]) {
456                $arrPluginInfo[$key] = $arrConstants[$key];
457            } else {
458                $arrPluginInfo[$key] = null;
459            }
460        }
461        return $arrPluginInfo;
462    }
463   
464    /**
465     * プラグインクラス内の定数をチェックします.
466     *
467     * @param ReflectionClass $objReflection リフレクションオブジェクト
468     * @return array エラー情報を格納した連想配列.
469     */
470    function checkPluginConstants(ReflectionClass $objReflection, $unpack_dir) {
471        $arrErr = array();
472        // プラグイン情報を取得
473        $arrPluginInfo = $this->getPluginInfo($objReflection);
474
475        if (!isset($arrPluginInfo['PLUGIN_CODE'])) {
476            $arrErr['plugin_file'] = '※ PLUGIN_CODEが定義されていません。<br/>';
477            return $arrErr;
478        }
479        if (!isset($arrPluginInfo['PLUGIN_NAME'])) {
480            $arrErr['plugin_file'] = '※ PLUGIN_NAMEが定義されていません。<br/>';
481            return $arrErr;
482        }
483        if (!isset($arrPluginInfo['CLASS_NAME'])) {
484            $arrErr['plugin_file'] = '※ CLASS_NAMEが定義されていません。<br/>';
485            return $arrErr;
486        }
487        $class_path = $unpack_dir . $arrPluginInfo['CLASS_NAME'] . '.php';
488        if (file_exists($class_path) === false) {
489            $arrErr['plugin_file'] = '※ CLASS_NAMEが正しく定義されていません。<br/>';
490            return $arrErr;
491        }
492        if (!isset($arrPluginInfo['PLUGIN_VERSION'])) {
493            $arrErr['plugin_file'] = '※ PLUGIN_VERSIONが定義されていません。<br/>';
494            return $arrErr;
495        }
496        if (!isset($arrPluginInfo['COMPLIANT_VERSION'])) {
497            $arrErr['plugin_file'] = '※ COMPLIANT_VERSIONが定義されていません。<br/>';
498            return $arrErr;
499        }
500        if (!isset($arrPluginInfo['AUTHOR'])) {
501            $arrErr['plugin_file'] = '※ AUTHORが定義されていません。<br/>';
502            return $arrErr;
503        }
504        if (!isset($arrPluginInfo['DESCRIPTION'])) {
505            $arrErr['plugin_file'] = '※ DESCRIPTIONが定義されていません。<br/>';
506            return $arrErr;
507        }
508        $objErr = new SC_CheckError_Ex($arrPluginInfo);
509        $objErr->doFunc(array('PLUGIN_CODE', 'PLUGIN_CODE', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
510        $objErr->doFunc(array('PLUGIN_NAME', 'PLUGIN_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK'));
511        $objErr->doFunc(array('CLASS_NAME', 'CLASS_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
512        $objErr->doFunc(array('PLUGIN_VERSION', 'PLUGIN_VERSION', STEXT_LEN), array('MAX_LENGTH_CHECK'));
513        $objErr->doFunc(array('COMPLIANT_VERSION', 'COMPLIANT_VERSION', STEXT_LEN), array('MAX_LENGTH_CHECK'));
514        $objErr->doFunc(array('AUTHOR', 'AUTHOR', STEXT_LEN), array('MAX_LENGTH_CHECK'));
515        $objErr->doFunc(array('DESCRIPTION', 'DESCRIPTION', MTEXT_LEN), array('MAX_LENGTH_CHECK'));
516        if (isset($arrPluginInfo['PLUGIN_SITE_URL'])) {
517            $objErr->doFunc(array('PLUGIN_SITE_URL', 'PLUGIN_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
518        }
519        if (isset($arrPluginInfo['AUTHOR_SITE_URL'])) {
520            $objErr->doFunc(array('AUTHOR_SITE_URL', 'AUTHOR_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
521        }
522        // エラー内容を出力用の配列にセットします.
523        if ($this->isError($objErr->arrErr)) {
524            $arrErr['plugin_file'] = '';
525            foreach ($objErr->arrErr as $error) {
526                    $arrErr['plugin_file'] .= $error;
527            }
528        }
529        return $arrErr;
530    }
531
532    /**
533     * プラグインをアップデートします.
534     *
535     * @param string $target_plugin アップデートするプラグインコード.
536     * @param string $upload_file_name アップロードファイル名.
537     * @return array エラー情報を格納した連想配列.
538     */
539    function updatePlugin($target_plugin, $upload_file_name) {
540        $arrErr = array();
541
542        // ファイルをチェックし展開します.
543        $arrErr = $this->unpackPluginFile($upload_file_name, DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, $target_plugin['plugin_code']);
544        if ($this->isError($arrErr) === true) {
545            return $arrErr;
546        }
547        // plugin_update.phpを読み込み.
548        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR . 'plugin_update.php', $target_plugin['plugin_code']);
549        if ($this->isError($arrErr) === true) {
550            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR);
551            return $arrErr;
552        }
553        // プラグインクラスファイルのUPDATE処理を実行.
554        $arrErr = $this->execPlugin($target_plugin, 'plugin_update', 'update');
555
556        // 保存ディレクトリの削除.
557        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, false);
558
559        return $arrErr;
560    }
561
562    /**
563     * ファイルをアップロードし、解凍先のディレクトリに解凍します.
564     *
565     * @param string $unpack_file_name 解凍ファイル名
566     * @param string $unpack_dir 解凍先ディレクトリ
567     * @param string $file_key ファイルキー
568     * @return array エラー情報を格納した連想配列.
569     */
570    function unpackPluginFile($unpack_file_name, $unpack_dir, $file_key) {
571        $arrErr = array();
572        // 解凍ディレクトリディレクトリを作成し、一時ディレクトリからファイルを移動
573        $objUpFile = new SC_UploadFile_Ex(PLUGIN_TEMP_REALDIR, $unpack_dir);
574        $this->initUploadFile($objUpFile, $file_key);
575        $arrErr = $objUpFile->makeTempFile($file_key, false);
576        if ($this->isError($arrErr) === true) {
577            return $arrErr;
578        }
579
580        // 正常にアップロードされているかをチェック.
581        $arrErr = $objUpFile->checkEXISTS($file_key);
582        if ($this->isError($arrErr) === true) {
583            return $arrErr;
584        }
585        $objUpFile->moveTempFile();
586        // 解凍
587        $update_plugin_file_path = $unpack_dir . $unpack_file_name;
588        if (!SC_Helper_FileManager_Ex::unpackFile($update_plugin_file_path)) {
589            $arrErr['plugin_file'] = '※ 解凍に失敗しました。<br/>';
590            return $arrErr;
591        }
592        return $arrErr;
593    }
594
595    /**
596     * プラグインをアンインストールします.
597     *
598     * @param array $plugin プラグイン情報を確認した連想配列.
599     * @return array エラー情報を格納した連想配列.
600     */
601    function uninstallPlugin($plugin) {
602        $arrErr = array();
603        // プラグインファイルを読み込みます.
604        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
605        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
606        if ($this->isError($arrErr) === true) {
607            return $arrErr;
608        }
609
610        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'uninstall');
611        if ($this->isError($arrErr) === true) {
612            return $arrErr;
613        }
614        // プラグインの削除処理.
615        $arrErr = $this->deletePlugin($plugin['plugin_id'], $plugin['plugin_code']);
616
617        return $arrErr;
618    }
619
620    /**
621     * プラグインを有効にします.
622     *
623     * @param array $plugin プラグイン情報を確認した連想配列.
624     * @return array $arrErr エラー情報を格納した連想配列.
625     */
626    function enablePlugin($plugin) {
627        $arrErr = array();
628        // クラスファイルを読み込み.
629        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
630        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
631        if ($this->isError($arrErr) === true) {
632            return $arrErr;
633        }
634        // 有効化処理を実行します.
635        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'enable');
636        if ($this->isError($arrErr) === true) {
637            return $arrErr;
638        }
639        // プラグインを有効にします.
640        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_TRUE);
641
642        return $arrErr;
643    }
644
645    /**
646     * プラグインを無効にします.
647     *
648     * @param array $plugin プラグイン情報を確認した連想配列.
649     * @return array $arrErr エラー情報を格納した連想配列.
650     */
651    function disablePlugin($plugin) {
652        $arrErr = array();
653        // クラスファイルを読み込み.
654        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
655        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
656        if ($this->isError($arrErr) === true) {
657            return $arrErr;
658        }
659
660        // 無効化処理を実行します.
661        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'disable');
662        if ($this->isError($arrErr) === true) {
663            return $arrErr;
664        }
665        // プラグインを無効にします.
666        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_FALSE);
667
668        return $arrErr;
669    }
670
671    /**
672     * 優先度を更新します.
673     *
674     * @param int $plugin_id プラグインID
675     * @param int $priority 優先度
676     * @return integer 更新件数
677     */
678    function updatePriority($plugin_id, $priority) {
679        $objQuery =& SC_Query_Ex::getSingletonInstance();
680        // UPDATEする値を作成する。
681        $sqlval['priority'] = $priority;
682        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
683        $where = 'plugin_id = ?';
684        // UPDATEの実行
685        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
686        return $ret;
687    }
688
689    /**
690     * プラグイン情報をDB登録.
691     *
692     * @param array $arrPluginInfo プラグイン情報を格納した連想配列.
693     * @return array エラー情報を格納した連想配列.
694     */
695    function registerData($arrPluginInfo) {
696
697        // プラグイン情報をDB登録.
698        $objQuery =& SC_Query_Ex::getSingletonInstance();
699        $objQuery->begin();
700        $arr_sqlval_plugin = array();
701        $plugin_id = $objQuery->nextVal('dtb_plugin_plugin_id');
702        $arr_sqlval_plugin['plugin_id'] = $plugin_id;
703        $arr_sqlval_plugin['plugin_name'] = $arrPluginInfo['PLUGIN_NAME'];
704        $arr_sqlval_plugin['plugin_code'] = $arrPluginInfo['PLUGIN_CODE'];
705        $arr_sqlval_plugin['class_name'] = $arrPluginInfo['CLASS_NAME'];
706        $arr_sqlval_plugin['author'] = $arrPluginInfo['AUTHOR'];
707        // AUTHOR_SITE_URLが定義されているか判定.
708        $author_site_url = $arrPluginInfo['AUTHOR_SITE_URL'];
709        if ($author_site_url !== null) {
710            $arr_sqlval_plugin['author_site_url'] = $arrPluginInfo['AUTHOR'];
711        }
712        // PLUGIN_SITE_URLが定義されているか判定.
713        $plugin_site_url = $arrPluginInfo['PLUGIN_SITE_URL'];
714        if ($plugin_site_url !== null) {
715            $arr_sqlval_plugin['plugin_site_url'] = $plugin_site_url;
716        }
717        $arr_sqlval_plugin['plugin_version'] = $arrPluginInfo['PLUGIN_VERSION'];
718        $arr_sqlval_plugin['compliant_version'] = $arrPluginInfo['COMPLIANT_VERSION'];
719        $arr_sqlval_plugin['plugin_description'] = $arrPluginInfo['DESCRIPTION'];
720        $arr_sqlval_plugin['priority'] = 0;
721        $arr_sqlval_plugin['enable'] = PLUGIN_ENABLE_FALSE;
722        $arr_sqlval_plugin['update_date'] = 'CURRENT_TIMESTAMP';
723        $objQuery->insert('dtb_plugin', $arr_sqlval_plugin);
724
725        // フックポイントをDB登録.
726        $hook_point = $arrPluginInfo['HOOK_POINTS'];
727        if ($hook_point !== null) {
728            /**
729             * FIXME コードが重複しているため、要修正
730             */
731            // フックポイントが配列で定義されている場合
732            if (is_array($hook_point)) {
733                foreach ($hook_point as $h) {
734                    $arr_sqlval_plugin_hookpoint = array();
735                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
736                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
737                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
738                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h[0];
739                    $arr_sqlval_plugin_hookpoint['callback'] = $h[1];
740                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
741                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
742                }
743            // 文字列定義の場合
744            } else {
745                $array_hook_point = explode(',', $hook_point);
746                foreach ($array_hook_point as $h) {
747                    $arr_sqlval_plugin_hookpoint = array();
748                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
749                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
750                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
751                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h;
752                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
753                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
754                }
755            }
756        }
757        return $objQuery->commit();
758    }
759
760    /**
761     * ファイルを読み込む.
762     *
763     * @param string $file_path クラスのpath
764     * @param string $key エラー情報のキー.
765     * @return array $arrErr エラー情報を格納した連想配列.
766     */
767    function requirePluginFile($file_path, $key) {
768        $arrErr = array();
769        if (file_exists($file_path)) {
770            require_once $file_path;
771        } else {
772            $arrErr[$key] = '※ ' . $file_path .'の読み込みに失敗しました。<br/>';
773        }
774        return $arrErr;
775    }
776
777    /**
778     * インスタンスを生成し、指定のメソッドを実行する.
779     *
780     * @param object $obj インスタンス
781     * @param string $class_name クラス名
782     * @param string $exec_func 実行するメソッド名.
783     * @return array $arrErr エラー情報を格納した連想配列.
784     *
785     */
786    function execPlugin($obj, $class_name, $exec_func) {
787        $arrErr = array();
788        if (method_exists($class_name, $exec_func) === true) {
789            call_user_func(array($class_name, $exec_func), $obj);
790        } else {
791            $arrErr['plugin_error'] = '※ ' . $class_name . '.php に' . $exec_func . 'が見つかりません。<br/>';
792        }
793        return $arrErr;
794    }
795
796    /**
797     * plugin_idをキーにdtb_pluginのstatusを更新します.
798     *
799     * @param int $plugin_id プラグインID
800     * @param int $enable_flg 有効フラグ
801     * @return integer 更新件数
802     */
803    function updatePluginEnable($plugin_id, $enable_flg) {
804        $objQuery =& SC_Query_Ex::getSingletonInstance();
805        // UPDATEする値を作成する。
806        $sqlval['enable'] = $enable_flg;
807        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
808        $where = 'plugin_id = ?';
809        // UPDATEの実行
810        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
811        return $ret;
812    }
813
814    /**
815     * plugin_idをキーにdtb_plugin, dtb_plugin_hookpointから物理削除します.
816     *
817     * @param int $plugin_id プラグインID.
818     * @param string $plugin_code プラグインコード.
819     * @return array $arrErr エラー情報を格納した連想配列.
820     */
821    function deletePlugin($plugin_id, $plugin_code) {
822        $arrErr = array();
823        $objQuery =& SC_Query_Ex::getSingletonInstance();
824        $objQuery->begin();
825
826        SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
827
828        if (SC_Helper_FileManager_Ex::deleteFile($this->getPluginDir($plugin_code)) === false) {
829            // TODO エラー処理
830        }
831
832        if (SC_Helper_FileManager_Ex::deleteFile($this->getHtmlPluginDir($plugin_code)) === false) {
833            // TODO エラー処理
834        }
835
836        $objQuery->commit();
837
838        return $arrErr;
839    }
840
841    /**
842     * ファイルがあるかを判定します.
843     *
844     * @param string $plugin_dir 対象ディレクトリ.
845     * @param string $file_name ファイル名.
846     * @return boolean
847     */
848    function isContainsFile($plugin_dir, $file_name) {
849        if (file_exists($plugin_dir) && is_dir($plugin_dir)) {
850            if ($handle = opendir($plugin_dir)) {
851                while (($item = readdir($handle)) !== false) {
852                    if ($item === $file_name) return true;
853                }
854            }
855            closedir($handle);
856        }
857        return false;
858    }
859
860    /**
861     * アーカイブ内に指定のファイルが存在するかを判定します.
862     *
863     * @param Archive_Tar $tar_obj
864     * @param string $file_path 判定するファイルパス
865     * @return boolean
866     */
867    function checkContainsFile($tar_obj, $file_path) {
868        // ファイル一覧を取得
869        $arrayFile = $tar_obj->listContent();
870        foreach ($arrayFile as  $value) {
871            if ($value['filename'] === $file_path) return true;
872        }
873        return false;
874    }
875
876    /**
877     * ディレクトリを作成します.
878     *
879     * @param string $dir_path 作成するディレクトリのパス
880     * @return void
881     */
882    function makeDir($dir_path) {
883        // ディレクトリ作成
884        if (!file_exists($dir_path)) {
885            mkdir($dir_path);
886        }
887    }
888
889    /**
890     * フックポイントで衝突する可能性のあるプラグインを判定.メッセージを返します.
891     *
892     * @param int $plugin_id プラグインID
893     * @return string $conflict_alert_message メッセージ
894     */
895    function checkConflictPlugin($plugin_id) {
896        // フックポイントを取得します.
897        $hookPoints = $this->getHookPoint($plugin_id);
898
899        $conflict_alert_message = '';
900        $arrConflictPluginName = array();
901        $objQuery =& SC_Query_Ex::getSingletonInstance();
902        foreach ($hookPoints as $hookPoint) {
903            // 競合するプラグインを取得する,
904            $table = 'dtb_plugin_hookpoint AS T1 LEFT JOIN dtb_plugin AS T2 USING(plugin_id)';
905            $where = 'T1.hook_point = ? AND NOT T1.plugin_id = ? AND T2.enable = ' . PLUGIN_ENABLE_TRUE;
906            $objQuery->setGroupBy('T1.plugin_id, T2.plugin_name');
907            $conflictPlugins = $objQuery->select('T1.plugin_id, T2.plugin_name', $table, $where, array($hookPoint['hook_point'], $hookPoint['plugin_id']));
908
909            // プラグイン名重複を削除する為、専用の配列に格納し直す.
910            foreach ($conflictPlugins as $conflictPlugin) {
911                // プラグイン名が見つからなければ配列に格納
912                if (!in_array($conflictPlugin['plugin_name'], $arrConflictPluginName)) {
913                    $arrConflictPluginName[] = $conflictPlugin['plugin_name'];
914                }
915            }
916        }
917        // メッセージをセットします.
918        foreach ($arrConflictPluginName as $conflictPluginName) {
919            $conflict_alert_message .= '* ' .  $conflictPluginName . 'と競合する可能性があります。<br/>';
920        }
921        return $conflict_alert_message;
922    }
923
924    /**
925     * エラー情報が格納されているか判定します.
926     *
927     * @param array $arrErr エラー情報を格納した連想配列.
928     * @return boolean.
929     */
930    function isError($error) {
931        if (is_array($error) && count($error) > 0) {
932            return true;
933        }
934        return false;
935    }
936
937    /**
938     * プラグインIDからフックポイントを取得します,
939     *
940     * @param string $plugin_id プラグインID
941     * @return array フックポイントの連想配列.
942     */
943    function getHookPoint($plugin_id) {
944        $objQuery =& SC_Query_Ex::getSingletonInstance();
945
946        $table = 'dtb_plugin_hookpoint';
947        $where = 'plugin_id = ?';
948        return $objQuery->select('*', $table, $where, array($plugin_id));
949    }
950}
Note: See TracBrowser for help on using the repository browser.