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("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 257         filter_add_if_missing("ufraw", "UFRaw ID file", ".ufraw", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 258         filter_add_if_missing("pto", "Panorama script file", ".pto", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 259
 260         /* These are the raw camera formats with embedded jpeg/exif.
 261          * (see format_raw.c and/or exiv2.cc)
 262          */
 263         filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 264         filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 265         filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 266         filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 267         filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 268         filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 269         filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 270         filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 271         filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef;.ptx", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 272         filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 273         filter_add_if_missing("x3f", "Sigma raw format", ".x3f", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 274         filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 275         filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 276         filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 277         filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 278         filter_add_if_missing("srw", "Samsung raw format", ".srw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 279         filter_add_if_missing("rw2", "Panasonic raw format", ".rw2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 280 }
 281
 282 GList *filter_to_list(const gchar *extensions)
 283 {
 284         GList *list = NULL;
 285         const gchar *p;
 286
 287         if (!extensions) return NULL;
 288
 289         p = extensions;
 290         while (*p != '\0')
 291                 {
 292                 const gchar *b;
 293                 gchar *ext;
 294                 gint file_class = -1;
 295                 guint l = 0;
 296
 297                 b = p;
 298                 while (*p != '\0' && *p != ';')
 299                         {
 300                         p++;
 301                         l++;
 302                         }
 303
 304                 ext = g_strndup(b, l);
 305
 306                 if (g_ascii_strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
 307                 else if (g_ascii_strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
 308                 else if (g_ascii_strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
 309                 else if (g_ascii_strcasecmp(ext, "%unknown") == 0) file_class = FORMAT_CLASS_UNKNOWN;
 310
 311                 if (file_class == -1)
 312                         {
 313                         list = g_list_append(list, ext);
 314                         }
 315                 else
 316                         {
 317                         list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
 318                         g_free(ext);
 319                         }
 320
 321                 if (*p == ';') p++;
 322                 }
 323
 324         return list;
 325 }
 326
 327 static gint filter_sort_ext_len_cb(gconstpointer a, gconstpointer b)
 328 {
 329         gchar *sa = (gchar *)a;
 330         gchar *sb = (gchar *)b;
 331
 332         gint len_a = strlen(sa);
 333         gint len_b = strlen(sb);
 334
 335         if (len_a > len_b) return -1;
 336         if (len_a < len_b) return 1;
 337         return 0;
 338 }
 339
 340
 341 void filter_rebuild(void)
 342 {
 343         GList *work;
 344         guint i;
 345
 346         string_list_free(extension_list);
 347         extension_list = NULL;
 348
 349         string_list_free(file_writable_list);
 350         file_writable_list = NULL;
 351
 352         string_list_free(file_sidecar_list);
 353         file_sidecar_list = NULL;
 354
 355         for (i = 0; i < FILE_FORMAT_CLASSES; i++)
 356                 {
 357                 string_list_free(file_class_extension_list[i]);
 358                 file_class_extension_list[i] = NULL;
 359                 }
 360
 361         work = filter_list;
 362         while (work)
 363                 {
 364                 FilterEntry *fe;
 365
 366                 fe = work->data;
 367                 work = work->next;
 368
 369                 if (fe->enabled)
 370                         {
 371                         GList *ext;
 372
 373                         ext = filter_to_list(fe->extensions);
 374                         if (ext) extension_list = g_list_concat(extension_list, ext);
 375
 376                         if (fe->file_class < FILE_FORMAT_CLASSES)
 377                                 {
 378                                 ext = filter_to_list(fe->extensions);
 379                                 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
 380                                 }
 381                         else
 382                                 {
 383                                 log_printf("WARNING: invalid file class %d\n", fe->file_class);
 384                                 }
 385
 386                         if (fe->writable)
 387                                 {
 388                                 ext = filter_to_list(fe->extensions);
 389                                 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
 390                                 }
 391
 392                         if (fe->allow_sidecar)
 393                                 {
 394                                 ext = filter_to_list(fe->extensions);
 395                                 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
 396                                 }
 397
 398                         }
 399                 }
 400
 401         /* make sure registered_extension_from_path finds the longer match first */
 402         extension_list = g_list_sort(extension_list, filter_sort_ext_len_cb);
 403         sidecar_ext_parse(options->sidecar.ext); /* this must be updated after changed file extensions */
 404 }
 405
 406 /* return the extension part of the name or NULL */
 407 static const gchar *filter_name_find(GList *filter, const gchar *name)
 408 {
 409         GList *work;
 410         guint ln;
 411
 412         ln = strlen(name);
 413         work = filter;
 414         while (work)
 415                 {
 416                 gchar *filter = work->data;
 417                 guint lf = strlen(filter);
 418
 419                 if (ln >= lf)
 420                         {
 421                         /* FIXME: utf8 */
 422                         if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return name + ln - lf;
 423                         }
 424                 work = work->next;
 425                 }
 426
 427         return NULL;
 428 }
 429 const gchar *registered_extension_from_path(const gchar *name)
 430 {
 431         return filter_name_find(extension_list, name);
 432 }
 433
 434 gboolean filter_name_exists(const gchar *name)
 435 {
 436         if (!extension_list || options->file_filter.disable) return TRUE;
 437
 438         return !!filter_name_find(extension_list, name);
 439 }
 440
 441 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
 442 {
 443         if (file_class >= FILE_FORMAT_CLASSES)
 444                 {
 445                 log_printf("WARNING: invalid file class %d\n", file_class);
 446                 return FALSE;
 447                 }
 448
 449         return !!filter_name_find(file_class_extension_list[file_class], name);
 450 }
 451
 452 gboolean filter_name_is_writable(const gchar *name)
 453 {
 454         return !!filter_name_find(file_writable_list, name);
 455 }
 456
 457 gboolean filter_name_allow_sidecar(const gchar *name)
 458 {
 459         return !!filter_name_find(file_sidecar_list, name);
 460 }
 461
 462 void filter_write_list(GString *outstr, gint indent)
 463 {
 464         GList *work;
 465
 466         WRITE_NL(); WRITE_STRING("<filter>");
 467         indent++;
 468
 469         work = filter_list;
 470         while (work)
 471                 {
 472                 FilterEntry *fe = work->data;
 473                 work = work->next;
 474
 475                 WRITE_NL(); WRITE_STRING("<file_type ");
 476                 WRITE_CHAR(*fe, key);
 477                 WRITE_BOOL(*fe, enabled);
 478                 WRITE_CHAR(*fe, extensions);
 479                 WRITE_CHAR(*fe, description);
 480                 WRITE_UINT(*fe, file_class);
 481                 WRITE_BOOL(*fe, writable);
 482                 WRITE_BOOL(*fe, allow_sidecar);
 483                 WRITE_STRING("/>");
 484                 }
 485         indent--;
 486         WRITE_NL(); WRITE_STRING("</filter>");
 487 }
 488
 489 void filter_load_file_type(const gchar **attribute_names, const gchar **attribute_values)
 490 {
 491         FilterEntry fe;
 492         FilterEntry *old_fe;
 493         memset(&fe, 0, sizeof(fe));
 494         while (*attribute_names)
 495                 {
 496                 const gchar *option = *attribute_names++;
 497                 const gchar *value = *attribute_values++;
 498
 499                 if (READ_CHAR(fe, key)) continue;
 500                 if (READ_BOOL(fe, enabled)) continue;
 501                 if (READ_CHAR(fe, extensions)) continue;
 502                 if (READ_CHAR(fe, description)) continue;
 503                 if (READ_UINT(fe, file_class)) continue;
 504                 if (READ_BOOL(fe, writable)) continue;
 505                 if (READ_BOOL(fe, allow_sidecar)) continue;
 506
 507                 log_printf("unknown attribute %s = %s\n", option, value);
 508                 }
 509         if (fe.file_class >= FILE_FORMAT_CLASSES) fe.file_class = FORMAT_CLASS_UNKNOWN;
 510
 511         if (fe.key && fe.key[0] != 0)
 512                 {
 513                 old_fe = filter_get_by_key(fe.key);
 514
 515                 if (old_fe != NULL) filter_remove_entry(old_fe);
 516                 filter_add(fe.key, fe.description, fe.extensions, fe.file_class, fe.writable, fe.allow_sidecar, fe.enabled);
 517                 }
 518         g_free(fe.key);
 519         g_free(fe.extensions);
 520         g_free(fe.description);
 521 }
 522
 523
 524 /*
 525  *-----------------------------------------------------------------------------
 526  * sidecar extension list
 527  *-----------------------------------------------------------------------------
 528  */
 529
 530 GList *sidecar_ext_get_list(void)
 531 {
 532         return sidecar_ext_list;
 533 }
 534
 535 static void sidecar_ext_free_list(void)
 536 {
 537         GList *work;
 538
 539         work = sidecar_ext_list;
 540         while (work)
 541                 {
 542                 gchar *ext = work->data;
 543                 work = work->next;
 544                 g_free(ext);
 545                 }
 546         g_list_free(sidecar_ext_list);
 547         sidecar_ext_list = NULL;
 548 }
 549
 550 void sidecar_ext_parse(const gchar *text)
 551 {
 552         sidecar_ext_free_list();
 553         if (text == NULL) return;
 554
 555         sidecar_ext_list = filter_to_list(text);
 556 }
 557
 558
 559 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */