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

Revision 22058, 20.3 KB checked in by h_yoshimoto, 11 years ago (diff)

#1955 r21998~r22057間のコミットをmerge

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