org.dromara.jpom.controller.system.BackupInfoController Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2019 Code Technology Studio
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.dromara.jpom.controller.system;
import cn.hutool.core.collection.CollStreamUtil;
import cn.hutool.core.io.FileUtil;
import cn.hutool.core.text.UnicodeUtil;
import cn.hutool.core.util.ClassUtil;
import cn.hutool.core.util.IdUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.crypto.SecureUtil;
import cn.hutool.extra.servlet.ServletUtil;
import cn.hutool.http.ContentType;
import cn.keepbx.jpom.IJsonMessage;
import cn.keepbx.jpom.model.JsonMessage;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.dromara.jpom.common.BaseServerController;
import org.dromara.jpom.common.validator.ValidatorItem;
import org.dromara.jpom.common.validator.ValidatorRule;
import org.dromara.jpom.db.DbExtConfig;
import org.dromara.jpom.db.StorageServiceFactory;
import org.dromara.jpom.db.TableName;
import org.dromara.jpom.model.PageResultDto;
import org.dromara.jpom.model.data.BackupInfoModel;
import org.dromara.jpom.model.enums.BackupStatusEnum;
import org.dromara.jpom.model.enums.BackupTypeEnum;
import org.dromara.jpom.permission.ClassFeature;
import org.dromara.jpom.permission.Feature;
import org.dromara.jpom.permission.MethodFeature;
import org.dromara.jpom.permission.SystemPermission;
import org.dromara.jpom.service.dblog.BackupInfoService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.util.Assert;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.util.*;
import java.util.stream.Collectors;
/**
* 数据库备份 controller
*
* @author Hotstrip
* @since 2021-11-18
*/
@RestController
@Feature(cls = ClassFeature.SYSTEM_BACKUP)
@SystemPermission
@ConditionalOnProperty(prefix = "jpom.db", name = "mode", havingValue = "H2", matchIfMissing = true)
@Slf4j
public class BackupInfoController extends BaseServerController {
/**
* 存储数据库表名称和别名的变量
*/
private static Map TABLE_NAME_MAP = new HashMap<>();
private final BackupInfoService backupInfoService;
public BackupInfoController(BackupInfoService backupInfoService) {
this.backupInfoService = backupInfoService;
}
/**
* 分页加载备份列表数据
*
* @return json
*/
@PostMapping(value = "/system/backup/list")
@Feature(method = MethodFeature.LIST)
public Object loadBackupList(HttpServletRequest request) {
// 查询数据库
PageResultDto pageResult = backupInfoService.listPage(request);
pageResult.each(backupInfoModel -> backupInfoModel.setFileExist(FileUtil.exist(backupInfoModel.getFilePath())));
return JsonMessage.success("获取成功", pageResult);
}
/**
* 删除备份数据
*
* @param id 备份 ID
* @return json
*/
@PostMapping(value = "/system/backup/delete")
@Feature(method = MethodFeature.DEL)
@SystemPermission(superUser = true)
public IJsonMessage deleteBackup(@ValidatorItem(value = ValidatorRule.NOT_BLANK, msg = "数据 id 不能为空") String id) {
// 删除备份信息
backupInfoService.delByKey(id);
return new JsonMessage<>(200, "删除成功");
}
/**
* 还原备份数据
* 还原的时候不能异步了，只能等待备份还原成功或者失败
*
* @param id 备份 ID
* @return json
*/
@PostMapping(value = "/system/backup/restore")
@Feature(method = MethodFeature.EXECUTE)
public IJsonMessage restoreBackup(@ValidatorItem(value = ValidatorRule.NOT_BLANK, msg = "数据 id 不能为空") String id) {
// 根据 id 查询备份信息
BackupInfoModel backupInfoModel = backupInfoService.getByKey(id);
Objects.requireNonNull(backupInfoModel, "备份数据不存在");
// 检查备份文件是否存在
String filePath = backupInfoModel.getFilePath();
File file = new File(filePath);
if (!FileUtil.exist(file)) {
return new JsonMessage<>(400, "备份文件不存在");
}
// 清空 sql 加载记录
StorageServiceFactory.clearExecuteSqlLog();
// 还原备份文件
boolean flag = backupInfoService.restoreWithSql(filePath);
if (flag) {
// 还原备份数据成功之后需要修改当前备份信息的状态（因为备份的时候该备份信息状态是备份中）
this.fuzzyUpdate(SecureUtil.sha1(file));
return new JsonMessage<>(200, "还原备份数据成功");
}
return new JsonMessage<>(400, "还原备份数据失败");
}
/**
* 模糊更新
*
* @param sha1 文件签名
*/
private void fuzzyUpdate(String sha1) {
BackupInfoModel where = new BackupInfoModel();
where.setStatus(BackupStatusEnum.DEFAULT.getCode());
List list = backupInfoService.listByBean(where);
Optional.ofNullable(list).ifPresent(backupInfoModels -> {
for (BackupInfoModel backupInfoModel : backupInfoModels) {
String filePath = backupInfoModel.getFilePath();
if (!FileUtil.exist(filePath)) {
continue;
}
File file = FileUtil.file(filePath);
if (StrUtil.equals(SecureUtil.sha1(file), sha1)) {
// 是同一个文件
BackupInfoModel update = new BackupInfoModel();
update.setId(backupInfoModel.getId());
update.setFileSize(FileUtil.size(file));
update.setStatus(BackupStatusEnum.SUCCESS.getCode());
update.setSha1Sum(sha1);
int updateCount = backupInfoService.updateById(update);
log.debug("更新还原数据：{}", updateCount);
}
}
});
}
/**
* 创建备份任务
*
* @param map 参数 map.tableNameList 选中备份的表名称
* @return json
*/
@PostMapping(value = "/system/backup/create")
@Feature(method = MethodFeature.EDIT)
public IJsonMessage backup(@RequestBody Map map) {
List tableNameList = JSON.parseArray(JSON.toJSONString(map.get("tableNameList")), String.class);
backupInfoService.backupToSql(tableNameList);
return new JsonMessage<>(200, "操作成功，请稍后刷新查看备份状态");
}
/**
* 导入备份数据
*
* @return json
*/
@PostMapping(value = "/system/backup/upload")
@Feature(method = MethodFeature.UPLOAD)
@SystemPermission(superUser = true)
public IJsonMessage uploadBackupFile(MultipartFile file) throws IOException {
String originalFilename = file.getOriginalFilename();
String extName = FileUtil.extName(originalFilename);
Assert.state(StrUtil.containsAnyIgnoreCase(extName, "sql"), "不支持的文件类型：" + extName);
String saveFileName = UnicodeUtil.toUnicode(originalFilename);
saveFileName = saveFileName.replace(StrUtil.BACKSLASH, "_");
// 存储目录
File directory = FileUtil.file(StorageServiceFactory.dbLocalPath(), DbExtConfig.BACKUP_DIRECTORY_NAME);
// 生成唯一id
String format = String.format("%s_%s", IdUtil.fastSimpleUUID(), saveFileName);
format = StrUtil.maxLength(format, 40);
File backupSqlFile = FileUtil.file(directory, format + "." + extName);
FileUtil.mkParentDirs(backupSqlFile);
file.transferTo(backupSqlFile);
// 记录到数据库
String sha1Sum = SecureUtil.sha1(backupSqlFile);
BackupInfoModel backupInfoModel = new BackupInfoModel();
backupInfoModel.setSha1Sum(sha1Sum);
boolean exists = backupInfoService.exists(backupInfoModel);
if (exists) {
FileUtil.del(backupSqlFile);
return new JsonMessage<>(400, "导入的数据已经存在啦");
}
backupInfoModel.setName(backupSqlFile.getName());
backupInfoModel.setBackupType(BackupTypeEnum.IMPORT.getCode());
backupInfoModel.setStatus(BackupStatusEnum.SUCCESS.getCode());
backupInfoModel.setFileSize(FileUtil.size(backupSqlFile));
backupInfoModel.setSha1Sum(sha1Sum);
backupInfoModel.setFilePath(FileUtil.getAbsolutePath(backupSqlFile));
backupInfoService.insert(backupInfoModel);
return new JsonMessage<>(200, "导入成功");
}
/**
* 下载备份数据
*
* @param id 备份 ID
*/
@GetMapping(value = "/system/backup/download")
@Feature(method = MethodFeature.DOWNLOAD)
public void downloadBackup(@ValidatorItem(value = ValidatorRule.NOT_BLANK, msg = "数据 id 不能为空") String id, HttpServletResponse response) {
// 根据 id 查询备份信息
BackupInfoModel backupInfoModel = backupInfoService.getByKey(id);
Objects.requireNonNull(backupInfoModel, "备份数据不存在");
// 检查备份文件是否存在
File file = new File(backupInfoModel.getFilePath());
if (!FileUtil.exist(file)) {
//log.error("文件不存在，无法下载...backupId: {}", id);
ServletUtil.write(response, JsonMessage.getString(404, "文件不存在，无法下载"), ContentType.JSON.toString());
return;
}
// 下载文件
ServletUtil.write(response, file);
}
/**
* 读取数据库表名称列表
*
* @return json
*/
@PostMapping(value = "/system/backup/table-name-list")
@Feature(method = MethodFeature.LIST)
public IJsonMessage> loadTableNameList() {
// 从数据库加载表名称列表
List tableNameList = backupInfoService.h2TableNameList();
// 扫描程序，拿到表名称和别名
if (TABLE_NAME_MAP.isEmpty()) {
Set> classes = ClassUtil.scanPackageByAnnotation("org.dromara.jpom", TableName.class);
TABLE_NAME_MAP = CollStreamUtil.toMap(classes, aClass -> {
TableName tableName = aClass.getAnnotation(TableName.class);
return tableName.value();
}, aClass -> {
TableName tableName = aClass.getAnnotation(TableName.class);
return tableName.name();
});
}
List list = tableNameList.stream().map(s -> {
JSONObject jsonObject = new JSONObject();
jsonObject.put("tableName", s);
jsonObject.put("tableDesc", StrUtil.emptyToDefault(TABLE_NAME_MAP.get(s), s));
return jsonObject;
}).collect(Collectors.toList());
return new JsonMessage<>(200, "", list);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy