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

Revision 21860, 41.8 KB checked in by h_yoshimoto, 10 years ago (diff)

#1827 プラグイン用のunpackFile関数を作成する

  • 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            // ロゴファイルへのパスを生成(ロゴが無い場合はNO_IMAGEを表示)
196            if(file_exists(PLUGIN_HTML_REALDIR . $plugins[$key]['plugin_code'] . "/logo.png") === true){
197                $plugins[$key]['logo'] = ROOT_URLPATH . "plugin/" . $plugins[$key]['plugin_code'] . "/logo.png";
198            } else {
199                $plugins[$key]['logo'] = IMAGE_SAVE_URLPATH . "noimage_plugin_list.gif";
200            }
201           
202            // 設定ファイルがあるかを判定.
203            $plugins[$key]['config_flg'] = $this->isContainsFile(PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'], 'config.php');
204            if ($plugins[$key]['enable'] === PLUGIN_ENABLE_TRUE) {
205                // 競合するプラグインがあるかを判定.
206                $plugins[$key]['conflict_message']= $this->checkConflictPlugin($plugin['plugin_id']);
207            }
208        }
209        $this->plugins = $plugins;
210    }
211
212    /**
213     * デストラクタ.
214     *
215     * @return void
216     */
217    function destroy() {
218        parent::destroy();
219    }
220
221    /**
222     * パラメーター初期化.
223     *
224     * @param SC_FormParam_Ex $objFormParam
225     * @param string $mode モード
226     * @return void
227     */
228    function initParam(&$objFormParam, $mode) {
229        $objFormParam->addParam('mode', 'mode', INT_LEN, '', array('ALPHA_CHECK', 'MAX_LENGTH_CHECK'));
230        $objFormParam->addParam('plugin_id', 'plugin_id', INT_LEN, '', array('NUM_CHECK', 'MAX_LENGTH_CHECK'));
231        $objFormParam->addParam('plugin_code', 'plugin_code', MTEXT_LEN, '', array('ALNUM_CHECK', 'MAX_LENGTH_CHECK'));
232        if ($mode === 'priority') {
233            $objFormParam->addParam('優先度', 'priority', INT_LEN, '', array('EXIST_CHECK', 'NUM_CHECK', 'MAX_LENGTH_CHECK'));
234        }
235    }
236
237    /**
238     * ファイルパラメーター初期化.
239     *
240     * @param SC_UploadFile_Ex $objUpFile SC_UploadFileのインスタンス.
241     * @param string $key 登録するキー.
242     * @return void
243     */
244    function initUploadFile(&$objUpFile, $key) {
245        $objUpFile->addFile('プラグインファイル', $key, explode(',', PLUGIN_EXTENSION), FILE_SIZE, true, 0, 0, false);
246    }
247
248    /**
249     * ファイルが指定されている事をチェックします.
250     *
251     * @param string $file ファイル
252     * @param string $file_key ファイルキー
253     * @return array エラー情報を格納した連想配列.
254     */
255    function checkUploadFile($file_key) {
256        $objErr = new SC_CheckError_Ex();
257        // 拡張子チェック
258        $objErr->doFunc(array('プラグインファイル', $file_key, explode(',', PLUGIN_EXTENSION)), array('FILE_EXT_CHECK'));
259        // ファイルサイズチェック
260        $objErr->doFunc(array('プラグインファイル', $file_key, FILE_SIZE), array('FILE_SIZE_CHECK'));
261        // ファイル名チェック
262        $objErr->doFunc(array('プラグインファイル', $file_key), array('FILE_NAME_CHECK'));
263
264        return $objErr->arrErr;
265    }
266
267    /**
268     * 既にインストールされているプラグインかを判定します.
269     *
270     * @param string $plugin_code プラグインコード
271     * @return boolean インストール済の場合true インストールされていない場合false
272     */
273    function isInstalledPlugin($plugin_code) {
274        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($plugin_code);
275        if (!empty($plugin)) {
276            return true;
277        }
278        return false;
279    }
280
281    /**
282     * ファイル名からプラグインコードを取得する.
283     *
284     * ファイル名を「.」で配列に分解.
285     * 配列内から拡張子として格納される可能性のある「tar」「gz」を除外すし、再度結合する.
286     *
287     * @param string $file_name ファイル名
288     * @return string $plugin_code プラグインコード.
289     */
290    function getPluginCode($file_name) {
291        // 分解
292        $array_ext = explode('.', $file_name);
293        $array_file_name = array_diff($array_ext, array('tar','gz'));
294        // 結合
295        $plugin_code = implode('.', $array_file_name);
296        return $plugin_code;
297    }
298
299    /**
300     * プラグイン保存ディレクトリのパスを取得する.
301     *
302     * @param string $plugin_code プラグインコード
303     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
304     */
305    function getPluginDir($plugin_code) {
306        $plugin_dir_path = PLUGIN_UPLOAD_REALDIR . $plugin_code . '/';
307        return $plugin_dir_path;
308    }
309
310    /**
311     * プラグインHTMLディレクトリのパスを取得する.
312     *
313     * @param string $plugin_code プラグインコード
314     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
315     */
316    function getHtmlPluginDir($plugin_code) {
317        $plugin_dir_path = PLUGIN_HTML_REALDIR . $plugin_code . '/';
318        return $plugin_dir_path;
319    }
320
321    /**
322     * プラグインファイルのパスを取得する.
323     *
324     * @param string $plugin_code プラグインコード
325     * @return string $plugin_file_path クラスファイルのパス.
326     */
327    function getPluginFilePath($plugin_code) {
328        $plugin_file_path = $this->getPluginDir($plugin_code) . $plugin_code . '.php';
329        return $plugin_file_path;
330    }
331
332    /**
333     * プラグインをインストールします.
334     *
335     * @param string $plugin_code プラグインコード.
336     * @param string $key キー.
337     * @return array エラー情報を格納した連想配列.
338     */
339    function installPlugin($upload_file_file_name, $key) {
340        // インストール前に不要なファイルを消しておきます.
341        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, false);
342       
343        $arrErr = array();
344        // ファイルをチェックし一時展開用ディレクトリに展開します.
345        $arrErr = $this->unpackPluginFile($upload_file_file_name, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $key);
346        if ($this->isError($arrErr) === true) {
347            return $arrErr;
348        }
349        // plugin_infoを読み込み.
350        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR . 'plugin_info.php', $key);
351        if ($this->isError($arrErr) === true) {
352            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
353            return $arrErr;
354        }
355
356        // リフレクションオブジェクトを生成.
357        $objReflection = new ReflectionClass('plugin_info');
358        $arrPluginInfo = $this->getPluginInfo($objReflection);
359        // プラグインクラスに必須となるパラメータが正常に定義されているかチェックします.
360        $arrErr = $this->checkPluginConstants($objReflection, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
361        if ($this->isError($arrErr) === true) {
362            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
363            return $arrErr;
364        }
365
366        // プラグインコード
367        $plugin_code = $arrPluginInfo['PLUGIN_CODE'];
368        // プラグイン名
369        $plugin_name = $arrPluginInfo['PLUGIN_NAME'];
370
371        // 既にインストールされていないかを判定.
372        if ($this->isInstalledPlugin($plugin_code) === true) {
373            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
374            $arrErr['plugin_file'] = '※ ' . $plugin_name . 'は既にインストールされています。<br/>';
375            return $arrErr;
376        }
377
378        // プラグイン情報をDB登録
379        if ($this->registerData($arrPluginInfo) === false) {
380            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
381            $arrErr['plugin_file'] = '※ DB登録に失敗しました。<br/>';
382            return $arrErr;
383        }
384
385        // プラグイン保存ディレクトリを作成し、一時展開用ディレクトリから移動します.
386        $plugin_dir_path = PLUGIN_UPLOAD_REALDIR . $plugin_code . '/';
387        $this->makeDir($plugin_dir_path);
388        SC_Utils_Ex::copyDirectory(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin_dir_path);
389
390        // プラグイン情報を取得
391        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($plugin_code);
392
393        // クラスファイルを読み込み.
394        $plugin_class_file_path = $plugin_dir_path . $plugin['class_name'] . '.php';
395        $arrErr = $this->requirePluginFile($plugin_class_file_path, $key);
396        if ($this->isError($arrErr) === true) {
397            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id']);
398            return $arrErr;
399        }
400        // プラグインhtmlディレクトリ作成
401        $plugin_html_dir = PLUGIN_HTML_REALDIR . $plugin_code;
402        $this->makeDir($plugin_html_dir);
403
404        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'install');
405        if ($this->isError($arrErr) === true) {
406            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id'], $plugin_html_dir);
407            return $arrErr;
408        }
409
410        // 不要なファイルの削除
411        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, false);
412        return $arrErr;
413    }
414
415    /**
416     * ロールバック処理
417     * インストール失敗時などに不要な一時ファイルを削除します.
418     *
419     * @param string $temp_dir インストール・アップデート時の一時展開用ディレクトリのパス.
420     * @param string $plugin_id プラグインID.
421     * @param string $plugin_html_dir プラグイン毎に生成されるhtmlディレクトリのパス.
422     */
423    function rollBack($temp_dir, $plugin_id = '', $plugin_html_dir ='') {
424        // 一時ディレクトリを削除.
425        SC_Helper_FileManager_Ex::deleteFile($temp_dir, false);
426        // DBからプラグイン情報を削除
427        if (empty($plugin_id) === false) {
428            SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
429        }
430        // htmlディレクトリを削除
431        if (empty($plugin_html_dir) === false) {
432            SC_Helper_FileManager_Ex::deleteFile($plugin_html_dir, true);
433        }
434    }
435
436    /**
437     * プラグイン情報を取得します.
438     *
439     * @param ReflectionClass $objReflection
440     * @return array プラグイン情報の配列
441     */
442    function getPluginInfo(ReflectionClass $objReflection) {
443        $arrStaticProps = $objReflection->getStaticProperties();
444        $arrConstants   = $objReflection->getConstants();
445
446        $arrPluginInfoKey = array(
447            'PLUGIN_CODE',
448            'PLUGIN_NAME',
449            'CLASS_NAME',
450            'PLUGIN_VERSION',
451            'COMPLIANT_VERSION',
452            'AUTHOR',
453            'DESCRIPTION',
454            'PLUGIN_SITE_URL',
455            'AUTHOR_SITE_URL',
456            'HOOK_POINTS',
457        );
458        $arrPluginInfo = array();
459        foreach ($arrPluginInfoKey as $key) {
460            // クラス変数での定義を優先
461            if (isset($arrStaticProps[$key])) {
462                $arrPluginInfo[$key] = $arrStaticProps[$key];
463            // クラス変数定義がなければ, クラス定数での定義を読み込み.
464            } elseif ($arrConstants[$key]) {
465                $arrPluginInfo[$key] = $arrConstants[$key];
466            } else {
467                $arrPluginInfo[$key] = null;
468            }
469        }
470        return $arrPluginInfo;
471    }
472
473    /**
474     * プラグインクラス内の定数をチェックします.
475     *
476     * @param ReflectionClass $objReflection リフレクションオブジェクト
477     * @return array エラー情報を格納した連想配列.
478     */
479    function checkPluginConstants(ReflectionClass $objReflection, $unpack_dir) {
480        $arrErr = array();
481        // プラグイン情報を取得
482        $arrPluginInfo = $this->getPluginInfo($objReflection);
483
484        if (!isset($arrPluginInfo['PLUGIN_CODE'])) {
485            $arrErr['plugin_file'] = '※ PLUGIN_CODEが定義されていません。<br/>';
486            return $arrErr;
487        }
488        if (!isset($arrPluginInfo['PLUGIN_NAME'])) {
489            $arrErr['plugin_file'] = '※ PLUGIN_NAMEが定義されていません。<br/>';
490            return $arrErr;
491        }
492        if (!isset($arrPluginInfo['CLASS_NAME'])) {
493            $arrErr['plugin_file'] = '※ CLASS_NAMEが定義されていません。<br/>';
494            return $arrErr;
495        }
496        $class_path = $unpack_dir . $arrPluginInfo['CLASS_NAME'] . '.php';
497        if (file_exists($class_path) === false) {
498            $arrErr['plugin_file'] = '※ CLASS_NAMEが正しく定義されていません。<br/>';
499            return $arrErr;
500        }
501        if (!isset($arrPluginInfo['PLUGIN_VERSION'])) {
502            $arrErr['plugin_file'] = '※ PLUGIN_VERSIONが定義されていません。<br/>';
503            return $arrErr;
504        }
505        if (!isset($arrPluginInfo['COMPLIANT_VERSION'])) {
506            $arrErr['plugin_file'] = '※ COMPLIANT_VERSIONが定義されていません。<br/>';
507            return $arrErr;
508        }
509        if (!isset($arrPluginInfo['AUTHOR'])) {
510            $arrErr['plugin_file'] = '※ AUTHORが定義されていません。<br/>';
511            return $arrErr;
512        }
513        if (!isset($arrPluginInfo['DESCRIPTION'])) {
514            $arrErr['plugin_file'] = '※ DESCRIPTIONが定義されていません。<br/>';
515            return $arrErr;
516        }
517        $objErr = new SC_CheckError_Ex($arrPluginInfo);
518        $objErr->doFunc(array('PLUGIN_CODE', 'PLUGIN_CODE', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
519        $objErr->doFunc(array('PLUGIN_NAME', 'PLUGIN_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK'));
520        $objErr->doFunc(array('CLASS_NAME', 'CLASS_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
521        $objErr->doFunc(array('PLUGIN_VERSION', 'PLUGIN_VERSION', STEXT_LEN), array('MAX_LENGTH_CHECK'));
522        $objErr->doFunc(array('COMPLIANT_VERSION', 'COMPLIANT_VERSION', STEXT_LEN), array('MAX_LENGTH_CHECK'));
523        $objErr->doFunc(array('AUTHOR', 'AUTHOR', STEXT_LEN), array('MAX_LENGTH_CHECK'));
524        $objErr->doFunc(array('DESCRIPTION', 'DESCRIPTION', MTEXT_LEN), array('MAX_LENGTH_CHECK'));
525        if (isset($arrPluginInfo['PLUGIN_SITE_URL'])) {
526            $objErr->doFunc(array('PLUGIN_SITE_URL', 'PLUGIN_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
527        }
528        if (isset($arrPluginInfo['AUTHOR_SITE_URL'])) {
529            $objErr->doFunc(array('AUTHOR_SITE_URL', 'AUTHOR_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
530        }
531        // エラー内容を出力用の配列にセットします.
532        if ($this->isError($objErr->arrErr)) {
533            $arrErr['plugin_file'] = '';
534            foreach ($objErr->arrErr as $error) {
535                    $arrErr['plugin_file'] .= $error;
536            }
537        }
538        return $arrErr;
539    }
540
541    /**
542     * プラグインをアップデートします.
543     *
544     * @param string $target_plugin アップデートするプラグインコード.
545     * @param string $upload_file_name アップロードファイル名.
546     * @return array エラー情報を格納した連想配列.
547     */
548    function updatePlugin($target_plugin, $upload_file_name) {
549        // アップデート前に不要なファイルを消しておきます.
550        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, false);
551       
552        $arrErr = array();
553
554        // ファイルをチェックし展開します.
555        $arrErr = $this->unpackPluginFile($upload_file_name, DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, $target_plugin['plugin_code']);
556        if ($this->isError($arrErr) === true) {
557            return $arrErr;
558        }
559        // plugin_infoを読み込み.
560        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR . 'plugin_info.php', $target_plugin['plugin_code']);
561        if ($this->isError($arrErr) === true) {
562            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
563            return $arrErr;
564        }
565        // リフレクションオブジェクトを生成.
566        $objReflection = new ReflectionClass('plugin_info');
567        $arrPluginInfo = $this->getPluginInfo($objReflection);
568        if ($arrPluginInfo['PLUGIN_CODE'] != $target_plugin['plugin_code']) {
569            $arrErr[$target_plugin['plugin_code']] = '※ プラグインコードが一致しません。<br/>';
570            return $arrErr;
571        }
572       
573        // plugin_update.phpを読み込み.
574        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR . 'plugin_update.php', $target_plugin['plugin_code']);
575        if ($this->isError($arrErr) === true) {
576            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR);
577            return $arrErr;
578        }
579        // プラグインクラスファイルのUPDATE処理を実行.
580        $arrErr = $this->execPlugin($target_plugin, 'plugin_update', 'update');
581
582        // 保存ディレクトリの削除.
583        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, false);
584
585        return $arrErr;
586    }
587
588    /**
589     * ファイルをアップロードし、解凍先のディレクトリに解凍します.
590     *
591     * @param string $unpack_file_name 解凍ファイル名
592     * @param string $unpack_dir 解凍先ディレクトリ
593     * @param string $file_key ファイルキー
594     * @return array エラー情報を格納した連想配列.
595     */
596    function unpackPluginFile($unpack_file_name, $unpack_dir, $file_key) {
597        $arrErr = array();
598        // 解凍ディレクトリディレクトリを作成し、一時ディレクトリからファイルを移動
599        $objUpFile = new SC_UploadFile_Ex(PLUGIN_TEMP_REALDIR, $unpack_dir);
600        $this->initUploadFile($objUpFile, $file_key);
601        $arrErr = $objUpFile->makeTempFile($file_key, false);
602        if ($this->isError($arrErr) === true) {
603            return $arrErr;
604        }
605
606        // 正常にアップロードされているかをチェック.
607        $arrErr = $objUpFile->checkEXISTS($file_key);
608        if ($this->isError($arrErr) === true) {
609            return $arrErr;
610        }
611        $objUpFile->moveTempFile();
612        // 解凍
613        $update_plugin_file_path = $unpack_dir . $unpack_file_name;
614        if (!$this->unpackPluginArchive($update_plugin_file_path)) {
615            $arrErr['plugin_file'] = '※ 解凍に失敗しました。<br/>';
616            return $arrErr;
617        }
618        return $arrErr;
619    }
620
621    /**
622     * プラグインをアンインストールします.
623     *
624     * @param array $plugin プラグイン情報を確認した連想配列.
625     * @return array エラー情報を格納した連想配列.
626     */
627    function uninstallPlugin($plugin) {
628        $arrErr = array();
629        // プラグインファイルを読み込みます.
630        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
631        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
632        if ($this->isError($arrErr) === true) {
633            return $arrErr;
634        }
635       
636        // プラグインが有効な場合に無効化処理を実行
637        if($plugin['enable'] == PLUGIN_ENABLE_TRUE){
638            // 無効化処理を実行します.
639            $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'disable');
640            if ($this->isError($arrErr) === true) {
641                return $arrErr;
642            }
643            // プラグインを無効にします.
644            $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_FALSE);
645        }
646       
647        // アンインストール処理を実行します.
648        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'uninstall');
649        if ($this->isError($arrErr) === true) {
650            return $arrErr;
651        }
652        // プラグインの削除処理.
653        $arrErr = $this->deletePlugin($plugin['plugin_id'], $plugin['plugin_code']);
654
655        return $arrErr;
656    }
657
658    /**
659     * プラグインを有効にします.
660     *
661     * @param array $plugin プラグイン情報を確認した連想配列.
662     * @return array $arrErr エラー情報を格納した連想配列.
663     */
664    function enablePlugin($plugin) {
665        $arrErr = array();
666        // クラスファイルを読み込み.
667        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
668        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
669        if ($this->isError($arrErr) === true) {
670            return $arrErr;
671        }
672        // 有効化処理を実行します.
673        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'enable');
674        if ($this->isError($arrErr) === true) {
675            return $arrErr;
676        }
677        // プラグインを有効にします.
678        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_TRUE);
679
680        return $arrErr;
681    }
682
683    /**
684     * プラグインを無効にします.
685     *
686     * @param array $plugin プラグイン情報を確認した連想配列.
687     * @return array $arrErr エラー情報を格納した連想配列.
688     */
689    function disablePlugin($plugin) {
690        $arrErr = array();
691        // クラスファイルを読み込み.
692        $plugin_class_file_path = PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'] . '/' . $plugin['class_name'] . '.php';
693        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
694        if ($this->isError($arrErr) === true) {
695            return $arrErr;
696        }
697
698        // 無効化処理を実行します.
699        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'disable');
700        if ($this->isError($arrErr) === true) {
701            return $arrErr;
702        }
703        // プラグインを無効にします.
704        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_FALSE);
705
706        return $arrErr;
707    }
708
709    /**
710     * 優先度を更新します.
711     *
712     * @param int $plugin_id プラグインID
713     * @param int $priority 優先度
714     * @return integer 更新件数
715     */
716    function updatePriority($plugin_id, $priority) {
717        $objQuery =& SC_Query_Ex::getSingletonInstance();
718        // UPDATEする値を作成する。
719        $sqlval['priority'] = $priority;
720        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
721        $where = 'plugin_id = ?';
722        // UPDATEの実行
723        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
724        return $ret;
725    }
726
727    /**
728     * プラグイン情報をDB登録.
729     *
730     * @param array $arrPluginInfo プラグイン情報を格納した連想配列.
731     * @return array エラー情報を格納した連想配列.
732     */
733    function registerData($arrPluginInfo) {
734
735        // プラグイン情報をDB登録.
736        $objQuery =& SC_Query_Ex::getSingletonInstance();
737        $objQuery->begin();
738        $arr_sqlval_plugin = array();
739        $plugin_id = $objQuery->nextVal('dtb_plugin_plugin_id');
740        $arr_sqlval_plugin['plugin_id'] = $plugin_id;
741        $arr_sqlval_plugin['plugin_name'] = $arrPluginInfo['PLUGIN_NAME'];
742        $arr_sqlval_plugin['plugin_code'] = $arrPluginInfo['PLUGIN_CODE'];
743        $arr_sqlval_plugin['class_name'] = $arrPluginInfo['CLASS_NAME'];
744        $arr_sqlval_plugin['author'] = $arrPluginInfo['AUTHOR'];
745        // AUTHOR_SITE_URLが定義されているか判定.
746        $author_site_url = $arrPluginInfo['AUTHOR_SITE_URL'];
747        if ($author_site_url !== null) {
748            $arr_sqlval_plugin['author_site_url'] = $arrPluginInfo['AUTHOR'];
749        }
750        // PLUGIN_SITE_URLが定義されているか判定.
751        $plugin_site_url = $arrPluginInfo['PLUGIN_SITE_URL'];
752        if ($plugin_site_url !== null) {
753            $arr_sqlval_plugin['plugin_site_url'] = $plugin_site_url;
754        }
755        $arr_sqlval_plugin['plugin_version'] = $arrPluginInfo['PLUGIN_VERSION'];
756        $arr_sqlval_plugin['compliant_version'] = $arrPluginInfo['COMPLIANT_VERSION'];
757        $arr_sqlval_plugin['plugin_description'] = $arrPluginInfo['DESCRIPTION'];
758        $arr_sqlval_plugin['priority'] = 0;
759        $arr_sqlval_plugin['enable'] = PLUGIN_ENABLE_FALSE;
760        $arr_sqlval_plugin['update_date'] = 'CURRENT_TIMESTAMP';
761        $objQuery->insert('dtb_plugin', $arr_sqlval_plugin);
762
763        // フックポイントをDB登録.
764        $hook_point = $arrPluginInfo['HOOK_POINTS'];
765        if ($hook_point !== null) {
766            /**
767             * FIXME コードが重複しているため、要修正
768             */
769            // フックポイントが配列で定義されている場合
770            if (is_array($hook_point)) {
771                foreach ($hook_point as $h) {
772                    $arr_sqlval_plugin_hookpoint = array();
773                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
774                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
775                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
776                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h[0];
777                    $arr_sqlval_plugin_hookpoint['callback'] = $h[1];
778                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
779                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
780                }
781            // 文字列定義の場合
782            } else {
783                $array_hook_point = explode(',', $hook_point);
784                foreach ($array_hook_point as $h) {
785                    $arr_sqlval_plugin_hookpoint = array();
786                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
787                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
788                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
789                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h;
790                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
791                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
792                }
793            }
794        }
795        return $objQuery->commit();
796    }
797
798    /**
799     * ファイルを読み込む.
800     *
801     * @param string $file_path クラスのpath
802     * @param string $key エラー情報のキー.
803     * @return array $arrErr エラー情報を格納した連想配列.
804     */
805    function requirePluginFile($file_path, $key) {
806        $arrErr = array();
807        if (file_exists($file_path)) {
808            require_once $file_path;
809        } else {
810            $arrErr[$key] = '※ ' . $file_path .'の読み込みに失敗しました。<br/>';
811        }
812        return $arrErr;
813    }
814
815    /**
816     * インスタンスを生成し、指定のメソッドを実行する.
817     *
818     * @param object $obj インスタンス
819     * @param string $class_name クラス名
820     * @param string $exec_func 実行するメソッド名.
821     * @return array $arrErr エラー情報を格納した連想配列.
822     *
823     */
824    function execPlugin($obj, $class_name, $exec_func) {
825        $arrErr = array();
826        if (method_exists($class_name, $exec_func) === true) {
827            call_user_func(array($class_name, $exec_func), $obj);
828        } else {
829            $arrErr['plugin_error'] = '※ ' . $class_name . '.php に' . $exec_func . 'が見つかりません。<br/>';
830        }
831        return $arrErr;
832    }
833   
834    /**
835     * プラグインアーカイブを解凍する.
836     *
837     * @param string $path アーカイブパス
838     * @return boolean Archive_Tar::extractModify()のエラー
839     */
840    function unpackPluginArchive($path) {
841        // 圧縮フラグTRUEはgzip解凍をおこなう
842        $tar = new Archive_Tar($path, true);
843
844        $dir = dirname($path);
845        $file_name = basename($path);
846
847        // 拡張子を切り取る
848        $unpacking_name = preg_replace("/(\.tar|\.tar\.gz)$/", '', $file_name);
849
850        // 指定されたフォルダ内に解凍する
851        $result = $tar->extractModify($dir. '/', $unpacking_name);
852        GC_Utils_Ex::gfPrintLog('解凍:' . $dir.'/'.$file_name.'->'.$dir.'/'.$unpacking_name);
853
854        return $result;
855    }
856
857    /**
858     * plugin_idをキーにdtb_pluginのstatusを更新します.
859     *
860     * @param int $plugin_id プラグインID
861     * @param int $enable_flg 有効フラグ
862     * @return integer 更新件数
863     */
864    function updatePluginEnable($plugin_id, $enable_flg) {
865        $objQuery =& SC_Query_Ex::getSingletonInstance();
866        // UPDATEする値を作成する。
867        $sqlval['enable'] = $enable_flg;
868        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
869        $where = 'plugin_id = ?';
870        // UPDATEの実行
871        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
872        return $ret;
873    }
874
875    /**
876     * plugin_idをキーにdtb_plugin, dtb_plugin_hookpointから物理削除します.
877     *
878     * @param int $plugin_id プラグインID.
879     * @param string $plugin_code プラグインコード.
880     * @return array $arrErr エラー情報を格納した連想配列.
881     */
882    function deletePlugin($plugin_id, $plugin_code) {
883        $arrErr = array();
884        $objQuery =& SC_Query_Ex::getSingletonInstance();
885        $objQuery->begin();
886
887        SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
888
889        if (SC_Helper_FileManager_Ex::deleteFile($this->getPluginDir($plugin_code)) === false) {
890            // TODO エラー処理
891        }
892
893        if (SC_Helper_FileManager_Ex::deleteFile($this->getHtmlPluginDir($plugin_code)) === false) {
894            // TODO エラー処理
895        }
896
897        $objQuery->commit();
898
899        return $arrErr;
900    }
901
902    /**
903     * ファイルがあるかを判定します.
904     *
905     * @param string $plugin_dir 対象ディレクトリ.
906     * @param string $file_name ファイル名.
907     * @return boolean
908     */
909    function isContainsFile($plugin_dir, $file_name) {
910        if (file_exists($plugin_dir) && is_dir($plugin_dir)) {
911            if ($handle = opendir($plugin_dir)) {
912                while (($item = readdir($handle)) !== false) {
913                    if ($item === $file_name) return true;
914                }
915            }
916            closedir($handle);
917        }
918        return false;
919    }
920
921    /**
922     * アーカイブ内に指定のファイルが存在するかを判定します.
923     *
924     * @param Archive_Tar $tar_obj
925     * @param string $file_path 判定するファイルパス
926     * @return boolean
927     */
928    function checkContainsFile($tar_obj, $file_path) {
929        // ファイル一覧を取得
930        $arrayFile = $tar_obj->listContent();
931        foreach ($arrayFile as  $value) {
932            if ($value['filename'] === $file_path) return true;
933        }
934        return false;
935    }
936
937    /**
938     * ディレクトリを作成します.
939     *
940     * @param string $dir_path 作成するディレクトリのパス
941     * @return void
942     */
943    function makeDir($dir_path) {
944        // ディレクトリ作成
945        if (!file_exists($dir_path)) {
946            mkdir($dir_path);
947        }
948    }
949
950    /**
951     * フックポイントで衝突する可能性のあるプラグインを判定.メッセージを返します.
952     *
953     * @param int $plugin_id プラグインID
954     * @return string $conflict_alert_message メッセージ
955     */
956    function checkConflictPlugin($plugin_id) {
957        // フックポイントを取得します.
958        $hookPoints = $this->getHookPoint($plugin_id);
959
960        $conflict_alert_message = '';
961        $arrConflictPluginName = array();
962        $objQuery =& SC_Query_Ex::getSingletonInstance();
963        foreach ($hookPoints as $hookPoint) {
964            // 競合するプラグインを取得する,
965            $table = 'dtb_plugin_hookpoint AS T1 LEFT JOIN dtb_plugin AS T2 ON T1.plugin_id = T2.plugin_id';
966            $where = 'T1.hook_point = ? AND NOT T1.plugin_id = ? AND T2.enable = ' . PLUGIN_ENABLE_TRUE;
967            $objQuery->setGroupBy('T1.plugin_id, T2.plugin_name');
968            $conflictPlugins = $objQuery->select('T1.plugin_id, T2.plugin_name', $table, $where, array($hookPoint['hook_point'], $hookPoint['plugin_id']));
969
970            // プラグイン名重複を削除する為、専用の配列に格納し直す.
971            foreach ($conflictPlugins as $conflictPlugin) {
972                // プラグイン名が見つからなければ配列に格納
973                if (!in_array($conflictPlugin['plugin_name'], $arrConflictPluginName)) {
974                    $arrConflictPluginName[] = $conflictPlugin['plugin_name'];
975                }
976            }
977        }
978        // メッセージをセットします.
979        foreach ($arrConflictPluginName as $conflictPluginName) {
980            $conflict_alert_message .= '* ' .  $conflictPluginName . 'と競合する可能性があります。<br/>';
981        }
982        return $conflict_alert_message;
983    }
984
985    /**
986     * エラー情報が格納されているか判定します.
987     *
988     * @param array $arrErr エラー情報を格納した連想配列.
989     * @return boolean.
990     */
991    function isError($error) {
992        if (is_array($error) && count($error) > 0) {
993            return true;
994        }
995        return false;
996    }
997
998    /**
999     * プラグインIDからフックポイントを取得します,
1000     *
1001     * @param string $plugin_id プラグインID
1002     * @return array フックポイントの連想配列.
1003     */
1004    function getHookPoint($plugin_id) {
1005        $objQuery =& SC_Query_Ex::getSingletonInstance();
1006
1007        $table = 'dtb_plugin_hookpoint';
1008        $where = 'plugin_id = ?';
1009        return $objQuery->select('*', $table, $where, array($plugin_id));
1010    }
1011}
Note: See TracBrowser for help on using the repository browser.