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

Revision 21730, 20.8 KB checked in by Seasoft, 9 years ago (diff)

#1716 (Postgres Plus Advanced Server 9.1 対応)

  • シーケンス

#1720 (バックアップ管理 同一シーケンス値を再発行させる不具合)
#1739 (PostgreSQL で SC_Query#setVal した直後 SC_Query#currVal == SC_Query#nextVal となる)

  • 根本的な解決ではない。

#1743 (バックアップファイルのみでのリストアに対応)
#1613 (typo修正・ソース整形・ソースコメントの改善)

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