source: branches/version-2_13-dev/data/class/pages/admin/contents/LC_Page_Admin_Contents_CsvSql.php @ 23507

Revision 23507, 16.1 KB checked in by shutta, 10 years ago (diff)

#2448 typo修正・ソース整形・ソースコメントの改善 for 2.13.3
  • 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 * CSV 出力項目設定(高度な設定)のページクラス.
28 *
29 * @package Page
30 * @author LOCKON CO.,LTD.
31 * @version $Id$
32 */
33class LC_Page_Admin_Contents_CsvSql 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 = 'contents/csv_sql.tpl';
44        $this->tpl_subno = 'csv';
45        $this->tpl_subno_csv = 'csv_sql';
46        $this->tpl_mainno = 'contents';
47        $this->tpl_maintitle = 'コンテンツ管理';
48        $this->tpl_subtitle = 'CSV出力設定';
49    }
50
51    /**
52     * Page のプロセス.
53     *
54     * @return void
55     */
56    public function process()
57    {
58        $this->action();
59        $this->sendResponse();
60    }
61
62    /**
63     * Page のアクション.
64     *
65     * @return void
66     */
67    public function action()
68    {
69        // パラメーター管理クラス
70        $objFormParam = new SC_FormParam_Ex();
71        // パラメーター設定
72        $this->lfInitParam($objFormParam);
73        $objFormParam->setParam($_POST);
74        $objFormParam->setParam($_GET);
75        $objFormParam->convParam();
76        $this->arrForm = $objFormParam->getHashArray();
77        switch ($this->getMode()) {
78            // データの登録
79            case 'confirm':
80                $this->arrErr = $this->lfCheckConfirmError($objFormParam);
81                if (SC_Utils_Ex::isBlank($this->arrErr)) {
82                    // データの更新
83                    $this->arrForm['sql_id'] = $this->lfUpdData($objFormParam->getValue('sql_id'), $objFormParam->getDbArray());
84                    // 完了メッセージ表示
85                    $this->tpl_onload = "alert('登録が完了しました。');";
86                }
87                break;
88            // 確認画面
89            case 'preview':
90                $this->arrErr = $this->lfCheckPreviewError($objFormParam);
91                if (SC_Utils_Ex::isBlank($this->arrErr)) {
92                    $this->sqlerr = $this->lfCheckSQL($objFormParam->getValue('csv_sql'));
93                }
94                $this->setTemplate('contents/csv_sql_view.tpl');
95
96                return;
97
98            // 新規作成
99            case 'new_page':
100                // リロード
101                SC_Response_Ex::reload();
102                break;
103            // データ削除
104            case 'delete':
105                $this->arrErr = $this->lfCheckDeleteError($objFormParam);
106                if (SC_Utils_Ex::isBlank($this->arrErr)) {
107                    $this->lfDelData($objFormParam->getValue('sql_id'));
108                    SC_Response_Ex::reload();
109                    SC_Response_Ex::actionExit();
110                }
111                break;
112            // CSV出力
113            case 'csv_output':
114                $this->arrErr = $this->lfCheckOutputError($objFormParam);
115                if (SC_Utils_Ex::isBlank($this->arrErr)) {
116                    $this->lfDoCsvOutput($objFormParam->getValue('csv_output_id'));
117                    SC_Response_Ex::actionExit();
118                }
119                break;
120            default:
121                $this->arrErr = $objFormParam->checkError();
122                if (SC_Utils_Ex::isBlank($this->arrErr)) {
123                    // 設定内容を取得する
124                    $this->arrForm = $this->lfGetSqlData($objFormParam);
125                    // カラム一覧を取得する
126                    $this->arrColList = $this->lfGetColList($objFormParam->getValue('select_table'));
127                }
128                break;
129        }
130
131        // 登録済みSQL一覧取得
132        $this->arrSqlList = $this->lfGetSqlList();
133        // テーブル一覧を取得する
134        $this->arrTableList = $this->lfGetTableList();
135    }
136
137    /**
138     * パラメーター情報の初期化
139     *
140     * @param  array $objFormParam フォームパラメータークラス
141     * @return void
142     */
143    public function lfInitParam(&$objFormParam)
144    {
145        $objFormParam->addParam('SQL ID', 'sql_id', INT_LEN, 'n', array('NUM_CHECK','MAX_LENGTH_CHECK'));
146        $objFormParam->addParam('CSV出力対象SQL ID', 'csv_output_id', INT_LEN, 'n', array('NUM_CHECK','MAX_LENGTH_CHECK'), '', false);
147        $objFormParam->addParam('選択テーブル', 'select_table', STEXT_LEN, 'KVa', array('GRAPH_CHECK','MAX_LENGTH_CHECK'), '', false);
148        $objFormParam->addParam('名称', 'sql_name', STEXT_LEN, 'KVa', array('MAX_LENGTH_CHECK','SPTAB_CHECK'));
149        $objFormParam->addParam('SQL文', 'csv_sql', '30000', 'KVa', array('MAX_LENGTH_CHECK','SPTAB_CHECK'));
150    }
151
152    /**
153     * SQL登録エラーチェック
154     *
155     * @param  array $objFormParam フォームパラメータークラス
156     * @return array エラー配列
157     */
158    public function lfCheckConfirmError(&$objFormParam)
159    {
160        // パラメーターの基本チェック
161        $arrErr = $objFormParam->checkError();
162        // 拡張エラーチェック
163        $objErr = new SC_CheckError_Ex($objFormParam->getHashArray());
164        $objErr->doFunc(array('名称', 'sql_name'), array('EXIST_CHECK'));
165        $objErr->doFunc(array('SQL文', 'csv_sql', '30000'), array('EXIST_CHECK', 'MAX_LENGTH_CHECK'));
166        $objErr->doFunc(array('SQL文には読み込み関係以外のSQLコマンドおよび";"記号', 'csv_sql', $this->lfGetSqlDenyList()), array('PROHIBITED_STR_CHECK'));
167        if (!SC_Utils_Ex::isBlank($objErr->arrErr)) {
168            $arrErr = array_merge($arrErr, $objErr->arrErr);
169        }
170        // SQL文自体の確認、エラーが無い時のみ実行
171        if (SC_Utils_Ex::isBlank($arrErr)) {
172            $sql_error = $this->lfCheckSQL($objFormParam->getValue('csv_sql'));
173            if (!SC_Utils_Ex::isBlank($sql_error)) {
174                $arrErr['csv_sql'] = '※ SQL文が不正です。SQL文を見直してください';
175            }
176        }
177
178        return $arrErr;
179    }
180
181    /**
182     * SQL確認エラーチェック
183     *
184     * @param  array $objFormParam フォームパラメータークラス
185     * @return array エラー配列
186     */
187    public function lfCheckPreviewError(&$objFormParam)
188    {
189        // パラメーターの基本チェック
190        $arrErr = $objFormParam->checkError();
191        // 拡張エラーチェック
192        $objErr = new SC_CheckError_Ex($objFormParam->getHashArray());
193        $objErr->doFunc(array('SQL文', 'csv_sql', '30000'), array('EXIST_CHECK', 'MAX_LENGTH_CHECK'));
194        $objErr->doFunc(array('SQL文には読み込み関係以外のSQLコマンドおよび";"記号', 'csv_sql', $this->lfGetSqlDenyList()), array('PROHIBITED_STR_CHECK'));
195        if (!SC_Utils_Ex::isBlank($objErr->arrErr)) {
196            $arrErr = array_merge($arrErr, $objErr->arrErr);
197        }
198
199        return $arrErr;
200    }
201
202    /**
203     * SQL設定 削除エラーチェック
204     *
205     * @param  array $objFormParam フォームパラメータークラス
206     * @return array エラー配列
207     */
208    public function lfCheckDeleteError(&$objFormParam)
209    {
210        // パラメーターの基本チェック
211        $arrErr = $objFormParam->checkError();
212        // 拡張エラーチェック
213        $objErr = new SC_CheckError_Ex($objFormParam->getHashArray());
214        $objErr->doFunc(array('SQL ID', 'sql_id'), array('EXIST_CHECK'));
215        if (!SC_Utils_Ex::isBlank($objErr->arrErr)) {
216            $arrErr = array_merge($arrErr, $objErr->arrErr);
217        }
218
219        return $arrErr;
220    }
221
222    /**
223     * SQL設定 CSV出力エラーチェック
224     *
225     * @param  array $objFormParam フォームパラメータークラス
226     * @return array エラー配列
227     */
228    public function lfCheckOutputError(&$objFormParam)
229    {
230        // パラメーターの基本チェック
231        $arrErr = $objFormParam->checkError();
232        // 拡張エラーチェック
233        $objErr = new SC_CheckError_Ex($objFormParam->getHashArray());
234        $objErr->doFunc(array('CSV出力対象SQL ID', 'csv_output_id'), array('EXIST_CHECK'));
235        if (!SC_Utils_Ex::isBlank($objErr->arrErr)) {
236            $arrErr = array_merge($arrErr, $objErr->arrErr);
237        }
238
239        return $arrErr;
240    }
241
242    /**
243     * テーブル一覧を取得する.
244     *
245     * @return array テーブル名一覧
246     */
247    public function lfGetTableList()
248    {
249        $objQuery =& SC_Query_Ex::getSingletonInstance();
250        // 実テーブル上のカラム設定を見に行く仕様に変更 ref #476
251        $arrTable = $objQuery->listTables();
252        if (SC_Utils_Ex::isBlank($arrTable)) {
253            return array();
254        }
255        $arrRet = array();
256        foreach ($arrTable as $table) {
257            if (substr($table, 0, 4) == 'dtb_') {
258                $arrRet[ $table ] = 'データテーブル: ' . $table;
259            } elseif (substr($table, 0, 4) == 'mtb_') {
260                $arrRet[ $table ] = 'マスターテーブル: ' . $table;
261            }
262        }
263
264        return $arrRet;
265    }
266
267    /**
268     * テーブルのカラム一覧を取得する.
269     *
270     * @param  string $selectTable テーブル名
271     * @return array  カラム一覧の配列
272     */
273    public function lfGetColList($table)
274    {
275        if (SC_Utils_Ex::isBlank($table)) {
276            return array();
277        }
278        $objQuery =& SC_Query_Ex::getSingletonInstance();
279        // 実テーブル上のカラム設定を見に行く仕様に変更 ref #476
280        $arrColList = $objQuery->listTableFields($table);
281        $arrColList= SC_Utils_Ex::sfArrCombine($arrColList, $arrColList);
282
283        return $arrColList;
284    }
285
286    /**
287     * 登録済みSQL一覧を取得する.
288     *
289     * @param  string $where  Where句
290     * @param  array  $arrVal 絞り込みデータ
291     * @return array  取得結果の配列
292     */
293    public function lfGetSqlList($where = '' , $arrVal = array())
294    {
295        $objQuery =& SC_Query_Ex::getSingletonInstance();
296        $table = 'dtb_csv_sql';
297        $objQuery->setOrder('sql_id');
298
299        return $objQuery->select('*', $table, $where, $arrVal);
300    }
301
302    /**
303     * 入力されたSQL文が正しく実行出来るかのチェックを行う.
304     *
305     * @param string SQL文データ(頭にSELECTは入れない)
306     * @return string エラー内容
307     */
308    public function lfCheckSQL($sql)
309    {
310        // FIXME: 意図的に new SC_Query しています。 force_runをtrueにする必要があるので.本当はqueryの引数で制御したい。ref SC_Query
311        $objQuery = new SC_Query_Ex('', true);
312        $err = '';
313        $sql = 'SELECT ' . $sql . ' ';
314        $objErrMsg = $objQuery->query($sql);
315        if (PEAR::isError($objErrMsg)) {
316            $err = $objErrMsg->message . "\n" . $objErrMsg->userinfo;
317        }
318
319        return $err;
320    }
321
322    /**
323     * SQL詳細設定情報呼び出し (編集中データがある場合はそれを保持する）
324     *
325     * @param  array $objFormParam フォームパラメータークラス
326     * @return mixed 表示用パラメーター
327     */
328    public function lfGetSqlData(&$objFormParam)
329    {
330        // 編集中データがある場合
331        if (!SC_Utils_Ex::isBlank($objFormParam->getValue('sql_name'))
332            || !SC_Utils_Ex::isBlank($objFormParam->getValue('csv_sql'))
333        ) {
334            return $objFormParam->getHashArray();
335        }
336        $sql_id = $objFormParam->getValue('sql_id');
337        if (!SC_Utils_Ex::isBlank($sql_id)) {
338            $arrData = $this->lfGetSqlList('sql_id = ?', array($sql_id));
339
340            return $arrData[0];
341        }
342
343        return array();
344    }
345
346    /**
347     * DBにデータを保存する.
348     *
349     * @param  integer $sql_id 出力するデータのSQL_ID
350     * @return void
351     */
352    public function lfDoCsvOutput($sql_id)
353    {
354        $objCSV = new SC_Helper_CSV_Ex();
355
356        $arrData = $this->lfGetSqlList('sql_id = ?', array($sql_id));
357        $sql = 'SELECT ' . $arrData[0]['csv_sql'];
358
359        $objCSV->sfDownloadCsvFromSql($sql, array(), 'contents', null, true);
360        SC_Response_Ex::actionExit();
361    }
362
363    /**
364     * DBにデータを保存する.
365     *
366     * @param  integer $sql_id    更新するデータのSQL_ID
367     * @param  array   $arrSqlVal 更新データの配列
368     * @return integer $sql_id SQL_IDを返す
369     */
370    public function lfUpdData($sql_id, $arrSqlVal)
371    {
372        $objQuery =& SC_Query_Ex::getSingletonInstance();
373        $table = 'dtb_csv_sql';
374        $arrSqlVal['update_date'] = 'CURRENT_TIMESTAMP';
375        if (SC_Utils_Ex::sfIsInt($sql_id)) {
376            //データ更新
377            $where = 'sql_id = ?';
378            $objQuery->update($table, $arrSqlVal, $where, array($sql_id));
379        } else {
380            //新規作成
381            $sql_id = $objQuery->nextVal('dtb_csv_sql_sql_id');
382            $arrSqlVal['sql_id'] = $sql_id;
383            $arrSqlVal['create_date'] = 'CURRENT_TIMESTAMP';
384            $objQuery->insert($table, $arrSqlVal);
385        }
386
387        return $sql_id;
388    }
389
390    /**
391     * 登録済みデータを削除する.
392     *
393     * @param  integer $sql_id 削除するデータのSQL_ID
394     * @return boolean 実行結果 true：成功
395     */
396    public function lfDelData($sql_id)
397    {
398        $objQuery =& SC_Query_Ex::getSingletonInstance();
399        $table = 'dtb_csv_sql';
400        $where = 'sql_id = ?';
401        if (SC_Utils_Ex::sfIsInt($sql_id)) {
402            $objQuery->delete($table, $where, array($sql_id));
403
404            return true;
405        }
406
407        return false;
408    }
409
410    /**
411     * SQL文に含めることを許可しないSQLキーワード
412     * 基本的にEC-CUBEのデータを取得するために必要なコマンドしか許可しない。複数クエリも不可
413     *
414     * FIXME: キーワードの精査。危険な部分なのでプログラム埋め込みで実装しました。mtb化の有無判断必要。
415     *
416     * @return array 不許可ワード配列
417     */
418    public function lfGetSqlDenyList()
419    {
420        $arrList = array(';'
421            ,'CREATE\s'
422            ,'INSERT\s'
423            ,'UPDATE\s'
424            ,'DELETE\s'
425            ,'ALTER\s'
426            ,'ABORT\s'
427            ,'ANALYZE\s'
428            ,'CLUSTER\s'
429            ,'COMMENT\s'
430            ,'COPY\s'
431            ,'DECLARE\s'
432            ,'DISCARD\s'
433            ,'DO\s'
434            ,'DROP\s'
435            ,'EXECUTE\s'
436            ,'EXPLAIN\s'
437            ,'GRANT\s'
438            ,'LISTEN\s'
439            ,'LOAD\s'
440            ,'LOCK\s'
441            ,'NOTIFY\s'
442            ,'PREPARE\s'
443            ,'REASSIGN\s'
444//            ,'REINDEX\s'      // REINDEXは許可で良いかなと
445            ,'RELEASE\sSAVEPOINT'
446            ,'RENAME\s'
447            ,'REST\s'
448            ,'REVOKE\s'
449            ,'SAVEPOINT\s'
450            ,'SET\s'
451            ,'SHOW\s'
452            ,'START\sTRANSACTION'
453            ,'TRUNCATE\s'
454            ,'UNLISTEN\s'
455            ,'VACCUM\s'
456            ,'HANDLER\s'
457            ,'LOAD\sDATA\s'
458            ,'LOAD\sXML\s'
459            ,'REPLACE\s'
460            ,'OPTIMIZE\s'
461            ,'REPAIR\s'
462            ,'INSTALL\sPLUGIN\s'
463            ,'UNINSTALL\sPLUGIN\s'
464            ,'BINLOG\s'
465            ,'KILL\s'
466            ,'RESET\s'
467            ,'PURGE\s'
468            ,'CHANGE\sMASTER'
469            ,'START\sSLAVE'
470            ,'STOP\sSLAVE'
471            ,'MASTER\sPOS\sWAIT'
472            ,'SIGNAL\s'
473            ,'RESIGNAL\s'
474            ,'RETURN\s'
475            ,'USE\s'
476            ,'HELP\s'
477            );
478
479        return $arrList;
480    }
481}
Note: See TracBrowser for help on using the repository browser.