src/editors.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 "editors.h"
  16
  17 #include "filedata.h"
  18 #include "filefilter.h"
  19 #include "misc.h"
  20 #include "ui_fileops.h"
  21 #include "ui_spinner.h"
  22 #include "ui_utildlg.h"
  23 #include "utilops.h"
  24
  25 #include <errno.h>
  26
  27
  28 #define EDITOR_WINDOW_WIDTH 500
  29 #define EDITOR_WINDOW_HEIGHT 300
  30
  31
  32
  33 typedef struct _EditorVerboseData EditorVerboseData;
  34 struct _EditorVerboseData {
  35         GenericDialog *gd;
  36         GtkWidget *button_close;
  37         GtkWidget *button_stop;
  38         GtkWidget *text;
  39         GtkWidget *progress;
  40         GtkWidget *spinner;
  41 };
  42
  43 typedef struct _EditorData EditorData;
  44 struct _EditorData {
  45         EditorFlags flags;
  46         GPid pid;
  47         GList *list;
  48         gint count;
  49         gint total;
  50         gboolean stopping;
  51         EditorVerboseData *vd;
  52         EditorCallback callback;
  53         gpointer data;
  54         const EditorDescription *editor;
  55 };
  56
  57
  58 static void editor_verbose_window_progress(EditorData *ed, const gchar *text);
  59 static EditorFlags editor_command_next_start(EditorData *ed);
  60 static EditorFlags editor_command_next_finish(EditorData *ed, gint status);
  61 static EditorFlags editor_command_done(EditorData *ed);
  62
  63 /*
  64  *-----------------------------------------------------------------------------
  65  * external editor routines
  66  *-----------------------------------------------------------------------------
  67  */
  68
  69 GHashTable *editors = NULL;
  70 GtkListStore *desktop_file_list;
  71
  72
  73 #ifdef G_KEY_FILE_DESKTOP_GROUP
  74 #define DESKTOP_GROUP G_KEY_FILE_DESKTOP_GROUP
  75 #else
  76 #define DESKTOP_GROUP "Desktop Entry"
  77 #endif
  78
  79 void editor_description_free(EditorDescription *editor)
  80 {
  81         if (!editor) return;
  82
  83         g_free(editor->key);
  84         g_free(editor->name);
  85         g_free(editor->icon);
  86         g_free(editor->exec);
  87         g_free(editor->menu_path);
  88         g_free(editor->hotkey);
  89         g_free(editor->comment);
  90         string_list_free(editor->ext_list);
  91         g_free(editor->file);
  92         g_free(editor);
  93 }
  94
  95 static GList *editor_mime_types_to_extensions(gchar **mime_types)
  96 {
  97         /* FIXME: this should be rewritten to use the shared mime database, as soon as we switch to gio */
  98
  99         static const gchar *conv_table[][2] = {
 100                 {"application/x-ufraw", "%raw"},
 101                 {"image/*",             "*"},
 102                 {"image/bmp",           ".bmp"},
 103                 {"image/gif",           ".gif"},
 104                 {"image/jpeg",          ".jpeg;.jpg"},
 105                 {"image/jpg",           ".jpg;.jpeg"},
 106                 {"image/pcx",           ".pcx"},
 107                 {"image/png",           ".png"},
 108                 {"image/svg",           ".svg"},
 109                 {"image/svg+xml",       ".svg"},
 110                 {"image/svg+xml-compressed",    ".svg"},
 111                 {"image/tiff",          ".tiff;.tif"},
 112                 {"image/x-bmp",         ".bmp"},
 113                 {"image/x-canon-crw",   ".crw"},
 114                 {"image/x-cr2",         ".cr2"},
 115                 {"image/x-dcraw",       "%raw"},
 116                 {"image/x-ico",         ".ico"},
 117                 {"image/x-mrw",         ".mrw"},
 118                 {"image/x-MS-bmp",      ".bmp"},
 119                 {"image/x-nef",         ".nef"},
 120                 {"image/x-orf",         ".orf"},
 121                 {"image/x-pcx",         ".pcx"},
 122                 {"image/xpm",           ".xpm"},
 123                 {"image/x-png",         ".png"},
 124                 {"image/x-portable-anymap",     ".pam"},
 125                 {"image/x-portable-bitmap",     ".pbm"},
 126                 {"image/x-portable-graymap",    ".pgm"},
 127                 {"image/x-portable-pixmap",     ".ppm"},
 128                 {"image/x-psd",         ".psd"},
 129                 {"image/x-raf",         ".raf"},
 130                 {"image/x-sgi",         ".sgi"},
 131                 {"image/x-tga",         ".tga"},
 132                 {"image/x-xbitmap",     ".xbm"},
 133                 {"image/x-xcf",         ".xcf"},
 134                 {"image/x-xpixmap",     ".xpm"},
 135                 {"image/x-x3f",         ".x3f"},
 136                 {NULL, NULL}};
 137
 138         gint i, j;
 139         GList *list = NULL;
 140
 141         for (i = 0; mime_types[i]; i++)
 142                 for (j = 0; conv_table[j][0]; j++)
 143                         if (strcmp(mime_types[i], conv_table[j][0]) == 0)
 144                                 list = g_list_concat(list, filter_to_list(conv_table[j][1]));
 145
 146         return list;
 147 }
 148
 149 static gboolean editor_accepts_parameters(EditorDescription *editor)
 150 {
 151         const gchar *p = editor->exec;
 152
 153         if (!p) return FALSE;
 154
 155         while (*p)
 156                 {
 157                 if (*p == '%' && p[1])
 158                         {
 159                         switch (p[1])
 160                                 {
 161                                 case 'F':
 162                                 case 'f':
 163                                 case 'U':
 164                                 case 'u':
 165                                 case 'i':
 166                                 case 'k':
 167                                 case 'c':
 168                                         return TRUE;
 169                                 default:
 170                                         break;
 171                                 }
 172                         }
 173                 p++;
 174                 }
 175
 176         return FALSE;
 177 }
 178
 179 static gboolean editor_read_desktop_file(const gchar *path)
 180 {
 181         GKeyFile *key_file;
 182         EditorDescription *editor;
 183         gchar *extensions;
 184         gchar *type;
 185         const gchar *key = filename_from_path(path);
 186         gchar **categories, **only_show_in, **not_show_in;
 187         gchar *try_exec;
 188         GtkTreeIter iter;
 189
 190         if (g_hash_table_lookup(editors, key)) return FALSE; /* the file found earlier wins */
 191
 192         key_file = g_key_file_new();
 193         if (!g_key_file_load_from_file(key_file, path, 0, NULL))
 194                 {
 195                 g_key_file_free(key_file);
 196                 return FALSE;
 197                 }
 198
 199         type = g_key_file_get_string(key_file, DESKTOP_GROUP, "Type", NULL);
 200         if (!type || strcmp(type, "Application") != 0)
 201                 {
 202                 /* We only consider desktop entries of Application type */
 203                 g_key_file_free(key_file);
 204                 g_free(type);
 205                 return FALSE;
 206                 }
 207         g_free(type);
 208
 209         editor = g_new0(EditorDescription, 1);
 210
 211         editor->key = g_strdup(key);
 212         editor->file = g_strdup(path);
 213
 214         g_hash_table_insert(editors, editor->key, editor);
 215
 216         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "Hidden", NULL)
 217             || g_key_file_get_boolean(key_file, DESKTOP_GROUP, "NoDisplay", NULL))
 218                 {
 219                 editor->hidden = TRUE;
 220                 }
 221
 222         categories = g_key_file_get_string_list(key_file, DESKTOP_GROUP, "Categories", NULL, NULL);
 223         if (categories)
 224                 {
 225                 gboolean found = FALSE;
 226                 gint i;
 227                 for (i = 0; categories[i]; i++)
 228                         /* IMHO "Graphics" is exactly the category that we are interested in, so this does not have to be configurable */
 229                         if (strcmp(categories[i], "Graphics") == 0 ||
 230                             strcmp(categories[i], "X-Geeqie") == 0)
 231                                 {
 232                                 found = TRUE;
 233                                 break;
 234                                 }
 235                 if (!found) editor->ignored = TRUE;
 236                 g_strfreev(categories);
 237                 }
 238         else
 239                 {
 240                 editor->ignored = TRUE;
 241                 }
 242
 243         only_show_in = g_key_file_get_string_list(key_file, DESKTOP_GROUP, "OnlyShowIn", NULL, NULL);
 244         if (only_show_in)
 245                 {
 246                 gboolean found = FALSE;
 247                 gint i;
 248                 for (i = 0; only_show_in[i]; i++)
 249                         if (strcmp(only_show_in[i], "X-Geeqie") == 0)
 250                                 {
 251                                 found = TRUE;
 252                                 break;
 253                                 }
 254                 if (!found) editor->ignored = TRUE;
 255                 g_strfreev(only_show_in);
 256                 }
 257
 258         not_show_in = g_key_file_get_string_list(key_file, DESKTOP_GROUP, "NotShowIn", NULL, NULL);
 259         if (not_show_in)
 260                 {
 261                 gboolean found = FALSE;
 262                 gint i;
 263                 for (i = 0; not_show_in[i]; i++)
 264                         if (strcmp(not_show_in[i], "X-Geeqie") == 0)
 265                                 {
 266                                 found = TRUE;
 267                                 break;
 268                                 }
 269                 if (found) editor->ignored = TRUE;
 270                 g_strfreev(not_show_in);
 271                 }
 272
 273
 274         try_exec = g_key_file_get_string(key_file, DESKTOP_GROUP, "TryExec", NULL);
 275         if (try_exec && !editor->hidden && !editor->ignored)
 276                 {
 277                 gchar *try_exec_res = g_find_program_in_path(try_exec);
 278                 if (!try_exec_res) editor->hidden = TRUE;
 279                 g_free(try_exec_res);
 280                 g_free(try_exec);
 281                 }
 282
 283         if (editor->ignored)
 284                 {
 285                 /* ignored editors will be deleted, no need to parse the rest */
 286                 g_key_file_free(key_file);
 287                 return TRUE;
 288                 }
 289
 290         editor->name = g_key_file_get_locale_string(key_file, DESKTOP_GROUP, "Name", NULL, NULL);
 291         editor->icon = g_key_file_get_string(key_file, DESKTOP_GROUP, "Icon", NULL);
 292
 293         /* Icon key can be either a full path (absolute with file name extension) or an icon name (without extension) */
 294         if (editor->icon && !g_path_is_absolute(editor->icon))
 295                 {
 296                 gchar *ext = strrchr(editor->icon, '.');
 297
 298                 if (ext && strlen(ext) == 4 &&
 299                     (!strcmp(ext, ".png") || !strcmp(ext, ".xpm") || !strcmp(ext, ".svg")))
 300                         {
 301                         log_printf(_("Desktop file '%s' should not include extension in Icon key: '%s'\n"),
 302                                    editor->file, editor->icon);
 303
 304                         // drop extension
 305                         *ext = '\0';
 306                         }
 307                 }
 308
 309         editor->exec = g_key_file_get_string(key_file, DESKTOP_GROUP, "Exec", NULL);
 310
 311         /* we take only editors that accept parameters */
 312         if (!editor_accepts_parameters(editor)) editor->hidden = TRUE;
 313
 314         editor->menu_path = g_key_file_get_string(key_file, DESKTOP_GROUP, "X-Geeqie-Menu-Path", NULL);
 315         if (!editor->menu_path) editor->menu_path = g_strdup("EditMenu/ExternalMenu");
 316
 317         editor->hotkey = g_key_file_get_string(key_file, DESKTOP_GROUP, "X-Geeqie-Hotkey", NULL);
 318
 319         editor->comment = g_key_file_get_string(key_file, DESKTOP_GROUP, "Comment", NULL);
 320
 321         extensions = g_key_file_get_string(key_file, DESKTOP_GROUP, "X-Geeqie-File-Extensions", NULL);
 322         if (extensions)
 323                 editor->ext_list = filter_to_list(extensions);
 324         else
 325                 {
 326                 gchar **mime_types = g_key_file_get_string_list(key_file, DESKTOP_GROUP, "MimeType", NULL, NULL);
 327                 if (mime_types)
 328                         {
 329                         editor->ext_list = editor_mime_types_to_extensions(mime_types);
 330                         g_strfreev(mime_types);
 331                         if (!editor->ext_list) editor->hidden = TRUE;
 332                         }
 333                 }
 334
 335         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "X-Geeqie-Keep-Fullscreen", NULL)) editor->flags |= EDITOR_KEEP_FS;
 336         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "X-Geeqie-Verbose", NULL)) editor->flags |= EDITOR_VERBOSE;
 337         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "X-Geeqie-Verbose-Multi", NULL)) editor->flags |= EDITOR_VERBOSE_MULTI;
 338         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "X-Geeqie-Filter", NULL)) editor->flags |= EDITOR_DEST;
 339         if (g_key_file_get_boolean(key_file, DESKTOP_GROUP, "Terminal", NULL)) editor->flags |= EDITOR_TERMINAL;
 340
 341         editor->flags |= editor_command_parse(editor, NULL, NULL);
 342         g_key_file_free(key_file);
 343
 344         if (editor->ignored) return TRUE;
 345
 346         gtk_list_store_append(desktop_file_list, &iter);
 347         gtk_list_store_set(desktop_file_list, &iter,
 348                            DESKTOP_FILE_COLUMN_KEY, key,
 349                            DESKTOP_FILE_COLUMN_NAME, editor->name,
 350                            DESKTOP_FILE_COLUMN_HIDDEN, editor->hidden,
 351                            DESKTOP_FILE_COLUMN_WRITABLE, access_file(path, W_OK),
 352                            DESKTOP_FILE_COLUMN_PATH, path, -1);
 353
 354         return TRUE;
 355 }
 356
 357 static gboolean editor_remove_desktop_file_cb(gpointer key, gpointer value, gpointer user_data)
 358 {
 359         EditorDescription *editor = value;
 360         return editor->hidden || editor->ignored;
 361 }
 362
 363 static void editor_read_desktop_dir(const gchar *path)
 364 {
 365         DIR *dp;
 366         struct dirent *dir;
 367         gchar *pathl;
 368
 369         pathl = path_from_utf8(path);
 370         dp = opendir(pathl);
 371         g_free(pathl);
 372         if (!dp)
 373                 {
 374                 /* dir not found */
 375                 return;
 376                 }
 377         while ((dir = readdir(dp)) != NULL)
 378                 {
 379                 gchar *namel = dir->d_name;
 380
 381                 if (g_str_has_suffix(namel, ".desktop"))
 382                         {
 383                         gchar *name = path_to_utf8(namel);
 384                         gchar *dpath = g_build_filename(path, name, NULL);
 385                         editor_read_desktop_file(dpath);
 386                         g_free(dpath);
 387                         g_free(name);
 388                         }
 389                 }
 390         closedir(dp);
 391 }
 392
 393 void editor_load_descriptions(void)
 394 {
 395         gchar *path;
 396         gchar *xdg_data_dirs;
 397         gchar *all_dirs;
 398         gchar **split_dirs;
 399         gint i;
 400
 401         if (desktop_file_list)
 402                 {
 403                 gtk_list_store_clear(desktop_file_list);
 404                 }
 405         else
 406                 {
 407                 desktop_file_list = gtk_list_store_new(DESKTOP_FILE_COLUMN_COUNT, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN, G_TYPE_BOOLEAN, G_TYPE_STRING);
 408                 }
 409         if (editors)
 410                 {
 411                 g_hash_table_destroy(editors);
 412                 }
 413         editors = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, (GDestroyNotify)editor_description_free);
 414
 415         xdg_data_dirs = getenv("XDG_DATA_DIRS");
 416         if (xdg_data_dirs && xdg_data_dirs[0])
 417                 xdg_data_dirs = path_to_utf8(xdg_data_dirs);
 418         else
 419                 xdg_data_dirs = g_strdup("/usr/share");
 420
 421         all_dirs = g_strconcat(get_rc_dir(), ":", GQ_APP_DIR, ":", xdg_data_home_get(), ":", xdg_data_dirs, NULL);
 422
 423         g_free(xdg_data_dirs);
 424
 425         split_dirs = g_strsplit(all_dirs, ":", 0);
 426
 427         g_free(all_dirs);
 428
 429         for (i = 0; split_dirs[i]; i++)
 430                 {
 431                 path = g_build_filename(split_dirs[i], "applications", NULL);
 432                 editor_read_desktop_dir(path);
 433                 g_free(path);
 434                 }
 435
 436         g_strfreev(split_dirs);
 437
 438         g_hash_table_foreach_remove(editors, editor_remove_desktop_file_cb, NULL);
 439 }
 440
 441 static void editor_list_add_cb(gpointer key, gpointer value, gpointer data)
 442 {
 443         GList **listp = data;
 444         EditorDescription *editor = value;
 445
 446         /* do not show the special commands in any list, they are called explicitly */
 447         if (strcmp(editor->key, CMD_COPY) == 0 ||
 448             strcmp(editor->key, CMD_MOVE) == 0 ||
 449             strcmp(editor->key, CMD_RENAME) == 0 ||
 450             strcmp(editor->key, CMD_DELETE) == 0 ||
 451             strcmp(editor->key, CMD_FOLDER) == 0) return;
 452
 453         *listp = g_list_prepend(*listp, editor);
 454 }
 455
 456 static gint editor_sort(gconstpointer a, gconstpointer b)
 457 {
 458         const EditorDescription *ea = a;
 459         const EditorDescription *eb = b;
 460         gint ret;
 461
 462         ret = strcmp(ea->menu_path, eb->menu_path);
 463         if (ret != 0) return ret;
 464
 465         return g_utf8_collate(ea->name, eb->name);
 466 }
 467
 468 GList *editor_list_get(void)
 469 {
 470         GList *editors_list = NULL;
 471         g_hash_table_foreach(editors, editor_list_add_cb, &editors_list);
 472         editors_list = g_list_sort(editors_list, editor_sort);
 473
 474         return editors_list;
 475 }
 476
 477 /* ------------------------------ */
 478
 479
 480 static void editor_verbose_data_free(EditorData *ed)
 481 {
 482         if (!ed->vd) return;
 483         g_free(ed->vd);
 484         ed->vd = NULL;
 485 }
 486
 487 static void editor_data_free(EditorData *ed)
 488 {
 489         editor_verbose_data_free(ed);
 490         g_free(ed);
 491 }
 492
 493 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
 494 {
 495         EditorData *ed = data;
 496
 497         generic_dialog_close(gd);
 498         editor_verbose_data_free(ed);
 499         if (ed->pid == -1) editor_data_free(ed); /* the process has already terminated */
 500 }
 501
 502 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
 503 {
 504         EditorData *ed = data;
 505         ed->stopping = TRUE;
 506         ed->count = 0;
 507         editor_verbose_window_progress(ed, _("stopping..."));
 508 }
 509
 510 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
 511 {
 512         vd->gd->cancel_cb = editor_verbose_window_close;
 513
 514         spinner_set_interval(vd->spinner, -1);
 515         gtk_widget_set_sensitive(vd->button_stop, FALSE);
 516         gtk_widget_set_sensitive(vd->button_close, TRUE);
 517 }
 518
 519 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
 520 {
 521         EditorVerboseData *vd;
 522         GtkWidget *scrolled;
 523         GtkWidget *hbox;
 524         gchar *buf;
 525
 526         vd = g_new0(EditorVerboseData, 1);
 527
 528         vd->gd = file_util_gen_dlg(_("Edit command results"), "editor_results",
 529                                    NULL, FALSE,
 530                                    NULL, ed);
 531         buf = g_strdup_printf(_("Output of %s"), text);
 532         generic_dialog_add_message(vd->gd, NULL, buf, NULL);
 533         g_free(buf);
 534         vd->button_stop = generic_dialog_add_button(vd->gd, GTK_STOCK_STOP, NULL,
 535                                                    editor_verbose_window_stop, FALSE);
 536         gtk_widget_set_sensitive(vd->button_stop, FALSE);
 537         vd->button_close = generic_dialog_add_button(vd->gd, GTK_STOCK_CLOSE, NULL,
 538                                                     editor_verbose_window_close, TRUE);
 539         gtk_widget_set_sensitive(vd->button_close, FALSE);
 540
 541         scrolled = gtk_scrolled_window_new(NULL, NULL);
 542         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
 543         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
 544                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 545         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), scrolled, TRUE, TRUE, 5);
 546         gtk_widget_show(scrolled);
 547
 548         vd->text = gtk_text_view_new();
 549         gtk_text_view_set_editable(GTK_TEXT_VIEW(vd->text), FALSE);
 550         gtk_widget_set_size_request(vd->text, EDITOR_WINDOW_WIDTH, EDITOR_WINDOW_HEIGHT);
 551         gtk_container_add(GTK_CONTAINER(scrolled), vd->text);
 552         gtk_widget_show(vd->text);
 553
 554         hbox = gtk_hbox_new(FALSE, 0);
 555         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), hbox, FALSE, FALSE, 0);
 556         gtk_widget_show(hbox);
 557
 558         vd->progress = gtk_progress_bar_new();
 559         gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(vd->progress), 0.0);
 560         gtk_box_pack_start(GTK_BOX(hbox), vd->progress, TRUE, TRUE, 0);
 561         gtk_widget_show(vd->progress);
 562
 563         vd->spinner = spinner_new(NULL, SPINNER_SPEED);
 564         gtk_box_pack_start(GTK_BOX(hbox), vd->spinner, FALSE, FALSE, 0);
 565         gtk_widget_show(vd->spinner);
 566
 567         gtk_widget_show(vd->gd->dialog);
 568
 569         ed->vd = vd;
 570         return vd;
 571 }
 572
 573 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
 574 {
 575         GtkTextBuffer *buffer;
 576         GtkTextIter iter;
 577
 578         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(vd->text));
 579         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 580         gtk_text_buffer_insert(buffer, &iter, text, len);
 581 }
 582
 583 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
 584 {
 585         if (!ed->vd) return;
 586
 587         if (ed->total)
 588                 {
 589                 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (gdouble)ed->count / ed->total);
 590                 }
 591
 592         gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
 593 }
 594
 595 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
 596 {
 597         EditorData *ed = data;
 598         gchar buf[512];
 599         gsize count;
 600
 601         if (condition & G_IO_IN)
 602                 {
 603                 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
 604                         {
 605                         if (!g_utf8_validate(buf, count, NULL))
 606                                 {
 607                                 gchar *utf8;
 608
 609                                 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
 610                                 if (utf8)
 611                                         {
 612                                         editor_verbose_window_fill(ed->vd, utf8, -1);
 613                                         g_free(utf8);
 614                                         }
 615                                 else
 616                                         {
 617                                         editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
 618                                         }
 619                                 }
 620                         else
 621                                 {
 622                                 editor_verbose_window_fill(ed->vd, buf, count);
 623                                 }
 624                         }
 625                 }
 626
 627         if (condition & (G_IO_ERR | G_IO_HUP))
 628                 {
 629                 g_io_channel_shutdown(source, TRUE, NULL);
 630                 return FALSE;
 631                 }
 632
 633         return TRUE;
 634 }
 635
 636 typedef enum {
 637         PATH_FILE,
 638         PATH_FILE_URL,
 639         PATH_DEST
 640 } PathType;
 641
 642
 643 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const EditorDescription *editor)
 644 {
 645         GString *string;
 646         gchar *pathl;
 647         const gchar *p = NULL;
 648
 649         string = g_string_new("");
 650
 651         if (type == PATH_FILE || type == PATH_FILE_URL)
 652                 {
 653                 GList *work = editor->ext_list;
 654
 655                 if (!work)
 656                         p = fd->path;
 657                 else
 658                         {
 659                         while (work)
 660                                 {
 661                                 GList *work2;
 662                                 gchar *ext = work->data;
 663                                 work = work->next;
 664
 665                                 if (strcmp(ext, "*") == 0 ||
 666                                     g_ascii_strcasecmp(ext, fd->extension) == 0)
 667                                         {
 668                                         p = fd->path;
 669                                         break;
 670                                         }
 671
 672                                 work2 = fd->sidecar_files;
 673                                 while (work2)
 674                                         {
 675                                         FileData *sfd = work2->data;
 676                                         work2 = work2->next;
 677
 678                                         if (g_ascii_strcasecmp(ext, sfd->extension) == 0)
 679                                                 {
 680                                                 p = sfd->path;
 681                                                 break;
 682                                                 }
 683                                         }
 684                                 if (p) break;
 685                                 }
 686                         if (!p) return NULL;
 687                         }
 688                 }
 689         else if (type == PATH_DEST)
 690                 {
 691                 if (fd->change && fd->change->dest)
 692                         p = fd->change->dest;
 693                 else
 694                         p = "";
 695                 }
 696
 697         g_assert(p);
 698         string = g_string_append(string, p);
 699
 700         if (type == PATH_FILE_URL) g_string_prepend(string, "file://");
 701         pathl = path_from_utf8(string->str);
 702         g_string_free(string, TRUE);
 703
 704         if (pathl && !pathl[0]) /* empty string case */
 705                 {
 706                 g_free(pathl);
 707                 pathl = NULL;
 708                 }
 709
 710         return pathl;
 711 }
 712
 713 static GString *append_quoted(GString *str, const char *s, gboolean single_quotes, gboolean double_quotes)
 714 {
 715         const char *p;
 716
 717         if (!single_quotes)
 718                 {
 719                 if (!double_quotes)
 720                         g_string_append_c(str, '\'');
 721                 else
 722                         g_string_append(str, "\"'");
 723                 }
 724
 725         for (p = s; *p != '\0'; p++)
 726                 {
 727                 if (*p == '\'')
 728                         g_string_append(str, "'\\''");
 729                 else
 730                         g_string_append_c(str, *p);
 731                 }
 732
 733         if (!single_quotes)
 734                 {
 735                 if (!double_quotes)
 736                         g_string_append_c(str, '\'');
 737                 else
 738                         g_string_append(str, "'\"");
 739                 }
 740
 741         return str;
 742 }
 743
 744
 745 EditorFlags editor_command_parse(const EditorDescription *editor, GList *list, gchar **output)
 746 {
 747         EditorFlags flags = 0;
 748         const gchar *p;
 749         GString *result = NULL;
 750         gboolean escape = FALSE;
 751         gboolean single_quotes = FALSE;
 752         gboolean double_quotes = FALSE;
 753
 754         if (output)
 755                 result = g_string_new("");
 756
 757         if (editor->exec[0] == '\0')
 758                 {
 759                 flags |= EDITOR_ERROR_EMPTY;
 760                 goto err;
 761                 }
 762
 763         p = editor->exec;
 764         /* skip leading whitespaces if any */
 765         while (g_ascii_isspace(*p)) p++;
 766
 767         /* command */
 768
 769         while (*p)
 770                 {
 771                 if (escape)
 772                         {
 773                         escape = FALSE;
 774                         if (output) result = g_string_append_c(result, *p);
 775                         }
 776                 else if (*p == '\\')
 777                         {
 778                         if (!single_quotes) escape = TRUE;
 779                         if (output) result = g_string_append_c(result, *p);
 780                         }
 781                 else if (*p == '\'')
 782                         {
 783                         if (output) result = g_string_append_c(result, *p);
 784                         if (!single_quotes && !double_quotes)
 785                                 single_quotes = TRUE;
 786                         else if (single_quotes)
 787                                 single_quotes = FALSE;
 788                         }
 789                 else if (*p == '"')
 790                         {
 791                         if (output) result = g_string_append_c(result, *p);
 792                         if (!single_quotes && !double_quotes)
 793                                 double_quotes = TRUE;
 794                         else if (double_quotes)
 795                                 double_quotes = FALSE;
 796                         }
 797                 else if (*p == '%' && p[1])
 798                         {
 799                         gchar *pathl = NULL;
 800
 801                         p++;
 802
 803                         switch (*p)
 804                                 {
 805                                 case 'f': /* single file */
 806                                 case 'u': /* single url */
 807                                         flags |= EDITOR_FOR_EACH;
 808                                         if (flags & EDITOR_SINGLE_COMMAND)
 809                                                 {
 810                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
 811                                                 goto err;
 812                                                 }
 813                                         if (list)
 814                                                 {
 815                                                 /* use the first file from the list */
 816                                                 if (!list->data)
 817                                                         {
 818                                                         flags |= EDITOR_ERROR_NO_FILE;
 819                                                         goto err;
 820                                                         }
 821                                                 pathl = editor_command_path_parse((FileData *)list->data,
 822                                                                                   (*p == 'f') ? PATH_FILE : PATH_FILE_URL,
 823                                                                                   editor);
 824                                                 if (!pathl)
 825                                                         {
 826                                                         flags |= EDITOR_ERROR_NO_FILE;
 827                                                         goto err;
 828                                                         }
 829                                                 if (output)
 830                                                         {
 831                                                         result = append_quoted(result, pathl, single_quotes, double_quotes);
 832                                                         }
 833                                                 g_free(pathl);
 834                                                 }
 835                                         break;
 836
 837                                 case 'F':
 838                                 case 'U':
 839                                         flags |= EDITOR_SINGLE_COMMAND;
 840                                         if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
 841                                                 {
 842                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
 843                                                 goto err;
 844                                                 }
 845
 846                                         if (list)
 847                                                 {
 848                                                 /* use whole list */
 849                                                 GList *work = list;
 850                                                 gboolean ok = FALSE;
 851
 852                                                 while (work)
 853                                                         {
 854                                                         FileData *fd = work->data;
 855                                                         pathl = editor_command_path_parse(fd, (*p == 'F') ? PATH_FILE : PATH_FILE_URL, editor);
 856                                                         if (pathl)
 857                                                                 {
 858                                                                 ok = TRUE;
 859
 860                                                                 if (output)
 861                                                                         {
 862                                                                         ok = TRUE;
 863                                                                         if (work != list) g_string_append_c(result, ' ');
 864                                                                         result = append_quoted(result, pathl, single_quotes, double_quotes);
 865                                                                         }
 866                                                                 g_free(pathl);
 867                                                                 }
 868                                                         work = work->next;
 869                                                         }
 870                                                 if (!ok)
 871                                                         {
 872                                                         flags |= EDITOR_ERROR_NO_FILE;
 873                                                         goto err;
 874                                                         }
 875                                                 }
 876                                         break;
 877                                 case 'i':
 878                                         if (editor->icon && *editor->icon)
 879                                                 {
 880                                                 if (output)
 881                                                         {
 882                                                         result = g_string_append(result, "--icon ");
 883                                                         result = append_quoted(result, editor->icon, single_quotes, double_quotes);
 884                                                         }
 885                                                 }
 886                                         break;
 887                                 case 'c':
 888                                         if (output)
 889                                                 {
 890                                                 result = append_quoted(result, editor->name, single_quotes, double_quotes);
 891                                                 }
 892                                         break;
 893                                 case 'k':
 894                                         if (output)
 895                                                 {
 896                                                 result = append_quoted(result, editor->file, single_quotes, double_quotes);
 897                                                 }
 898                                         break;
 899                                 case '%':
 900                                         /* %% = % escaping */
 901                                         if (output) result = g_string_append_c(result, *p);
 902                                         break;
 903                                 case 'd':
 904                                 case 'D':
 905                                 case 'n':
 906                                 case 'N':
 907                                 case 'v':
 908                                 case 'm':
 909                                         /* deprecated according to spec, ignore */
 910                                         break;
 911                                 default:
 912                                         flags |= EDITOR_ERROR_SYNTAX;
 913                                         goto err;
 914                                 }
 915                         }
 916                 else
 917                         {
 918                         if (output) result = g_string_append_c(result, *p);
 919                         }
 920                 p++;
 921                 }
 922
 923         if (output)
 924                 {
 925                 *output = g_string_free(result, FALSE);
 926                 DEBUG_3("Editor cmd: %s", *output);
 927                 }
 928
 929         return flags;
 930
 931
 932 err:
 933         if (output)
 934                 {
 935                 g_string_free(result, TRUE);
 936                 *output = NULL;
 937                 }
 938         return flags;
 939 }
 940
 941
 942 static void editor_child_exit_cb(GPid pid, gint status, gpointer data)
 943 {
 944         EditorData *ed = data;
 945         g_spawn_close_pid(pid);
 946         ed->pid = -1;
 947
 948         editor_command_next_finish(ed, status);
 949 }
 950
 951
 952 static EditorFlags editor_command_one(const EditorDescription *editor, GList *list, EditorData *ed)
 953 {
 954         gchar *command;
 955         FileData *fd = list->data;
 956         GPid pid;
 957         gint standard_output;
 958         gint standard_error;
 959         gboolean ok;
 960
 961         ed->pid = -1;
 962         ed->flags = editor->flags;
 963         ed->flags |= editor_command_parse(editor, list, &command);
 964
 965         ok = !EDITOR_ERRORS(ed->flags);
 966
 967         if (ok)
 968                 {
 969                 ok = (options->shell.path && *options->shell.path);
 970                 if (!ok) log_printf("ERROR: empty shell command\n");
 971
 972                 if (ok)
 973                         {
 974                         ok = (access(options->shell.path, X_OK) == 0);
 975                         if (!ok) log_printf("ERROR: cannot execute shell command '%s'\n", options->shell.path);
 976                         }
 977
 978                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
 979                 }
 980
 981         if (ok)
 982                 {
 983                 gchar *working_directory;
 984                 gchar *args[4];
 985                 guint n = 0;
 986
 987                 working_directory = remove_level_from_path(fd->path);
 988                 args[n++] = options->shell.path;
 989                 if (options->shell.options && *options->shell.options)
 990                         args[n++] = options->shell.options;
 991                 args[n++] = command;
 992                 args[n] = NULL;
 993
 994                 if ((ed->flags & EDITOR_DEST) && fd->change && fd->change->dest) /* FIXME: error handling */
 995                         {
 996                         g_setenv("GEEQIE_DESTINATION", fd->change->dest, TRUE);
 997                         }
 998                 else
 999                         {
1000                         g_unsetenv("GEEQIE_DESTINATION");
1001                         }
1002
1003                 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
1004                                       G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
1005                                       NULL, NULL,
1006                                       &pid,
1007                                       NULL,
1008                                       ed->vd ? &standard_output : NULL,
1009                                       ed->vd ? &standard_error : NULL,
1010                                       NULL);
1011
1012                 g_free(working_directory);
1013
1014                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
1015                 }
1016
1017         if (ok)
1018                 {
1019                 g_child_watch_add(pid, editor_child_exit_cb, ed);
1020                 ed->pid = pid;
1021                 }
1022
1023         if (ed->vd)
1024                 {
1025                 if (!ok)
1026                         {
1027                         gchar *buf;
1028
1029                         buf = g_strdup_printf(_("Failed to run command:\n%s\n"), editor->file);
1030                         editor_verbose_window_fill(ed->vd, buf, strlen(buf));
1031                         g_free(buf);
1032
1033                         }
1034                 else
1035                         {
1036                         GIOChannel *channel_output;
1037                         GIOChannel *channel_error;
1038
1039                         channel_output = g_io_channel_unix_new(standard_output);
1040                         g_io_channel_set_flags(channel_output, G_IO_FLAG_NONBLOCK, NULL);
1041                         g_io_channel_set_encoding(channel_output, NULL, NULL);
1042
1043                         g_io_add_watch_full(channel_output, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
1044                                             editor_verbose_io_cb, ed, NULL);
1045                         g_io_channel_unref(channel_output);
1046
1047                         channel_error = g_io_channel_unix_new(standard_error);
1048                         g_io_channel_set_flags(channel_error, G_IO_FLAG_NONBLOCK, NULL);
1049                         g_io_channel_set_encoding(channel_error, NULL, NULL);
1050
1051                         g_io_add_watch_full(channel_error, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
1052                                             editor_verbose_io_cb, ed, NULL);
1053                         g_io_channel_unref(channel_error);
1054                         }
1055                 }
1056
1057         g_free(command);
1058
1059         return EDITOR_ERRORS(ed->flags);
1060 }
1061
1062 static EditorFlags editor_command_next_start(EditorData *ed)
1063 {
1064         if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
1065
1066         if (ed->list && ed->count < ed->total)
1067                 {
1068                 FileData *fd;
1069                 EditorFlags error;
1070
1071                 fd = ed->list->data;
1072
1073                 if (ed->vd)
1074                         {
1075                         if (ed->flags & EDITOR_FOR_EACH)
1076                                 editor_verbose_window_progress(ed, fd->path);
1077                         else
1078                                 editor_verbose_window_progress(ed, _("running..."));
1079                         }
1080                 ed->count++;
1081
1082                 error = editor_command_one(ed->editor, ed->list, ed);
1083                 if (!error && ed->vd)
1084                         {
1085                         gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
1086                         if (ed->flags & EDITOR_FOR_EACH)
1087                                 {
1088                                 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
1089                                 editor_verbose_window_fill(ed->vd, "\n", 1);
1090                                 }
1091                         }
1092
1093                 if (!error)
1094                         return 0;
1095
1096                 /* command was not started, call the finish immediately */
1097                 return editor_command_next_finish(ed, 0);
1098                 }
1099
1100         /* everything is done */
1101         return editor_command_done(ed);
1102 }
1103
1104 static EditorFlags editor_command_next_finish(EditorData *ed, gint status)
1105 {
1106         gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
1107
1108         if (status)
1109                 ed->flags |= EDITOR_ERROR_STATUS;
1110
1111         if (ed->flags & EDITOR_FOR_EACH)
1112                 {
1113                 /* handle the first element from the list */
1114                 GList *fd_element = ed->list;
1115
1116                 ed->list = g_list_remove_link(ed->list, fd_element);
1117                 if (ed->callback)
1118                         {
1119                         cont = ed->callback(ed->list ? ed : NULL, ed->flags, fd_element, ed->data);
1120                         if (ed->stopping && cont == EDITOR_CB_CONTINUE) cont = EDITOR_CB_SKIP;
1121                         }
1122                 filelist_free(fd_element);
1123                 }
1124         else
1125                 {
1126                 /* handle whole list */
1127                 if (ed->callback)
1128                         cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
1129                 filelist_free(ed->list);
1130                 ed->list = NULL;
1131                 }
1132
1133         switch (cont)
1134                 {
1135                 case EDITOR_CB_SUSPEND:
1136                         return EDITOR_ERRORS(ed->flags);
1137                 case EDITOR_CB_SKIP:
1138                         return editor_command_done(ed);
1139                 }
1140
1141         return editor_command_next_start(ed);
1142 }
1143
1144 static EditorFlags editor_command_done(EditorData *ed)
1145 {
1146         EditorFlags flags;
1147
1148         if (ed->vd)
1149                 {
1150                 if (ed->count == ed->total)
1151                         {
1152                         editor_verbose_window_progress(ed, _("done"));
1153                         }
1154                 else
1155                         {
1156                         editor_verbose_window_progress(ed, _("stopped by user"));
1157                         }
1158                 editor_verbose_window_enable_close(ed->vd);
1159                 }
1160
1161         /* free the not-handled items */
1162         if (ed->list)
1163                 {
1164                 ed->flags |= EDITOR_ERROR_SKIPPED;
1165                 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
1166                 filelist_free(ed->list);
1167                 ed->list = NULL;
1168                 }
1169
1170         ed->count = 0;
1171
1172         flags = EDITOR_ERRORS(ed->flags);
1173
1174         if (!ed->vd) editor_data_free(ed);
1175
1176         return flags;
1177 }
1178
1179 void editor_resume(gpointer ed)
1180 {
1181         editor_command_next_start(ed);
1182 }
1183
1184 void editor_skip(gpointer ed)
1185 {
1186         editor_command_done(ed);
1187 }
1188
1189 static EditorFlags editor_command_start(const EditorDescription *editor, const gchar *text, GList *list, EditorCallback cb, gpointer data)
1190 {
1191         EditorData *ed;
1192         EditorFlags flags = editor->flags;
1193
1194         if (EDITOR_ERRORS(flags)) return EDITOR_ERRORS(flags);
1195
1196         ed = g_new0(EditorData, 1);
1197         ed->list = filelist_copy(list);
1198         ed->flags = flags;
1199         ed->editor = editor;
1200         ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
1201         ed->callback = cb;
1202         ed->data =  data;
1203
1204         if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
1205                 flags |= EDITOR_VERBOSE;
1206
1207         if (flags & EDITOR_VERBOSE)
1208                 editor_verbose_window(ed, text);
1209
1210         editor_command_next_start(ed);
1211         /* errors from editor_command_next_start will be handled via callback */
1212         return EDITOR_ERRORS(flags);
1213 }
1214
1215 gboolean is_valid_editor_command(const gchar *key)
1216 {
1217         if (!key) return FALSE;
1218         return g_hash_table_lookup(editors, key) != NULL;
1219 }
1220
1221 EditorFlags start_editor_from_filelist_full(const gchar *key, GList *list, EditorCallback cb, gpointer data)
1222 {
1223         EditorFlags error;
1224         EditorDescription *editor;
1225         if (!key) return FALSE;
1226
1227         editor = g_hash_table_lookup(editors, key);
1228
1229         if (!list) return FALSE;
1230         if (!editor) return FALSE;
1231
1232         error = editor_command_start(editor, editor->name, list, cb, data);
1233
1234         if (EDITOR_ERRORS(error))
1235                 {
1236                 gchar *text = g_strdup_printf(_("%s\n\"%s\""), editor_get_error_str(error), editor->file);
1237
1238                 file_util_warning_dialog(_("Invalid editor command"), text, GTK_STOCK_DIALOG_ERROR, NULL);
1239                 g_free(text);
1240                 }
1241
1242         return error;
1243 }
1244
1245 EditorFlags start_editor_from_filelist(const gchar *key, GList *list)
1246 {
1247         return start_editor_from_filelist_full(key, list,  NULL, NULL);
1248 }
1249
1250 EditorFlags start_editor_from_file_full(const gchar *key, FileData *fd, EditorCallback cb, gpointer data)
1251 {
1252         GList *list;
1253         EditorFlags error;
1254
1255         if (!fd) return FALSE;
1256
1257         list = g_list_append(NULL, fd);
1258         error = start_editor_from_filelist_full(key, list, cb, data);
1259         g_list_free(list);
1260         return error;
1261 }
1262
1263 EditorFlags start_editor_from_file(const gchar *key, FileData *fd)
1264 {
1265         return start_editor_from_file_full(key, fd, NULL, NULL);
1266 }
1267
1268 gboolean editor_window_flag_set(const gchar *key)
1269 {
1270         EditorDescription *editor;
1271         if (!key) return TRUE;
1272
1273         editor = g_hash_table_lookup(editors, key);
1274         if (!editor) return TRUE;
1275
1276         return !!(editor->flags & EDITOR_KEEP_FS);
1277 }
1278
1279 gboolean editor_is_filter(const gchar *key)
1280 {
1281         EditorDescription *editor;
1282         if (!key) return TRUE;
1283
1284         editor = g_hash_table_lookup(editors, key);
1285         if (!editor) return TRUE;
1286
1287         return !!(editor->flags & EDITOR_DEST);
1288 }
1289
1290 const gchar *editor_get_error_str(EditorFlags flags)
1291 {
1292         if (flags & EDITOR_ERROR_EMPTY) return _("Editor template is empty.");
1293         if (flags & EDITOR_ERROR_SYNTAX) return _("Editor template has incorrect syntax.");
1294         if (flags & EDITOR_ERROR_INCOMPATIBLE) return _("Editor template uses incompatible macros.");
1295         if (flags & EDITOR_ERROR_NO_FILE) return _("Can't find matching file type.");
1296         if (flags & EDITOR_ERROR_CANT_EXEC) return _("Can't execute external editor.");
1297         if (flags & EDITOR_ERROR_STATUS) return _("External editor returned error status.");
1298         if (flags & EDITOR_ERROR_SKIPPED) return _("File was skipped.");
1299         return _("Unknown error.");
1300 }
1301
1302 const gchar *editor_get_name(const gchar *key)
1303 {
1304         EditorDescription *editor = g_hash_table_lookup(editors, key);
1305
1306         if (!editor) return NULL;
1307
1308         return editor->name;
1309 }
1310 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */