source: branches/version-2_13-dev/data/class/pages/admin/system/LC_Page_Admin_System_Bkup.php @ 23124

Revision 23124, 20.3 KB checked in by kimoto, 8 years ago (diff)

#2043 typo修正・ソース整形・ソースコメントの改善 for 2.13.0
PHP4的な書き方の修正

  • 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_System_Bkup extends LC_Page_Admin_Ex
34{
35    /** リストア中にエラーが発生したか */
36    public $tpl_restore_err = false;
37
38    /** 対象外とするシーケンス生成器 */
39    public $arrExcludeSequence = array(
40        'plsql_profiler_runid', // Postgres Plus Advanced Server 9.1
41        'snapshot_num',         // Postgres Plus Advanced Server 9.1
42    );
43
44    /**
45     * Page を初期化する.
46     *
47     * @return void
48     */
49    public function init()
50    {
51        parent::init();
52        $this->tpl_mainpage = 'system/bkup.tpl';
53        $this->tpl_mainno = 'system';
54        $this->tpl_subno = 'bkup';
55        $this->tpl_maintitle = 'システム設定';
56        $this->tpl_subtitle = 'バックアップ管理';
57
58        $this->bkup_dir = DATA_REALDIR . 'downloads/backup/';
59        $this->bkup_ext = '.tar.gz';
60    }
61
62    /**
63     * Page のプロセス.
64     *
65     * @return void
66     */
67    public function process()
68    {
69        $this->action();
70        $this->sendResponse();
71    }
72
73    /**
74     * Page のアクション.
75     *
76     * @return void
77     */
78    public function action()
79    {
80        $objFormParam = new SC_FormParam_Ex;
81
82        // パラメーターの初期化
83        $this->initParam($objFormParam, $_POST);
84
85        $arrErrTmp  = array();
86        $arrForm = array();
87
88        $this->mode = $this->getMode();
89        switch ($this->mode) {
90            // バックアップを作成する
91            case 'bkup':
92
93                // データ型エラーチェック
94                $arrErrTmp[1] = $objFormParam->checkError();
95
96                // データ型に問題がない場合
97                if (SC_Utils_Ex::isBlank($arrErrTmp[1])) {
98                    // データ型以外のエラーチェック
99                    $arrErrTmp[2] = $this->lfCheckError($objFormParam->getHashArray(), $this->mode);
100                }
101
102                // エラーがなければバックアップ処理を行う
103                if (SC_Utils_Ex::isBlank($arrErrTmp[1]) && SC_Utils_Ex::isBlank($arrErrTmp[2])) {
104                    $arrData = $objFormParam->getHashArray();
105
106                    $work_dir = $this->bkup_dir . $arrData['bkup_name'] . '/';
107                    // バックアップデータの事前削除
108                    SC_Helper_FileManager_Ex::deleteFile($work_dir);
109                    // バックアップファイル作成
110                    $res = $this->lfCreateBkupData($arrData['bkup_name'], $work_dir);
111                    // バックアップデータの事後削除
112                    SC_Helper_FileManager_Ex::deleteFile($work_dir);
113
114                    $arrErrTmp[3] = array();
115                    if ($res !== true) {
116                        $arrErrTmp[3]['bkup_name'] = 'バックアップに失敗しました。(' . $res . ')';
117                    }
118
119                    // DBにデータ更新
120                    if (SC_Utils_Ex::isBlank($arrErrTmp[3])) {
121                        $this->lfUpdBkupData($arrData);
122                    } else {
123                        $arrForm = $arrData;
124                        $arrErr = $arrErrTmp[3];
125                    }
126
127                    $this->tpl_onload = "alert('バックアップ完了しました');";
128                } else {
129                    $arrForm = $objFormParam->getHashArray();
130                    $arrErr = array_merge((array) $arrErrTmp[1],(array) $arrErrTmp[2]);
131                }
132                break;
133
134            // リストア
135            case 'restore_config':
136            case 'restore':
137                // データベースに存在するかどうかチェック
138                $arrErr = $this->lfCheckError($objFormParam->getHashArray(), $this->mode);
139
140                // エラーがなければリストア処理を行う
141                if (SC_Utils_Ex::isBlank($arrErr)) {
142                    $arrData = $objFormParam->getHashArray();
143
144                    $msg = '「' . $arrData['list_name'] . '」のリストアを開始します。';
145                    GC_Utils_Ex::gfPrintLog($msg);
146
147                    $success = $this->lfRestore($arrData['list_name'], $this->bkup_dir, $this->bkup_ext, $this->mode);
148
149                    $msg = '「' . $arrData['list_name'] . '」の';
150                    $msg .= $success ? 'リストアを終了しました。' : 'リストアに失敗しました。';
151
152                    $this->tpl_restore_msg .= $msg . "\n";
153                    GC_Utils_Ex::gfPrintLog($msg);
154                }
155                break;
156
157            // 削除
158            case 'delete':
159
160                // データベースに存在するかどうかチェック
161                $arrErr = $this->lfCheckError($objFormParam->getHashArray(), $this->mode);
162
163                // エラーがなければリストア処理を行う
164                if (SC_Utils_Ex::isBlank($arrErr)) {
165                    $arrData = $objFormParam->getHashArray();
166
167                    // DBとファイルを削除
168                    $this->lfDeleteBackUp($arrData, $this->bkup_dir, $this->bkup_ext);
169                }
170
171                break;
172
173                // ダウンロード
174            case 'download' :
175
176                // データベースに存在するかどうかチェック
177                $arrErr = $this->lfCheckError($objFormParam->getHashArray(), $this->mode);
178
179                // エラーがなければダウンロード処理を行う
180                if (SC_Utils_Ex::isBlank($arrErr)) {
181                    $arrData = $objFormParam->getHashArray();
182
183                    $filename = $arrData['list_name'] . $this->bkup_ext;
184                    $dl_file = $this->bkup_dir.$arrData['list_name'] . $this->bkup_ext;
185
186                    // ダウンロード開始
187                    Header("Content-disposition: attachment; filename=${filename}");
188                    Header("Content-type: application/octet-stream; name=${filename}");
189                    header('Content-Length: ' .filesize($dl_file));
190                    readfile ($dl_file);
191                    exit();
192                    break;
193                }
194
195            default:
196                break;
197        }
198
199        // 不要になった変数を解放
200        unset($arrErrTmp);
201
202        // バックアップリストを取得する
203        $arrBkupList = $this->lfGetBkupData('ORDER BY create_date DESC');
204        // テンプレートファイルに渡すデータをセット
205        $this->arrErr = isset($arrErr) ? $arrErr : array();
206        $this->arrForm = isset($arrForm) ? $arrForm : array();
207        $this->arrBkupList = $arrBkupList;
208    }
209
210    /**
211     * パラメーター初期化.
212     *
213     * @param  object $objFormParam
214     * @param  array  $arrParams    $_POST値
215     * @return void
216     */
217    public function initParam(&$objFormParam, &$arrParams)
218    {
219        $objFormParam->addParam('バックアップ名', 'bkup_name', STEXT_LEN, 'a', array('EXIST_CHECK', 'MAX_LENGTH_CHECK', 'NO_SPTAB', 'FILE_NAME_CHECK_BY_NOUPLOAD'));
220        $objFormParam->addParam('バックアップメモ', 'bkup_memo', MTEXT_LEN, 'KVa', array('MAX_LENGTH_CHECK'));
221        $objFormParam->addParam('バックアップ名(リスト)', 'list_name', STEXT_LEN, 'a', array('MAX_LENGTH_CHECK', 'NO_SPTAB', 'FILE_NAME_CHECK_BY_NOUPLOAD'));
222        $objFormParam->setParam($arrParams);
223        $objFormParam->convParam();
224    }
225
226    /**
227     * データ型以外のエラーチェック.
228     *
229     * @param array  $arrForm
230     * @param string $mode
231     * @return $arrErr
232     */
233    public function lfCheckError(&$arrForm, $mode)
234    {
235        switch ($mode) {
236            case 'bkup':
237                $name = $arrForm['bkup_name'];
238                break;
239
240            case 'restore_config':
241            case 'restore':
242            case 'download':
243            case 'delete':
244                $name = $arrForm['list_name'];
245                break;
246
247            default:
248                trigger_error('不明な処理', E_USER_ERROR);
249                break;
250        }
251
252        // 重複・存在チェック
253        $ret = $this->lfGetBkupData('', $name);
254        if (count($ret) > 0 && $mode == 'bkup') {
255            $arrErr['bkup_name'] = 'バックアップ名が重複しています。別名を入力してください。';
256        } elseif (count($ret) <= 0 && $mode != 'bkup') {
257            $arrErr['list_name'] = '選択されたデータがみつかりませんでした。既に削除されている可能性があります。';
258        }
259
260        return $arrErr;
261    }
262
263    /**
264     * バックアップファイル作成.
265     *
266     * @param  string      $bkup_name
267     * @return boolean|int 結果。true:成功 int:失敗 FIXME 本来は int ではなく、エラーメッセージを戻すべき
268     */
269    public function lfCreateBkupData($bkup_name, $work_dir)
270    {
271        $objQuery =& SC_Query_Ex::getSingletonInstance();
272        $csv_autoinc = '';
273        $arrData = array();
274
275        $success = mkdir($work_dir, 0777, true);
276        if (!$success) {
277            return __LINE__;
278        }
279
280        // 全テーブル取得
281        $arrTableList = $objQuery->listTables();
282
283        // 各テーブル情報を取得する
284        foreach ($arrTableList as $table) {
285            if ($table == 'dtb_bkup' || $table == 'mtb_zip') {
286                continue;
287            }
288
289            // dataをCSV出力
290            $csv_file = $work_dir . $table . '.csv';
291            $fp = fopen($csv_file, 'w');
292            if (!$fp) {
293                return __LINE__;
294            }
295
296            // 全データを取得
297            $sql = 'SELECT * FROM ' . $objQuery->conn->quoteIdentifier($table);
298
299            $this->fpOutput =& $fp;
300            $this->first_line = true;
301            $success = $objQuery->doCallbackAll(array(&$this, 'cbOutputCSV'), $sql);
302            unset($this->fpOutput);
303
304            if ($success === false) {
305                return __LINE__;
306            }
307
308            fclose($fp);
309
310            // タイムアウトを防ぐ
311            SC_Utils_Ex::sfFlush();
312        }
313
314        // 自動採番型の構成を取得する
315        $csv_autoinc = $this->lfGetAutoIncrement();
316
317        $csv_autoinc_file = $work_dir . 'autoinc_data.csv';
318
319        // CSV出力
320
321        // 自動採番をCSV出力
322        $fp = fopen($csv_autoinc_file,'w');
323        if ($fp) {
324            if ($csv_autoinc != '') {
325                $success = fwrite($fp, $csv_autoinc);
326                if (!$success) {
327                    return __LINE__;
328                }
329            }
330            fclose($fp);
331        }
332
333        //圧縮フラグTRUEはgzip圧縮をおこなう
334        $tar = new Archive_Tar($this->bkup_dir . $bkup_name . $this->bkup_ext, TRUE);
335
336        //bkupフォルダに移動する
337        chdir($work_dir);
338
339        //圧縮をおこなう
340        $zip = $tar->create('./');
341
342        return true;
343    }
344
345    /**
346     * CSV作成 テンポラリファイル出力 コールバック関数
347     *
348     * @param  mixed   $data 出力データ
349     * @return boolean true (true:固定 false:中断)
350     */
351    public function cbOutputCSV($data)
352    {
353        $line = '';
354        if ($this->first_line) {
355            // カラム名
356            $line .= SC_Helper_CSV_Ex::sfArrayToCsv(array_keys($data)) . "\n";
357            $this->first_line = false;
358        }
359        $line .= SC_Helper_CSV_Ex::sfArrayToCsv($data);
360        $line .= "\n";
361        SC_Utils_Ex::extendTimeOut();
362
363        return fwrite($this->fpOutput, $line);
364    }
365
366    /**
367     * シーケンス一覧をCSV出力形式に変換する.
368     *
369     * シーケンス名,シーケンス値 の形式に出力する.
370     *
371     * @return string シーケンス一覧の文字列
372     * @return string $ret
373     */
374    public function lfGetAutoIncrement()
375    {
376        $objQuery =& SC_Query_Ex::getSingletonInstance();
377        $arrSequences = $objQuery->listSequences();
378
379        foreach ($arrSequences as $name) {
380            if (in_array($name, $this->arrExcludeSequence, true)) {
381                continue 1;
382            }
383
384            // XXX SC_Query::currVal は、PostgreSQL で nextval と等しい値を戻すケースがある。欠番を生じうるが、さして問題無いと推測している。
385            $seq = $objQuery->currVal($name);
386
387            // TODO CSV 生成の共通処理を使う
388            $ret .= $name . ',';
389            $ret .= is_null($seq) ? '0' : $seq;
390            $ret .= "\r\n";
391        }
392
393        return $ret;
394    }
395
396    // バックアップテーブルにデータを更新する
397    public function lfUpdBkupData($data)
398    {
399        $objQuery =& SC_Query_Ex::getSingletonInstance();
400
401        $arrVal = array();
402        $arrVal['bkup_name'] = $data['bkup_name'];
403        $arrVal['bkup_memo'] = $data['bkup_memo'];
404        $arrVal['create_date'] = 'CURRENT_TIMESTAMP';
405
406        $objQuery->insert('dtb_bkup', $arrVal);
407    }
408
409    /**
410     * バックアップの一覧を取得する
411     */
412    public function lfGetBkupData($sql_option = '', $filter_bkup_name = '')
413    {
414        $objQuery =& SC_Query_Ex::getSingletonInstance();
415
416        // テーブルから取得
417        $arrVal = array();
418
419        $sql = 'SELECT bkup_name, bkup_memo, create_date FROM dtb_bkup';
420        if (strlen($filter_bkup_name) >= 1) {
421            $sql .= ' WHERE bkup_name = ?';
422            $arrVal[] = $filter_bkup_name;
423        }
424        if ($sql_option != '') {
425            $sql .= ' ' . $sql_option;
426        }
427
428        $ret = $objQuery->getAll($sql, $arrVal);
429
430        // ファイルのみのものを取得
431        $glob = glob($this->bkup_dir . '*' . $this->bkup_ext);
432        if (is_array($glob)) {
433            foreach ($glob as $path) {
434                $bkup_name = basename($path, $this->bkup_ext);
435                if (strlen($filter_bkup_name) >= 1 && $bkup_name !== $filter_bkup_name) {
436                    continue 1;
437                }
438                unset($row);
439                foreach ($ret as $key => $value) {
440                    if ($ret[$key]['bkup_name'] == $bkup_name) {
441                        $row =& $ret[$key];
442                    }
443                }
444                if (!isset($row)) {
445                    $ret[] = array();
446                    $row =& $ret[array_pop(array_keys($ret))];
447                    $row['bkup_name'] = $bkup_name;
448                    $row['bkup_memo'] = '(記録なし。バックアップファイルのみ。)';
449                    $row['create_date'] = date('Y-m-d H:i:s', filemtime($path));
450                }
451            }
452        }
453
454        return $ret;
455    }
456
457    /**
458     * バックアップファイルをリストアする
459     *
460     * @param  string $bkup_name
461     * @param  string $bkup_dir
462     * @param  string $bkup_ext
463     * @return void
464     */
465    public function lfRestore($bkup_name, $bkup_dir, $bkup_ext, $mode)
466    {
467        $objQuery =& SC_Query_Ex::getSingletonInstance();
468
469        $bkup_filepath = $bkup_dir . $bkup_name . $bkup_ext;
470        $work_dir = $bkup_dir . $bkup_name . '/';
471
472        //圧縮フラグTRUEはgzip解凍をおこなう
473        $tar = new Archive_Tar($bkup_filepath, TRUE);
474
475        //指定されたフォルダ内に解凍する
476        $success = $tar->extract($work_dir);
477
478        if (!$success) {
479            $msg = 'バックアップファイルの展開に失敗しました。' . "\n";
480            $msg .= '展開元: ' . $bkup_filepath . "\n";
481            $msg .= '展開先: ' . $work_dir;
482            trigger_error($msg, E_USER_ERROR);
483        }
484
485        // トランザクション開始
486        $objQuery->begin();
487
488        // INSERT実行
489        $success = $this->lfExeInsertSQL($objQuery, $work_dir, $mode);
490
491        // シーケンス生成器を復元する
492        if ($success) $this->restoreSequence($objQuery, $work_dir . 'autoinc_data.csv');
493
494        // リストア成功ならコミット失敗ならロールバック
495        if ($success) {
496            $objQuery->commit();
497            $this->tpl_restore_err = true;
498        } else {
499            $objQuery->rollback();
500            $this->tpl_restore_name = $bkup_name;
501        }
502
503        // FIXME この辺りで、バックアップ時と同等の一時ファイルの削除を実行すべきでは?
504
505        SC_Utils_Ex::extendTimeOut();
506
507        return $success;
508    }
509
510    /**
511     * CSVファイルからインサート実行.
512     *
513     * @param  object $objQuery
514     * @param  string $dir
515     * @param  string $mode
516     * @return void
517     */
518    public function lfExeInsertSQL(&$objQuery, $dir, $mode)
519    {
520        $tbl_flg = false;
521        $col_flg = false;
522        $ret = true;
523        $pagelayout_flg = false;
524        $arrVal = array();
525        $arrCol = array();
526        $arrAllTableList = $objQuery->listTables();
527
528        $objDir = dir($dir);
529        while (false !== ($file_name = $objDir->read())) {
530            if (!preg_match('/^((dtb|mtb|plg)_(\w+))\.csv$/', $file_name, $matches)) {
531                continue;
532            }
533            $file_path = $dir . $file_name;
534            $table = $matches[1];
535
536            // テーブル存在チェック
537            if (!in_array($table, $arrAllTableList)) {
538                if ($mode === 'restore_config') {
539                    continue;
540                }
541
542                return false;
543            }
544
545            // csvファイルからデータの取得
546            $fp = fopen($file_path, 'r');
547            if ($fp === false) {
548                trigger_error($file_name . ' のファイルオープンに失敗しました。', E_USER_ERROR);
549            }
550
551            GC_Utils_Ex::gfPrintLog('リストア実行: ' . $table);
552            $objQuery->delete($table);
553
554            $line = 0;
555            $arrColName = array();
556            while (!feof($fp)) {
557                $line++;
558                $arrCsvLine = fgetcsv($fp, 1024 * 1024);
559
560                // 1行目: 列名
561                if ($line === 1) {
562                    $arrColName = $arrCsvLine;
563                    continue;
564                }
565
566                // 空行を無視
567                // false との比較は PHP 5.2.x Windows バグ対応
568                // 参考: http://www.php.net/manual/ja/function.fgetcsv.php#98502
569                if ($arrCsvLine === array(null) || $arrCsvLine === false) {
570                    continue;
571                }
572
573                $arrVal = array_combine($arrColName, $arrCsvLine);
574                $objQuery->insert($table, $arrVal);
575
576                SC_Utils_Ex::extendTimeOut();
577            }
578
579            fclose($fp);
580        }
581
582        return $ret;
583    }
584
585    /**
586     * シーケンス生成器を復元する
587     */
588    public function restoreSequence(&$objQuery, $csv)
589    {
590        // csvファイルからデータの取得
591        $arrCsvData = file($csv);
592
593        foreach ($arrCsvData as $line) {
594            list($name, $currval) = explode(',', trim($line));
595
596            if (in_array($name, $this->arrExcludeSequence, true)) {
597                continue 1;
598            }
599
600            // FIXME テーブルと同様に整合チェックを行う。また不整合時はスキップして続行する。
601
602            // XXX +1 ではなく、nextVal を呼ぶべきかも。
603            $objQuery->setVal($name, $currval + 1);
604        }
605    }
606
607    // 選択したバックアップをDBから削除
608    public function lfDeleteBackUp(&$arrForm, $bkup_dir, $bkup_ext)
609    {
610        $objQuery =& SC_Query_Ex::getSingletonInstance();
611
612        $del_file = $bkup_dir.$arrForm['list_name'] . $bkup_ext;
613        // ファイルの削除
614        if (is_file($del_file)) {
615            $ret = unlink($del_file);
616        }
617
618        $objQuery->delete('dtb_bkup', 'bkup_name = ?', array($arrForm['list_name']));
619    }
620}
Note: See TracBrowser for help on using the repository browser.