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                 desc = gdk_pixbuf_format_get_description(format);
 192                 extensions = gdk_pixbuf_format_get_extensions(format);
 193
 194                 i = 0;
 195                 while (extensions[i])
 196                         {
 197                         if (!filter)
 198                                 {
 199                                 filter = g_string_new(".");
 200                                 filter = g_string_append(filter, extensions[i]);
 201                                 }
 202                         else
 203                                 {
 204                                 filter = g_string_append(filter, ";.");
 205                                 filter = g_string_append(filter, extensions[i]);
 206                                 }
 207                         i++;
 208                         }
 209
 210                 DEBUG_1("loader reported [%s] [%s] [%s]", name, desc, filter->str);
 211
 212                 filter_add_if_missing(name, desc, filter->str, FORMAT_CLASS_IMAGE, TRUE, FALSE, TRUE);
 213
 214                 g_free(name);
 215                 g_free(desc);
 216                 g_strfreev(extensions);
 217                 g_string_free(filter, TRUE);
 218                 }
 219         g_slist_free(list);
 220
 221         /* add defaults even if gdk-pixbuf does not have them, but disabled */
 222         filter_add_if_missing("jpeg", "JPEG group", ".jpg;.jpeg;.jpe", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 223         filter_add_if_missing("png", "Portable Network Graphic", ".png", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 224         filter_add_if_missing("tiff", "Tiff", ".tif;.tiff", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 225         filter_add_if_missing("pnm", "Packed Pixel formats", ".pbm;.pgm;.pnm;.ppm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 226         filter_add_if_missing("gif", "Graphics Interchange Format", ".gif", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 227         filter_add_if_missing("xbm", "X bitmap", ".xbm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 228         filter_add_if_missing("xpm", "X pixmap", ".xpm", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 229         filter_add_if_missing("bmp", "Bitmap", ".bmp", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 230         filter_add_if_missing("ico", "Icon file", ".ico;.cur", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 231         filter_add_if_missing("ras", "Raster", ".ras", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 232         filter_add_if_missing("svg", "Scalable Vector Graphics", ".svg", FORMAT_CLASS_IMAGE, TRUE, FALSE, FALSE);
 233
 234         /* non-image files that might be desirable to show */
 235         filter_add_if_missing("xmp", "XMP sidecar", ".xmp", FORMAT_CLASS_META, TRUE, FALSE, TRUE);
 236         filter_add_if_missing("gqv", GQ_APPNAME " image collection", GQ_COLLECTION_EXT, FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 237         filter_add_if_missing("ufraw", "UFRaw ID file", ".ufraw", FORMAT_CLASS_META, FALSE, FALSE, TRUE);
 238
 239         /* These are the raw camera formats with embedded jpeg/exif.
 240          * (see format_raw.c and/or exiv2.cc)
 241          */
 242         filter_add_if_missing("arw", "Sony raw format", ".arw;.srf;.sr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 243         filter_add_if_missing("crw", "Canon raw format", ".crw;.cr2", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 244         filter_add_if_missing("kdc", "Kodak raw format", ".kdc;.dcr;.k25", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 245         filter_add_if_missing("raf", "Fujifilm raw format", ".raf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 246         filter_add_if_missing("mef", "Mamiya raw format", ".mef;.mos", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 247         filter_add_if_missing("mrw", "Minolta raw format", ".mrw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 248         filter_add_if_missing("nef", "Nikon raw format", ".nef", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 249         filter_add_if_missing("orf", "Olympus raw format", ".orf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 250         filter_add_if_missing("pef", "Pentax or Samsung raw format", ".pef;.ptx", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 251         filter_add_if_missing("dng", "Adobe Digital Negative raw format", ".dng", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 252         filter_add_if_missing("x3f", "Sigma raw format", ".x3f", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 253         filter_add_if_missing("raw", "Panasonic raw format", ".raw", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 254         filter_add_if_missing("r3d", "Red raw format", ".r3d", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 255         filter_add_if_missing("3fr", "Hasselblad raw format", ".3fr", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 256         filter_add_if_missing("erf", "Epson raw format", ".erf", FORMAT_CLASS_RAWIMAGE, FALSE, TRUE, TRUE);
 257 }
 258
 259 GList *filter_to_list(const gchar *extensions)
 260 {
 261         GList *list = NULL;
 262         const gchar *p;
 263
 264         if (!extensions) return NULL;
 265
 266         p = extensions;
 267         while (*p != '\0')
 268                 {
 269                 const gchar *b;
 270                 gchar *ext;
 271                 gint file_class = -1;
 272                 guint l = 0;
 273
 274                 b = p;
 275                 while (*p != '\0' && *p != ';')
 276                         {
 277                         p++;
 278                         l++;
 279                         }
 280
 281                 ext = g_strndup(b, l);
 282
 283                 if (g_ascii_strcasecmp(ext, "%image") == 0) file_class = FORMAT_CLASS_IMAGE;
 284                 else if (g_ascii_strcasecmp(ext, "%raw") == 0) file_class = FORMAT_CLASS_RAWIMAGE;
 285                 else if (g_ascii_strcasecmp(ext, "%meta") == 0) file_class = FORMAT_CLASS_META;
 286                 else if (g_ascii_strcasecmp(ext, "%unknown") == 0) file_class = FORMAT_CLASS_UNKNOWN;
 287
 288                 if (file_class == -1)
 289                         {
 290                         list = g_list_append(list, ext);
 291                         }
 292                 else
 293                         {
 294                         list = g_list_concat(list, string_list_copy(file_class_extension_list[file_class]));
 295                         g_free(ext);
 296                         }
 297
 298                 if (*p == ';') p++;
 299                 }
 300
 301         return list;
 302 }
 303
 304 void filter_rebuild(void)
 305 {
 306         GList *work;
 307         guint i;
 308
 309         string_list_free(extension_list);
 310         extension_list = NULL;
 311
 312         string_list_free(file_writable_list);
 313         file_writable_list = NULL;
 314
 315         string_list_free(file_sidecar_list);
 316         file_sidecar_list = NULL;
 317
 318         for (i = 0; i < FILE_FORMAT_CLASSES; i++)
 319                 {
 320                 string_list_free(file_class_extension_list[i]);
 321                 file_class_extension_list[i] = NULL;
 322                 }
 323
 324         work = filter_list;
 325         while (work)
 326                 {
 327                 FilterEntry *fe;
 328
 329                 fe = work->data;
 330                 work = work->next;
 331
 332                 if (fe->enabled)
 333                         {
 334                         GList *ext;
 335
 336                         ext = filter_to_list(fe->extensions);
 337                         if (ext) extension_list = g_list_concat(extension_list, ext);
 338
 339                         if (fe->file_class < FILE_FORMAT_CLASSES)
 340                                 {
 341                                 ext = filter_to_list(fe->extensions);
 342                                 if (ext) file_class_extension_list[fe->file_class] = g_list_concat(file_class_extension_list[fe->file_class], ext);
 343                                 }
 344                         else
 345                                 {
 346                                 log_printf("WARNING: invalid file class %d\n", fe->file_class);
 347                                 }
 348
 349                         if (fe->writable)
 350                                 {
 351                                 ext = filter_to_list(fe->extensions);
 352                                 if (ext) file_writable_list = g_list_concat(file_writable_list, ext);
 353                                 }
 354
 355                         if (fe->allow_sidecar)
 356                                 {
 357                                 ext = filter_to_list(fe->extensions);
 358                                 if (ext) file_sidecar_list = g_list_concat(file_sidecar_list, ext);
 359                                 }
 360
 361                         }
 362                 }
 363
 364         sidecar_ext_parse(options->sidecar.ext); /* this must be updated after changed file extensions */
 365 }
 366
 367 static gboolean filter_name_find(GList *filter, const gchar *name)
 368 {
 369         GList *work;
 370         guint ln;
 371
 372         ln = strlen(name);
 373         work = filter;
 374         while (work)
 375                 {
 376                 gchar *filter = work->data;
 377                 guint lf = strlen(filter);
 378
 379                 if (ln >= lf)
 380                         {
 381                         /* FIXME: utf8 */
 382                         if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return TRUE;
 383                         }
 384                 work = work->next;
 385                 }
 386
 387         return FALSE;
 388 }
 389
 390
 391 gboolean filter_name_exists(const gchar *name)
 392 {
 393         if (!extension_list || options->file_filter.disable) return TRUE;
 394
 395         return filter_name_find(extension_list, name);
 396 }
 397
 398 gboolean filter_file_class(const gchar *name, FileFormatClass file_class)
 399 {
 400         if (file_class >= FILE_FORMAT_CLASSES)
 401                 {
 402                 log_printf("WARNING: invalid file class %d\n", file_class);
 403                 return FALSE;
 404                 }
 405
 406         return filter_name_find(file_class_extension_list[file_class], name);
 407 }
 408
 409 gboolean filter_name_is_writable(const gchar *name)
 410 {
 411         return filter_name_find(file_writable_list, name);
 412 }
 413
 414 gboolean filter_name_allow_sidecar(const gchar *name)
 415 {
 416         return filter_name_find(file_sidecar_list, name);
 417 }
 418
 419 void filter_write_list(GString *outstr, gint indent)
 420 {
 421         GList *work;
 422
 423         WRITE_NL(); WRITE_STRING("<filter>");
 424         indent++;
 425
 426         work = filter_list;
 427         while (work)
 428                 {
 429                 FilterEntry *fe = work->data;
 430                 work = work->next;
 431
 432                 WRITE_NL(); WRITE_STRING("<file_type ");
 433                 WRITE_CHAR(*fe, key);
 434                 WRITE_BOOL(*fe, enabled);
 435                 WRITE_CHAR(*fe, extensions);
 436                 WRITE_CHAR(*fe, description);
 437                 WRITE_UINT(*fe, file_class);
 438                 WRITE_BOOL(*fe, writable);
 439                 WRITE_BOOL(*fe, allow_sidecar);
 440                 WRITE_STRING("/>");
 441                 }
 442         indent--;
 443         WRITE_NL(); WRITE_STRING("</filter>");
 444 }
 445
 446 void filter_load_file_type(const gchar **attribute_names, const gchar **attribute_values)
 447 {
 448         FilterEntry fe;
 449         FilterEntry *old_fe;
 450         memset(&fe, 0, sizeof(fe));
 451         while (*attribute_names)
 452                 {
 453                 const gchar *option = *attribute_names++;
 454                 const gchar *value = *attribute_values++;
 455
 456                 if (READ_CHAR(fe, key)) continue;
 457                 if (READ_BOOL(fe, enabled)) continue;
 458                 if (READ_CHAR(fe, extensions)) continue;
 459                 if (READ_CHAR(fe, description)) continue;
 460                 if (READ_UINT(fe, file_class)) continue;
 461                 if (READ_BOOL(fe, writable)) continue;
 462                 if (READ_BOOL(fe, allow_sidecar)) continue;
 463
 464                 log_printf("unknown attribute %s = %s\n", option, value);
 465                 }
 466         if (fe.file_class >= FILE_FORMAT_CLASSES) fe.file_class = FORMAT_CLASS_UNKNOWN;
 467
 468         if (fe.key && fe.key[0] != 0)
 469                 {
 470                 old_fe = filter_get_by_key(fe.key);
 471
 472                 if (old_fe != NULL) filter_remove_entry(old_fe);
 473                 filter_add(fe.key, fe.description, fe.extensions, fe.file_class, fe.writable, fe.allow_sidecar, fe.enabled);
 474                 }
 475         g_free(fe.key);
 476         g_free(fe.extensions);
 477         g_free(fe.description);
 478 }
 479
 480
 481 /*
 482  *-----------------------------------------------------------------------------
 483  * sidecar extension list
 484  *-----------------------------------------------------------------------------
 485  */
 486
 487 GList *sidecar_ext_get_list(void)
 488 {
 489         return sidecar_ext_list;
 490 }
 491
 492 static void sidecar_ext_free_list(void)
 493 {
 494         GList *work;
 495
 496         work = sidecar_ext_list;
 497         while (work)
 498                 {
 499                 gchar *ext = work->data;
 500                 work = work->next;
 501                 g_free(ext);
 502                 }
 503         g_list_free(sidecar_ext_list);
 504         sidecar_ext_list = NULL;
 505 }
 506
 507 void sidecar_ext_parse(const gchar *text)
 508 {
 509         sidecar_ext_free_list();
 510         if (text == NULL) return;
 511
 512         sidecar_ext_list = filter_to_list(text);
 513 }
 514
 515
 516 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */