yhkylin-backup-tools/common/utils.cpp

794 lines
24 KiB
C++
Raw Normal View History

2021-08-06 10:20:03 +08:00
#include "utils.h"
#include <QByteArray>
#include <QDateTime>
#include <QFile>
#include <QTextStream>
#include <QDir>
#include <QRegularExpression>
2021-08-17 10:07:35 +08:00
#include <QThread>
2021-08-24 18:08:18 +08:00
#include <QUuid>
2021-08-06 10:20:03 +08:00
#include <iostream>
#include <unistd.h>
#include <fcntl.h>
#include <sys/file.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <memory>
#include <functional>
#include <QRegularExpression>
2021-10-13 16:31:58 +08:00
#include <QProcess>
2021-08-06 10:20:03 +08:00
#include "mylittleparse.h"
2021-08-24 18:08:18 +08:00
#include "mydefine.h"
2021-08-06 10:20:03 +08:00
QString Utils::m_sysRootPath = "/";
/**
* @brief initSysRootPath,
* @param qsAppPath
* @note
* /usr/bin中
* 1. grub引导中根目录为/root
* 2. livecd中根目录为/target
* 3. 使/
*/
void Utils::initSysRootPath(const QString& qsAppPath)
{
QString sysRootPath = qsAppPath;
if (sysRootPath.contains(DEFAULT_APP_PATH)) {
sysRootPath.replace(DEFAULT_APP_PATH, "/");
} else {
sysRootPath = "/";
}
m_sysRootPath = sysRootPath;
}
/**
* @brief customMessageHandler
* @param type debug等
* @param context
* @param msg
*/
void Utils::customMessageHandler(QtMsgType type, const QMessageLogContext& context, const QString& msg)
{
QByteArray localMsg = msg.toLocal8Bit();
QString strMsg("");
switch (type) {
case QtDebugMsg:
strMsg = QString("[Debug]");
break;
case QtWarningMsg:
strMsg = QString("[Warning]");
break;
case QtCriticalMsg:
strMsg = QString("[Critical]");
break;
case QtFatalMsg:
strMsg = QString("[Fatal]");
break;
default:
strMsg = QString("[Debug]");
break;
}
// 设置输出信息格式
QString strDateTime = QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss ddd");
2021-08-17 10:07:35 +08:00
QString strMessage = strMsg + QString("DateTime:%1 ThreadId:%2 Message:%3 File:%4(%5)")
.arg(strDateTime).arg(QString::number(quintptr(QThread::currentThreadId()))).arg(localMsg.constData()).arg(context.file).arg(context.line);
2021-08-06 10:20:03 +08:00
std::cout << strMessage.toUtf8().data() << std::endl;
// 输出信息至文件中(读写、追加形式)
2021-08-17 10:07:35 +08:00
QString fileName = m_sysRootPath + PROC_LOG;
2021-08-06 10:20:03 +08:00
fileName.replace("//", "/");
QFile file(fileName);
file.open(QIODevice::ReadWrite | QIODevice::Append);
QTextStream stream(&file);
stream << strMessage << endl;
2021-08-24 18:08:18 +08:00
stream.flush();
2021-08-06 10:20:03 +08:00
file.close();
}
/**
* @brief
* @param frontUidid
* @return
* @note 使QLockFile
* /tmp/lock路径下的锁文件xx程序在运行不允许关机等
*/
int Utils::lockProgram(int frontUid)
{
2021-08-17 10:07:35 +08:00
QDir dir(LOCK_FILE_PATH);
2021-08-06 10:20:03 +08:00
if (!dir.exists()) {
2021-08-17 10:07:35 +08:00
dir.mkdir(LOCK_FILE_PATH);
chmod(LOCK_FILE_PATH, S_IRWXU | S_IRWXG | S_IRWXO);
2021-08-06 10:20:03 +08:00
}
int lock_file_fd = ::open(LOCK_FILE, O_CREAT | O_RDWR, 0666);
if (0 > lock_file_fd) {
return -2;
}
fchmod(lock_file_fd, S_IRWXU | S_IRWXG | S_IRWXO);
int lock_ret = flock(lock_file_fd, LOCK_EX | LOCK_NB);
if (0 > lock_ret) {
return -11;
}
ftruncate(lock_file_fd, 0);
char write_string[PID_STRING_LEN] = { 0 };
snprintf(write_string, PID_STRING_LEN, "%d\n%s\n", frontUid, BACKUP_CLI_NAME);
write(lock_file_fd, write_string, strlen(write_string));
fdatasync(lock_file_fd);
return lock_file_fd;
}
/**
* @brief
* @param lock_file_fd
* @return 01
*/
int Utils::unLockProgram(int lock_file_fd)
{
int lock_ret = flock(lock_file_fd, LOCK_UN);
if (lock_ret < 0) {
qCritical("unlock fail!");
return 1;
}
qDebug("unlock success!");
rmLockFile();
return 0;
}
/**
* @brief
* @return bool
*/
bool Utils::rmLockFile()
{
bool res = QFile::remove(LOCK_FILE);
if (!res)
qCritical() << QString("remove %s fail").arg(LOCK_FILE);
return res;
}
/**
* @brief /etc/.bootinfo是否存在并可读UUID等信息
* @return bool
*/
bool Utils::checkBootInfoExists()
{
QString bootinfoPath = Utils::m_sysRootPath + BOOTINFO_PATH;
bootinfoPath.replace("//", "/");
QFile bootinfoFile(bootinfoPath);
if (!bootinfoFile.exists()) {
qCritical("%s is not exists!", qUtf8Printable(bootinfoPath));
return false;
}
if (!bootinfoFile.open(QIODevice::ReadOnly)) {
qCritical("%s file can't open!", qUtf8Printable(bootinfoPath));
return false;
}
bootinfoFile.close();
return true;
}
/**
* @brief UUID
2021-08-17 10:07:35 +08:00
* @return UUID
2021-08-06 10:20:03 +08:00
*/
QString Utils::getBackupPartitionUuid()
{
QString bootinfoPath = Utils::m_sysRootPath + BOOTINFO_PATH;
bootinfoPath.replace("//", "/");
MyLittleParse parse(bootinfoPath);
QString restoreUuid;
parse.find("RECOVERY_DEV_UUID", restoreUuid);
2021-08-24 18:08:18 +08:00
if (restoreUuid.isEmpty()) {
QString fstab = Utils::m_sysRootPath + FSTAB_PATH;
fstab.replace("//", "/");
QFile file(fstab);
if (file.exists()) {
if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
QTextStream in(&file);
2021-10-26 09:24:05 +08:00
QString preLine;
2021-08-24 18:08:18 +08:00
while (!in.atEnd()) {
QString line = in.readLine();
if (line.startsWith("UUID=") && line.contains("/backup")) {
2021-10-26 09:24:05 +08:00
// like:
// # /dev/add4 LABEL=KYLIN-BACKUP
// UUID=40be1cac-cd92-49db-8a98-68ee21ddbc49 /backup ext4 noauto 0 0
2021-08-24 18:08:18 +08:00
int indexOfSpace = line.indexOf(QRegularExpression("[ \t]"), 0);
QString uuid = line.mid(0, indexOfSpace);
uuid.replace("UUID=", "");
restoreUuid = uuid.trimmed();
2021-10-26 09:24:05 +08:00
parse.Add("RECOVERY_DEV_UUID", restoreUuid);
2021-08-24 18:08:18 +08:00
break ;
2021-10-26 09:24:05 +08:00
} else if (line.startsWith("/dev/") && line.contains("/backup")) {
// like:
// # UUID=40be1cac-cd92-49db-8a98-68ee21ddbc49 LABEL=KYLIN-BACKUP
// /dev/add4 /backup ext4 noauto 0 0
if (preLine.startsWith("#") && preLine.contains("UUID=")) {
preLine.replace("# ", "");
preLine.replace("#", "");
int indexOfSpace = preLine.indexOf(QRegularExpression("[ \t]"), 0);
QString uuid = preLine.mid(0, indexOfSpace);
uuid.replace("UUID=", "");
restoreUuid = uuid.trimmed();
parse.Add("RECOVERY_DEV_UUID", restoreUuid);
break ;
}
2021-08-24 18:08:18 +08:00
}
2021-10-26 09:24:05 +08:00
preLine = line;
2021-08-24 18:08:18 +08:00
}
}
}
}
2021-08-06 10:20:03 +08:00
return restoreUuid;
}
/**
* @brief
* @param path
*/
void Utils::mkdir(const QString& path)
{
QDir dir(path);
if (!dir.exists())
dir.mkdir(path);
}
/**
* @brief
* @param path
* @return bool
*/
bool Utils::mkpath(const QString& path)
{
QDir dir(path);
if (!dir.exists()) {
return dir.mkpath(path);
}
return true;
}
/**
* @brief
* @param excludes
*/
void Utils::excludeFstabBindPath(QStringList &excludes)
{
QString fstabPath = Utils::m_sysRootPath + FSTAB_PATH;
fstabPath.replace("//", "/");
QFile file(fstabPath);
if (!file.open(QIODevice::ReadOnly))
return;
QTextStream in(&file);
while (!in.atEnd()) {
const QString &line = in.readLine();
if (line.startsWith("#"))
continue ;
if (line.startsWith("UUID="))
continue ;
2021-09-16 16:05:46 +08:00
if (line.startsWith("/dev/"))
continue ;
2021-08-06 10:20:03 +08:00
if (line.isEmpty())
continue ;
if (!line.contains("bind"))
continue ;
// 配置文件/etc/fstab每行6个域: <file system> <mount point> <type> <options> <dump> <pass>, 形如:
// UUID=232f5fb4-53e0-46b9-ba9b-22bfec64f2a2 /boot ext4 rw,relatime 0 0
QStringList list = line.split(QRegularExpression("[ \t]"));
QStringList fields;
for (int i = 0; i < list.size(); ++i) {
QString field = list.at(i);
field = field.trimmed();
if (field.isEmpty())
continue;
fields << field;
}
2021-09-16 16:05:46 +08:00
// 配置文件/etc/fstab每行6个域第二个域为挂载路径, 第一个域就是待排除路径
2021-08-06 10:20:03 +08:00
if (6 == fields.size())
2021-09-16 16:05:46 +08:00
excludes << fields.at(0);
2021-08-06 10:20:03 +08:00
}
file.close();
}
/**
2021-08-17 10:07:35 +08:00
* @brief rsync --exclude-from排除路径规则文件
2021-08-06 10:20:03 +08:00
* @return
*/
bool Utils::generateExcludePathsFile()
{
QString excludeFile = Utils::m_sysRootPath + EXCLUDE_FILE_PATH;
excludeFile.replace("//", "/");
QFile excludePathFile(excludeFile);
// 暂时改为每次都重写文件内容,以便能随版本更新排除路径
if (!excludePathFile.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
qCritical("%s create failed", qUtf8Printable(excludeFile));
return false;
}
QTextStream in(&excludePathFile);
in << "/backup" << endl; //分区
2021-09-16 16:05:46 +08:00
// in << "/boot/efi" << endl;
2021-08-17 10:07:35 +08:00
in << "/cdrom" << endl;
in << "/dev" << endl;
2021-08-06 10:20:03 +08:00
// efi原始目录在/boot/efi备份到目标目录为/efi下再还原时已经单独处理了批量还原时应该屏蔽此目录
in << "/efi" << endl;
// 安全模块会将文件/usr/share/kysec-utils/data/readonly_list中的文件列表限制只读无法修改、备份包含扩展属性时、删除等
// 现在里面仅有/etc/uid_list先暂时排除掉等后续安全模块有其它保护方案后再进一步修改
in << "/etc/uid_list" << endl;
2021-08-17 10:07:35 +08:00
in << "/ghost" << endl; //ghost镜像文件
in << "/lost+found" << endl;
in << "/media" << endl;
in << "/mnt" << endl;
in << "/proc" << endl;
in << "/run" << endl;
in << "/swap_file" << endl;
in << "/sys" << endl; //添加*(/sys/*),表示如果/sys目录不存在则会拷贝/sys但不会拷贝/sys下的内容
in << "/tmp" << endl;
2021-08-19 19:24:49 +08:00
in << "/var/lib/docker/overlay2" << endl;
2021-08-06 10:20:03 +08:00
// 安卓兼容的这个里面很多文件都是设置了特殊扩展文件属性lsetxattr无法设置成功听取安卓兼容模块同事的意见不用管这个文件夹其实是从home下挂载的
in << "/var/lib/kmre" << endl;
2021-08-17 10:07:35 +08:00
in << "/var/lib/udisks2" << endl;
2021-08-06 10:20:03 +08:00
in << "/var/log" << endl;
2021-09-23 11:21:58 +08:00
// 系统安装后有的会将/data/home /data/root挂载到的/home /root上实际文件是存放在/data/home /data/root下面为了统一标准保留/home /root排除/data/home /data/root
2021-08-06 10:20:03 +08:00
QStringList excludes;
Utils::excludeFstabBindPath(excludes);
for (const QString& item : excludes) {
in << item << endl;
}
in.flush();
excludePathFile.close();
return true;
}
2021-08-17 10:07:35 +08:00
/**
* @brief
* @param
* @return true,false,
*/
bool Utils::isDirExist(const QString& fullDirName)
{
QDir dir(fullDirName);
if (dir.exists())
return true;
return false;
}
/**
* @brief , rsync --exclude-from排除路径规则文件中读取
* @return
*/
QStringList Utils::getFromExcludePathsFile()
{
QStringList list;
list << "/backup";
2021-09-16 16:05:46 +08:00
// list << "/boot/efi";
2021-08-17 10:07:35 +08:00
list << "/cdrom";
list << "/dev";
list << "/efi";
list << "/etc/uid_list";
list << "/ghost";
list << "/lost+found";
list << "/media";
list << "/mnt";
list << "/proc";
list << "/run";
list << "/swap_file";
list << "/sys";
list << "/tmp";
2021-08-19 19:24:49 +08:00
list << "/var/lib/docker/overlay2";
2021-08-17 10:07:35 +08:00
list << "/var/lib/kmre";
list << "/var/lib/udisks2";
list << "/var/log";
// 系统安装后有的会将/data/home /data/root挂载到的/home /root上实际文件是存放在/data/home /data/root下面
QStringList excludes;
Utils::excludeFstabBindPath(excludes);
for (const QString& item : excludes) {
list << item;
}
return list;
}
2021-08-24 18:08:18 +08:00
/**
* @brief Uuid
* @return UUID
*/
QString Utils::createUuid()
{
QString uuid;
do {
uuid = QUuid::createUuid().toString();
} while (uuid == AUTO_BACKUP_UUID || uuid == FACTORY_BACKUP_UUID);
return uuid;
}
/**
* @brief
* @param fileName
* @param lines
* @return truefalse
*/
bool Utils::writeFileByLines(const QString& fileName, const QStringList& lines)
{
QFile file(fileName);
if (!file.open(QIODevice::ReadWrite | QIODevice::Truncate)) {
return false;
}
QTextStream out(&file);
for (const QString& line : lines) {
out << line << endl;
}
out.flush();
2021-08-24 18:08:18 +08:00
file.close();
return true;
}
/**
* @brief
* @param fileName
* @return booltrue-false-
* @author zhaominyong
* @since 2021/05/29
*/
bool Utils::filsExists(const QString &fileName)
{
struct stat buffer;
return (stat(fileName.toStdString().data(), &buffer) == 0);
}
/**
* @brief
* @param line
* @return bool, true-false-
* @author zhaominyong
* @since 2021/05/29
* @note
* rebootfdatasync确保缓存落盘
*/
bool Utils::writeBackupLog(QString line)
{
line = line + "\n";
QString logFile = Utils::getSysRootPath() + BACKUP_LOG_TEXT_PATH;
logFile.replace("//", "/");
std::string fileName(logFile.toStdString());
// 判断文件是否存在
bool exists = filsExists(logFile);
std::unique_ptr<std::FILE, int (*)(std::FILE*)> fp(std::fopen(fileName.data(), "a+"), std::fclose);
if (!fp) {
std::perror("file opening failed!");
return false;
}
if (!exists) {
std::fputs("#This file must not be deleted and it is for the backup tool.\n", fp.get());
std::fputs("#0:new system backup\n", fp.get());
std::fputs("#1:update system backup\n", fp.get());
std::fputs("#2:new data backup\n", fp.get());
std::fputs("#3:update data backup\n", fp.get());
std::fputs("#4:restore system\n", fp.get());
std::fputs("#5:retaining user data\n", fp.get());
std::fputs("#6:restore data\n", fp.get());
std::fputs("#8:delete backup\n", fp.get());
std::fputs("#for example: 17-04-25 10:43:56,{uuidxxxxx},0,this is a note\n", fp.get());
}
std::fputs(line.toStdString().data(), fp.get());
std::fflush(fp.get());
fdatasync(fileno(fp.get()));
return true;
}
2021-09-23 11:21:58 +08:00
/**
* @brief
* @param fileName
* @param content
* @return bool
*/
bool Utils::syncWriteFile(const QString &fileName, const QString& content)
{
std::unique_ptr<std::FILE, int (*)(std::FILE*)> fp(std::fopen(fileName.toStdString().data(), "a+"), std::fclose);
if (!fp) {
std::perror("file opening failed!");
return false;
}
QStringList lines = content.split("\n");
for (const QString& line : lines) {
std::fputs(line.toStdString().data(), fp.get());
}
std::fflush(fp.get());
fdatasync(fileno(fp.get()));
return true;
}
/**
* @brief GB等表示的字符串
* @param sizeqint64
* @return GB/MB/KB等表示的字符串型大小
*/
QString Utils::StringBySize(qint64 size)
{
#define GB (1024 * 1024 * 1024)
#define MB (1024 * 1024)
#define KB (1024)
float fcount = size * 1.0;
if (size > GB)
return QString(QString::number(fcount / GB, 10, 2) + "GB");
else if (size > MB)
return QString(QString::number(fcount / MB, 10, 2) + "MB");
else
return QString(QString::number(fcount / KB, 10, 2) + "KB");
}
2021-10-13 16:31:58 +08:00
/**
* @brief
* @return MOUNTPOINT,PATH键值对列表
* @author zhaominyong
* @since 2021/06/07
* @note
* for bug 59636 cpmHUAWEIKOSL0V3试制dev/sdc的路径(++)
* QStorageInfo::mountedVolumes获取的磁盘列表区分不出来是否移动设备
*/
QHash<QString, QString> Utils::getRemovableStorages()
{
QHash<QString, QString> removalbeStorages;
QProcess process_lsblk;
process_lsblk.start("lsblk -P -o PATH,RM,TYPE,MOUNTPOINT,TRAN");
if (!process_lsblk.waitForStarted(-1)) {
return removalbeStorages;
}
if (!process_lsblk.waitForFinished(-1)) {
return removalbeStorages;
}
QString result = process_lsblk.readAllStandardOutput();
/*
result like bellow :
PATH="/dev/sdb" RM="1" TYPE="disk" MOUNTPOINT="" TRAN="usb"
PATH="/dev/sdb4" RM="1" TYPE="part" MOUNTPOINT="/media/zhaominyong/31 GB" TRAN=""
PATH="/dev/sr0" RM="1" TYPE="rom" MOUNTPOINT="/media/zhaominyong/Kylin-Desktop-V10-SP1" TRAN=""
*/
QStringList items = result.split("\n");
QStringList usbDevs;
for (QStringList::const_iterator it = items.constBegin(); it != items.constEnd(); ++it) {
const QString &line = (*it);
if (line.contains(" TRAN=\"usb\"")) {
QStringList storageAttrs = line.split("\" ");
if (5 != storageAttrs.size())
continue ;
QString path = storageAttrs.at(0);
path = path.replace("PATH=\"", "");
usbDevs.append(path);
}
if (line.contains(" RM=\"1\" ") || line.contains(" MOUNTPOINT=\"/media/")) {
if (line.contains(" TYPE=\"rom\" "))
continue;
if (line.contains(" MOUNTPOINT=\"\""))
continue;
// "PATH RM TYPE MOUNTPOINT TRAN" for each row, split by "\" "
QStringList storageAttrs = line.split("\" ");
if (5 != storageAttrs.size())
continue ;
QString path = storageAttrs.at(0);
path = path.replace("PATH=\"", "");
bool isSubPart = false;
for (const QString& usbDev : usbDevs) {
if (path.contains(usbDev)) {
isSubPart = true;
break;
}
}
if (!isSubPart)
continue;
QString mount_point = storageAttrs.at(3);
mount_point = mount_point.replace("MOUNTPOINT=\"", "");
mount_point = mount_point.left(mount_point.length() - 1);
removalbeStorages.insert(path, mount_point);
}
}
return removalbeStorages;
}
2021-10-26 09:24:05 +08:00
/**
* @brief
* @param enabletruefalse
*/
void Utils::setKysecStatus(bool enable)
{
QFile file("/usr/bin/setstatus");
if (!file.exists()) {
file.setFileName("/usr/sbin/setstatus");
if (!file.exists())
return ;
}
if (enable) {
QProcess::execute("setstatus enable");
} else {
QProcess::execute("setstatus softmode");
}
}
/**
* @brief kysec-sync-daemon服务
* @param enabletruefalse
*/
void Utils::setKysecDaemon(bool enable){
if(enable){
QProcess::execute("systemctl start kysec-sync-daemon");
}else{
QProcess::execute("systemctl stop kysec-sync-daemon");
}
}
/**
* @brief
* @param processName
* @return bool
*/
bool Utils::isRunning(const QString &processName)
{
bool bRet = false;
QProcess ps;
QProcess grep;
ps.setStandardOutputProcess(&grep);
ps.start("ps", QStringList() << "-ef");
grep.start("grep", QStringList() << processName);
if (grep.waitForFinished()) {
QString result(grep.readAll());
qDebug() << result;
QStringList lines = result.split("\n");
for (const QString& line : lines) {
if (line.contains("grep"))
continue;
if (line.contains(processName)){
bRet = true;
break;
}
}
}
return bRet;
}
/**
* @brief 9909006C处理器
* @return bool
*/
bool Utils::isHuawei990()
{
QString result;
Utils::executeCMD("cat /proc/cpuinfo | grep -i \"kirin.*9.0\"", result);
if (result.isEmpty())
return false;
return true;
}
/**
* @brief popen()fork()shell以运行命令来开启一个进程
* @param cmd NULL shell bin/sh 使 -c shell
* @param result
* @note 使
*/
void Utils::executeCMD(const char* cmd, QString &result)
{
char buf_ps[1024] = { 0 };
FILE* ptr = nullptr;
// 只能是读或者写中的一种,得到的返回值(标准 I/O 流)也具有和 type 相应的只读或只写类型。
// 如果 type 是 “r” 则文件指针连接到 command 的标准输出;如果 type 是 “w” 则文件指针连接到 command 的标准输入。
if ((ptr = popen(cmd, "r")) != nullptr) {
while (fgets(buf_ps, 1024, ptr) != nullptr) {
result += buf_ps;
memset(buf_ps, 0, 1024);
}
pclose(ptr);
ptr = nullptr;
} else {
qCritical("popen %s error", cmd);
}
}
/**
* @brief
* @return
*/
QList<BackupWrapper> Utils::getBackupLogList()
{
QString logFile = Utils::getSysRootPath() + BACKUP_LOG_TEXT_PATH;
logFile.replace("//", "/");
QFile file(logFile);
QList<BackupWrapper> list;
if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
QTextStream in(&file);
while (!in.atEnd()) {
QString line = in.readLine();
if (line.startsWith("#") || line.isEmpty())
continue;
QStringList fields = line.split(",");
BackupWrapper record;
int index = 0;
for (const QString &field : fields) {
switch (index) {
case 0: // 备份时间
record.m_time = field;
break;
case 1: // uuid
record.m_uuid = field;
break;
case 2: // 操作类型
record.m_type = field.toInt();
break;
case 3: // 备注
record.m_note = field;
break;
case 4: // 备份大小
record.m_size = field;
break;
case 5: // 备份用户id
if (field.isEmpty())
record.m_frontUid = -1;
else
record.m_frontUid = field.toInt();
break;
case 6: // 备份名称
record.m_backupName = field;
break;
default:
break;
}
++index;
}
if (record.m_backupName.isEmpty()) {
// if (FACTORY_BACKUP_UUID == record.m_uuid) {
// record.m_backupName = QObject::tr("Factory Backup");
// } else if (AUTO_BACKUP_UUID == record.m_uuid) {
// record.m_backupName = QObject::tr("Auto Backup");
// } else {
record.m_backupName = record.m_uuid;
// }
}
list << record;
}
}
return list;
}