src/filefilter.c

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