Move miscellaneous functions to their own files (new misc.[ch]).
[geeqie.git] / src / editors.c
1 /*
2  * Geeqie
3  * (C) 2006 John Ellis
4  * Copyright (C) 2008 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         gchar *command_template;
48         GList *list;
49         gint count;
50         gint total;
51         gboolean stopping;
52         EditorVerboseData *vd;
53         EditorCallback callback;
54         gpointer data;
55 };
56
57
58 static Editor editor_slot_defaults[GQ_EDITOR_SLOTS] = {
59         { N_("The Gimp"), "gimp-remote %{.cr2;.crw;.nef;.raw;*}f" },
60         { N_("XV"), "xv %f" },
61         { N_("Xpaint"), "xpaint %f" },
62         { N_("UFraw"), "ufraw %{.cr2;.crw;.nef;.raw}p" },
63         { N_("Add XMP sidecar"), "%vFILE=%{.cr2;.crw;.nef;.raw}p;XMP=`echo \"$FILE\"|sed -e 's|\\.[^.]*$|.xmp|'`; exiftool -tagsfromfile \"$FILE\" \"$XMP\"" },
64         { N_("Symlink"), "ln -s %p %d"},
65         { NULL, NULL },
66         { NULL, NULL },
67         { N_("Rotate jpeg clockwise"), "%vif jpegtran -rotate 90 -copy all -outfile %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p; then mv %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p;else rm %{.jpg;.jpeg}p_tmp;fi" },
68         { N_("Rotate jpeg counterclockwise"), "%vif jpegtran -rotate 270 -copy all -outfile %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p; then mv %{.jpg;.jpeg}p_tmp %{.jpg;.jpeg}p;else rm %{.jpg;.jpeg}p_tmp;fi" },
69         /* special slots */
70 #if 1
71         /* for testing */
72         { N_("External Copy command"), "%vset -x;cp %p %d" },
73         { N_("External Move command"), "%vset -x;mv %p %d" },
74         { N_("External Rename command"), "%vset -x;mv %p %d" },
75         { N_("External Delete command"), NULL },
76         { N_("External New Folder command"), NULL },
77 #else
78         { N_("External Copy command"), NULL },
79         { N_("External Move command"), NULL },
80         { N_("External Rename command"), NULL },
81         { N_("External Delete command"), NULL },
82         { N_("External New Folder command"), NULL },
83 #endif
84 };
85
86 static void editor_verbose_window_progress(EditorData *ed, const gchar *text);
87 static gint editor_command_next_start(EditorData *ed);
88 static gint editor_command_next_finish(EditorData *ed, gint status);
89 static gint editor_command_done(EditorData *ed);
90
91 /*
92  *-----------------------------------------------------------------------------
93  * external editor routines
94  *-----------------------------------------------------------------------------
95  */
96
97 void editor_set_name(gint n, gchar *name)
98 {
99         if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
100
101         g_free(options->editor[n].name);
102         
103         options->editor[n].name = name ? utf8_validate_or_convert(name) : NULL;
104 }
105
106 void editor_set_command(gint n, gchar *command)
107 {
108         if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
109
110         g_free(options->editor[n].command);
111         options->editor[n].command = command ? utf8_validate_or_convert(command) : NULL;
112 }
113
114 void editor_reset_defaults(void)
115 {
116         gint i;
117
118         for (i = 0; i < GQ_EDITOR_SLOTS; i++)
119                 {
120                 editor_set_name(i, _(editor_slot_defaults[i].name));
121                 editor_set_command(i, _(editor_slot_defaults[i].command));
122                 }
123 }
124
125 static void editor_verbose_data_free(EditorData *ed)
126 {
127         if (!ed->vd) return;
128         g_free(ed->vd);
129         ed->vd = NULL;
130 }
131
132 static void editor_data_free(EditorData *ed)
133 {
134         editor_verbose_data_free(ed);
135         g_free(ed->command_template);
136         g_free(ed);
137 }
138
139 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
140 {
141         EditorData *ed = data;
142
143         generic_dialog_close(gd);
144         editor_verbose_data_free(ed);
145         if (ed->pid == -1) editor_data_free(ed); /* the process has already terminated */
146 }
147
148 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
149 {
150         EditorData *ed = data;
151         ed->stopping = TRUE;
152         ed->count = 0;
153         editor_verbose_window_progress(ed, _("stopping..."));
154 }
155
156 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
157 {
158         vd->gd->cancel_cb = editor_verbose_window_close;
159
160         spinner_set_interval(vd->spinner, -1);
161         gtk_widget_set_sensitive(vd->button_stop, FALSE);
162         gtk_widget_set_sensitive(vd->button_close, TRUE);
163 }
164
165 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
166 {
167         EditorVerboseData *vd;
168         GtkWidget *scrolled;
169         GtkWidget *hbox;
170         gchar *buf;
171
172         vd = g_new0(EditorVerboseData, 1);
173
174         vd->gd = file_util_gen_dlg(_("Edit command results"), GQ_WMCLASS, "editor_results",
175                                    NULL, FALSE,
176                                    NULL, ed);
177         buf = g_strdup_printf(_("Output of %s"), text);
178         generic_dialog_add_message(vd->gd, NULL, buf, NULL);
179         g_free(buf);
180         vd->button_stop = generic_dialog_add_button(vd->gd, GTK_STOCK_STOP, NULL,
181                                                    editor_verbose_window_stop, FALSE);
182         gtk_widget_set_sensitive(vd->button_stop, FALSE);
183         vd->button_close = generic_dialog_add_button(vd->gd, GTK_STOCK_CLOSE, NULL,
184                                                     editor_verbose_window_close, TRUE);
185         gtk_widget_set_sensitive(vd->button_close, FALSE);
186
187         scrolled = gtk_scrolled_window_new(NULL, NULL);
188         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
189         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
190                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
191         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), scrolled, TRUE, TRUE, 5);
192         gtk_widget_show(scrolled);
193
194         vd->text = gtk_text_view_new();
195         gtk_text_view_set_editable(GTK_TEXT_VIEW(vd->text), FALSE);
196         gtk_widget_set_size_request(vd->text, EDITOR_WINDOW_WIDTH, EDITOR_WINDOW_HEIGHT);
197         gtk_container_add(GTK_CONTAINER(scrolled), vd->text);
198         gtk_widget_show(vd->text);
199
200         hbox = gtk_hbox_new(FALSE, 0);
201         gtk_box_pack_start(GTK_BOX(vd->gd->vbox), hbox, FALSE, FALSE, 0);
202         gtk_widget_show(hbox);
203
204         vd->progress = gtk_progress_bar_new();
205         gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(vd->progress), 0.0);
206         gtk_box_pack_start(GTK_BOX(hbox), vd->progress, TRUE, TRUE, 0);
207         gtk_widget_show(vd->progress);
208
209         vd->spinner = spinner_new(NULL, SPINNER_SPEED);
210         gtk_box_pack_start(GTK_BOX(hbox), vd->spinner, FALSE, FALSE, 0);
211         gtk_widget_show(vd->spinner);
212
213         gtk_widget_show(vd->gd->dialog);
214
215         ed->vd = vd;
216         return vd;
217 }
218
219 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
220 {
221         GtkTextBuffer *buffer;
222         GtkTextIter iter;
223
224         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(vd->text));
225         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
226         gtk_text_buffer_insert(buffer, &iter, text, len);
227 }
228
229 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
230 {
231         if (!ed->vd) return;
232
233         if (ed->total)
234                 {
235                 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (gdouble)ed->count / ed->total);
236                 }
237
238         gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
239 }
240
241 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
242 {
243         EditorData *ed = data;
244         gchar buf[512];
245         gsize count;
246
247         if (condition & G_IO_IN)
248                 {
249                 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
250                         {
251                         if (!g_utf8_validate(buf, count, NULL))
252                                 {
253                                 gchar *utf8;
254
255                                 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
256                                 if (utf8)
257                                         {
258                                         editor_verbose_window_fill(ed->vd, utf8, -1);
259                                         g_free(utf8);
260                                         }
261                                 else
262                                         {
263                                         editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
264                                         }
265                                 }
266                         else
267                                 {
268                                 editor_verbose_window_fill(ed->vd, buf, count);
269                                 }
270                         }
271                 }
272
273         if (condition & (G_IO_ERR | G_IO_HUP))
274                 {
275                 g_io_channel_shutdown(source, TRUE, NULL);
276                 return FALSE;
277                 }
278
279         return TRUE;
280 }
281
282 typedef enum {
283         PATH_FILE,
284         PATH_DEST
285 } PathType;
286
287
288 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const gchar *extensions)
289 {
290         GString *string;
291         gchar *pathl;
292         const gchar *p = NULL;
293
294         string = g_string_new("");
295
296         if (type == PATH_FILE)
297                 {
298                 GList *ext_list = filter_to_list(extensions);
299                 GList *work = ext_list;
300
301                 if (!work)
302                         p = fd->path;
303                 else
304                         {
305                         while (work)
306                                 {
307                                 GList *work2;
308                                 gchar *ext = work->data;
309                                 work = work->next;
310
311                                 if (strcmp(ext, "*") == 0 ||
312                                     strcasecmp(ext, fd->extension) == 0)
313                                         {
314                                         p = fd->path;
315                                         break;
316                                         }
317
318                                 work2 = fd->sidecar_files;
319                                 while (work2)
320                                         {
321                                         FileData *sfd = work2->data;
322                                         work2 = work2->next;
323
324                                         if (strcasecmp(ext, sfd->extension) == 0)
325                                                 {
326                                                 p = sfd->path;
327                                                 break;
328                                                 }
329                                         }
330                                 if (p) break;
331                                 }
332                         string_list_free(ext_list);
333                         if (!p) return NULL;
334                         }
335                 }
336         else if (type == PATH_DEST)
337                 {
338                 if (fd->change && fd->change->dest)
339                         p = fd->change->dest;
340                 else
341                         p = "";
342                 }
343
344         while (*p != '\0')
345                 {
346                 /* must escape \, ", `, and $ to avoid problems,
347                  * we assume system shell supports bash-like escaping
348                  */
349                 if (strchr("\\\"`$", *p) != NULL)
350                         {
351                         string = g_string_append_c(string, '\\');
352                         }
353                 string = g_string_append_c(string, *p);
354                 p++;
355                 }
356
357         pathl = path_from_utf8(string->str);
358         g_string_free(string, TRUE);
359
360         return pathl;
361 }
362
363
364 /*
365  * The supported macros for editor commands:
366  *
367  *   %f   first occurence replaced by quoted sequence of filenames, command is run once.
368  *        only one occurence of this macro is supported.
369  *        ([ls %f] results in [ls "file1" "file2" ... "lastfile"])
370  *   %p   command is run for each filename in turn, each instance replaced with single filename.
371  *        multiple occurences of this macro is supported for complex shell commands.
372  *        This macro will BLOCK THE APPLICATION until it completes, since command is run once
373  *        for every file in syncronous order. To avoid blocking add the %v macro, below.
374  *        ([ls %p] results in [ls "file1"], [ls "file2"] ... [ls "lastfile"])
375  *   none if no macro is supplied, the result is equivalent to "command %f"
376  *        ([ls] results in [ls "file1" "file2" ... "lastfile"])
377  *
378  *  Only one of the macros %f or %p may be used in a given commmand.
379  *
380  *   %v   must be the first two characters[1] in a command, causes a window to display
381  *        showing the output of the command(s).
382  *   %V   same as %v except in the case of %p only displays a window for multiple files,
383  *        operating on a single file is suppresses the output dialog.
384  *
385  *   %w   must be first two characters in a command, presence will disable full screen
386  *        from exiting upon invocation.
387  *
388  *
389  * [1] Note: %v,%V may also be preceded by "%w".
390  */
391
392
393 gint editor_command_parse(const gchar *template, GList *list, gchar **output)
394 {
395         gint flags = 0;
396         const gchar *p = template;
397         GString *result = NULL;
398         gchar *extensions = NULL;
399
400         if (output)
401                 result = g_string_new("");
402
403         if (!template || template[0] == '\0')
404                 {
405                 flags |= EDITOR_ERROR_EMPTY;
406                 goto err;
407                 }
408         
409         /* skip leading whitespaces if any */
410         while (g_ascii_isspace(*p)) p++;
411
412         /* global flags */
413         while (*p == '%')
414                 {
415                 switch (*++p)
416                         {
417                         case 'w':
418                                 flags |= EDITOR_KEEP_FS;
419                                 p++;
420                                 break;
421                         case 'v':
422                                 flags |= EDITOR_VERBOSE;
423                                 p++;
424                                 break;
425                         case 'V':
426                                 flags |= EDITOR_VERBOSE_MULTI;
427                                 p++;
428                                 break;
429                         default:
430                                 flags |= EDITOR_ERROR_SYNTAX;
431                                 goto err;
432                         }
433                 }
434
435         /* skip whitespaces if any */
436         while (g_ascii_isspace(*p)) p++;
437
438         /* command */
439
440         while (*p)
441                 {
442                 if (*p != '%')
443                         {
444                         if (output) result = g_string_append_c(result, *p);
445                         }
446                 else /* *p == '%' */
447                         {
448                         extensions = NULL;
449                         gchar *pathl = NULL;
450
451                         p++;
452
453                         /* for example "%f" or "%{.crw;.raw;.cr2}f" */
454                         if (*p == '{')
455                                 {
456                                 gchar *end;
457                                 
458                                 p++;
459                                 end = strchr(p, '}');
460                                 if (!end)
461                                         {
462                                         flags |= EDITOR_ERROR_SYNTAX;
463                                         goto err;
464                                         }
465
466                                 extensions = g_strndup(p, end - p);
467                                 p = end + 1;
468                                 }
469
470                         switch (*p)
471                                 {
472                                 case 'd':
473                                         flags |= EDITOR_DEST;
474                                         /* fall through */
475                                 case 'p':
476                                         flags |= EDITOR_FOR_EACH;
477                                         if (flags & EDITOR_SINGLE_COMMAND)
478                                                 {
479                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
480                                                 goto err;
481                                                 }
482                                         if (output)
483                                                 {
484                                                 /* use the first file from the list */
485                                                 if (!list || !list->data)
486                                                         {
487                                                         flags |= EDITOR_ERROR_NO_FILE;
488                                                         goto err;
489                                                         }
490                                                 pathl = editor_command_path_parse((FileData *)list->data,
491                                                                                   (flags & EDITOR_DEST) ? PATH_DEST : PATH_FILE,
492                                                                                   extensions);
493                                                 if (!pathl)
494                                                         {
495                                                         flags |= EDITOR_ERROR_NO_FILE;
496                                                         goto err;
497                                                         }
498                                                 result = g_string_append_c(result, '"');
499                                                 result = g_string_append(result, pathl);
500                                                 g_free(pathl);
501                                                 result = g_string_append_c(result, '"');
502                                                 }
503                                         break;
504
505                                 case 'f':
506                                         flags |= EDITOR_SINGLE_COMMAND;
507                                         if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
508                                                 {
509                                                 flags |= EDITOR_ERROR_INCOMPATIBLE;
510                                                 goto err;
511                                                 }
512
513                                         if (output)
514                                                 {
515                                                 /* use whole list */
516                                                 GList *work = list;
517                                                 gboolean ok = FALSE;
518
519                                                 while (work)
520                                                         {
521                                                         FileData *fd = work->data;
522                                                         pathl = editor_command_path_parse(fd, PATH_FILE, extensions);
523
524                                                         if (pathl)
525                                                                 {
526                                                                 ok = TRUE;
527                                                                 if (work != list) g_string_append_c(result, ' ');
528                                                                 result = g_string_append_c(result, '"');
529                                                                 result = g_string_append(result, pathl);
530                                                                 g_free(pathl);
531                                                                 result = g_string_append_c(result, '"');
532                                                                 }
533                                                         work = work->next;
534                                                         }
535                                                 if (!ok)
536                                                         {
537                                                         flags |= EDITOR_ERROR_NO_FILE;
538                                                         goto err;
539                                                         }
540                                                 }
541                                         break;
542                                 case '%':
543                                         /* %% = % escaping */
544                                         if (output) result = g_string_append_c(result, *p);
545                                         break;
546                                 default:
547                                         flags |= EDITOR_ERROR_SYNTAX;
548                                         goto err;
549                                 }
550                         if (extensions) g_free(extensions);
551                         extensions = NULL;
552                         }
553                 p++;
554                 }
555
556         if (output) *output = g_string_free(result, FALSE);
557         return flags;
558
559
560 err:
561         if (output)
562                 {
563                 g_string_free(result, TRUE);
564                 *output = NULL;
565                 }
566         if (extensions) g_free(extensions);
567         return flags;
568 }
569
570 static void editor_child_exit_cb (GPid pid, gint status, gpointer data)
571 {
572         EditorData *ed = data;
573         g_spawn_close_pid(pid);
574         ed->pid = -1;
575
576         editor_command_next_finish(ed, status);
577 }
578
579
580 static gint editor_command_one(const gchar *template, GList *list, EditorData *ed)
581 {
582         gchar *command;
583         FileData *fd = list->data;
584         GPid pid;
585         gint standard_output;
586         gint standard_error;
587         gboolean ok;
588
589         ed->pid = -1;
590         ed->flags = editor_command_parse(template, list, &command);
591
592         ok = !(ed->flags & EDITOR_ERROR_MASK);
593
594         if (ok)
595                 {
596                 ok = (options->shell.path && *options->shell.path);
597                 if (!ok) log_printf("ERROR: empty shell command\n");
598                         
599                 if (ok)
600                         {
601                         ok = (access(options->shell.path, X_OK) == 0);
602                         if (!ok) log_printf("ERROR: cannot execute shell command '%s'\n", options->shell.path);
603                         }
604
605                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
606                 }
607
608         if (ok)
609                 {
610                 gchar *working_directory;
611                 gchar *args[4];
612                 guint n = 0;
613
614                 working_directory = remove_level_from_path(fd->path);
615                 args[n++] = options->shell.path;
616                 if (options->shell.options && *options->shell.options)
617                         args[n++] = options->shell.options;
618                 args[n++] = command;
619                 args[n] = NULL;
620
621                 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
622                                       G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
623                                       NULL, NULL,
624                                       &pid,
625                                       NULL,
626                                       ed->vd ? &standard_output : NULL,
627                                       ed->vd ? &standard_error : NULL,
628                                       NULL);
629                 
630                 g_free(working_directory);
631
632                 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
633                 }
634
635         if (ok)
636                 {
637                 g_child_watch_add(pid, editor_child_exit_cb, ed);
638                 ed->pid = pid;
639                 }
640
641         if (ed->vd)
642                 {
643                 if (!ok)
644                         {
645                         gchar *buf;
646
647                         buf = g_strdup_printf(_("Failed to run command:\n%s\n"), template);
648                         editor_verbose_window_fill(ed->vd, buf, strlen(buf));
649                         g_free(buf);
650
651                         }
652                 else
653                         {
654                         GIOChannel *channel_output;
655                         GIOChannel *channel_error;
656
657                         channel_output = g_io_channel_unix_new(standard_output);
658                         g_io_channel_set_flags(channel_output, G_IO_FLAG_NONBLOCK, NULL);
659                         g_io_channel_set_encoding(channel_output, NULL, NULL);
660
661                         g_io_add_watch_full(channel_output, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
662                                             editor_verbose_io_cb, ed, NULL);
663                         g_io_channel_unref(channel_output);
664
665                         channel_error = g_io_channel_unix_new(standard_error);
666                         g_io_channel_set_flags(channel_error, G_IO_FLAG_NONBLOCK, NULL);
667                         g_io_channel_set_encoding(channel_error, NULL, NULL);
668
669                         g_io_add_watch_full(channel_error, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
670                                             editor_verbose_io_cb, ed, NULL);
671                         g_io_channel_unref(channel_error);
672                         }
673                 }
674
675         g_free(command);
676
677         return ed->flags & EDITOR_ERROR_MASK;
678 }
679
680 static gint editor_command_next_start(EditorData *ed)
681 {
682         if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
683
684         if (ed->list && ed->count < ed->total)
685                 {
686                 FileData *fd;
687                 gint error;
688
689                 fd = ed->list->data;
690
691                 if (ed->vd)
692                         {
693                         editor_verbose_window_progress(ed, (ed->flags & EDITOR_FOR_EACH) ? fd->path : _("running..."));
694                         }
695                 ed->count++;
696
697                 error = editor_command_one(ed->command_template, ed->list, ed);
698                 if (!error && ed->vd)
699                         {
700                         gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
701                         if (ed->flags & EDITOR_FOR_EACH)
702                                 {
703                                 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
704                                 editor_verbose_window_fill(ed->vd, "\n", 1);
705                                 }
706                         }
707
708                 if (!error)
709                         return 0;
710                 else
711                         /* command was not started, call the finish immediately */
712                         return editor_command_next_finish(ed, 0);
713                 }
714
715         /* everything is done */
716         return editor_command_done(ed);
717 }
718
719 static gint editor_command_next_finish(EditorData *ed, gint status)
720 {
721         gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
722
723         if (status)
724                 ed->flags |= EDITOR_ERROR_STATUS;
725
726         if (ed->flags & EDITOR_FOR_EACH)
727                 {
728                 /* handle the first element from the list */
729                 GList *fd_element = ed->list;
730
731                 ed->list = g_list_remove_link(ed->list, fd_element);
732                 if (ed->callback)
733                         {
734                         cont = ed->callback(ed->list ? ed : NULL, ed->flags, fd_element, ed->data);
735                         if (ed->stopping && cont == EDITOR_CB_CONTINUE) cont = EDITOR_CB_SKIP;
736                         }
737                 filelist_free(fd_element);
738                 }
739         else
740                 {
741                 /* handle whole list */
742                 if (ed->callback)
743                         cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
744                 filelist_free(ed->list);
745                 ed->list = NULL;
746                 }
747
748         if (cont == EDITOR_CB_SUSPEND)
749                 return ed->flags & EDITOR_ERROR_MASK;
750         else if (cont == EDITOR_CB_SKIP)
751                 return editor_command_done(ed);
752         else
753                 return editor_command_next_start(ed);
754 }
755
756 static gint editor_command_done(EditorData *ed)
757 {
758         gint flags;
759
760         if (ed->vd)
761                 {
762                 const gchar *text;
763
764                 if (ed->count == ed->total)
765                         {
766                         text = _("done");
767                         }
768                 else
769                         {
770                         text = _("stopped by user");
771                         }
772                 editor_verbose_window_progress(ed, text);
773                 editor_verbose_window_enable_close(ed->vd);
774                 }
775
776         /* free the not-handled items */
777         if (ed->list)
778                 {
779                 ed->flags |= EDITOR_ERROR_SKIPPED;
780                 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
781                 filelist_free(ed->list);
782                 ed->list = NULL;
783                 }
784
785         ed->count = 0;
786
787         flags = ed->flags & EDITOR_ERROR_MASK;
788
789         if (!ed->vd) editor_data_free(ed);
790
791         return flags;
792 }
793
794 void editor_resume(gpointer ed)
795 {
796         editor_command_next_start(ed);
797 }
798
799 void editor_skip(gpointer ed)
800 {
801         editor_command_done(ed);
802 }
803
804 static gint editor_command_start(const gchar *template, const gchar *text, GList *list, EditorCallback cb, gpointer data)
805 {
806         EditorData *ed;
807         gint flags = editor_command_parse(template, NULL, NULL);
808
809         if (flags & EDITOR_ERROR_MASK) return flags & EDITOR_ERROR_MASK;
810
811         ed = g_new0(EditorData, 1);
812         ed->list = filelist_copy(list);
813         ed->flags = flags;
814         ed->command_template = g_strdup(template);
815         ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
816         ed->count = 0;
817         ed->stopping = FALSE;
818         ed->callback = cb;
819         ed->data =  data;
820
821         if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
822                 flags |= EDITOR_VERBOSE;
823
824         if (flags & EDITOR_VERBOSE)
825                 editor_verbose_window(ed, text);
826
827         editor_command_next_start(ed);
828         /* errors from editor_command_next_start will be handled via callback */
829         return flags & EDITOR_ERROR_MASK;
830 }
831
832 gboolean is_valid_editor_command(gint n)
833 {
834         return (n >= 0 && n < GQ_EDITOR_SLOTS
835                 && options->editor[n].command
836                 && strlen(options->editor[n].command) > 0);
837 }
838
839 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data)
840 {
841         gchar *command;
842         gint error;
843
844         if (!list) return FALSE;
845         if (!is_valid_editor_command(n)) return FALSE;
846
847         command = g_locale_from_utf8(options->editor[n].command, -1, NULL, NULL, NULL);
848         error = editor_command_start(command, options->editor[n].name, list, cb, data);
849         g_free(command);
850
851         if (n < GQ_EDITOR_GENERIC_SLOTS && (error & EDITOR_ERROR_MASK))
852                 {
853                 gchar *text = g_strdup_printf(_("%s\n#%d \"%s\":\n%s"), editor_get_error_str(error), n+1,
854                                               options->editor[n].name, options->editor[n].command);
855                 
856                 file_util_warning_dialog(_("Invalid editor command"), text, GTK_STOCK_DIALOG_ERROR, NULL);
857                 g_free(text);
858                 }
859
860         return error;
861 }
862
863 gint start_editor_from_filelist(gint n, GList *list)
864 {
865         return start_editor_from_filelist_full(n, list,  NULL, NULL);
866 }
867
868 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data)
869 {
870         GList *list;
871         gint error;
872
873         if (!fd) return FALSE;
874
875         list = g_list_append(NULL, fd);
876         error = start_editor_from_filelist_full(n, list, cb, data);
877         g_list_free(list);
878         return error;
879 }
880
881 gint start_editor_from_file(gint n, FileData *fd)
882 {
883         return start_editor_from_file_full(n, fd, NULL, NULL);
884 }
885
886 gint editor_window_flag_set(gint n)
887 {
888         if (!is_valid_editor_command(n)) return TRUE;
889
890         return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_KEEP_FS);
891 }
892
893 gint editor_is_filter(gint n)
894 {
895         if (!is_valid_editor_command(n)) return FALSE;
896
897         return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_DEST);
898 }
899
900 const gchar *editor_get_error_str(gint flags)
901 {
902         if (flags & EDITOR_ERROR_EMPTY) return _("Editor template is empty.");
903         if (flags & EDITOR_ERROR_SYNTAX) return _("Editor template has incorrect syntax.");
904         if (flags & EDITOR_ERROR_INCOMPATIBLE) return _("Editor template uses incompatible macros.");
905         if (flags & EDITOR_ERROR_NO_FILE) return _("Can't find matching file type.");
906         if (flags & EDITOR_ERROR_CANT_EXEC) return _("Can't execute external editor.");
907         if (flags & EDITOR_ERROR_STATUS) return _("External editor returned error status.");
908         if (flags & EDITOR_ERROR_SKIPPED) return _("File was skipped.");
909         return _("Unknown error.");
910 }
911
912 const gchar *editor_get_name(gint n)
913 {
914         if (!is_valid_editor_command(n)) return NULL;
915
916         if (options->editor[n].name && strlen(options->editor[n].name) > 0)
917                 return options->editor[n].name;
918         
919         return _("(unknown)");
920 }