source: branches/camp/camp-2_13-plugin/data/class/pages/admin/ownersstore/LC_Page_Admin_OwnersStore.php @ 22663

Revision 22663, 40.6 KB checked in by Yammy, 11 years ago (diff)

プラグインの競合チェック関数を Utils に移行

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