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

Revision 23303, 44.8 KB checked in by dkazuto, 7 years ago (diff)

#2479 COMPLIANT_VERSION の許容文字数が不足

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2013 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24require_once CLASS_EX_REALDIR . 'page_extends/admin/LC_Page_Admin_Ex.php';
25
26/**
27 * オーナーズストア:プラグイン管理 のページクラス.
28 *
29 * @package Page
30 * @author LOCKON CO.,LTD.
31 * @version $Id$
32 */
33class LC_Page_Admin_OwnersStore extends LC_Page_Admin_Ex
34{
35    /**
36     * Page を初期化する.
37     *
38     * @return void
39     */
40    public function init()
41    {
42        parent::init();
43        $this->tpl_mainpage = 'ownersstore/plugin.tpl';
44        $this->tpl_subno    = 'index';
45        $this->tpl_mainno   = 'ownersstore';
46        $this->tpl_maintitle = 'オーナーズストア';
47        $this->tpl_subtitle = 'プラグイン管理';
48    }
49
50    /**
51     * Page のプロセス.
52     *
53     * @return void
54     */
55    public function process()
56    {
57        $this->action();
58        $this->sendResponse();
59    }
60
61    /**
62     * Page のアクション.
63     *
64     * @return void
65     */
66    public function action()
67    {
68        // パラメーター管理クラス
69        $objFormParam = new SC_FormParam_Ex();
70        $mode = $this->getMode();
71        // パラメーター情報の初期化
72        $this->initParam($objFormParam, $mode);
73        $objFormParam->setParam($_POST);
74
75        switch ($mode) {
76            // インストール
77            case 'install':
78                $file_key = 'plugin_file';
79                $this->arrErr = $this->checkUploadFile($file_key);
80                if ($this->isError($this->arrErr) === false) {
81                    $archive_file_name = $_FILES[$file_key]['name'];
82                    // インストール処理.
83                    $this->arrErr = $this->installPlugin($archive_file_name, 'plugin_file');
84                    if ($this->isError($this->arrErr) === false) {
85                        // コンパイルファイルのクリア処理
86                        SC_Utils_Ex::clearCompliedTemplate();
87                        $this->tpl_onload = "alert('プラグインをインストールしました。');";
88                    }
89                }
90                break;
91            // 削除
92            case 'uninstall':
93                // エラーチェック
94                $this->arrErr = $objFormParam->checkError();
95                if ($this->isError($this->arrErr) === false) {
96                    $plugin_id = $objFormParam->getValue('plugin_id');
97                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
98                    $this->arrErr = $this->uninstallPlugin($plugin);
99                    if ($this->isError($this->arrErr) === false) {
100                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
101                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
102                        // コンパイルファイルのクリア処理
103                        SC_Utils_Ex::clearCompliedTemplate();
104                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] ."を削除しました。');";
105                    }
106                }
107                break;
108            // 有効化
109            case 'enable':
110                // エラーチェック
111                $this->arrErr = $objFormParam->checkError();
112                if ($this->isError($this->arrErr) === false) {
113                    $plugin_id = $objFormParam->getValue('plugin_id');
114                    // プラグイン取得.
115                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
116                    $this->arrErr = $this->enablePlugin($plugin);
117                    if ($this->isError($this->arrErr) === false) {
118                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
119                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
120                        // コンパイルファイルのクリア処理
121                        SC_Utils_Ex::clearCompliedTemplate();
122                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] . "を有効にしました。');";
123                    }
124                }
125                break;
126            // 無効化
127            case 'disable':
128                // エラーチェック
129                $this->arrErr = $objFormParam->checkError();
130                if ($this->isError($this->arrErr) === false) {
131                    $plugin_id = $objFormParam->getValue('plugin_id');
132                    // プラグイン取得.
133                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
134                    $this->arrErr = $this->disablePlugin($plugin);
135                    if ($this->isError($this->arrErr) === false) {
136                        // TODO 全プラグインのインスタンスを保持したまま後続処理が実行されるので、全てのインスタンスを解放する。
137                        unset($GLOBALS['_SC_Helper_Plugin_instance']);
138                        // コンパイルファイルのクリア処理
139                        SC_Utils_Ex::clearCompliedTemplate();
140                        $this->tpl_onload = "alert('" . $plugin['plugin_name'] . "を無効にしました。');";
141                    }
142                }
143                break;
144            // アップデート.
145            case 'update':
146                // エラーチェック
147                $this->arrErr = $objFormParam->checkError();
148                if ($this->isError($this->arrErr) === false) {
149                    $plugin_id = $objFormParam->getValue('plugin_id');
150                    $plugin = SC_Plugin_Util_Ex::getPluginByPluginId($plugin_id);
151                    $target_plugin_code = $plugin['plugin_code']; // アップデート対象のプラグインコード
152                    $this->arrErr = $this->checkUploadFile($target_plugin_code);
153
154                    if ($this->isError($this->arrErr) === false) {
155                        $update_plugin_file = $_FILES[$target_plugin_code];
156                        $update_plugin_file_name = $update_plugin_file['name']; // アップデートファイルのファイル名.
157                        // インストール処理.
158                        $target_plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($target_plugin_code);
159                        $this->arrErr = $this->updatePlugin($target_plugin, $update_plugin_file_name, $target_plugin_code);
160                        if ($this->isError($this->arrErr) === false) {
161                            // コンパイルファイルのクリア処理
162                            SC_Utils_Ex::clearCompliedTemplate();
163                            $this->tpl_onload = "alert('プラグインをアップデートしました。');";
164                        }
165                    }
166                }
167                break;
168            // 優先度.
169            case 'priority':
170                // エラーチェック
171                $arrErr = $objFormParam->checkError();
172                $plugin_id = $objFormParam->getValue('plugin_id');
173                if ($this->isError($arrErr) === false) {
174                    // 優先度の更新
175                    $priority = $objFormParam->getValue('priority');
176                    $this->updatePriority($plugin_id, $priority);
177                    // コンパイルファイルのクリア処理
178                    SC_Utils_Ex::clearCompliedTemplate();
179                } else {
180                    // エラーメッセージを詰め直す.
181                    $this->arrErr['priority'][$plugin_id] = $arrErr['priority'];
182                }
183
184                break;
185            default:
186                break;
187        }
188        // DBからプラグイン情報を取得
189        $plugins = SC_Plugin_Util_Ex::getAllPlugin();
190
191        foreach ($plugins as $key => $plugin) {
192            // ロゴファイルへのパスを生成(ロゴが無い場合はNO_IMAGEを表示)
193            if (file_exists(PLUGIN_HTML_REALDIR . $plugins[$key]['plugin_code'] . '/logo.png') === true) {
194                $plugins[$key]['logo'] = ROOT_URLPATH . 'plugin/' . $plugins[$key]['plugin_code'] . '/logo.png';
195            } else {
196                $plugins[$key]['logo'] = IMAGE_SAVE_URLPATH . 'noimage_plugin_list.png';
197            }
198
199            // 設定ファイルがあるかを判定.
200            $plugins[$key]['config_flg'] = $this->isContainsFile(PLUGIN_UPLOAD_REALDIR . $plugin['plugin_code'], 'config.php');
201            if ($plugins[$key]['enable'] === PLUGIN_ENABLE_TRUE) {
202                // 競合するプラグインがあるかを判定.
203                //$plugins[$key]['conflict_message']= $this->checkConflictPlugin($plugin['plugin_id']);
204                $plugins[$key]['conflict_message'] = SC_Plugin_Util_Ex::checkConflictPlugin($plugin['plugin_id']);
205            }
206        }
207        $this->plugins = $plugins;
208    }
209
210    /**
211     * パラメーター初期化.
212     *
213     * @param  SC_FormParam_Ex $objFormParam
214     * @param  string          $mode         モード
215     * @return void
216     */
217    public function initParam(&$objFormParam, $mode)
218    {
219        $objFormParam->addParam('mode', 'mode', INT_LEN, '', array('ALPHA_CHECK', 'MAX_LENGTH_CHECK'));
220        $objFormParam->addParam('plugin_id', 'plugin_id', INT_LEN, '', array('NUM_CHECK', 'MAX_LENGTH_CHECK'));
221        if ($mode === 'priority') {
222            $objFormParam->addParam('優先度', 'priority', INT_LEN, '', array('EXIST_CHECK', 'NUM_CHECK', 'MAX_LENGTH_CHECK'));
223        }
224    }
225
226    /**
227     * ファイルパラメーター初期化.
228     *
229     * @param  SC_UploadFile_Ex $objUpFile SC_UploadFileのインスタンス.
230     * @param  string           $key       登録するキー.
231     * @return void
232     */
233    public function initUploadFile(&$objUpFile, $key)
234    {
235        $objUpFile->addFile('プラグインファイル', $key, explode(',', PLUGIN_EXTENSION), FILE_SIZE, true, 0, 0, false);
236    }
237
238    /**
239     * ファイルが指定されている事をチェックします.
240     *
241     * @param  string $file     ファイル
242     * @param  string $file_key ファイルキー
243     * @return array  エラー情報を格納した連想配列.
244     */
245    public function checkUploadFile($file_key)
246    {
247        $objErr = new SC_CheckError_Ex();
248        // 拡張子チェック
249        $objErr->doFunc(array('プラグインファイル', $file_key, explode(',', PLUGIN_EXTENSION)), array('FILE_EXT_CHECK'));
250        // ファイルサイズチェック
251        $objErr->doFunc(array('プラグインファイル', $file_key, FILE_SIZE), array('FILE_SIZE_CHECK'));
252        // ファイル名チェック
253        $objErr->doFunc(array('プラグインファイル', $file_key), array('FILE_NAME_CHECK'));
254
255        return $objErr->arrErr;
256    }
257
258    /**
259     * 既にインストールされているプラグインかを判定します.
260     *
261     * @param  string  $plugin_code プラグインコード
262     * @return boolean インストール済の場合true インストールされていない場合false
263     */
264    public function isInstalledPlugin($plugin_code)
265    {
266        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($plugin_code);
267        if (!empty($plugin)) {
268            return true;
269        }
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    public function getPluginCode($file_name)
284    {
285        // 分解
286        $array_ext = explode('.', $file_name);
287        $array_file_name = array_diff($array_ext, array('tar','gz'));
288        // 結合
289        $plugin_code = implode('.', $array_file_name);
290
291        return $plugin_code;
292    }
293
294    /**
295     * プラグイン保存ディレクトリのパスを取得する.
296     *
297     * @param  string $plugin_code プラグインコード
298     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
299     */
300    public function getPluginDir($plugin_code)
301    {
302        $plugin_dir_path = PLUGIN_UPLOAD_REALDIR . $plugin_code . '/';
303
304        return $plugin_dir_path;
305    }
306
307    /**
308     * プラグインHTMLディレクトリのパスを取得する.
309     *
310     * @param  string $plugin_code プラグインコード
311     * @return string $plugin_dir_path プラグイン保存ディレクトリのパス.
312     */
313    public function getHtmlPluginDir($plugin_code)
314    {
315        $plugin_html_dir_path = PLUGIN_HTML_REALDIR . $plugin_code . '/';
316
317        return $plugin_html_dir_path;
318    }
319
320    /**
321     * プラグインファイルのパスを取得する.
322     *
323     * @param  string $plugin_code  プラグインコード
324     * @param  string $plugin_class プラグインクラス名
325     * @return string $plugin_file_path クラスファイルのパス.
326     */
327    public function getPluginFilePath($plugin_code , $plugin_class)
328    {
329        $plugin_file_path = $this->getPluginDir($plugin_code) . $plugin_class . '.php';
330
331        return $plugin_file_path;
332    }
333
334    /**
335     * プラグインをインストールします.
336     *
337     * @param  string $archive_file_name アーカイブファイル名.
338     * @param  string $key               キー.
339     * @return array  エラー情報を格納した連想配列.
340     */
341    public function installPlugin($archive_file_name, $key)
342    {
343        $objQuery =& SC_Query_Ex::getSingletonInstance();
344        $objQuery->begin();
345
346        // 一時展開ディレクトリにファイルがある場合は事前に削除.
347        $arrFileHash = SC_Helper_FileManager_Ex::sfGetFileList(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
348        if (count($arrFileHash) > 0) {
349            SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, false);
350        }
351
352        //シンタックスエラーがあるtar.gzをアップ後、削除するとたまにディレクトリが消えるので追加
353        $this->makeDir(PLUGIN_UPLOAD_REALDIR);
354
355        $arrErr = array();
356        // 必須拡張モジュールのチェック
357        $arrErr = SC_Plugin_Util_Ex::checkExtension($key);
358        if ($this->isError($arrErr) === true) {
359            return $arrErr;
360        }
361        // ファイルをチェックし一時展開用ディレクトリに展開します.
362        $arrErr = $this->unpackPluginFile($archive_file_name, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $key);
363        if ($this->isError($arrErr) === true) {
364            return $arrErr;
365        }
366        // plugin_infoを読み込み.
367        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR . 'plugin_info.php', $key);
368        if ($this->isError($arrErr) === true) {
369            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
370
371            return $arrErr;
372        }
373
374        // リフレクションオブジェクトを生成.
375        $objReflection = new ReflectionClass('plugin_info');
376        $arrPluginInfo = $this->getPluginInfo($objReflection);
377        // プラグインクラスに必須となるパラメータが正常に定義されているかチェックします.
378        $arrErr = $this->checkPluginConstants($objReflection, DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
379        if ($this->isError($arrErr) === true) {
380            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
381
382            return $arrErr;
383        }
384
385        // 既にインストールされていないかを判定.
386        if ($this->isInstalledPlugin($arrPluginInfo['PLUGIN_CODE']) === true) {
387            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
388            $arrErr['plugin_file'] = '※ ' . $arrPluginInfo['PLUGIN_NAME'] . 'は既にインストールされています。<br/>';
389
390            return $arrErr;
391        }
392
393        // プラグイン情報をDB登録
394        if ($this->registerData($arrPluginInfo) === false) {
395            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
396            $arrErr['plugin_file'] = '※ DB登録に失敗しました。<br/>';
397
398            return $arrErr;
399        }
400
401        // プラグイン保存ディレクトリを作成し、一時展開用ディレクトリから移動します.
402        $plugin_dir_path = $this->getPluginDir($arrPluginInfo['PLUGIN_CODE']);
403        $this->makeDir($plugin_dir_path);
404        SC_Utils_Ex::copyDirectory(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin_dir_path);
405
406        // プラグイン情報を取得
407        $plugin = SC_Plugin_Util_Ex::getPluginByPluginCode($arrPluginInfo['PLUGIN_CODE']);
408
409        // クラスファイルを読み込み.
410        $plugin_class_file_path = $this->getPluginFilePath($plugin['plugin_code'], $plugin['class_name']);
411        $arrErr = $this->requirePluginFile($plugin_class_file_path, $key);
412        if ($this->isError($arrErr) === true) {
413            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id']);
414
415            return $arrErr;
416        }
417        // プラグインhtmlディレクトリ作成
418        $plugin_html_dir_path = $this->getHtmlPluginDir($plugin['plugin_code']);
419        $this->makeDir($plugin_html_dir_path);
420
421        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'install');
422        if ($this->isError($arrErr) === true) {
423            // エラー時, transactionがabortしてるのでロールバック
424            $objQuery->rollback();
425            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, $plugin['plugin_id'], $plugin_html_dir_path);
426
427            return $arrErr;
428        }
429
430        $objQuery->commit();
431
432        // 不要なファイルの削除
433        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR, false);
434
435        return $arrErr;
436    }
437
438    /**
439     * ロールバック処理
440     * インストール失敗時などに不要な一時ファイルを削除します.
441     *
442     * @param string $temp_dir             インストール・アップデート時の一時展開用ディレクトリのパス.
443     * @param string $plugin_id            プラグインID.
444     * @param string $plugin_html_dir_path プラグイン毎に生成されるhtmlディレクトリのパス.
445     */
446    public function rollBack($temp_dir, $plugin_id = '', $plugin_html_dir_path ='')
447    {
448        // 一時ディレクトリを削除.
449        SC_Helper_FileManager_Ex::deleteFile($temp_dir, false);
450        // DBからプラグイン情報を削除
451        if (empty($plugin_id) === false) {
452            SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
453        }
454        // htmlディレクトリを削除
455        if (empty($plugin_html_dir_path) === false) {
456            SC_Helper_FileManager_Ex::deleteFile($plugin_html_dir_path, true);
457        }
458    }
459
460    /**
461     * プラグイン情報を取得します.
462     *
463     * @param  ReflectionClass $objReflection
464     * @return array           プラグイン情報の配列
465     */
466    public function getPluginInfo(ReflectionClass $objReflection)
467    {
468        $arrStaticProps = $objReflection->getStaticProperties();
469        $arrConstants   = $objReflection->getConstants();
470
471        $arrPluginInfoKey = array(
472            'PLUGIN_CODE',
473            'PLUGIN_NAME',
474            'CLASS_NAME',
475            'PLUGIN_VERSION',
476            'COMPLIANT_VERSION',
477            'AUTHOR',
478            'DESCRIPTION',
479            'PLUGIN_SITE_URL',
480            'AUTHOR_SITE_URL',
481            'HOOK_POINTS',
482        );
483        $arrPluginInfo = array();
484        foreach ($arrPluginInfoKey as $key) {
485            // クラス変数での定義を優先
486            if (isset($arrStaticProps[$key])) {
487                $arrPluginInfo[$key] = $arrStaticProps[$key];
488            // クラス変数定義がなければ, クラス定数での定義を読み込み.
489            } elseif ($arrConstants[$key]) {
490                $arrPluginInfo[$key] = $arrConstants[$key];
491            } else {
492                $arrPluginInfo[$key] = null;
493            }
494        }
495
496        return $arrPluginInfo;
497    }
498
499    /**
500     * プラグインクラス内の定数をチェックします.
501     *
502     * @param  ReflectionClass $objReflection リフレクションオブジェクト
503     * @param  string          $dir_path      チェックするプラグインディレクトリ
504     * @return array           エラー情報を格納した連想配列.
505     */
506    public function checkPluginConstants(ReflectionClass $objReflection, $dir_path)
507    {
508        $arrErr = array();
509        // プラグイン情報を取得
510        $arrPluginInfo = $this->getPluginInfo($objReflection);
511
512        if (!isset($arrPluginInfo['PLUGIN_CODE'])) {
513            $arrErr['plugin_file'] = '※ PLUGIN_CODEが定義されていません。<br/>';
514
515            return $arrErr;
516        }
517        if (!isset($arrPluginInfo['PLUGIN_NAME'])) {
518            $arrErr['plugin_file'] = '※ PLUGIN_NAMEが定義されていません。<br/>';
519
520            return $arrErr;
521        }
522        if (!isset($arrPluginInfo['CLASS_NAME'])) {
523            $arrErr['plugin_file'] = '※ CLASS_NAMEが定義されていません。<br/>';
524
525            return $arrErr;
526        }
527        $plugin_class_file_path = $dir_path . $arrPluginInfo['CLASS_NAME'] . '.php';
528        if (file_exists($plugin_class_file_path) === false) {
529            $arrErr['plugin_file'] = '※ CLASS_NAMEが正しく定義されていません。<br/>';
530
531            return $arrErr;
532        }
533        if (!isset($arrPluginInfo['PLUGIN_VERSION'])) {
534            $arrErr['plugin_file'] = '※ PLUGIN_VERSIONが定義されていません。<br/>';
535
536            return $arrErr;
537        }
538        if (!isset($arrPluginInfo['COMPLIANT_VERSION'])) {
539            $arrErr['plugin_file'] = '※ COMPLIANT_VERSIONが定義されていません。<br/>';
540
541            return $arrErr;
542        }
543        if (!isset($arrPluginInfo['AUTHOR'])) {
544            $arrErr['plugin_file'] = '※ AUTHORが定義されていません。<br/>';
545
546            return $arrErr;
547        }
548        if (!isset($arrPluginInfo['DESCRIPTION'])) {
549            $arrErr['plugin_file'] = '※ DESCRIPTIONが定義されていません。<br/>';
550
551            return $arrErr;
552        }
553        $objErr = new SC_CheckError_Ex($arrPluginInfo);
554        $objErr->doFunc(array('PLUGIN_CODE', 'PLUGIN_CODE', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
555        $objErr->doFunc(array('PLUGIN_NAME', 'PLUGIN_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK'));
556        $objErr->doFunc(array('CLASS_NAME', 'CLASS_NAME', STEXT_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
557        $objErr->doFunc(array('PLUGIN_VERSION', 'PLUGIN_VERSION', STEXT_LEN), array('MAX_LENGTH_CHECK'));
558        $objErr->doFunc(array('COMPLIANT_VERSION', 'COMPLIANT_VERSION', LTEXT_LEN), array('MAX_LENGTH_CHECK'));
559        $objErr->doFunc(array('AUTHOR', 'AUTHOR', STEXT_LEN), array('MAX_LENGTH_CHECK'));
560        $objErr->doFunc(array('DESCRIPTION', 'DESCRIPTION', MTEXT_LEN), array('MAX_LENGTH_CHECK'));
561        if (isset($arrPluginInfo['PLUGIN_SITE_URL'])) {
562            $objErr->doFunc(array('PLUGIN_SITE_URL', 'PLUGIN_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
563        }
564        if (isset($arrPluginInfo['AUTHOR_SITE_URL'])) {
565            $objErr->doFunc(array('AUTHOR_SITE_URL', 'AUTHOR_SITE_URL', URL_LEN), array('MAX_LENGTH_CHECK','GRAPH_CHECK'));
566        }
567        // エラー内容を出力用の配列にセットします.
568        if ($this->isError($objErr->arrErr)) {
569            $arrErr['plugin_file'] = '';
570            foreach ($objErr->arrErr as $error) {
571                    $arrErr['plugin_file'] .= $error;
572            }
573        }
574
575        return $arrErr;
576    }
577
578    /**
579     * プラグインをアップデートします.
580     *
581     * @param  array  $target_plugin    アップデートするプラグイン情報の配列.
582     * @param  string $upload_file_name アップロードファイル名.
583     * @return array  エラー情報を格納した連想配列.
584     */
585    public function updatePlugin($target_plugin, $upload_file_name)
586    {
587        // アップデート前に不要なファイルを消しておきます.
588        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, false);
589
590        $arrErr = array();
591
592        // ファイルをチェックし展開します.
593        $arrErr = $this->unpackPluginFile($upload_file_name, DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, $target_plugin['plugin_code']);
594        if ($this->isError($arrErr) === true) {
595            return $arrErr;
596        }
597        // plugin_infoを読み込み.
598        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR . 'plugin_info.php', $target_plugin['plugin_code']);
599        if ($this->isError($arrErr) === true) {
600            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_INSTALL_DIR);
601
602            return $arrErr;
603        }
604        // リフレクションオブジェクトを生成.
605        $objReflection = new ReflectionClass('plugin_info');
606        $arrPluginInfo = $this->getPluginInfo($objReflection);
607        if ($arrPluginInfo['PLUGIN_CODE'] != $target_plugin['plugin_code']) {
608            $arrErr[$target_plugin['plugin_code']] = '※ プラグインコードが一致しません。<br/>';
609
610            return $arrErr;
611        }
612
613        // plugin_update.phpを読み込み.
614        $arrErr = $this->requirePluginFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR . 'plugin_update.php', $target_plugin['plugin_code']);
615        if ($this->isError($arrErr) === true) {
616            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR);
617
618            return $arrErr;
619        }
620        // プラグインクラスファイルのUPDATE処理を実行.
621        $arrErr = $this->execPlugin($target_plugin, 'plugin_update', 'update');
622
623        // プラグイン情報を更新
624        if ($this->registerData($arrPluginInfo, 'update') === false) {
625            $this->rollBack(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR);
626            $arrErr['plugin_file'] = '※ プラグイン情報の更新に失敗しました。<br/>';
627
628            return $arrErr;
629        }
630
631        // 保存ディレクトリの削除.
632        SC_Helper_FileManager_Ex::deleteFile(DOWNLOADS_TEMP_PLUGIN_UPDATE_DIR, false);
633
634        return $arrErr;
635    }
636
637    /**
638     * ファイルをアップロードし、解凍先のディレクトリに解凍します.
639     *
640     * @param  string $unpack_file_name 解凍ファイル名
641     * @param  string $unpack_dir_path  解凍先ディレクトリパス
642     * @param  string $file_key         ファイルキー
643     * @return array  エラー情報を格納した連想配列.
644     */
645    public function unpackPluginFile($unpack_file_name, $unpack_dir_path, $file_key)
646    {
647        $arrErr = array();
648        // 解凍ディレクトリディレクトリを作成し、一時ディレクトリからファイルを移動
649        $objUpFile = new SC_UploadFile_Ex(PLUGIN_TEMP_REALDIR, $unpack_dir_path);
650        $this->initUploadFile($objUpFile, $file_key);
651        $arrErr = $objUpFile->makeTempFile($file_key, false);
652        if ($this->isError($arrErr) === true) {
653            return $arrErr;
654        }
655
656        // 正常にアップロードされているかをチェック.
657        $arrErr = $objUpFile->checkExists($file_key);
658        if ($this->isError($arrErr) === true) {
659            return $arrErr;
660        }
661        $objUpFile->moveTempFile();
662        // 解凍
663        $unpack_file_path = $unpack_dir_path . $unpack_file_name;
664        if (!$this->unpackPluginArchive($unpack_file_path)) {
665            $arrErr['plugin_file'] = '※ 解凍に失敗しました。<br/>';
666
667            return $arrErr;
668        }
669
670        return $arrErr;
671    }
672
673    /**
674     * プラグインをアンインストールします.
675     *
676     * @param  array $plugin プラグイン情報を確認した連想配列.
677     * @return array エラー情報を格納した連想配列.
678     */
679    public function uninstallPlugin($plugin)
680    {
681        $arrErr = array();
682        // プラグインファイルを読み込みます.
683        $plugin_class_file_path = $this->getPluginFilePath($plugin['plugin_code'], $plugin['class_name']);
684        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
685        if ($this->isError($arrErr) === true) {
686            return $arrErr;
687        }
688
689        // プラグインが有効な場合に無効化処理を実行
690        if ($plugin['enable'] == PLUGIN_ENABLE_TRUE) {
691            // 無効化処理を実行します.
692            $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'disable');
693            if ($this->isError($arrErr) === true) {
694                return $arrErr;
695            }
696            // プラグインを無効にします.
697            $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_FALSE);
698        }
699
700        // アンインストール処理を実行します.
701        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'uninstall');
702        // プラグインの削除処理.
703        $arrErr = $this->deletePlugin($plugin['plugin_id'], $plugin['plugin_code']);
704
705        return $arrErr;
706    }
707
708    /**
709     * プラグインを有効にします.
710     *
711     * @param  array $plugin プラグイン情報を確認した連想配列.
712     * @return array $arrErr エラー情報を格納した連想配列.
713     */
714    public function enablePlugin($plugin)
715    {
716        $arrErr = array();
717        // クラスファイルを読み込み.
718        $plugin_class_file_path = $this->getPluginFilePath($plugin['plugin_code'], $plugin['class_name']);
719        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
720        if ($this->isError($arrErr) === true) {
721            return $arrErr;
722        }
723        // 有効化処理を実行します.
724        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'enable');
725        if ($this->isError($arrErr) === true) {
726            return $arrErr;
727        }
728        // プラグインを有効にします.
729        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_TRUE);
730
731        return $arrErr;
732    }
733
734    /**
735     * プラグインを無効にします.
736     *
737     * @param  array $plugin プラグイン情報を確認した連想配列.
738     * @return array $arrErr エラー情報を格納した連想配列.
739     */
740    public function disablePlugin($plugin)
741    {
742        $arrErr = array();
743        // クラスファイルを読み込み.
744        $plugin_class_file_path =$this->getPluginFilePath($plugin['plugin_code'], $plugin['class_name']);
745        $arrErr = $this->requirePluginFile($plugin_class_file_path, 'plugin_error');
746        if ($this->isError($arrErr) === true) {
747            return $arrErr;
748        }
749
750        // 無効化処理を実行します.
751        $arrErr = $this->execPlugin($plugin, $plugin['class_name'], 'disable');
752        if ($this->isError($arrErr) === true) {
753            return $arrErr;
754        }
755        // プラグインを無効にします.
756        $this->updatePluginEnable($plugin['plugin_id'], PLUGIN_ENABLE_FALSE);
757
758        return $arrErr;
759    }
760
761    /**
762     * 優先度を更新します.
763     *
764     * @param  int     $plugin_id プラグインID
765     * @param  int     $priority  優先度
766     * @return integer 更新件数
767     */
768    public function updatePriority($plugin_id, $priority)
769    {
770        $objQuery =& SC_Query_Ex::getSingletonInstance();
771        // UPDATEする値を作成する。
772        $sqlval['priority'] = $priority;
773        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
774        $where = 'plugin_id = ?';
775        // UPDATEの実行
776        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
777
778        return $ret;
779    }
780
781    /**
782     * プラグイン情報をDB登録.
783     *
784     * @param  array  $arrPluginInfo プラグイン情報を格納した連想配列.
785     * @param  string $mode          モード
786     * @return array  エラー情報を格納した連想配列.
787     */
788    public function registerData($arrPluginInfo, $mode = 'install')
789    {
790        // プラグイン情報をDB登録.
791        $objQuery =& SC_Query_Ex::getSingletonInstance();
792        $arr_sqlval_plugin = array();
793        $arr_sqlval_plugin['plugin_name'] = $arrPluginInfo['PLUGIN_NAME'];
794        $arr_sqlval_plugin['plugin_code'] = $arrPluginInfo['PLUGIN_CODE'];
795        $arr_sqlval_plugin['class_name'] = $arrPluginInfo['CLASS_NAME'];
796        $arr_sqlval_plugin['author'] = $arrPluginInfo['AUTHOR'];
797        // AUTHOR_SITE_URLが定義されているか判定.
798        $author_site_url = $arrPluginInfo['AUTHOR_SITE_URL'];
799        if ($author_site_url !== null) {
800            $arr_sqlval_plugin['author_site_url'] = $arrPluginInfo['AUTHOR_SITE_URL'];
801        }
802        // PLUGIN_SITE_URLが定義されているか判定.
803        $plugin_site_url = $arrPluginInfo['PLUGIN_SITE_URL'];
804        if ($plugin_site_url !== null) {
805            $arr_sqlval_plugin['plugin_site_url'] = $plugin_site_url;
806        }
807        $arr_sqlval_plugin['plugin_version'] = $arrPluginInfo['PLUGIN_VERSION'];
808        $arr_sqlval_plugin['compliant_version'] = $arrPluginInfo['COMPLIANT_VERSION'];
809        $arr_sqlval_plugin['plugin_description'] = $arrPluginInfo['DESCRIPTION'];
810        $arr_sqlval_plugin['priority'] = 0;
811        $arr_sqlval_plugin['enable'] = PLUGIN_ENABLE_FALSE;
812        $arr_sqlval_plugin['update_date'] = 'CURRENT_TIMESTAMP';
813        if ($mode === 'install') {
814            // 新規登録
815            $plugin_id = $objQuery->nextVal('dtb_plugin_plugin_id');
816            $arr_sqlval_plugin['plugin_id'] = $plugin_id;
817            $objQuery->insert('dtb_plugin', $arr_sqlval_plugin);
818        } elseif ($mode === 'update') {
819            // 情報を更新
820            $plugin_id = $objQuery->get('plugin_id', 'dtb_plugin', 'plugin_code = ? ', array($arrPluginInfo['PLUGIN_CODE']));
821            $arrUnsetKeys = array('plugin_code', 'priority', 'enable');
822            foreach ($arrUnsetKeys as $key) {
823                unset($arr_sqlval_plugin[$key]);
824            }
825            $objQuery->update('dtb_plugin', $arr_sqlval_plugin, 'plugin_id = ?', array($plugin_id));
826            // 該当プラグインのフックポイントを一旦削除
827            $objQuery->delete('dtb_plugin_hookpoint', 'plugin_id = ? ', array($plugin_id));
828        } else {
829            GC_Utils_Ex::gfPrintLog("モードの指定が不正($mode)", ERROR_LOG_REALFILE);
830
831            return false;
832        }
833
834        // フックポイントをDB登録.
835        $hook_point = $arrPluginInfo['HOOK_POINTS'];
836        if ($hook_point !== null) {
837            /**
838             * FIXME コードが重複しているため、要修正
839             */
840            // フックポイントが配列で定義されている場合
841            if (is_array($hook_point)) {
842                foreach ($hook_point as $h) {
843                    $arr_sqlval_plugin_hookpoint = array();
844                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
845                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
846                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
847                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h[0];
848                    $arr_sqlval_plugin_hookpoint['callback'] = $h[1];
849                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
850                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
851                }
852            // 文字列定義の場合
853            } else {
854                $array_hook_point = explode(',', $hook_point);
855                foreach ($array_hook_point as $h) {
856                    $arr_sqlval_plugin_hookpoint = array();
857                    $id = $objQuery->nextVal('dtb_plugin_hookpoint_plugin_hookpoint_id');
858                    $arr_sqlval_plugin_hookpoint['plugin_hookpoint_id'] = $id;
859                    $arr_sqlval_plugin_hookpoint['plugin_id'] = $plugin_id;
860                    $arr_sqlval_plugin_hookpoint['hook_point'] = $h;
861                    $arr_sqlval_plugin_hookpoint['update_date'] = 'CURRENT_TIMESTAMP';
862                    $objQuery->insert('dtb_plugin_hookpoint', $arr_sqlval_plugin_hookpoint);
863                }
864            }
865        }
866
867        return $objQuery->commit();
868    }
869
870    /**
871     * ファイルを読み込む.
872     *
873     * @param  string $file_path クラスのpath
874     * @param  string $key       エラー情報のキー.
875     * @return array  $arrErr エラー情報を格納した連想配列.
876     */
877    public function requirePluginFile($file_path, $key)
878    {
879        $arrErr = array();
880        if (file_exists($file_path)) {
881            require_once $file_path;
882        } else {
883            $arrErr[$key] = '※ ' . $file_path .'の読み込みに失敗しました。<br/>';
884        }
885
886        return $arrErr;
887    }
888
889    /**
890     * インスタンスを生成し、指定のメソッドを実行する.
891     *
892     * @param  object $obj        インスタンス
893     * @param  string $class_name クラス名
894     * @param  string $exec_func  実行するメソッド名.
895     * @return array  $arrErr エラー情報を格納した連想配列.
896     *
897     */
898    public function execPlugin($obj, $class_name, $exec_func)
899    {
900        $objPluginInstaller = new SC_Plugin_Installer($exec_func, $obj);
901
902        $arrErr = array();
903        if (method_exists($class_name, $exec_func) === true) {
904            $ret = call_user_func_array(
905                    array($class_name, $exec_func),
906                    array($obj, $objPluginInstaller));
907            if (!(is_null($ret) || $ret === true)) {
908                $arrErr[$obj['plugin_code']] = $ret;
909            }
910            $arrInstallErr = $objPluginInstaller->execPlugin();
911            if ($arrInstallErr) {
912                $arrErr['plugin_file'] = "プラグインのインストールに失敗しました.<br/>";
913            }
914        } else {
915            $arrErr['plugin_file'] = '※ ' . $class_name . '.php に' . $exec_func . 'が見つかりません。<br/>';
916        }
917
918        return $arrErr;
919    }
920
921    /**
922     * プラグインアーカイブを解凍する.
923     *
924     * @param  string  $path アーカイブパス
925     * @return boolean Archive_Tar::extractModify()のエラー
926     */
927    public function unpackPluginArchive($path)
928    {
929        // 圧縮フラグTRUEはgzip解凍をおこなう
930        $tar = new Archive_Tar($path, true);
931
932        $dir = dirname($path);
933        $file_name = basename($path);
934
935        // 拡張子を切り取る
936        $unpacking_name = preg_replace("/(\.tar|\.tar\.gz)$/", '', $file_name);
937
938        // 指定されたフォルダ内に解凍する
939        $result = $tar->extractModify($dir. '/', $unpacking_name);
940        GC_Utils_Ex::gfPrintLog('解凍:' . $dir.'/'.$file_name.'->'.$dir.'/'.$unpacking_name);
941        // 解凍元のファイルを削除する.
942        unlink($path);
943
944        return $result;
945    }
946
947    /**
948     * plugin_idをキーにdtb_pluginのstatusを更新します.
949     *
950     * @param  int     $plugin_id  プラグインID
951     * @param  int     $enable_flg 有効フラグ
952     * @return integer 更新件数
953     */
954    public function updatePluginEnable($plugin_id, $enable_flg)
955    {
956        $objQuery =& SC_Query_Ex::getSingletonInstance();
957        // UPDATEする値を作成する。
958        $sqlval['enable'] = $enable_flg;
959        $sqlval['update_date'] = 'CURRENT_TIMESTAMP';
960        $where = 'plugin_id = ?';
961        // UPDATEの実行
962        $ret = $objQuery->update('dtb_plugin', $sqlval, $where, array($plugin_id));
963
964        return $ret;
965    }
966
967    /**
968     * plugin_idをキーにdtb_plugin, dtb_plugin_hookpointから物理削除します.
969     *
970     * @param  int    $plugin_id   プラグインID.
971     * @param  string $plugin_code プラグインコード.
972     * @return array  $arrErr エラー情報を格納した連想配列.
973     */
974    public function deletePlugin($plugin_id, $plugin_code)
975    {
976        $arrErr = array();
977        $objQuery =& SC_Query_Ex::getSingletonInstance();
978        $objQuery->begin();
979
980        SC_Plugin_Util_Ex::deletePluginByPluginId($plugin_id);
981
982        if (SC_Helper_FileManager_Ex::deleteFile($this->getPluginDir($plugin_code)) === false) {
983            // TODO エラー処理
984        }
985
986        if (SC_Helper_FileManager_Ex::deleteFile($this->getHtmlPluginDir($plugin_code)) === false) {
987            // TODO エラー処理
988        }
989
990        $objQuery->commit();
991
992        return $arrErr;
993    }
994
995    /**
996     * ファイルがあるかを判定します.
997     *
998     * @param  string  $plugin_dir 対象ディレクトリ.
999     * @param  string  $file_name  ファイル名.
1000     * @return boolean
1001     */
1002    public function isContainsFile($plugin_dir, $file_name)
1003    {
1004        if (file_exists($plugin_dir) && is_dir($plugin_dir)) {
1005            if ($handle = opendir($plugin_dir)) {
1006                while (($item = readdir($handle)) !== false) {
1007                    if ($item === $file_name) return true;
1008                }
1009            }
1010            closedir($handle);
1011        }
1012
1013        return false;
1014    }
1015
1016    /**
1017     * アーカイブ内に指定のファイルが存在するかを判定します.
1018     *
1019     * @param  Archive_Tar $tar_obj
1020     * @param  string      $file_path 判定するファイルパス
1021     * @return boolean
1022     */
1023    public function checkContainsFile($tar_obj, $file_path)
1024    {
1025        // ファイル一覧を取得
1026        $arrayFile = $tar_obj->listContent();
1027        foreach ($arrayFile as  $value) {
1028            if ($value['filename'] === $file_path) return true;
1029        }
1030
1031        return false;
1032    }
1033
1034    /**
1035     * ディレクトリを作成します.
1036     *
1037     * @param  string $dir_path 作成するディレクトリのパス
1038     * @return void
1039     */
1040    public function makeDir($dir_path)
1041    {
1042        // ディレクトリ作成
1043        if (!file_exists($dir_path)) {
1044            mkdir($dir_path);
1045        }
1046    }
1047
1048    /**
1049     * フックポイントで衝突する可能性のあるプラグインを判定.メッセージを返します.
1050     *
1051     * @param  int    $plugin_id プラグインID
1052     * @return string $conflict_alert_message メッセージ
1053     */
1054    public function checkConflictPlugin($plugin_id)
1055    {
1056        // フックポイントを取得します.
1057        $hookPoints = $this->getHookPoint($plugin_id);
1058
1059        $conflict_alert_message = '';
1060        $arrConflictPluginName = array();
1061        $objQuery =& SC_Query_Ex::getSingletonInstance();
1062        foreach ($hookPoints as $hookPoint) {
1063            // 競合するプラグインを取得する,
1064            $table = 'dtb_plugin_hookpoint AS T1 LEFT JOIN dtb_plugin AS T2 ON T1.plugin_id = T2.plugin_id';
1065            $where = 'T1.hook_point = ? AND NOT T1.plugin_id = ? AND T2.enable = ' . PLUGIN_ENABLE_TRUE;
1066            $objQuery->setGroupBy('T1.plugin_id, T2.plugin_name');
1067            $conflictPlugins = $objQuery->select('T1.plugin_id, T2.plugin_name', $table, $where, array($hookPoint['hook_point'], $hookPoint['plugin_id']));
1068
1069            // プラグイン名重複を削除する為、専用の配列に格納し直す.
1070            foreach ($conflictPlugins as $conflictPlugin) {
1071                // プラグイン名が見つからなければ配列に格納
1072                if (!in_array($conflictPlugin['plugin_name'], $arrConflictPluginName)) {
1073                    $arrConflictPluginName[] = $conflictPlugin['plugin_name'];
1074                }
1075            }
1076        }
1077        // メッセージをセットします.
1078        foreach ($arrConflictPluginName as $conflictPluginName) {
1079            $conflict_alert_message .= '* ' .  $conflictPluginName . 'と競合する可能性があります。<br/>';
1080        }
1081
1082        return $conflict_alert_message;
1083    }
1084
1085    /**
1086     * エラー情報が格納されているか判定します.
1087     *
1088     * @param  array    $arrErr エラー情報を格納した連想配列.
1089     * @return boolean.
1090     */
1091    public function isError($error)
1092    {
1093        if (is_array($error) && count($error) > 0) {
1094            return true;
1095        }
1096
1097        return false;
1098    }
1099
1100    /**
1101     * プラグインIDからフックポイントを取得します,
1102     *
1103     * @param  string $plugin_id プラグインID
1104     * @return array  フックポイントの連想配列.
1105     */
1106    public function getHookPoint($plugin_id)
1107    {
1108        $objQuery =& SC_Query_Ex::getSingletonInstance();
1109
1110        $table = 'dtb_plugin_hookpoint';
1111        $where = 'plugin_id = ?';
1112
1113        return $objQuery->select('*', $table, $where, array($plugin_id));
1114    }
1115}
Note: See TracBrowser for help on using the repository browser.