src/filefilter.c

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