Fix: opening missing file didnt remove in recent-files.txt

Refactor recent-file.txt handling, split into smaller functions.
It wasn't possible to write the current state to disk (depended on current context).

4 files changed, 86 insertions, 47 deletions

diff --git a/source/blender/windowmanager/intern/wm_files.c b/source/blender/windowmanager/intern/wm_files.c
index 24c25fd0eb7..7d06211f519 100644
--- a/source/blender/windowmanager/intern/wm_files.c
+++ b/source/blender/windowmanager/intern/wm_files.c
@@ -116,7 +116,11 @@
 #include "wm_window.h"
 #include "wm_event_system.h"
 
-static void write_history(void);
+static RecentFile *wm_file_history_find(const char *filepath);
+static void wm_history_file_free(RecentFile *recent);
+static void wm_history_file_update(void);
+static void wm_history_file_write(void);
+
 
 /* To be able to read files without windows closing, opening, moving
  * we try to prepare for worst case:
@@ -456,7 +460,7 @@ bool WM_file_read(bContext *C, const char *filepath, ReportList *reports)
 		
 		if (retval != BKE_READ_FILE_FAIL) {
 			if (do_history) {
-				write_history();
+				wm_history_file_update();
 			}
 		}
 
@@ -531,11 +535,10 @@ bool WM_file_read(bContext *C, const char *filepath, ReportList *reports)
 	if (success == false) {
 		/* remove from recent files list */
 		if (do_history) {
-			RecentFile *recent = BLI_findstring_ptr(&G.recent_files, filepath, offsetof(RecentFile, filepath));
+			RecentFile *recent = wm_file_history_find(filepath);
 			if (recent) {
-				MEM_freeN(recent->filepath);
-				BLI_freelinkN(&G.recent_files, recent);
-				write_history();
+				wm_history_file_free(recent);
+				wm_history_file_write();
 			}
 		}
 	}
@@ -703,10 +706,10 @@ int wm_homefile_read(bContext *C, ReportList *reports, bool from_memory, const c
 	return true;
 }
 
-int wm_history_read_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
+int wm_history_file_read_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
 {
 	ED_file_read_bookmarks();
-	wm_read_history();
+	wm_history_file_read();
 	return OPERATOR_FINISHED;
 }
 
@@ -737,7 +740,10 @@ int wm_homefile_read_exec(bContext *C, wmOperator *op)
 	return wm_homefile_read(C, op->reports, from_memory, filepath) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
 }
 
-void wm_read_history(void)
+/** \name WM History File API
+ * \{ */
+
+void wm_history_file_read(void)
 {
 	char name[FILE_MAX];
 	LinkNode *l, *lines;
@@ -769,18 +775,35 @@ void wm_read_history(void)
 	BLI_file_free_lines(lines);
 }
 
-static void write_history(void)
+static RecentFile *wm_history_file_new(const char *filepath)
+{
+	RecentFile *recent = MEM_mallocN(sizeof(RecentFile), "RecentFile");
+	recent->filepath = BLI_strdup(filepath);
+	return recent;
+}
+
+static void wm_history_file_free(RecentFile *recent)
+{
+	BLI_assert(BLI_findindex(&G.recent_files, recent) != -1);
+	MEM_freeN(recent->filepath);
+	BLI_freelinkN(&G.recent_files, recent);
+}
+
+static RecentFile *wm_file_history_find(const char *filepath)
+{
+	return BLI_findstring_ptr(&G.recent_files, filepath, offsetof(RecentFile, filepath));
+}
+
+/**
+ * Write #BLENDER_HISTORY_FILE as-is, without checking the environment
+ * (thats handled by #wm_history_file_update).
+ */
+static void wm_history_file_write(void)
 {
-	struct RecentFile *recent, *next_recent;
-	char name[FILE_MAX];
 	const char *user_config_dir;
+	char name[FILE_MAX];
 	FILE *fp;
-	int i;
 
-	/* no write history for recovered startup files */
-	if (G.main->name[0] == 0)
-		return;
-	
 	/* will be NULL in background mode */
 	user_config_dir = BKE_appdir_folder_id_create(BLENDER_USER_CONFIG, NULL);
 	if (!user_config_dir)
@@ -788,42 +811,58 @@ static void write_history(void)
 
 	BLI_make_file_string("/", name, user_config_dir, BLENDER_HISTORY_FILE);
 
+	fp = BLI_fopen(name, "w");
+	if (fp) {
+		struct RecentFile *recent;
+		for (recent = G.recent_files.first; recent; recent = recent->next) {
+			fprintf(fp, "%s\n", recent->filepath);
+		}
+		fclose(fp);
+	}
+}
+
+/**
+ * Run after saving a file to refresh the #BLENDER_HISTORY_FILE list.
+ */
+static void wm_history_file_update(void)
+{
+	RecentFile *recent;
+
+	/* no write history for recovered startup files */
+	if (G.main->name[0] == 0)
+		return;
+
 	recent = G.recent_files.first;
 	/* refresh recent-files.txt of recent opened files, when current file was changed */
 	if (!(recent) || (BLI_path_cmp(recent->filepath, G.main->name) != 0)) {
-		fp = BLI_fopen(name, "w");
-		if (fp) {
-			/* add current file to the beginning of list */
-			recent = (RecentFile *)MEM_mallocN(sizeof(RecentFile), "RecentFile");
-			recent->filepath = BLI_strdup(G.main->name);
-			BLI_addhead(&(G.recent_files), recent);
-			/* write current file to recent-files.txt */
-			fprintf(fp, "%s\n", recent->filepath);
-			recent = recent->next;
-			i = 1;
-			/* write rest of recent opened files to recent-files.txt */
-			while ((i < U.recent_files) && (recent)) {
-				/* this prevents to have duplicities in list */
-				if (BLI_path_cmp(recent->filepath, G.main->name) != 0) {
-					fprintf(fp, "%s\n", recent->filepath);
-					recent = recent->next;
-				}
-				else {
-					next_recent = recent->next;
-					MEM_freeN(recent->filepath);
-					BLI_freelinkN(&(G.recent_files), recent);
-					recent = next_recent;
-				}
-				i++;
+
+		recent = wm_file_history_find(G.main->name);
+		if (recent) {
+			BLI_remlink(&G.recent_files, recent);
+		}
+		else {
+			RecentFile *recent_next;
+			for (recent = BLI_findlink(&G.recent_files, U.recent_files - 1); recent; recent = recent_next) {
+				recent_next = recent->next;
+				wm_history_file_free(recent);
 			}
-			fclose(fp);
+			recent = wm_history_file_new(G.main->name);
 		}
 
+		/* add current file to the beginning of list */
+		BLI_addhead(&(G.recent_files), recent);
+
+		/* write current file to recent-files.txt */
+		wm_history_file_write();
+
 		/* also update most recent files on System */
 		GHOST_addToSystemRecentFiles(G.main->name);
 	}
 }
 
+/** \} */
+
+
 /* screen can be NULL */
 static ImBuf *blend_file_thumb(Scene *scene, bScreen *screen, int **thumb_pt)
 {
@@ -996,7 +1035,7 @@ int wm_file_write(bContext *C, const char *filepath, int fileflags, ReportList *
 
 		/* prevent background mode scripts from clobbering history */
 		if (!G.background) {
-			write_history();
+			wm_history_file_update();
 		}
 
 		BLI_callback_exec(G.main, NULL, BLI_CB_EVT_SAVE_POST);
diff --git a/source/blender/windowmanager/intern/wm_init_exit.c b/source/blender/windowmanager/intern/wm_init_exit.c
index 9750bfd2f7f..bde6db259bc 100644
--- a/source/blender/windowmanager/intern/wm_init_exit.c
+++ b/source/blender/windowmanager/intern/wm_init_exit.c
@@ -230,7 +230,7 @@ void WM_init(bContext *C, int argc, const char **argv)
 
 	// glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 
-	wm_read_history();
+	wm_history_file_read();
 
 	/* allow a path of "", this is what happens when making a new file */
 #if 0
diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c
index 19c604170d7..37d434faa6e 100644
--- a/source/blender/windowmanager/intern/wm_operators.c
+++ b/source/blender/windowmanager/intern/wm_operators.c
@@ -2298,7 +2298,7 @@ static void WM_OT_read_history(wmOperatorType *ot)
 	ot->description = "Reloads history and bookmarks";
 
 	ot->invoke = WM_operator_confirm;
-	ot->exec = wm_history_read_exec;
+	ot->exec = wm_history_file_read_exec;
 
 	/* this operator is only used for loading settings from a previous blender install */
 	ot->flag = OPTYPE_INTERNAL;
diff --git a/source/blender/windowmanager/wm_files.h b/source/blender/windowmanager/wm_files.h
index 526696138a5..467926aa770 100644
--- a/source/blender/windowmanager/wm_files.h
+++ b/source/blender/windowmanager/wm_files.h
@@ -31,9 +31,9 @@
 #ifndef __WM_FILES_H__
 #define __WM_FILES_H__
 
-void		wm_read_history(void);
+void		wm_history_file_read(void);
+int			wm_history_file_read_exec(bContext *C, wmOperator *op);
 int			wm_file_write(struct bContext *C, const char *target, int fileflags, struct ReportList *reports);
-int			wm_history_read_exec(bContext *C, wmOperator *op);
 int			wm_homefile_read_exec(struct bContext *C, struct wmOperator *op);
 int			wm_homefile_read(struct bContext *C, struct ReportList *reports, bool from_memory, const char *filepath);
 int			wm_homefile_write_exec(struct bContext *C, struct wmOperator *op);