ROX-Filer/src/usericons.c

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * Copyright (C) 2005, the ROX-Filer team.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 /* usericons.c - handle user-defined icons. Diego Zamboni, Feb 7, 2001. */
  23
  24 #include "config.h"
  25
  26 #include <gtk/gtk.h>
  27 #include <errno.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30 #include <unistd.h>
  31 #include <fnmatch.h>
  32 #include <libxml/parser.h>
  33 #include <time.h>
  34
  35 #include "global.h"
  36
  37 #include "fscache.h"
  38 #include "diritem.h"
  39 #include "dir.h"
  40 #include "gui_support.h"
  41 #include "choices.h"
  42 #include "pixmaps.h"
  43 #include "type.h"
  44 #include "run.h"
  45 #include "dnd.h"
  46 #include "support.h"
  47 #include "usericons.h"
  48 #include "main.h"
  49 #include "menu.h"
  50 #include "filer.h"
  51 #include "action.h"
  52 #include "display.h"
  53 #include "xml.h"
  54 #include "dropbox.h"
  55
  56 #define SET_MEDIA 2
  57 #define SET_TYPE 1
  58 #define SET_PATH 0              /* Store in globicons */
  59 #define SET_COPY 3              /* Create .DirIcon */
  60
  61 static GHashTable *glob_icons = NULL; /* Pathname -> Icon pathname */
  62
  63 /* Static prototypes */
  64 static const char *process_globicons_line(gchar *line);
  65 static gboolean free_globicon(gpointer key, gpointer value, gpointer data);
  66 static void write_globicons(void);
  67 static void add_globicon(const gchar *path, const gchar *icon);
  68 static void drag_icon_dropped(GtkWidget *drop_box,
  69                                   const guchar  *path,
  70                                   GtkWidget     *dialog);
  71 static gboolean set_icon_for_type(MIME_type *type, const gchar *iconpath,
  72                                   gboolean just_media);
  73 static void delete_globicon(const gchar *path);
  74 static gboolean convert_to_png(const gchar *src, const gchar *dest);
  75 static void radios_changed(Radios *radios, gpointer data);
  76
  77 /****************************************************************
  78  *                      EXTERNAL INTERFACE                      *
  79  ****************************************************************/
  80
  81 /* Read glob-pattern -> icon mappings from "globicons" in Choices */
  82 void read_globicons()
  83 {
  84         static time_t last_read = (time_t) 0;
  85         struct stat info;
  86         guchar *path;
  87         xmlDocPtr doc;
  88
  89         if (!glob_icons)
  90                 glob_icons = g_hash_table_new(g_str_hash, g_str_equal);
  91
  92         path = choices_find_xdg_path_load("globicons", PROJECT, SITE);
  93         if (!path)
  94                 return; /* Nothing to load */
  95
  96         if (mc_stat(path, &info))
  97                 goto out;
  98
  99         if (info.st_mtime <= last_read)
 100                 goto out;  /* File hasn't been modified since we last read it */
 101
 102         g_hash_table_foreach_remove(glob_icons, free_globicon, NULL);
 103
 104         doc = xmlParseFile(path);
 105         if (doc)
 106         {
 107                 xmlNodePtr node, icon, root;
 108                 char       *match;
 109
 110                 root = xmlDocGetRootElement(doc);
 111
 112                 /* Handle the new XML file format */
 113                 for (node = root->xmlChildrenNode; node; node = node->next)
 114                 {
 115                         gchar *path, *icon_path;
 116
 117                         if (node->type != XML_ELEMENT_NODE)
 118                                 continue;
 119                         if (strcmp(node->name, "rule") != 0)
 120                                 continue;
 121                         icon = get_subnode(node, NULL, "icon");
 122                         if (!icon)
 123                                 continue;
 124                         match = xmlGetProp(node, "match");
 125                         if (!match)
 126                                 continue;
 127
 128                         icon_path = xmlNodeGetContent(icon);
 129                         path = expand_path(match);
 130                         g_hash_table_insert(glob_icons, path, icon_path);
 131                         g_free(match);
 132                 }
 133
 134                 xmlFreeDoc(doc);
 135         }
 136         else
 137         {
 138                 /* Handle the old non-XML format */
 139                 parse_file(path, process_globicons_line);
 140                 if (g_hash_table_size(glob_icons))
 141                         write_globicons();      /* Upgrade to new format */
 142         }
 143
 144         last_read = time(NULL);   /* Update time stamp */
 145 out:
 146         g_free(path);
 147 }
 148
 149 /* Set an item's image field according to the globicons patterns if
 150  * it matches one of them and the file exists.
 151  */
 152 void check_globicon(const guchar *path, DirItem *item)
 153 {
 154         gchar *gi;
 155
 156         g_return_if_fail(item && !item->_image);
 157
 158         gi = g_hash_table_lookup(glob_icons, path);
 159         if (gi)
 160                 item->_image = g_fscache_lookup(pixmap_cache, gi);
 161 }
 162
 163 static gboolean create_diricon(const guchar *filepath, const guchar *iconpath)
 164 {
 165         if (!convert_to_png(iconpath, make_path(filepath, ".DirIcon")))
 166                 return FALSE;
 167
 168         dir_check_this(filepath);
 169
 170         return TRUE;
 171 }
 172
 173 /* Add a globicon mapping for the given file to the given icon path */
 174 static gboolean set_icon_path(const guchar *filepath, const guchar *iconpath)
 175 {
 176         MaskedPixmap *pic;
 177
 178         /* Check if file exists */
 179         if (!file_exists(iconpath))
 180         {
 181                 delayed_error(_("The pathname you gave does not exist. "
 182                                     "The icon has not been changed."));
 183                 return FALSE;
 184         }
 185
 186         /* Check if we can load the image, warn the user if not. */
 187         pic = g_fscache_lookup(pixmap_cache, iconpath);
 188         if (!pic)
 189         {
 190                 delayed_error(
 191                         _("Unable to load image file -- maybe it's not in a "
 192                           "format I understand, or maybe the permissions are "
 193                           "wrong?\n"
 194                           "The icon has not been changed."));
 195                 return FALSE;
 196         }
 197         g_object_unref(pic);
 198
 199         /* Add the globicon mapping and update visible icons */
 200         add_globicon(filepath, iconpath);
 201
 202         return TRUE;
 203 }
 204
 205 static void dialog_response(GtkWidget *dialog, gint response, gpointer data)
 206 {
 207         gtk_widget_destroy(dialog);
 208 }
 209
 210 static void clear_icon(DropBox *drop_box, GObject *dialog)
 211 {
 212         Radios *radios;
 213
 214         radios = g_object_get_data(G_OBJECT(dialog), "radios");
 215         g_return_if_fail(radios != NULL);
 216
 217         if (radios_get_value(radios) == SET_PATH)
 218         {
 219                 const guchar *path;
 220
 221                 path = g_object_get_data(G_OBJECT(dialog), "pathname");
 222                 g_return_if_fail(path != NULL);
 223
 224                 delete_globicon(path);
 225         }
 226         else
 227         {
 228                 const guchar *path;
 229                 guchar *tmp;
 230                 DropBox *drop_box;
 231
 232                 drop_box = g_object_get_data(G_OBJECT(dialog), "rox-dropbox");
 233                 g_return_if_fail(drop_box != NULL);
 234
 235                 path = drop_box_get_path(drop_box);
 236                 g_return_if_fail(path != NULL);
 237
 238                 tmp = g_strdup_printf(_("Really delete icon '%s'?"), path);
 239                 if (confirm(tmp, GTK_STOCK_DELETE, NULL))
 240                 {
 241                         if (unlink(path))
 242                                 delayed_error(_("Can't delete '%s':\n%s"),
 243                                                 path, g_strerror(errno));
 244                 }
 245                 g_free(tmp);
 246         }
 247
 248         full_refresh();
 249         radios_changed(g_object_get_data(dialog, "radios"), dialog);
 250 }
 251
 252 /* Display a dialog box allowing the user to set the icon for
 253  * a file or directory.
 254  */
 255 void icon_set_handler_dialog(DirItem *item, const guchar *path)
 256 {
 257         struct stat     info;
 258         GtkDialog       *dialog;
 259         GtkWidget       *frame;
 260         Radios          *radios;
 261
 262         g_return_if_fail(item != NULL && path != NULL);
 263
 264         dialog = GTK_DIALOG(gtk_dialog_new());
 265         gtk_dialog_set_has_separator(dialog, FALSE);
 266         gtk_window_set_position(GTK_WINDOW(dialog), GTK_WIN_POS_MOUSE);
 267         g_object_set_data_full(G_OBJECT(dialog), "pathname",
 268                                  strdup(path), g_free);
 269
 270         gtk_window_set_title(GTK_WINDOW(dialog), _("Set icon"));
 271
 272         radios = radios_new(radios_changed, dialog);
 273
 274         g_object_set_data(G_OBJECT(dialog), "radios", radios);
 275         g_object_set_data(G_OBJECT(dialog), "mime-type", item->mime_type);
 276
 277 #if 0
 278         radios_add(radios,
 279                         _("Use a copy of the image as the default for all "
 280                           "files of these MIME types."), SET_MEDIA,
 281                         _("Set icon for all `%s/<anything>'"),
 282                         item->mime_type->media_type);
 283 #endif
 284
 285         radios_add(radios,
 286                         _("Use a copy of the image for all files of this MIME "
 287                           "type."), SET_TYPE,
 288                         _("For all files of type `%s' (%s/%s)"),
 289                         mime_type_comment(item->mime_type),
 290                         item->mime_type->media_type,
 291                         item->mime_type->subtype);
 292
 293         radios_add(radios,
 294                         _("Add the file and image filenames to your "
 295                         "personal list. The setting will be lost if the image "
 296                         "or the file is moved."), SET_PATH,
 297                         _("Only for the file `%s'"), path);
 298
 299         radios_set_value(radios, SET_PATH);
 300
 301         /* If it's a directory, offer to create a .DirIcon */
 302         if (mc_stat(path, &info) == 0 && S_ISDIR(info.st_mode))
 303         {
 304                 radios_add(radios,
 305                         _("Copy the image inside the directory, as "
 306                         "a hidden file called '.DirIcon'. "
 307                         "All users will then see the "
 308                         "icon, and you can move the directory around safely. "
 309                         "This is usually the best option if you can write to "
 310                         "the directory."), SET_COPY,
 311                         _("Copy image into directory"));
 312                 if (access(path, W_OK) == 0)
 313                         radios_set_value(radios, SET_COPY);
 314         }
 315
 316
 317         frame = drop_box_new(_("Drop an icon file here"));
 318         g_object_set_data(G_OBJECT(dialog), "rox-dropbox", frame);
 319
 320         /* Make sure rox-dropbox is set before packing (calls changed) */
 321         radios_pack(radios, GTK_BOX(dialog->vbox));
 322         gtk_box_pack_start(GTK_BOX(dialog->vbox), frame, TRUE, TRUE, 4);
 323
 324         g_signal_connect(frame, "path_dropped",
 325                         G_CALLBACK(drag_icon_dropped), dialog);
 326         g_signal_connect(frame, "clear",
 327                         G_CALLBACK(clear_icon), dialog);
 328
 329         gtk_dialog_add_buttons(dialog,
 330                         GTK_STOCK_CLOSE, GTK_RESPONSE_OK,
 331                         NULL);
 332         g_signal_connect(dialog, "response", G_CALLBACK(dialog_response), NULL);
 333         gtk_dialog_set_default_response(dialog, GTK_RESPONSE_OK);
 334
 335         gtk_widget_show_all(GTK_WIDGET(dialog));
 336 }
 337
 338
 339 /****************************************************************
 340  *                      INTERNAL FUNCTIONS                      *
 341  ****************************************************************/
 342
 343 /* The dropbox shows the path for the currently selected radio setting.
 344  */
 345 static void radios_changed(Radios *radios, gpointer data)
 346 {
 347         GObject *dialog = G_OBJECT(data);
 348         DropBox *drop_box;
 349         const guchar *path;
 350         MIME_type *mime_type;
 351
 352         path = g_object_get_data(dialog, "pathname");
 353         drop_box = g_object_get_data(dialog, "rox-dropbox");
 354         mime_type = g_object_get_data(dialog, "mime-type");
 355
 356         g_return_if_fail(radios != NULL);
 357         g_return_if_fail(path != NULL);
 358         g_return_if_fail(drop_box != NULL);
 359         g_return_if_fail(mime_type != NULL);
 360
 361         switch (radios_get_value(radios))
 362         {
 363                 case SET_MEDIA:
 364                 {
 365                         char *path, *type;
 366
 367                         type = g_strconcat(mime_type->media_type, ".png", NULL);
 368                         path = choices_find_xdg_path_load(type, "MIME-icons",
 369                                                           SITE);
 370                         g_free(type);
 371                         drop_box_set_path(drop_box, path);
 372                         g_free(path);
 373                         break;
 374                 }
 375                 case SET_TYPE:
 376                 {
 377                         char *path, *type;
 378
 379                         type = g_strconcat(mime_type->media_type, "_",
 380                                            mime_type->subtype, ".png", NULL);
 381                         path = choices_find_xdg_path_load(type, "MIME-icons",
 382                                                           SITE);
 383                         g_free(type);
 384                         drop_box_set_path(drop_box, path);
 385                         g_free(path);
 386                         break;
 387                 }
 388                 case SET_PATH:
 389                 {
 390                         const char      *gi;
 391                         gi = g_hash_table_lookup(glob_icons, path);
 392                         drop_box_set_path(drop_box, gi);
 393                         break;
 394                 }
 395                 case SET_COPY:
 396                 {
 397                         const char *diricon;
 398                         diricon = make_path(path, ".DirIcon");
 399                         if (file_exists(diricon))
 400                                 drop_box_set_path(drop_box, diricon);
 401                         else
 402                                 drop_box_set_path(drop_box, NULL);
 403                         break;
 404                 }
 405                 default:
 406                         drop_box_set_path(drop_box, NULL);
 407                         break;
 408         }
 409 }
 410
 411 static gboolean free_globicon(gpointer key, gpointer value, gpointer data)
 412 {
 413         g_free(key);
 414         g_free(value);
 415
 416         return TRUE;            /* For g_hash_table_foreach_remove() */
 417 }
 418
 419 static void write_globicon(gpointer key, gpointer value, gpointer data)
 420 {
 421         xmlNodePtr doc = (xmlNodePtr) data;
 422         xmlNodePtr tree;
 423
 424         tree = xmlNewTextChild(doc, NULL, "rule", NULL);
 425         xmlSetProp(tree, "match", key);
 426         xmlNewTextChild(tree, NULL, "icon", value);
 427 }
 428
 429 /* Write globicons file */
 430 static void write_globicons(void)
 431 {
 432         gchar *save = NULL, *save_new = NULL;
 433         xmlDocPtr doc = NULL;
 434
 435         save = choices_find_xdg_path_save("globicons", PROJECT, SITE, TRUE);
 436
 437         if (!save)
 438                 return;         /* Saving is disabled */
 439
 440         save_new = g_strconcat(save, ".new", NULL);
 441
 442         doc = xmlNewDoc("1.0");
 443         xmlDocSetRootElement(doc,
 444                              xmlNewDocNode(doc, NULL, "special-files", NULL));
 445
 446         g_hash_table_foreach(glob_icons, write_globicon,
 447                              xmlDocGetRootElement(doc));
 448
 449         if (save_xml_file(doc, save_new) || rename(save_new, save))
 450                 delayed_error(_("Error saving %s: %s"),
 451                                 save, g_strerror(errno));
 452
 453         g_free(save_new);
 454         g_free(save);
 455
 456         if (doc)
 457                 xmlFreeDoc(doc);
 458 }
 459
 460 /* Process a globicon line. Format:
 461         glob-pattern    icon-path
 462    Example:
 463        /home/<*>/Mail   /usr/local/icons/mailbox.xpm
 464          (<*> represents a single asterisk, enclosed in brackets to not break
 465          the C comment).
 466 */
 467 static const char *process_globicons_line(gchar *line)
 468 {
 469         guchar *pattern, *iconpath;
 470
 471         pattern = strtok(line, " \t");
 472         /* We ignore empty lines, but they are no cause for a message */
 473         if (pattern == NULL)
 474                 return NULL;
 475
 476         iconpath = strtok(NULL, " \t");
 477
 478         /* If there is no icon, then we worry */
 479         g_return_val_if_fail(iconpath != NULL,
 480                         "Invalid line in globicons: no icon specified");
 481
 482         g_hash_table_insert(glob_icons, g_strdup(pattern), g_strdup(iconpath));
 483
 484         return NULL;
 485 }
 486
 487 /* Add a globicon entry to the list. If another one with the same
 488  * path exists, it is replaced. Otherwise, the new entry is
 489  * added to the top of the list (so that it takes precedence over
 490  * other entries).
 491  */
 492 static void add_globicon(const gchar *path, const gchar *icon)
 493 {
 494         g_hash_table_insert(glob_icons, g_strdup(path), g_strdup(icon));
 495
 496         /* Rewrite the globicons file */
 497         write_globicons();
 498
 499         /* Make sure any visible icons for the file are updated */
 500         examine(path);
 501 }
 502
 503 /* Remove the globicon for a certain path */
 504 static void delete_globicon(const gchar *path)
 505 {
 506         gpointer key, value;
 507
 508         if (!g_hash_table_lookup_extended(glob_icons, path, &key, &value))
 509                 return;
 510
 511         g_hash_table_remove(glob_icons, path);
 512
 513         g_free(key);
 514         g_free(value);
 515
 516         write_globicons();
 517         examine(path);
 518 }
 519
 520 /* Set the icon for this dialog's file to 'icon' */
 521 static void do_set_icon(GtkWidget *dialog, const gchar *icon)
 522 {
 523         guchar  *path = NULL;
 524         Radios *radios;
 525         int op;
 526
 527         path = g_object_get_data(G_OBJECT(dialog), "pathname");
 528         g_return_if_fail(path != NULL);
 529
 530         radios = g_object_get_data(G_OBJECT(dialog), "radios");
 531         g_return_if_fail(radios != NULL);
 532
 533         op = radios_get_value(radios);
 534
 535         if (op == SET_PATH)
 536         {
 537                 if (!set_icon_path(path, icon))
 538                         return;
 539         }
 540         else if (op == SET_COPY)
 541         {
 542                 if (!create_diricon(path, icon))
 543                         return;
 544         }
 545         else
 546         {
 547                 gboolean just_media = (op == SET_MEDIA);
 548                 MIME_type *type;
 549
 550                 type = g_object_get_data(G_OBJECT(dialog), "mime-type");
 551
 552                 if (!set_icon_for_type(type, icon, just_media))
 553                         return;
 554         }
 555
 556         destroy_on_idle(dialog);
 557 }
 558
 559 /* Called when a URI list is dropped onto the box in the Set Icon
 560  * dialog. Make that the default icon.
 561  */
 562 static void drag_icon_dropped(GtkWidget *drop_box,
 563                               const guchar *path,
 564                               GtkWidget *dialog)
 565 {
 566         do_set_icon(dialog, path);
 567 }
 568
 569 /* Set the icon for the given MIME type.  We copy the file. */
 570 static gboolean set_icon_for_type(MIME_type *type, const gchar *iconpath,
 571                                   gboolean just_media)
 572 {
 573         gchar *target;
 574         gchar *leaf;
 575
 576         if (just_media)
 577                 leaf = g_strconcat(type->media_type, ".png", NULL);
 578         else
 579                 leaf = g_strconcat(type->media_type, "_", type->subtype,
 580                                                                 ".png", NULL);
 581
 582         target = choices_find_xdg_path_save(leaf, "MIME-icons", SITE, TRUE);
 583         g_free(leaf);
 584
 585         if (!target)
 586         {
 587                 delayed_error(_("Setting icon disabled by CHOICESPATH"));
 588                 return FALSE;
 589         }
 590
 591         if (!convert_to_png(iconpath, target))
 592         {
 593                 g_free(target);
 594                 return FALSE;
 595         }
 596
 597         g_free(target);
 598
 599         full_refresh();
 600
 601         return TRUE;
 602 }
 603
 604 /* Load image 'src', and save it as an icon-sized image in png format.
 605  * TRUE on success, error is already reported on failure.
 606  */
 607 static gboolean convert_to_png(const gchar *src, const gchar *dest)
 608 {
 609         MaskedPixmap *pic;
 610         GError  *error = NULL;
 611
 612         pic = g_fscache_lookup(pixmap_cache, src);
 613         if (!pic)
 614         {
 615                 delayed_error(
 616                         _("Unable to load image file -- maybe it's not in a "
 617                           "format I understand, or maybe the permissions are "
 618                           "wrong?\n"
 619                           "The icon has not been changed."));
 620                 return FALSE;
 621         }
 622
 623         gdk_pixbuf_save(pic->src_pixbuf, dest,
 624                         "png", &error,
 625                         "tEXt::Software", PROJECT,
 626                         NULL);
 627         g_object_unref(pic);
 628
 629         if (error)
 630         {
 631                 delayed_error(_("Error creating image '%s':\n%s"),
 632                                 dest, error->message);
 633                 g_error_free(error);
 634                 return FALSE;
 635         }
 636
 637         return TRUE;
 638 }