Implement backup on overwriting migrated file (#5533)

Author: amibranch

.gitignore

@@ -117,6 +117,7 @@ peda-session-*
 .cache/
 test/.tmp/*
 test/.sync_disk_db
+test/prj/.*.BAK
 subprojects/.wraplock
 subprojects/capstone-*/
 subprojects/pcre2*/

librz/core/core.c

@@ -1885,6 +1885,7 @@ RZ_API void rz_core_fini(RzCore *c) {
 	RZ_FREE_CUSTOM(c->warnings_after, rz_list_free);
 	RZ_FREE_CUSTOM(c->sys_path, rz_path_free);
 	RZ_FREE_CUSTOM(c->marks, rz_mark_free);
+	RZ_FREE_CUSTOM(c->backup, sdb_free);
 }
 
 RZ_API void rz_core_free(RzCore *c) {

librz/core/project.c

@@ -40,6 +40,76 @@ RZ_API RzProjectErr rz_project_save(RzCore *core, RzProject *prj, const char *fi
 	return RZ_PROJECT_ERR_SUCCESS;
 }
 
+static unsigned long rz_project_get_version(RzProject *prj) {
+	const char *version_str = sdb_const_get(prj, RZ_PROJECT_KEY_VERSION);
+	if (!version_str) {
+		return ULONG_MAX;
+	}
+	return strtoul(version_str, NULL, 0);
+}
+
+RZ_API RzProjectErr rz_project_save_backup_file(RzCore *core, const char *file, bool compress) {
+	char *tmp_file = NULL;
+	if (!core->backup) {
+		/* No backup necessary */
+		return RZ_PROJECT_ERR_SUCCESS;
+	}
+
+	if (compress) {
+		int mkstemp_fd = rz_file_mkstemp("svprjbu", &tmp_file);
+		if (mkstemp_fd == -1 || !tmp_file) {
+			return RZ_PROJECT_ERR_FILE;
+		}
+		close(mkstemp_fd);
+	}
+
+	char *dst_path = NULL;
+	const char *basename = rz_file_basename(file);
+	char *dirname = rz_file_dirname(file);
+	unsigned long version = rz_project_get_version(core->backup);
+	if (!version || version == ULONG_MAX) {
+		free(dirname);
+		return RZ_PROJECT_ERR_INVALID_VERSION;
+	}
+
+	int dst_path_len = snprintf(NULL, 0, "%s/.%s_%ld.BAK", dirname, basename, version);
+	if (dst_path_len < 0) {
+		free(dirname);
+		return RZ_PROJECT_ERR_UNKNOWN;
+	}
+
+	dst_path_len++;
+	dst_path = calloc(dst_path_len, 1);
+	if (dst_path == NULL) {
+		free(dirname);
+		return RZ_PROJECT_ERR_UNKNOWN;
+	}
+
+	if (strlen(dirname) > 0) {
+		snprintf(dst_path, dst_path_len, "%s/.%s_%ld.BAK", dirname, basename, version);
+	} else {
+		snprintf(dst_path, dst_path_len, ".%s_%ld.BAK", basename, version);
+	}
+
+	free(dirname);
+
+	const char *save_file = compress ? tmp_file : dst_path;
+	RzProjectErr err = RZ_PROJECT_ERR_SUCCESS;
+
+	if (!sdb_text_save(core->backup, save_file, true)) {
+		err = RZ_PROJECT_ERR_FILE;
+		goto tmp_file_err;
+	}
+
+	if (compress && !rz_file_deflate(tmp_file, dst_path)) {
+		err = RZ_PROJECT_ERR_COMPRESSION_FAILED;
+	}
+
+tmp_file_err:
+	free(dst_path);
+	return err;
+}
+
 RZ_API RzProjectErr rz_project_save_file(RzCore *core, const char *file, bool compress) {
 	char *tmp_file = NULL;
 
@@ -137,11 +207,7 @@ RZ_API RzProjectErr rz_project_load(RzCore *core, RzProject *prj, bool load_bin_
 	if (!type || strcmp(type, RZ_PROJECT_TYPE) != 0) {
 		return RZ_PROJECT_ERR_INVALID_TYPE;
 	}
-	const char *version_str = sdb_const_get(prj, RZ_PROJECT_KEY_VERSION);
-	if (!version_str) {
-		return RZ_PROJECT_ERR_INVALID_VERSION;
-	}
-	unsigned long version = strtoul(version_str, NULL, 0);
+	unsigned long version = rz_project_get_version(prj);
 	if (!version || version == ULONG_MAX) {
 		return RZ_PROJECT_ERR_INVALID_VERSION;
 	}
@@ -161,6 +227,11 @@ RZ_API RzProjectErr rz_project_load(RzCore *core, RzProject *prj, bool load_bin_
 		return RZ_PROJECT_ERR_INVALID_CONTENTS;
 	}
 
+	if (prj->backup) {
+		prj->backup->refs++;
+		core->backup = prj->backup;
+	}
+
 	rz_config_set(core->config, "prj.file", file);
 
 	return RZ_PROJECT_ERR_SUCCESS;

librz/core/project_migrate.c

@@ -759,6 +759,12 @@ static bool (*const migrations[])(RzProject *prj, RzSerializeResultInfo *res) =
 /// Migrate the given project to the current version in-place
 RZ_API bool rz_project_migrate(RzProject *prj, unsigned long version, RzSerializeResultInfo *res) {
 	RZ_STATIC_ASSERT(RZ_ARRAY_SIZE(migrations) + 1 == RZ_PROJECT_VERSION);
+
+	if (prj->backup == NULL) {
+		prj->backup = sdb_new0();
+		sdb_copy(prj, prj->backup);
+	}
+
 	while (version < RZ_PROJECT_VERSION) {
 		bool succ = migrations[version - 1](prj, res);
 		if (!succ) {

librz/include/rz_core.h

@@ -398,6 +398,8 @@ struct rz_core_t {
 	int (*rz_main_rz_gg)(int argc, const char **argv);
 	int (*rz_main_rz_asm)(int argc, const char **argv);
 	int (*rz_main_rz_ax)(int argc, const char **argv);
+
+	Sdb *backup;
 };
 
 // maybe move into RzAnalysis

librz/include/rz_project.h

@@ -30,6 +30,7 @@ typedef enum rz_project_err {
 
 RZ_API RZ_NONNULL const char *rz_project_err_message(RzProjectErr err);
 RZ_API RzProjectErr rz_project_save(RzCore *core, RzProject *prj, const char *file);
+RZ_API RzProjectErr rz_project_save_backup_file(RzCore *core, const char *file, bool compress);
 RZ_API RzProjectErr rz_project_save_file(RzCore *core, const char *file, bool compress);
 RZ_API RzProject *rz_project_load_file_raw(const char *file);
 RZ_API void rz_project_free(RzProject *prj);

librz/main/rizin.c

@@ -1444,11 +1444,13 @@ RZ_API int rz_main_rizin(int argc, const char **argv) {
 			if (no_question_save) {
 				if (prj && *prj && y_save_project) {
 					prj_err = rz_project_save_file(r, prj, compress);
+					rz_project_save_backup_file(r, prj, compress);
 				}
 			} else {
 				question = rz_str_newf("Do you want to save the '%s' project? (Y/n)", prj);
 				if (prj && *prj && rz_cons_yesno('y', "%s", question)) {
 					prj_err = rz_project_save_file(r, prj, compress);
+					rz_project_save_backup_file(r, prj, compress);
 				}
 				free(question);
 			}

librz/util/sdb/src/sdb.c

@@ -194,6 +194,9 @@ static void sdb_fini(Sdb *s, int donull) {
 	free(s->ndump);
 	free(s->dir);
 	if (donull) {
+		if (s->backup) {
+			sdb_free(s->backup);
+		};
 		memset(s, 0, sizeof(Sdb));
 	}
 }

librz/util/sdb/src/sdb.h

@@ -81,6 +81,7 @@ typedef struct sdb_t {
 	int ns_lock; // TODO: merge into options?
 	RzList /*<SdbNs *>*/ *ns;
 	ut32 depth;
+	struct sdb_t *backup;
 } Sdb;
 
 typedef struct sdb_ns_t {

test/integration/meson.build

@@ -25,6 +25,7 @@ if get_option('enable_tests') and cli_enabled
     'dwarf_integration',
     'glibc_version',
     'open_analyse_save_load_project',
+    'open_migrate_backup_compare_project',
     'pdb',
     'project_migrate',
     'rzpipe',