2 * Copyright (C) 2008 - 2016 The Geeqie Team
4 * Authors: John Ellis, Vladimir Nadvornik, Laurent Monin
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "history_list.h"
24 #include "secure_save.h"
25 #include "ui_fileops.h"
30 *-----------------------------------------------------------------------------
31 * Implements a history chain. Used by the Back and Forward toolbar buttons.
32 * Selecting any folder appends the path to the end of the chain.
33 * Pressing the Back and Forward buttons moves along the chain, but does
34 * not make additions to the chain.
35 * The chain always increases and is deleted at the end of the session
37 *-----------------------------------------------------------------------------
40 static GList *history_chain = NULL;
41 static guint chain_index = G_MAXUINT;
42 static gboolean nav_button = FALSE; /** Used to prevent the nav buttons making entries to the chain **/
44 const gchar *history_chain_back()
48 chain_index = chain_index > 0 ? chain_index - 1 : 0;
50 return g_list_nth_data(history_chain, chain_index);
53 const gchar *history_chain_forward()
56 guint last = g_list_length(history_chain) - 1;
58 chain_index = chain_index < last ? chain_index + 1 : last;
60 return g_list_nth_data(history_chain, chain_index);
64 * @brief Appends a path to the history chain
65 * @param path Path selected
67 * Each time the user selects a new path it is appended to the chain
68 * except when it is identical to the current last entry
69 * The pointer is always moved to the end of the chain
71 void history_chain_append_end(const gchar *path)
77 if(chain_index == G_MAXUINT)
79 history_chain = g_list_append (history_chain, g_strdup(path));
84 work = g_list_last(history_chain);
85 if (g_strcmp0(work->data , path) != 0)
87 history_chain = g_list_append (history_chain, g_strdup(path));
88 chain_index = g_list_length(history_chain) - 1;
89 DEBUG_3("%d %s", chain_index, path);
93 chain_index = g_list_length(history_chain) - 1;
105 *-----------------------------------------------------------------------------
106 * Implements an image history chain. Whenever an image is displayed it is
107 * appended to a chain.
108 * Pressing the Image Back and Image Forward buttons moves along the chain,
109 * but does not make additions to the chain.
110 * The chain always increases and is deleted at the end of the session
112 *-----------------------------------------------------------------------------
114 static GList *image_chain = NULL;
115 static guint image_chain_index = G_MAXUINT;
116 static gboolean image_nav_button = FALSE; /** Used to prevent the nav buttons making entries to the chain **/
117 const gchar *image_chain_back()
119 image_nav_button = TRUE;
121 image_chain_index = image_chain_index > 0 ? image_chain_index - 1 : 0;
123 return g_list_nth_data(image_chain, image_chain_index);
126 const gchar *image_chain_forward()
128 image_nav_button= TRUE;
129 guint last = g_list_length(image_chain) - 1;
131 image_chain_index = image_chain_index < last ? image_chain_index + 1 : last;
133 return g_list_nth_data(image_chain, image_chain_index);
137 * @brief Appends a path to the image history chain
138 * @param path Image path selected
140 * Each time the user selects a new image it is appended to the chain
141 * except when it is identical to the current last entry
142 * The pointer is always moved to the end of the chain
144 void image_chain_append_end(const gchar *path)
148 if (!image_nav_button)
150 if(image_chain_index == G_MAXUINT)
152 image_chain = g_list_append(image_chain, g_strdup(path));
153 image_chain_index = 0;
157 work = g_list_last(image_chain);
158 if (g_strcmp0(work->data , path) != 0)
160 image_chain = g_list_append(image_chain, g_strdup(path));
161 image_chain_index = g_list_length(image_chain) - 1;
162 DEBUG_3("%d %s", image_chain_index, path);
166 image_chain_index = g_list_length(image_chain) - 1;
172 image_nav_button = FALSE;
177 *-----------------------------------------------------------------------------
179 *-----------------------------------------------------------------------------
182 #define HISTORY_DEFAULT_KEY_COUNT 16
185 typedef struct _HistoryData HistoryData;
192 static GList *history_list = NULL;
195 static gchar *quoted_from_text(const gchar *text)
199 gint l = strlen(text);
201 if (l == 0) return NULL;
203 while (c < l && text[c] !='"') c++;
210 while (e < l && text[e] !='"') e++;
215 return g_strndup(ptr, e - c);
222 gboolean history_list_load(const gchar *path)
229 pathl = path_from_utf8(path);
230 f = fopen(pathl, "r");
232 if (!f) return FALSE;
234 /* first line must start with History comment */
235 if (!fgets(s_buf, sizeof(s_buf), f) ||
236 strncmp(s_buf, "#History", 8) != 0)
242 while (fgets(s_buf, sizeof(s_buf), f))
244 if (s_buf[0]=='#') continue;
252 while (ptr[c] != ']' && ptr[c] != '\n' && ptr[c] != '\0') c++;
255 key = g_strndup(ptr, c);
261 value = quoted_from_text(s_buf);
264 history_list_add_to_key(key, value, 0);
277 gboolean history_list_save(const gchar *path)
284 pathl = path_from_utf8(path);
285 ssi = secure_open(pathl);
289 log_printf(_("Unable to write history lists to: %s\n"), path);
293 secure_fprintf(ssi, "#History lists\n\n");
295 list = g_list_last(history_list);
296 while (list && secsave_errno == SS_ERR_NONE)
304 secure_fprintf(ssi, "[%s]\n", hd->key);
306 /* save them inverted (oldest to newest)
307 * so that when reading they are added correctly
309 work = g_list_last(hd->list);
310 list_count = g_list_position(hd->list, g_list_last(hd->list)) + 1;
311 while (work && secsave_errno == SS_ERR_NONE)
313 if ((!(strcmp(hd->key, "path_list") == 0 && list_count > options->open_recent_list_maxsize)) && (!(strcmp(hd->key, "recent") == 0 && (!isfile(work->data)))))
315 secure_fprintf(ssi, "\"%s\"\n", (gchar *)work->data);
320 secure_fputc(ssi, '\n');
323 secure_fprintf(ssi, "#end\n");
325 return (secure_close(ssi) == 0);
328 static void history_list_free(HistoryData *hd)
345 static HistoryData *history_list_find_by_key(const gchar *key)
347 GList *work = history_list;
349 if (!key) return NULL;
353 HistoryData *hd = work->data;
354 if (strcmp(hd->key, key) == 0) return hd;
360 const gchar *history_list_find_last_path_by_key(const gchar *key)
364 hd = history_list_find_by_key(key);
365 if (!hd || !hd->list) return NULL;
367 return hd->list->data;
370 void history_list_free_key(const gchar *key)
373 hd = history_list_find_by_key(key);
376 history_list = g_list_remove(history_list, hd);
377 history_list_free(hd);
380 void history_list_add_to_key(const gchar *key, const gchar *path, gint max)
385 if (!key || !path) return;
387 hd = history_list_find_by_key(key);
390 hd = g_new(HistoryData, 1);
391 hd->key = g_strdup(key);
393 history_list = g_list_prepend(history_list, hd);
396 /* if already in the list, simply move it to the top */
400 gchar *buf = work->data;
402 if (strcmp(buf, path) == 0)
404 /* if not first, move it */
405 if (work != hd->list)
407 hd->list = g_list_remove(hd->list, buf);
408 hd->list = g_list_prepend(hd->list, buf);
415 hd->list = g_list_prepend(hd->list, g_strdup(path));
417 if (max == -1) max = HISTORY_DEFAULT_KEY_COUNT;
421 GList *work = hd->list;
432 while (work && len > max)
438 hd->list = g_list_delete_link(hd->list, node);
444 void history_list_item_change(const gchar *key, const gchar *oldpath, const gchar *newpath)
449 if (!oldpath) return;
450 hd = history_list_find_by_key(key);
456 gchar *buf = work->data;
457 if (strcmp(buf, oldpath) == 0)
461 work->data = g_strdup(newpath);
465 hd->list = g_list_remove(hd->list, buf);
474 void history_list_item_move(const gchar *key, const gchar *path, gint direction)
481 hd = history_list_find_by_key(key);
487 gchar *buf = work->data;
488 if (strcmp(buf, path) == 0)
492 hd->list = g_list_remove(hd->list, buf);
493 hd->list = g_list_insert(hd->list, buf, p);
501 void history_list_item_remove(const gchar *key, const gchar *path)
503 history_list_item_change(key, path, NULL);
506 GList *history_list_get_by_key(const gchar *key)
510 hd = history_list_find_by_key(key);
511 if (!hd) return NULL;
515 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */