Compare commits
4 Commits
master
...
bkcsoft/re
| Author | SHA1 | Date |
|---|---|---|
Kim "BKC" Carlbäcker
|
b0c7a3bb5c | 7 years ago |
|
Kim "BKC" Carlbäcker
|
77ef39112d | 7 years ago |
|
Kim "BKC" Carlbäcker
|
8c708202b6 | 7 years ago |
|
Kim "BKC" Carlbäcker
|
3e61f49da4 | 7 years ago |
@ -0,0 +1,3 @@ |
||||
title: Implement proper `gitea restore` & `gitea backup`. Deprecating `gitea dump` |
||||
kind: feature |
||||
pull_request: 1637 |
||||
@ -0,0 +1,197 @@ |
||||
// Copyright 2017 the Gitea Authors. All rights reserved.
|
||||
// Copyright 2017 The Gogs Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package cmd |
||||
|
||||
import ( |
||||
"fmt" |
||||
"io/ioutil" |
||||
"os" |
||||
"path" |
||||
"runtime/debug" |
||||
"time" |
||||
|
||||
"github.com/Unknwon/cae/zip" |
||||
"github.com/Unknwon/com" |
||||
"github.com/urfave/cli" |
||||
"gopkg.in/ini.v1" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/log" |
||||
"code.gitea.io/gitea/modules/setting" |
||||
) |
||||
|
||||
// Backup files and database
|
||||
var Backup = cli.Command{ |
||||
Name: "backup", |
||||
Usage: "Backup files and database", |
||||
Description: `Backup dumps and compresses all related files and database into zip file, |
||||
which can be used for migrating Gitea to another server. The output format is meant to be |
||||
portable among all supported database engines.`, |
||||
Action: runBackup, |
||||
Flags: []cli.Flag{ |
||||
cli.StringFlag{ |
||||
Name: "config, c", |
||||
Value: "custom/conf/app.ini", |
||||
Usage: "Custom configuration `FILE` path", |
||||
}, |
||||
cli.StringFlag{ |
||||
Name: "tempdir, t", |
||||
Value: os.TempDir(), |
||||
Usage: "Temporary directory `PATH`", |
||||
}, |
||||
cli.StringFlag{ |
||||
Name: "target", |
||||
Value: "./", |
||||
Usage: "Target directory `PATH` to save backup archive", |
||||
}, |
||||
cli.BoolFlag{ |
||||
Name: "verbose, v", |
||||
Usage: "Show process details", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "db", |
||||
Usage: "Backup the database (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "repos", |
||||
Usage: "Backup repositories (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "data", |
||||
Usage: "Backup attachments and avatars (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "custom", |
||||
Usage: "Backup custom files (default: true)", |
||||
}, |
||||
}, |
||||
} |
||||
|
||||
const ( |
||||
archiveRootDir = "gitea-backup" |
||||
backupVersion = 1 |
||||
) |
||||
|
||||
func runBackup(c *cli.Context) error { |
||||
zip.Verbose = c.Bool("verbose") |
||||
if c.IsSet("config") { |
||||
setting.CustomConf = c.String("config") |
||||
} |
||||
setting.NewContext() |
||||
models.LoadConfigs() |
||||
if err := models.SetEngine(); err != nil { |
||||
return err |
||||
} |
||||
|
||||
// Setup temp-dir
|
||||
tmpDir := c.String("tempdir") |
||||
if !com.IsExist(tmpDir) { |
||||
log.Fatal(0, "'--tempdir' does not exist: %s", tmpDir) |
||||
} |
||||
rootDir, err := ioutil.TempDir(tmpDir, "gitea-backup-") |
||||
if err != nil { |
||||
log.Fatal(0, "Fail to create backup root directory '%s': %v", rootDir, err) |
||||
} |
||||
defer func(rootDir string) { |
||||
os.RemoveAll(rootDir) |
||||
}(rootDir) |
||||
log.Info("Backup root directory: %s", rootDir) |
||||
|
||||
// Metadata
|
||||
metaFile := path.Join(rootDir, "metadata.ini") |
||||
metadata := ini.Empty() |
||||
metadata.Section("").Key("VERSION").SetValue(fmt.Sprintf("%d", backupVersion)) |
||||
metadata.Section("").Key("DATE_TIME").SetValue(time.Now().String()) |
||||
metadata.Section("").Key("GITEA_VERSION").SetValue(setting.AppVer) |
||||
if err = metadata.SaveTo(metaFile); err != nil { |
||||
log.Fatal(0, "Fail to save metadata '%s': %v", metaFile, err) |
||||
} |
||||
|
||||
// Create ZIP-file
|
||||
archiveName := path.Join(c.String("target"), fmt.Sprintf("gitea-backup-%d.zip", time.Now().Unix())) |
||||
log.Info("Packing backup files to: %s", archiveName) |
||||
|
||||
z, err := zip.Create(archiveName) |
||||
if err != nil { |
||||
log.Fatal(0, "Fail to create backup archive '%s': %v", archiveName, err) |
||||
} |
||||
defer func(archiveName string) { |
||||
if r := recover(); r != nil { |
||||
var ok bool |
||||
err, ok = r.(error) |
||||
if !ok { |
||||
err = fmt.Errorf("pkg: %v", r) |
||||
} |
||||
debug.PrintStack() |
||||
log.Info("Removing partial backup-file %s\n", archiveName) |
||||
os.Remove(archiveName) |
||||
log.Fatal(9, "%v\n", err) |
||||
} |
||||
}(archiveName) |
||||
|
||||
// Add metadata-file
|
||||
if err = z.AddFile(archiveRootDir+"/metadata.ini", metaFile); err != nil { |
||||
log.Fatal(0, "Fail to include 'metadata.ini': %v", err) |
||||
} |
||||
|
||||
// Database
|
||||
if c.Bool("db") { |
||||
log.Info("Backing up database") |
||||
dbDir := path.Join(rootDir, "db") |
||||
if err = models.DumpDatabase(dbDir); err != nil { |
||||
log.Fatal(0, "Fail to dump database: %v", err) |
||||
} |
||||
if err = z.AddDir(archiveRootDir+"/db", dbDir); err != nil { |
||||
log.Fatal(0, "Fail to include 'db': %v", err) |
||||
} |
||||
} |
||||
|
||||
// Custom files
|
||||
if c.Bool("custom") { |
||||
log.Info("Backing up custom files") |
||||
if err = z.AddDir(archiveRootDir+"/custom", setting.CustomPath); err != nil { |
||||
log.Fatal(0, "Fail to include 'custom': %v", err) |
||||
} |
||||
} |
||||
|
||||
// Data files
|
||||
if c.Bool("data") { |
||||
log.Info("Backing up attachments and avatars") |
||||
for _, dir := range []string{"attachments", "avatars"} { |
||||
dirPath := path.Join(setting.AppDataPath, dir) |
||||
if !com.IsDir(dirPath) { |
||||
continue |
||||
} |
||||
|
||||
if err = z.AddDir(path.Join(archiveRootDir+"/data", dir), dirPath); err != nil { |
||||
log.Fatal(0, "Fail to include 'data': %v", err) |
||||
} |
||||
} |
||||
} |
||||
|
||||
// Repositories
|
||||
if c.Bool("repos") { |
||||
log.Info("Backing up repositories") |
||||
reposDump := path.Join(rootDir, "repositories.zip") |
||||
log.Info("Dumping repositories in '%s'", setting.RepoRootPath) |
||||
if err = zip.PackTo(setting.RepoRootPath, reposDump, true); err != nil { |
||||
log.Fatal(0, "Fail to dump repositories: %v", err) |
||||
} |
||||
log.Info("Repositories dumped to: %s", reposDump) |
||||
|
||||
if err = z.AddFile(archiveRootDir+"/repositories.zip", reposDump); err != nil { |
||||
log.Fatal(0, "Fail to include 'repositories.zip': %v", err) |
||||
} |
||||
} |
||||
|
||||
if err = z.Close(); err != nil { |
||||
log.Fatal(0, "Fail to save backup archive '%s': %v", archiveName, err) |
||||
} |
||||
|
||||
os.RemoveAll(rootDir) |
||||
log.Info("Backup succeed! Archive is located at: %s", archiveName) |
||||
return nil |
||||
} |
||||
@ -0,0 +1,166 @@ |
||||
// Copyright 2017 The Gogs Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package cmd |
||||
|
||||
import ( |
||||
"os" |
||||
"path" |
||||
|
||||
"github.com/Unknwon/cae/zip" |
||||
"github.com/Unknwon/com" |
||||
"github.com/mcuadros/go-version" |
||||
"github.com/urfave/cli" |
||||
"gopkg.in/ini.v1" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/log" |
||||
"code.gitea.io/gitea/modules/setting" |
||||
) |
||||
|
||||
// Restore a backup
|
||||
var Restore = cli.Command{ |
||||
Name: "restore", |
||||
Usage: "Restore files and database from backup", |
||||
Description: `Restore imports all related files and database from a backup archive. |
||||
The backup version must lower or equal to current Gitea version. You can also import |
||||
backup from other database engines, which is useful for database migrating. |
||||
|
||||
If corresponding files or database tables are not presented in the archive, they will |
||||
be skipped and remian unchanged.`, |
||||
Action: runRestore, |
||||
Flags: []cli.Flag{ |
||||
cli.StringFlag{ |
||||
Name: "config, c", |
||||
Value: "custom/conf/app.ini", |
||||
Usage: "Custom configuration file path", |
||||
}, |
||||
cli.StringFlag{ |
||||
Name: "tempdir, t", |
||||
Value: os.TempDir(), |
||||
Usage: "Temporary directory path", |
||||
}, |
||||
cli.StringFlag{ |
||||
Name: "from", |
||||
Value: "", |
||||
Usage: "Path to backup archive", |
||||
}, |
||||
cli.BoolFlag{ |
||||
Name: "verbose, v", |
||||
Usage: "Show process details", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "repos", |
||||
Usage: "Restore repositories (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "data", |
||||
Usage: "Restore attachments and avatars (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "custom", |
||||
Usage: "Restore custom files (default: true)", |
||||
}, |
||||
cli.BoolTFlag{ |
||||
Name: "db", |
||||
Usage: "Restore database (default: true)", |
||||
}, |
||||
}, |
||||
} |
||||
|
||||
func runRestore(c *cli.Context) error { |
||||
zip.Verbose = c.Bool("verbose") |
||||
|
||||
tmpDir := c.String("tempdir") |
||||
if !com.IsExist(tmpDir) { |
||||
log.Fatal(0, "'--tempdir' does not exist: %s", tmpDir) |
||||
} |
||||
|
||||
log.Info("Restore backup from: %s", c.String("from")) |
||||
if err := zip.ExtractTo(c.String("from"), tmpDir); err != nil { |
||||
log.Fatal(0, "Fail to extract backup archive: %v", err) |
||||
} |
||||
archivePath := path.Join(tmpDir, archiveRootDir) |
||||
|
||||
// Check backup version
|
||||
metaFile := path.Join(archivePath, "metadata.ini") |
||||
if !com.IsExist(metaFile) { |
||||
log.Fatal(0, "File 'metadata.ini' is missing") |
||||
} |
||||
metadata, err := ini.Load(metaFile) |
||||
if err != nil { |
||||
log.Fatal(0, "Fail to load metadata '%s': %v", metaFile, err) |
||||
} |
||||
ver := metadata.Section("").Key("VERSION").MustInt(10000000) |
||||
if ver != backupVersion { |
||||
log.Fatal(0, "Current Backup version does not match the version in the backup: %d != %d", ver, backupVersion) |
||||
} |
||||
backupVersion := metadata.Section("").Key("GITEA_VERSION").MustString("999.0") |
||||
if version.Compare(setting.AppVer, backupVersion, "<") { |
||||
log.Fatal(0, "Current Gitea version is lower than backup version: %s < %s", setting.AppVer, backupVersion) |
||||
} |
||||
|
||||
// If config file is not present in backup, user must set this file via flag.
|
||||
// Otherwise, it's optional to set config file flag.
|
||||
configFile := path.Join(archivePath, "custom/conf/app.ini") |
||||
if c.IsSet("config") { |
||||
setting.CustomConf = c.String("config") |
||||
} else if !com.IsExist(configFile) { |
||||
log.Fatal(0, "'--config' is not specified and custom config file is not found in backup") |
||||
} else { |
||||
setting.CustomConf = configFile |
||||
} |
||||
setting.NewContext() |
||||
models.LoadConfigs() |
||||
models.SetEngine() |
||||
|
||||
// Database
|
||||
if c.Bool("db") { |
||||
dbDir := path.Join(archivePath, "db") |
||||
if err = models.ImportDatabase(dbDir); err != nil { |
||||
log.Fatal(0, "Fail to import database: %v", err) |
||||
} |
||||
} |
||||
|
||||
// Custom files
|
||||
if c.Bool("custom") { |
||||
if com.IsExist(setting.CustomPath) { |
||||
if err = os.Rename(setting.CustomPath, setting.CustomPath+".bak"); err != nil { |
||||
log.Fatal(0, "Fail to backup current 'custom': %v", err) |
||||
} |
||||
} |
||||
if err = os.Rename(path.Join(archivePath, "custom"), setting.CustomPath); err != nil { |
||||
log.Fatal(0, "Fail to import 'custom': %v", err) |
||||
} |
||||
} |
||||
|
||||
// Data files
|
||||
if c.Bool("data") { |
||||
for _, dir := range []string{"attachments", "avatars"} { |
||||
dirPath := path.Join(setting.AppDataPath, dir) |
||||
if com.IsExist(dirPath) { |
||||
if err = os.Rename(dirPath, dirPath+".bak"); err != nil { |
||||
log.Fatal(0, "Fail to backup current 'data': %v", err) |
||||
} |
||||
} |
||||
if err = os.Rename(path.Join(archivePath, "data", dir), dirPath); err != nil { |
||||
log.Fatal(0, "Fail to import 'data': %v", err) |
||||
} |
||||
} |
||||
} |
||||
|
||||
// Repositories
|
||||
if c.Bool("repos") { |
||||
reposPath := path.Join(archivePath, "repositories.zip") |
||||
if !c.Bool("exclude-repos") && !c.Bool("database-only") && com.IsExist(reposPath) { |
||||
if err := zip.ExtractTo(reposPath, path.Dir(setting.RepoRootPath)); err != nil { |
||||
log.Fatal(0, "Fail to extract 'repositories.zip': %v", err) |
||||
} |
||||
} |
||||
} |
||||
|
||||
os.RemoveAll(path.Join(tmpDir, archiveRootDir)) |
||||
log.Info("Restore succeed!") |
||||
return nil |
||||
} |
||||
Loading…
Reference in new issue