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

Revision 21783, 36.9 KB checked in by adachi, 9 years ago (diff)

#1772 システム設定メニューの修正、コメント等修正

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