1fc53285c8a5922da40ff73c31456b195fbf2a41
[geeqie.git] / src / filefilter.c
1 /*
2  * Copyright (C) 2006 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #include "main.h"
23 #include "filefilter.h"
24
25 #include "cache.h"
26 #include "misc.h"
27 #include "secure_save.h"
28 #include "thumb_standard.h"
29 #include "ui_fileops.h"
30 #include "rcfile.h"
31
32 /*
33  *-----------------------------------------------------------------------------
34  * file filtering
35  *-----------------------------------------------------------------------------
36  */
37
38 static GList *filter_list = NULL;
39 static GList *extension_list = NULL;
40 static GList *sidecar_ext_list = NULL;
41
42 static GList *file_class_extension_list[FILE_FORMAT_CLASSES];
43
44 static GList *file_writable_list = NULL; /* writable files */
45 static GList *file_sidecar_list = NULL; /* files with allowed sidecar */
46
47
48 static FilterEntry *filter_entry_new(const gchar *key, const gchar *description,
49                                      const gchar *extensions, FileFormatClass file_class,
50                                      gboolean writable, gboolean allow_sidecar, gboolean enabled)
51 {
52         FilterEntry *fe;
53
54         fe = g_new0(FilterEntry, 1);
55         fe->key = g_strdup(key);
56         fe->description = g_strdup(description);
57         fe->extensions = g_strdup(extensions);
58         fe->enabled = enabled;
59         fe->file_class = file_class;
60         fe->writable = writable;
61         fe->allow_sidecar = allow_sidecar;
62
63         return fe;
64 }
65
66 static void filter_entry_free(FilterEntry *fe)
67 {
68         if (!fe) return;
69
70         g_free(fe->key);
71         g_free(fe->description);
72         g_free(fe->extensions);
73         g_free(fe);
74 }
75
76 GList *filter_get_list(void)
77 {
78         return filter_list;
79 }
80
81 void filter_remove_entry(FilterEntry *fe)
82 {
83         if (!g_list_find(filter_list, fe)) return;
84
85         filter_list = g_list_remove(filter_list, fe);
86         filter_entry_free(fe);
87 }
88
89 static FilterEntry *filter_get_by_key(const gchar *key)
90 {
91         GList *work;
92
93         if (!key) return NULL;
94
95         work = filter_list;
96         while (work)
97                 {
98                 FilterEntry *fe = work->data;
99                 work = work->next;
100
101                 if (strcmp(fe->key, key) == 0) return fe;
102                 }
103
104         return NULL;
105 }
106
107 static gboolean filter_key_exists(const gchar *key)
108 {
109         return (filter_get_by_key(key) != NULL);
110 }
111
112 void filter_add(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
113 {
114         filter_list = g_list_append(filter_list, filter_entry_new(key, description, extensions, file_class, writable, allow_sidecar, enabled));
115 }
116
117 void filter_add_unique(const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
118 {
119         gchar *key;
120         guint n;
121
122         key = g_strdup("user0");
123         n = 1;
124         while (filter_key_exists(key))
125                 {
126                 g_free(key);
127                 if (n > 999) return;
128                 key = g_strdup_printf("user%d", n);
129                 n++;
130                 }
131
132         filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
133         g_free(key);
134 }
135
136 static void filter_add_if_missing(const gchar *key, const gchar *description, const gchar *extensions, FileFormatClass file_class, gboolean writable, gboolean allow_sidecar, gboolean enabled)
137 {
138         GList *work;
139
140         if (!key) return;
141
142         work = filter_list;
143         while (work)
144                 {
145                 FilterEntry *fe = work->data;
146                 work = work->next;
147                 if (fe->key && strcmp(fe->key, key) == 0)
148                         {
149                         if (fe->file_class == FORMAT_CLASS_UNKNOWN)
150                                 fe->file_class = file_class;    /* for compatibility */
151
152                         if (fe->writable && fe->allow_sidecar)
153                                 {
154                                 fe->writable = writable;
155                                 fe->allow_sidecar = allow_sidecar;
156                                 }
157                         return;
158                         }
159                 }
160
161         filter_add(key, description, extensions, file_class, writable, allow_sidecar, enabled);
162 }
163
164 void filter_reset(void)
165 {
166         GList *work;
167
168         work = filter_list;
169         while (work)
170                 {
171                 FilterEntry *fe = work->data;
172                 work = work->next;
173                 filter_entry_free(fe);
174                 }
175
176         g_list_free(filter_list);
177         filter_list = NULL;
178 }
179
180 void filter_add_defaults(void)
181 {
182         GSList *list, *work;
183
184         list = gdk_pixbuf_get_formats();
185         work = list;
186         while (work)
187                 {
188                 GdkPixbufFormat *format;
189                 gchar *name;
190                 gchar *desc;
191                 gchar **extensions;
192                 GString *filter = NULL;
193                 guint i;
194
195                 format = work->data;
196                 work = work->next;
197
198                 name = gdk_pixbuf_format_get_name(format);
199
200                 if (strcmp(name, "Digital camera RAW") == 0)
201                         {
202                         DEBUG_1("Skipped '%s' from loader", name);
203                         g_free(name);
204                         continue;
205                         }
206
207                 desc = gdk_pixbuf_format_get_description(format);
208                 extensions = gdk_pixbuf_format_get_extensions(format);
209
210                 i = 0;
211                 while (extensions[i])
212                         {
213                         if (!filter)
214                                 {
215                                 filter = g_string_new(".");
216                                 filter = g_string_append(filter, extensions[i]);
217                                 }
218                         else
219                                 {
220                                 filter = g_string_append(filter, ";.");
221                                 filter = g_string_append(filter, extensions[i]);
222                                 }
223                         i++;
224                         }
225
226                 DEBUG_1("loader reported [%s] [%s] [%s]", name, desc, filter->str);
227
228                 filter_add_if_missing(name, desc, filter->str, FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
229
230                 g_free(name);
231                 g_free(desc);
232                 g_strfreev(extensions);
233                 g_string_free(filter, TRUE);
234                 }
235         g_slist_free(list);
236
237         /* add defaults even if gdk-pixbuf does not have them, but disabled */
238         filter_add_if_missing("jpeg", "JPEG group", ".jpg;.jpeg;.jpe", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
239         filter_add_if_missing("png", "Portable Network Graphic", ".png", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
240         filter_add_if_missing("tiff", "Tiff", ".tif;.tiff", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
241         filter_add_if_missing("pnm", "Packed Pixel formats", ".pbm;.pgm;.pnm;.ppm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
242         filter_add_if_missing("gif", "Graphics Interchange Format", ".gif", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
243         filter_add_if_missing("xbm", "X bitmap", ".xbm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
244         filter_add_if_missing("xpm", "X pixmap", ".xpm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
245         filter_add_if_missing("bmp", "Bitmap", ".bmp", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
246         filter_add_if_missing("ico", "Icon file", ".ico;.cur", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
247         filter_add_if_missing("ras", "Raster", ".ras", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
248         filter_add_if_missing("svg", "Scalable Vector Graphics", ".svg", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
249
250         /* special formats for stereo */
251         filter_add_if_missing("jps", "Stereo side-by-side jpeg", ".jps", FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
252         filter_add_if_missing("mpo", "Stereo multi-image jpeg", ".mpo", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
253
254         /* non-image files that might be desirable to show */
255         filter_add_if_missing("xmp", "XMP sidecar", ".xmp", FORMAT_CLASS_META, TRUE, FALSE, TRUE);
256         filter_add_if_missing("meta", "GQview legacy metadata", GQ_CACHE_EXT_METADATA, FORMAT_CLASS_META, TRUE, FALSE, TRUE);
257         filter_add_if_missing("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_COLLECTION, FALSE, FALSE, TRUE);
258         filter_add_if_missing("ufraw", "UFRaw ID file", ".ufraw", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
259         filter_add_if_missing("pto", "Panorama script file", ".pto", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
260
261         /* These are the raw camera formats with embedded jpeg/exif.
262          * (see format_raw.c and/or exiv2.cc)
263          */
264         filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
265         filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
266         filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
267         filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
268         filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
269         filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
270         filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
271         filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
272         filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef;.ptx", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
273         filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
274         filter_add_if_missing("x3f", "Sigma raw format", ".x3f", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
275         filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
276         filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
277         filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
278         filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
279         filter_add_if_missing("srw", "Samsung raw format", ".srw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
280         filter_add_if_missing("rw2", "Panasonic raw format", ".rw2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
281
282         /* video files */
283         filter_add_if_missing("mp4", "MP4 video file", ".mp4;.m4v;.3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
284         filter_add_if_missing("3gp", "3GP video file", ".3gp;.3g2", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
285         filter_add_if_missing("mov", "MOV video file", ".mov;.qt", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
286         filter_add_if_missing("avi", "AVI video file", ".avi", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
287         filter_add_if_missing("mpg", "MPG video file", ".mpg;.mpeg;.mts;.m2ts", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
288         filter_add_if_missing("mkv", "Matroska video file", ".mkv;.webm", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
289         filter_add_if_missing("wmv", "Windows Media Video file", ".wmv;.asf", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
290         filter_add_if_missing("flv", "Flash Video file", ".flv", FORMAT_CLASS_VIDEO, FALSE, FALSE, FALSE);
291
292         /* other supported formats */
293         filter_add_if_missing("dds", "DirectDraw Surface", ".dds", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
294         filter_add_if_missing("pdf", "Portable Document Format", ".pdf", FORMAT_CLASS_PDF, FALSE, FALSE, TRUE);
295         filter_add_if_missing("HEIF", "HEIF Format", ".heic", FORMAT_CLASS_IMAGE, FALSE, FALSE, TRUE);
296 }
297
298 GList *filter_to_list(const gchar *extensions)
299 {
300         GList *list = NULL;
301         const gchar *p;
302
303         if (!extensions) return NULL;
304
305         p = extensions;
306         while (*p != '\0')
307                 {
308                 const gchar *b;
309                 gchar *ext;
310                 gint file_class = -1;
311                 guint l = 0;
312
313                 b = p;
314                 while (*p != '\0' && *p != ';')
315                         {
316                         p++;
317                         l++;
318                         }
319
320                 ext = g_strndup(b, l);
321
322                 if (g_ascii_strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
323                 else if (g_ascii_strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
324                 else if (g_ascii_strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
325                 else if (g_ascii_strcasecmp(ext, "%unknown") == 0) file_class = FORMAT_CLASS_UNKNOWN;
326
327                 if (file_class == -1)
328                         {
329                         list = g_list_append(list, ext);
330                         }
331                 else
332                         {
333                         list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
334                         g_free(ext);
335                         }
336
337                 if (*p == ';') p++;
338                 }
339
340         return list;
341 }
342
343 static gint filter_sort_ext_len_cb(gconstpointer a, gconstpointer b)
344 {
345         gchar *sa = (gchar *)a;
346         gchar *sb = (gchar *)b;
347
348         gint len_a = strlen(sa);
349         gint len_b = strlen(sb);
350
351         if (len_a > len_b) return -1;
352         if (len_a < len_b) return 1;
353         return 0;
354 }
355
356
357 void filter_rebuild(void)
358 {
359         GList *work;
360         guint i;
361
362         string_list_free(extension_list);
363         extension_list = NULL;
364
365         string_list_free(file_writable_list);
366         file_writable_list = NULL;
367
368         string_list_free(file_sidecar_list);
369         file_sidecar_list = NULL;
370
371         for (i = 0; i < FILE_FORMAT_CLASSES; i++)
372                 {
373                 string_list_free(file_class_extension_list[i]);
374                 file_class_extension_list[i] = NULL;
375                 }
376
377         work = filter_list;
378         while (work)
379                 {
380                 FilterEntry *fe;
381
382                 fe = work->data;
383                 work = work->next;
384
385                 if (fe->enabled)
386                         {
387                         GList *ext;
388
389                         ext = filter_to_list(fe->extensions);
390                         if (ext) extension_list = g_list_concat(extension_list, ext);
391
392                         if (fe->file_class < FILE_FORMAT_CLASSES)
393                                 {
394                                 ext = filter_to_list(fe->extensions);
395                                 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
396                                 }
397                         else
398                                 {
399                                 log_printf("WARNING: invalid file class %d\n", fe->file_class);
400                                 }
401
402                         if (fe->writable)
403                                 {
404                                 ext = filter_to_list(fe->extensions);
405                                 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
406                                 }
407
408                         if (fe->allow_sidecar)
409                                 {
410                                 ext = filter_to_list(fe->extensions);
411                                 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
412                                 }
413
414                         }
415                 }
416
417         /* make sure registered_extension_from_path finds the longer match first */
418         extension_list = g_list_sort(extension_list, filter_sort_ext_len_cb);
419         sidecar_ext_parse(options->sidecar.ext); /* this must be updated after changed file extensions */
420 }
421
422 /* return the extension part of the name or NULL */
423 static const gchar *filter_name_find(GList *filter, const gchar *name)
424 {
425         GList *work;
426         guint ln;
427
428         ln = strlen(name);
429         work = filter;
430         while (work)
431                 {
432                 gchar *filter = work->data;
433                 guint lf = strlen(filter);
434
435                 if (ln >= lf)
436                         {
437                         /* FIXME: utf8 */
438                         if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return name + ln - lf;
439                         }
440                 work = work->next;
441                 }
442
443         return NULL;
444 }
445 const gchar *registered_extension_from_path(const gchar *name)
446 {
447         return filter_name_find(extension_list, name);
448 }
449
450 gboolean filter_name_exists(const gchar *name)
451 {
452         if (!extension_list || options->file_filter.disable) return TRUE;
453
454         return !!filter_name_find(extension_list, name);
455 }
456
457 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
458 {
459         if (file_class >= FILE_FORMAT_CLASSES)
460                 {
461                 log_printf("WARNING: invalid file class %d\n", file_class);
462                 return FALSE;
463                 }
464
465         return !!filter_name_find(file_class_extension_list[file_class], name);
466 }
467
468 FileFormatClass filter_file_get_class(const gchar *name)
469 {
470         if (filter_file_class(name, FORMAT_CLASS_IMAGE)) return FORMAT_CLASS_IMAGE;
471         if (filter_file_class(name, FORMAT_CLASS_RAWIMAGE)) return FORMAT_CLASS_RAWIMAGE;
472         if (filter_file_class(name, FORMAT_CLASS_META)) return FORMAT_CLASS_META;
473         if (filter_file_class(name, FORMAT_CLASS_VIDEO)) return FORMAT_CLASS_VIDEO;
474         if (filter_file_class(name, FORMAT_CLASS_COLLECTION)) return FORMAT_CLASS_COLLECTION;
475         if (filter_file_class(name, FORMAT_CLASS_PDF)) return FORMAT_CLASS_PDF;
476         return FORMAT_CLASS_UNKNOWN;
477 }
478
479 gboolean filter_name_is_writable(const gchar *name)
480 {
481         return !!filter_name_find(file_writable_list, name);
482 }
483
484 gboolean filter_name_allow_sidecar(const gchar *name)
485 {
486         return !!filter_name_find(file_sidecar_list, name);
487 }
488
489 void filter_write_list(GString *outstr, gint indent)
490 {
491         GList *work;
492
493         WRITE_NL(); WRITE_STRING("<filter>");
494         indent++;
495
496         work = filter_list;
497         while (work)
498                 {
499                 FilterEntry *fe = work->data;
500                 work = work->next;
501
502                 WRITE_NL(); WRITE_STRING("<file_type ");
503                 WRITE_CHAR(*fe, key);
504                 WRITE_BOOL(*fe, enabled);
505                 WRITE_CHAR(*fe, extensions);
506                 WRITE_CHAR(*fe, description);
507                 WRITE_UINT(*fe, file_class);
508                 WRITE_BOOL(*fe, writable);
509                 WRITE_BOOL(*fe, allow_sidecar);
510                 WRITE_STRING("/>");
511                 }
512         indent--;
513         WRITE_NL(); WRITE_STRING("</filter>");
514 }
515
516 void filter_load_file_type(const gchar **attribute_names, const gchar **attribute_values)
517 {
518         FilterEntry fe;
519         FilterEntry *old_fe;
520         memset(&fe, 0, sizeof(fe));
521         while (*attribute_names)
522                 {
523                 const gchar *option = *attribute_names++;
524                 const gchar *value = *attribute_values++;
525
526                 if (READ_CHAR(fe, key)) continue;
527                 if (READ_BOOL(fe, enabled)) continue;
528                 if (READ_CHAR(fe, extensions)) continue;
529                 if (READ_CHAR(fe, description)) continue;
530                 if (READ_UINT(fe, file_class)) continue;
531                 if (READ_BOOL(fe, writable)) continue;
532                 if (READ_BOOL(fe, allow_sidecar)) continue;
533
534                 log_printf("unknown attribute %s = %s\n", option, value);
535                 }
536         if (fe.file_class >= FILE_FORMAT_CLASSES) fe.file_class = FORMAT_CLASS_UNKNOWN;
537
538         if (fe.key && fe.key[0] != 0)
539                 {
540                 old_fe = filter_get_by_key(fe.key);
541
542                 if (old_fe != NULL) filter_remove_entry(old_fe);
543                 filter_add(fe.key, fe.description, fe.extensions, fe.file_class, fe.writable, fe.allow_sidecar, fe.enabled);
544                 }
545         g_free(fe.key);
546         g_free(fe.extensions);
547         g_free(fe.description);
548 }
549
550
551 /*
552  *-----------------------------------------------------------------------------
553  * sidecar extension list
554  *-----------------------------------------------------------------------------
555  */
556
557 GList *sidecar_ext_get_list(void)
558 {
559         return sidecar_ext_list;
560 }
561
562 static void sidecar_ext_free_list(void)
563 {
564         GList *work;
565
566         work = sidecar_ext_list;
567         while (work)
568                 {
569                 gchar *ext = work->data;
570                 work = work->next;
571                 g_free(ext);
572                 }
573         g_list_free(sidecar_ext_list);
574         sidecar_ext_list = NULL;
575 }
576
577 void sidecar_ext_parse(const gchar *text)
578 {
579         sidecar_ext_free_list();
580         if (text == NULL) return;
581
582         sidecar_ext_list = filter_to_list(text);
583 }
584
585
586 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */