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