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

Revision 21867, 20.5 KB checked in by nakanishi, 9 years ago (diff)

#1831 Copyright Update

  • 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;
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        // 実行時間を制限しない
288        set_time_limit(0);
289
290        $objQuery =& SC_Query_Ex::getSingletonInstance();
291        $csv_autoinc = '';
292        $arrData = array();
293
294        $success = mkdir($work_dir, 0777, true);
295        if (!$success) {
296            return __LINE__;
297        }
298
299        // 全テーブル取得
300        $arrTableList = $objQuery->listTables();
301
302        // 各テーブル情報を取得する
303        foreach ($arrTableList as $table) {
304
305            if ($table == 'dtb_bkup' || $table == 'mtb_zip') {
306                continue;
307            }
308
309            // dataをCSV出力
310            $csv_file = $work_dir . $table . '.csv';
311            $fp = fopen($csv_file, 'w');
312            if (!$fp) {
313                return __LINE__;
314            }
315
316            // 全データを取得
317            $sql = "SELECT * FROM $table";
318
319            $this->fpOutput =& $fp;
320            $this->first_line = true;
321            $success = $objQuery->doCallbackAll(array(&$this, 'cbOutputCSV'), $sql);
322            unset($this->fpOutput);
323
324            if ($success === false) {
325                return __LINE__;
326            }
327
328            fclose($fp);
329
330            // タイムアウトを防ぐ
331            SC_Utils_Ex::sfFlush();
332        }
333
334        // 自動採番型の構成を取得する
335        $csv_autoinc = $this->lfGetAutoIncrement();
336
337        $csv_autoinc_file = $work_dir . 'autoinc_data.csv';
338
339        // CSV出力
340
341        // 自動採番をCSV出力
342        $fp = fopen($csv_autoinc_file,'w');
343        if ($fp) {
344            if ($csv_autoinc != '') {
345                $success = fwrite($fp, $csv_autoinc);
346                if (!$success) {
347                    return __LINE__;
348                }
349            }
350            fclose($fp);
351        }
352
353        //圧縮フラグTRUEはgzip圧縮をおこなう
354        $tar = new Archive_Tar($this->bkup_dir . $bkup_name . $this->bkup_ext, TRUE);
355
356        //bkupフォルダに移動する
357        chdir($work_dir);
358
359        //圧縮をおこなう
360        $zip = $tar->create('./');
361
362        return true;
363    }
364
365    /**
366     * CSV作成 テンポラリファイル出力 コールバック関数
367     *
368     * @param mixed $data 出力データ
369     * @return boolean true (true:固定 false:中断)
370     */
371    function cbOutputCSV($data) {
372        $line = '';
373        if ($this->first_line) {
374            // カラム名
375            $line .= SC_Helper_CSV_Ex::sfArrayToCsv(array_keys($data)) . "\n";
376            $this->first_line = false;
377        }
378        $line .= SC_Helper_CSV_Ex::sfArrayToCsv($data);
379        $line .= "\n";
380        return fwrite($this->fpOutput, $line);
381    }
382
383    /**
384     * シーケンス一覧をCSV出力形式に変換する.
385     *
386     * シーケンス名,シーケンス値 の形式に出力する.
387     *
388     * @return string シーケンス一覧の文字列
389     * @return string $ret
390     */
391    function lfGetAutoIncrement() {
392        $objQuery =& SC_Query_Ex::getSingletonInstance();
393        $arrSequences = $objQuery->listSequences();
394
395        foreach ($arrSequences as $name) {
396            if (in_array($name, $this->arrExcludeSequence, true)) {
397                continue 1;
398            }
399
400            // XXX SC_Query::currVal は、PostgreSQL で nextval と等しい値を戻すケースがある。欠番を生じうるが、さして問題無いと推測している。
401            $seq = $objQuery->currVal($name);
402
403            // TODO CSV 生成の共通処理を使う
404            $ret .= $name . ',';
405            $ret .= is_null($seq) ? '0' : $seq;
406            $ret .= "\r\n";
407        }
408        return $ret;
409    }
410
411    // バックアップテーブルにデータを更新する
412    function lfUpdBkupData($data) {
413        $objQuery =& SC_Query_Ex::getSingletonInstance();
414
415        $arrVal = array();
416        $arrVal['bkup_name'] = $data['bkup_name'];
417        $arrVal['bkup_memo'] = $data['bkup_memo'];
418        $arrVal['create_date'] = 'CURRENT_TIMESTAMP';
419
420        $objQuery->insert('dtb_bkup', $arrVal);
421    }
422
423    /**
424     * バックアップの一覧を取得する
425     */
426    function lfGetBkupData($sql_option = '', $filter_bkup_name) {
427        $objQuery =& SC_Query_Ex::getSingletonInstance();
428
429        // テーブルから取得
430        $arrVal = array();
431
432        $sql = 'SELECT bkup_name, bkup_memo, create_date FROM dtb_bkup';
433        if (strlen($filter_bkup_name) >= 1) {
434            $sql .= ' WHERE bkup_name = ?';
435            $arrVal[] = $filter_bkup_name;
436        }
437        if ($sql_option != '') {
438            $sql .= ' ' . $sql_option;
439        }
440
441        $ret = $objQuery->getAll($sql, $arrVal);
442
443        // ファイルのみのものを取得
444        $glob = glob($this->bkup_dir . '*' . $this->bkup_ext);
445        if (is_array($glob)) {
446            foreach ($glob as $path) {
447                $bkup_name = basename($path, $this->bkup_ext);
448                if (strlen($filter_bkup_name) >= 1 && $bkup_name !== $filter_bkup_name) {
449                    continue 1;
450                }
451                unset($row);
452                foreach (array_keys($ret) as $key) {
453                    if ($ret[$key]['bkup_name'] == $bkup_name) {
454                        $row =& $ret[$key];
455                    }
456                }
457                if (!isset($row)) {
458                    $ret[] = array();
459                    $row =& $ret[array_pop(array_keys($ret))];
460                    $row['bkup_name'] = $bkup_name;
461                    $row['bkup_memo'] = '(記録なし。バックアップファイルのみ。)';
462                    $row['create_date'] = date('Y-m-d H:i:s', filemtime($path));
463                }
464            }
465        }
466
467        return $ret;
468    }
469
470    /**
471     * バックアップファイルをリストアする
472     *
473     * @param string $bkup_name
474     * @param string $bkup_dir
475     * @param string $bkup_ext
476     * @return void
477     */
478    function lfRestore($bkup_name, $bkup_dir, $bkup_ext, $mode) {
479        $objQuery =& SC_Query_Ex::getSingletonInstance();
480
481        // 実行時間を制限しない
482        // FIXME ファイル展開時に限定すべき
483        set_time_limit(0);
484
485        $bkup_filepath = $bkup_dir . $bkup_name . $bkup_ext;
486        $work_dir = $bkup_dir . $bkup_name . '/';
487
488        //圧縮フラグTRUEはgzip解凍をおこなう
489        $tar = new Archive_Tar($bkup_filepath, TRUE);
490
491        //指定されたフォルダ内に解凍する
492        $success = $tar->extract($work_dir);
493
494        if (!$success) {
495            $msg = 'バックアップファイルの展開に失敗しました。' . "\n";
496            $msg .= '展開元: ' . $bkup_filepath . "\n";
497            $msg .= '展開先: ' . $work_dir;
498            trigger_error($msg, E_USER_ERROR);
499        }
500
501        // トランザクション開始
502        $objQuery->begin();
503
504        // INSERT実行
505        $success = $this->lfExeInsertSQL($objQuery, $work_dir, $mode);
506
507        // シーケンス生成器を復元する
508        if ($success) $this->restoreSequence($objQuery, $work_dir . 'autoinc_data.csv');
509
510        // リストア成功ならコミット失敗ならロールバック
511        if ($success) {
512            $objQuery->commit();
513            $this->tpl_restore_err = true;
514        } else {
515            $objQuery->rollback();
516            $this->tpl_restore_name = $bkup_name;
517        }
518
519        // FIXME この辺りで、バックアップ時と同等の一時ファイルの削除を実行すべきでは?
520
521        return $success;
522    }
523
524    /**
525     * CSVファイルからインサート実行.
526     *
527     * @param object $objQuery
528     * @param string $dir
529     * @param string $mode
530     * @return void
531     */
532    function lfExeInsertSQL(&$objQuery, $dir, $mode) {
533
534        $tbl_flg = false;
535        $col_flg = false;
536        $ret = true;
537        $pagelayout_flg = false;
538        $arrVal = array();
539        $arrCol = array();
540        $arrAllTableList = $objQuery->listTables();
541
542        $objDir = dir($dir);
543        while (false !== ($file_name = $objDir->read())) {
544            if (!preg_match('/^((dtb|mtb|plg)_(\w+))\.csv$/', $file_name, $matches)) {
545                continue;
546            }
547            $file_path = $dir . $file_name;
548            $table = $matches[1];
549
550            // テーブル存在チェック
551            if (!in_array($table, $arrAllTableList)) {
552                if ($mode === 'restore_config') {
553                    continue;
554                }
555                return false;
556            }
557
558            // csvファイルからデータの取得
559            $fp = fopen($file_path, 'r');
560            if ($fp === false) {
561                trigger_error($file_name . ' のファイルオープンに失敗しました。', E_USER_ERROR);
562            }
563
564            GC_Utils_Ex::gfPrintLog('リストア実行: ' . $table);
565            $objQuery->delete($table);
566
567            $line = 0;
568            $arrColName = array();
569            while (!feof($fp)) {
570                $line++;
571                $arrCsvLine = fgetcsv($fp, 1024 * 1024);
572
573                // 1行目: 列名
574                if ($line === 1) {
575                    $arrColName = $arrCsvLine;
576                    continue;
577                }
578
579                // 空行を無視
580                // false との比較は PHP 5.2.x Windows バグ対応
581                // 参考: http://www.php.net/manual/ja/function.fgetcsv.php#98502
582                if ($arrCsvLine === array(null) || $arrCsvLine === false) {
583                    continue;
584                }
585
586                $arrVal = array_combine($arrColName, $arrCsvLine);
587                $objQuery->insert($table, $arrVal);
588
589                SC_Utils_Ex::extendTimeOut();
590            }
591
592            fclose($fp);
593        }
594
595        return $ret;
596    }
597
598    /**
599     * シーケンス生成器を復元する
600     */
601    function restoreSequence(&$objQuery, $csv) {
602        // csvファイルからデータの取得
603        $arrCsvData = file($csv);
604
605        foreach ($arrCsvData as $line) {
606            list($name, $currval) = explode(',', trim($line));
607
608            if (in_array($name, $this->arrExcludeSequence, true)) {
609                continue 1;
610            }
611
612            // FIXME テーブルと同様に整合チェックを行う。また不整合時はスキップして続行する。
613
614            // XXX +1 ではなく、nextVal を呼ぶべきかも。
615            $objQuery->setVal($name, $currval + 1);
616        }
617    }
618
619    // 選択したバックアップをDBから削除
620    function lfDeleteBackUp(&$arrForm, $bkup_dir, $bkup_ext) {
621
622        $objQuery =& SC_Query_Ex::getSingletonInstance();
623
624        $del_file = $bkup_dir.$arrForm['list_name'] . $bkup_ext;
625        // ファイルの削除
626        if (is_file($del_file)) {
627            $ret = unlink($del_file);
628        }
629
630        $delsql = 'DELETE FROM dtb_bkup WHERE bkup_name = ?';
631        $objQuery->delete('dtb_bkup', 'bkup_name = ?', array($arrForm['list_name']));
632
633    }
634
635}
Note: See TracBrowser for help on using the repository browser.