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

Revision 21879, 42.2 KB checked in by shutta, 11 years ago (diff)

#1839 (phpの文法に乗っ取ってない表記で書かれたソースでもプラグインとして読み込める)
コメント中のら抜き言葉を修正(日本語を正しく)

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