7 * This software is released under the GNU General Public License (GNU GPL).
8 * Please read the included file COPYING for more information.
9 * This software comes with no warranty of any kind, use at your own risk!
14 #include "collect-io.h"
18 #include "layout_util.h"
20 #include "secure_save.h"
22 #include "ui_fileops.h"
25 #define GQ_COLLECTION_MARKER "#" GQ_APPNAME
27 #define GQ_COLLECTION_FAIL_MIN 300
28 #define GQ_COLLECTION_FAIL_PERCENT 98
29 #define GQ_COLLECTION_READ_BUFSIZE 4096
31 typedef struct _CollectManagerEntry CollectManagerEntry;
33 static void collection_load_thumb_step(CollectionData *cd);
34 static gint collection_save_private(CollectionData *cd, const gchar *path);
36 static CollectManagerEntry *collect_manager_get_entry(const gchar *path);
37 static void collect_manager_entry_reset(CollectManagerEntry *entry);
38 static gint collect_manager_process_action(CollectManagerEntry *entry, gchar **path_ptr);
41 static gint scan_geometry(gchar *buffer, gint *x, gint *y, gint *w, gint *h)
45 if(sscanf(buffer, "%d %d %d %d", &nx, &ny, &nw, &nh) != 4) return FALSE;
55 static gint collection_load_private(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
57 gchar s_buf[GQ_COLLECTION_READ_BUFSIZE];
60 gint limit_failures = TRUE;
62 gint has_official_header = FALSE;
63 gint has_geometry_header = FALSE;
64 gint has_gqview_header = FALSE;
65 gint need_header = TRUE;
68 gboolean changed = FALSE;
69 CollectManagerEntry *entry = NULL;
70 guint flush = !!(flags & COLLECTION_LOAD_FLUSH);
71 guint append = !!(flags & COLLECTION_LOAD_APPEND);
72 guint only_geometry = !!(flags & COLLECTION_LOAD_GEOMETRY);
76 collection_load_stop(cd);
79 collect_manager_flush();
81 entry = collect_manager_get_entry(path);
85 collection_list_free(cd->list);
90 if (!path && !cd->path) return FALSE;
92 if (!path) path = cd->path;
94 if (debug) printf("collection load: append=%d flush=%d only_geometry=%d path=%s\n",
95 append, flush, only_geometry, path);
98 pathl = path_from_utf8(path);
99 f = fopen(pathl, "r");
103 printf("Failed to open collection file: \"%s\"\n", path);
107 while (fgets(s_buf, sizeof(s_buf), f))
112 /* Skip whitespaces and empty lines */
113 while (*p && g_ascii_isspace(*p)) p++;
114 if (*p == '\n' || *p == '\r') continue;
119 if (!need_header) continue;
120 if (strncasecmp(p, GQ_COLLECTION_MARKER, strlen(GQ_COLLECTION_MARKER)) == 0)
122 /* Looks like an official collection, allow unchecked input.
123 * All this does is allow adding files that may not exist,
124 * which is needed for the collection manager to work.
125 * Also unofficial files abort after too many invalid entries.
127 has_official_header = TRUE;
128 limit_failures = FALSE;
130 else if (strncmp(p, "#geometry:", 10 ) == 0 &&
131 scan_geometry(p + 10, &cd->window_x, &cd->window_y, &cd->window_w, &cd->window_h))
133 has_geometry_header = TRUE;
134 cd->window_read = TRUE;
135 if (only_geometry) break;
137 else if (strncasecmp(p, "#GQview collection", strlen("#GQview collection")) == 0)
139 /* As 2008/04/15 there is no difference between our collection file format
140 * and GQview 2.1.5 collection file format so ignore failures as well. */
141 has_gqview_header = TRUE;
142 limit_failures = FALSE;
144 need_header = (!has_official_header && !has_gqview_header) || !has_geometry_header;
149 buf = quoted_value(p, NULL);
155 changed |= collect_manager_process_action(entry, &buf);
157 valid = (buf[0] == '/' && collection_add_check(cd, file_data_new_simple(buf), FALSE, TRUE));
158 if (debug && !valid) printf("collection invalid file: %s\n", buf);
165 if (limit_failures &&
166 fail > GQ_COLLECTION_FAIL_MIN &&
167 fail * 100 / total > GQ_COLLECTION_FAIL_PERCENT)
169 printf("%d invalid filenames in unoffical collection file, closing: %s\n", fail, path);
177 if (debug) printf("collection files: total = %d fail = %d official=%d gqview=%d geometry=%d\n",
178 total, fail, has_official_header, has_gqview_header, has_geometry_header);
181 if (only_geometry) return has_geometry_header;
186 while (collect_manager_process_action(entry, &buf))
188 collection_add_check(cd, file_data_new_simple(buf), FALSE, TRUE);
194 cd->list = collection_list_sort(cd->list, cd->sort_method);
196 if (!flush && changed && success)
197 collection_save_private(cd, path);
200 collect_manager_entry_reset(entry);
202 if (!append) cd->changed = FALSE;
207 gint collection_load(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
209 if (collection_load_private(cd, path, flags | COLLECTION_LOAD_FLUSH))
211 layout_recent_add_path(cd->path);
218 static void collection_load_thumb_do(CollectionData *cd)
222 if (!cd->thumb_loader || !g_list_find(cd->list, cd->thumb_info)) return;
224 pixbuf = thumb_loader_get_pixbuf(cd->thumb_loader, TRUE);
225 collection_info_set_thumb(cd->thumb_info, pixbuf);
226 g_object_unref(pixbuf);
228 if (cd->info_updated_func) cd->info_updated_func(cd, cd->thumb_info, cd->info_updated_data);
231 static void collection_load_thumb_error_cb(ThumbLoader *tl, gpointer data)
233 CollectionData *cd = data;
235 collection_load_thumb_do(cd);
236 collection_load_thumb_step(cd);
239 static void collection_load_thumb_done_cb(ThumbLoader *tl, gpointer data)
241 CollectionData *cd = data;
243 collection_load_thumb_do(cd);
244 collection_load_thumb_step(cd);
247 static void collection_load_thumb_step(CollectionData *cd)
254 collection_load_stop(cd);
261 /* find first unloaded thumb */
262 while (work && ci->pixbuf)
268 if (!ci || ci->pixbuf)
271 collection_load_stop(cd);
273 /* send a NULL CollectInfo to notify end */
274 if (cd->info_updated_func) cd->info_updated_func(cd, NULL, cd->info_updated_data);
279 /* setup loader and call it */
281 thumb_loader_free(cd->thumb_loader);
282 cd->thumb_loader = thumb_loader_new(options->thumbnails.max_width, options->thumbnails.max_height);
283 thumb_loader_set_callbacks(cd->thumb_loader,
284 collection_load_thumb_done_cb,
285 collection_load_thumb_error_cb,
290 if (!thumb_loader_start(cd->thumb_loader, ci->fd->path))
292 /* error, handle it, do next */
293 if (debug) printf("error loading thumb for %s\n", ci->fd->path);
294 collection_load_thumb_do(cd);
295 collection_load_thumb_step(cd);
299 void collection_load_thumb_idle(CollectionData *cd)
301 if (!cd->thumb_loader) collection_load_thumb_step(cd);
304 gint collection_load_begin(CollectionData *cd, const gchar *path, CollectionLoadFlags flags)
306 if (!collection_load(cd, path, flags)) return FALSE;
308 collection_load_thumb_idle(cd);
313 void collection_load_stop(CollectionData *cd)
315 if (!cd->thumb_loader) return;
317 thumb_loader_free(cd->thumb_loader);
318 cd->thumb_loader = NULL;
321 static gint collection_save_private(CollectionData *cd, const gchar *path)
327 if (!path && !cd->path) return FALSE;
335 pathl = path_from_utf8(path);
336 ssi = secure_open(pathl);
342 buf = g_strdup_printf(_("failed to open collection (write) \"%s\"\n"), path);
348 secure_fprintf(ssi, "%s collection\n", GQ_COLLECTION_MARKER);
349 secure_fprintf(ssi, "#created with %s version %s\n", GQ_APPNAME, VERSION);
351 collection_update_geometry(cd);
354 secure_fprintf(ssi, "#geometry: %d %d %d %d\n", cd->window_x, cd->window_y, cd->window_w, cd->window_h);
358 while (work && secsave_errno == SS_ERR_NONE)
360 CollectInfo *ci = work->data;
361 secure_fprintf(ssi, "\"%s\"\n", ci->fd->path);
365 secure_fprintf(ssi, "#end\n");
367 if (secure_close(ssi))
371 buf = g_strdup_printf(_("error saving collection file: %s\nerror: %s\n"), path,
372 secsave_strerror(secsave_errno));
378 if (!cd->path || strcmp(path, cd->path) != 0)
380 gchar *buf = cd->path;
381 cd->path = g_strdup(path);
386 cd->name = g_strdup(filename_from_path(cd->path));
388 collection_path_changed(cd);
396 gint collection_save(CollectionData *cd, const gchar *path)
398 if (collection_save_private(cd, path))
400 layout_recent_add_path(cd->path);
407 gint collection_load_only_geometry(CollectionData *cd, const gchar *path)
409 return collection_load(cd, path, COLLECTION_LOAD_GEOMETRY);
414 *-------------------------------------------------------------------
416 *-------------------------------------------------------------------
419 #define COLLECT_MANAGER_ACTIONS_PER_IDLE 1000
420 #define COLLECT_MANAGER_FLUSH_DELAY 10000
422 struct _CollectManagerEntry
426 GHashTable *oldpath_hash;
427 GHashTable *newpath_hash;
432 COLLECTION_MANAGER_UPDATE,
433 COLLECTION_MANAGER_ADD,
434 COLLECTION_MANAGER_REMOVE
435 } CollectManagerType;
437 typedef struct _CollectManagerAction CollectManagerAction;
438 struct _CollectManagerAction
443 CollectManagerType type;
449 static GList *collection_manager_entry_list = NULL;
450 static GList *collection_manager_action_list = NULL;
451 static GList *collection_manager_action_tail = NULL;
452 static gint collection_manager_timer_id = -1;
455 static CollectManagerAction *collect_manager_action_new(const gchar *oldpath, const gchar *newpath,
456 CollectManagerType type)
458 CollectManagerAction *action;
460 action = g_new0(CollectManagerAction, 1);
463 action->oldpath = g_strdup(oldpath);
464 action->newpath = g_strdup(newpath);
471 static void collect_manager_action_ref(CollectManagerAction *action)
476 static void collect_manager_action_unref(CollectManagerAction *action)
480 if (action->ref > 0) return;
482 g_free(action->oldpath);
483 g_free(action->newpath);
487 static void collect_manager_entry_free_data(CollectManagerEntry *entry)
491 work = entry->add_list;
494 CollectManagerAction *action;
499 collect_manager_action_unref(action);
501 g_list_free(entry->add_list);
502 g_hash_table_destroy(entry->oldpath_hash);
503 g_hash_table_destroy(entry->newpath_hash);
506 static void collect_manager_entry_init_data(CollectManagerEntry *entry)
508 entry->add_list = NULL;
509 entry->oldpath_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, (GDestroyNotify) collect_manager_action_unref);
510 entry->newpath_hash = g_hash_table_new(g_str_hash, g_str_equal);
515 static CollectManagerEntry *collect_manager_entry_new(const gchar *path)
517 CollectManagerEntry *entry;
519 entry = g_new0(CollectManagerEntry, 1);
520 entry->path = g_strdup(path);
521 collect_manager_entry_init_data(entry);
523 collection_manager_entry_list = g_list_append(collection_manager_entry_list, entry);
529 static void collect_manager_entry_free(CollectManagerEntry *entry)
531 collection_manager_entry_list = g_list_remove(collection_manager_entry_list, entry);
533 collect_manager_entry_free_data(entry);
539 static void collect_manager_entry_reset(CollectManagerEntry *entry)
541 collect_manager_entry_free_data(entry);
542 collect_manager_entry_init_data(entry);
545 static CollectManagerEntry *collect_manager_get_entry(const gchar *path)
549 work = collection_manager_entry_list;
552 CollectManagerEntry *entry;
556 if (strcmp(entry->path, path) == 0)
565 static void collect_manager_entry_add_action(CollectManagerEntry *entry, CollectManagerAction *action)
568 CollectManagerAction *orig_action;
570 entry->empty = FALSE;
572 if (action->oldpath == NULL)
575 if (action->newpath == NULL)
580 orig_action = g_hash_table_lookup(entry->newpath_hash, action->newpath);
583 /* target already exists */
584 printf("collection manager failed to add another action for target %s in collection %s\n",
585 action->newpath, entry->path);
588 entry->add_list = g_list_append(entry->add_list, action);
589 g_hash_table_insert(entry->newpath_hash, action->newpath, action);
590 collect_manager_action_ref(action);
594 orig_action = g_hash_table_lookup(entry->newpath_hash, action->oldpath);
597 /* new action with the same file */
598 CollectManagerAction *new_action = collect_manager_action_new(orig_action->oldpath, action->newpath, action->type);
600 if (new_action->oldpath)
602 g_hash_table_steal(entry->oldpath_hash, orig_action->oldpath);
603 g_hash_table_insert(entry->oldpath_hash, new_action->oldpath, new_action);
607 GList *work = g_list_find(entry->add_list, orig_action);
608 work->data = new_action;
611 g_hash_table_steal(entry->newpath_hash, orig_action->newpath);
612 if (new_action->newpath)
614 g_hash_table_insert(entry->newpath_hash, new_action->newpath, new_action);
616 collect_manager_action_unref(orig_action);
621 orig_action = g_hash_table_lookup(entry->oldpath_hash, action->oldpath);
624 /* another action for the same source, ignore */
625 printf("collection manager failed to add another action for source %s in collection %s\n",
626 action->oldpath, entry->path);
630 g_hash_table_insert(entry->oldpath_hash, action->oldpath, action);
633 g_hash_table_insert(entry->newpath_hash, action->newpath, action);
635 collect_manager_action_ref(action);
638 static gint collect_manager_process_action(CollectManagerEntry *entry, gchar **path_ptr)
640 gchar *path = *path_ptr;
641 CollectManagerAction *action;
648 action = entry->add_list->data;
649 g_assert(action->oldpath == NULL);
650 entry->add_list = g_list_remove(entry->add_list, action);
651 path = g_strdup(action->newpath);
652 g_hash_table_remove(entry->newpath_hash, path);
653 collect_manager_action_unref(action);
656 return (path != NULL);
659 action = g_hash_table_lookup(entry->oldpath_hash, path);
664 path = g_strdup(action->newpath);
669 return FALSE; /* no change */
672 static void collect_manager_refresh(void)
678 base = g_strconcat(homedir(), "/", GQ_RC_DIR_COLLECTIONS, NULL);
679 path_list(base, &list, NULL);
682 work = collection_manager_entry_list;
685 CollectManagerEntry *entry;
692 while (list_step && entry)
696 path = list_step->data;
697 list_step = list_step->next;
699 if (strcmp(path, entry->path) == 0)
701 list = g_list_remove(list, path);
708 collect_manager_entry_free(entry);
721 collect_manager_entry_new(path);
728 static void collect_manager_process_actions(gint max)
730 if (debug && collection_manager_action_list)
732 printf("collection manager processing actions\n");
735 while (collection_manager_action_list != NULL && max > 0)
737 CollectManagerAction *action;
740 action = collection_manager_action_list->data;
741 work = collection_manager_entry_list;
744 CollectManagerEntry *entry;
749 if (action->type == COLLECTION_MANAGER_UPDATE)
751 collect_manager_entry_add_action(entry, action);
753 else if (action->oldpath && action->newpath &&
754 strcmp(action->newpath, entry->path) == 0)
756 /* convert action to standard add format */
757 g_free(action->newpath);
758 if (action->type == COLLECTION_MANAGER_ADD)
760 action->newpath = action->oldpath;
761 action->oldpath = NULL;
763 else if (action->type == COLLECTION_MANAGER_REMOVE)
765 action->newpath = NULL;
767 collect_manager_entry_add_action(entry, action);
773 if (action->type != COLLECTION_MANAGER_UPDATE &&
774 action->oldpath && action->newpath)
776 printf("collection manager failed to %s %s for collection %s\n",
777 (action->type == COLLECTION_MANAGER_ADD) ? "add" : "remove",
778 action->oldpath, action->newpath);
781 if (collection_manager_action_tail == collection_manager_action_list)
783 collection_manager_action_tail = NULL;
785 collection_manager_action_list = g_list_remove(collection_manager_action_list, action);
786 collect_manager_action_unref(action);
790 static gint collect_manager_process_entry(CollectManagerEntry *entry)
795 if (entry->empty) return FALSE;
797 cd = collection_new(entry->path);
798 success = collection_load_private(cd, entry->path, COLLECTION_LOAD_NONE);
800 collection_unref(cd);
805 static gint collect_manager_process_entry_list(void)
809 work = collection_manager_entry_list;
812 CollectManagerEntry *entry;
816 if (collect_manager_process_entry(entry)) return TRUE;
824 static gint collect_manager_process_cb(gpointer data)
826 if (collection_manager_action_list) collect_manager_refresh();
827 collect_manager_process_actions(COLLECT_MANAGER_ACTIONS_PER_IDLE);
828 if (collection_manager_action_list) return TRUE;
830 if (collect_manager_process_entry_list()) return TRUE;
832 if (debug) printf("collection manager is up to date\n");
836 static gint collect_manager_timer_cb(gpointer data)
838 if (debug) printf("collection manager timer expired\n");
840 g_idle_add_full(G_PRIORITY_LOW, collect_manager_process_cb, NULL, NULL);
842 collection_manager_timer_id = -1;
846 static void collect_manager_timer_push(gint stop)
848 if (collection_manager_timer_id != -1)
852 g_source_remove(collection_manager_timer_id);
853 collection_manager_timer_id = -1;
858 collection_manager_timer_id = g_timeout_add(COLLECT_MANAGER_FLUSH_DELAY,
859 collect_manager_timer_cb, NULL);
860 if (debug) printf("collection manager timer started\n");
864 static void collect_manager_add_action(CollectManagerAction *action)
868 /* we keep track of the list's tail to keep this a n(1) operation */
870 if (collection_manager_action_tail)
872 collection_manager_action_tail = g_list_append(collection_manager_action_tail, action);
873 collection_manager_action_tail = collection_manager_action_tail->next;
877 collection_manager_action_list = g_list_append(collection_manager_action_list, action);
878 collection_manager_action_tail = collection_manager_action_list;
881 collect_manager_timer_push(FALSE);
884 void collect_manager_moved(FileData *fd)
886 CollectManagerAction *action;
887 const gchar *oldpath = fd->change->source;
888 const gchar *newpath = fd->change->dest;
890 action = collect_manager_action_new(oldpath, newpath, COLLECTION_MANAGER_UPDATE);
891 collect_manager_add_action(action);
894 void collect_manager_add(FileData *fd, const gchar *collection)
896 CollectManagerAction *action;
899 if (!fd || !collection) return;
901 cw = collection_window_find_by_path(collection);
904 if (collection_list_find(cw->cd->list, fd->path) == NULL)
906 collection_add(cw->cd, fd, FALSE);
911 action = collect_manager_action_new(fd->path, collection, COLLECTION_MANAGER_ADD);
912 collect_manager_add_action(action);
915 void collect_manager_remove(FileData *fd, const gchar *collection)
917 CollectManagerAction *action;
920 if (!fd || !collection) return;
922 cw = collection_window_find_by_path(collection);
925 while (collection_remove(cw->cd, fd));
929 action = collect_manager_action_new(fd->path, collection, COLLECTION_MANAGER_REMOVE);
930 collect_manager_add_action(action);
933 void collect_manager_flush(void)
935 collect_manager_timer_push(TRUE);
937 if (debug) printf("collection manager flushing\n");
938 while (collect_manager_process_cb(NULL));