4 * Copyright (C) 2008 The Geeqie Team
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!
18 #include "filefilter.h"
20 #include "ui_fileops.h"
21 #include "ui_spinner.h"
22 #include "ui_utildlg.h"
27 #define EDITOR_WINDOW_WIDTH 500
28 #define EDITOR_WINDOW_HEIGHT 300
32 typedef struct _EditorVerboseData EditorVerboseData;
33 struct _EditorVerboseData {
35 GtkWidget *button_close;
36 GtkWidget *button_stop;
42 typedef struct _EditorData EditorData;
46 gchar *command_template;
51 EditorVerboseData *vd;
52 EditorCallback callback;
57 static Editor editor_slot_defaults[GQ_EDITOR_SLOTS] = {
58 { N_("The Gimp"), "gimp-remote %{.cr2;.crw;.nef;.raw;*}f" },
59 { N_("XV"), "xv %f" },
60 { N_("Xpaint"), "xpaint %f" },
61 { N_("UFraw"), "ufraw %{.cr2;.crw;.nef;.raw}p" },
62 { N_("Add XMP sidecar"), "%vFILE=%{.cr2;.crw;.nef;.raw}p;XMP=`echo \"$FILE\"|sed -e 's|\\.[^.]*$|.xmp|'`; exiftool -tagsfromfile \"$FILE\" \"$XMP\"" },
66 { 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" },
67 { 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" },
71 { N_("External Copy command"), "%vset -x;cp %p %d" },
72 { N_("External Move command"), "%vset -x;mv %p %d" },
73 { N_("External Rename command"), "%vset -x;mv %p %d" },
74 { N_("External Delete command"), NULL },
75 { N_("External New Folder command"), NULL },
77 { N_("External Copy command"), NULL },
78 { N_("External Move command"), NULL },
79 { N_("External Rename command"), NULL },
80 { N_("External Delete command"), NULL },
81 { N_("External New Folder command"), NULL },
85 static void editor_verbose_window_progress(EditorData *ed, const gchar *text);
86 static gint editor_command_next_start(EditorData *ed);
87 static gint editor_command_next_finish(EditorData *ed, gint status);
88 static gint editor_command_done(EditorData *ed);
91 *-----------------------------------------------------------------------------
92 * external editor routines
93 *-----------------------------------------------------------------------------
96 void editor_reset_defaults(void)
100 for (i = 0; i < GQ_EDITOR_SLOTS; i++)
102 g_free(options->editor[i].name);
103 options->editor[i].name = g_strdup(_(editor_slot_defaults[i].name));
104 g_free(options->editor[i].command);
105 options->editor[i].command = g_strdup(editor_slot_defaults[i].command);
109 static void editor_verbose_data_free(EditorData *ed)
116 static void editor_data_free(EditorData *ed)
118 editor_verbose_data_free(ed);
119 g_free(ed->command_template);
123 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
125 EditorData *ed = data;
127 generic_dialog_close(gd);
128 editor_verbose_data_free(ed);
129 if (ed->pid == -1) editor_data_free(ed); /* the process has already terminated */
132 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
134 EditorData *ed = data;
137 editor_verbose_window_progress(ed, _("stopping..."));
140 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
142 vd->gd->cancel_cb = editor_verbose_window_close;
144 spinner_set_interval(vd->spinner, -1);
145 gtk_widget_set_sensitive(vd->button_stop, FALSE);
146 gtk_widget_set_sensitive(vd->button_close, TRUE);
149 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
151 EditorVerboseData *vd;
156 vd = g_new0(EditorVerboseData, 1);
158 vd->gd = file_util_gen_dlg(_("Edit command results"), GQ_WMCLASS, "editor_results",
161 buf = g_strdup_printf(_("Output of %s"), text);
162 generic_dialog_add_message(vd->gd, NULL, buf, NULL);
164 vd->button_stop = generic_dialog_add_button(vd->gd, GTK_STOCK_STOP, NULL,
165 editor_verbose_window_stop, FALSE);
166 gtk_widget_set_sensitive(vd->button_stop, FALSE);
167 vd->button_close = generic_dialog_add_button(vd->gd, GTK_STOCK_CLOSE, NULL,
168 editor_verbose_window_close, TRUE);
169 gtk_widget_set_sensitive(vd->button_close, FALSE);
171 scrolled = gtk_scrolled_window_new(NULL, NULL);
172 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
173 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
174 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
175 gtk_box_pack_start(GTK_BOX(vd->gd->vbox), scrolled, TRUE, TRUE, 5);
176 gtk_widget_show(scrolled);
178 vd->text = gtk_text_view_new();
179 gtk_text_view_set_editable(GTK_TEXT_VIEW(vd->text), FALSE);
180 gtk_widget_set_size_request(vd->text, EDITOR_WINDOW_WIDTH, EDITOR_WINDOW_HEIGHT);
181 gtk_container_add(GTK_CONTAINER(scrolled), vd->text);
182 gtk_widget_show(vd->text);
184 hbox = gtk_hbox_new(FALSE, 0);
185 gtk_box_pack_start(GTK_BOX(vd->gd->vbox), hbox, FALSE, FALSE, 0);
186 gtk_widget_show(hbox);
188 vd->progress = gtk_progress_bar_new();
189 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(vd->progress), 0.0);
190 gtk_box_pack_start(GTK_BOX(hbox), vd->progress, TRUE, TRUE, 0);
191 gtk_widget_show(vd->progress);
193 vd->spinner = spinner_new(NULL, SPINNER_SPEED);
194 gtk_box_pack_start(GTK_BOX(hbox), vd->spinner, FALSE, FALSE, 0);
195 gtk_widget_show(vd->spinner);
197 gtk_widget_show(vd->gd->dialog);
203 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
205 GtkTextBuffer *buffer;
208 buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(vd->text));
209 gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
210 gtk_text_buffer_insert(buffer, &iter, text, len);
213 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
219 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (double)ed->count / ed->total);
222 gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
225 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
227 EditorData *ed = data;
231 if (condition & G_IO_IN)
233 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
235 if (!g_utf8_validate(buf, count, NULL))
239 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
242 editor_verbose_window_fill(ed->vd, utf8, -1);
247 editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
252 editor_verbose_window_fill(ed->vd, buf, count);
257 if (condition & (G_IO_ERR | G_IO_HUP))
259 g_io_channel_shutdown(source, TRUE, NULL);
272 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const gchar *extensions)
276 const gchar *p = NULL;
278 string = g_string_new("");
280 if (type == PATH_FILE)
282 GList *ext_list = filter_to_list(extensions);
283 GList *work = ext_list;
292 gchar *ext = work->data;
295 if (strcmp(ext, "*") == 0 ||
296 strcasecmp(ext, fd->extension) == 0)
302 work2 = fd->sidecar_files;
305 FileData *sfd = work2->data;
308 if (strcasecmp(ext, sfd->extension) == 0)
316 string_list_free(ext_list);
320 else if (type == PATH_DEST)
322 if (fd->change && fd->change->dest)
323 p = fd->change->dest;
330 /* must escape \, ", `, and $ to avoid problems,
331 * we assume system shell supports bash-like escaping
333 if (strchr("\\\"`$", *p) != NULL)
335 string = g_string_append_c(string, '\\');
337 string = g_string_append_c(string, *p);
341 pathl = path_from_utf8(string->str);
342 g_string_free(string, TRUE);
349 * The supported macros for editor commands:
351 * %f first occurence replaced by quoted sequence of filenames, command is run once.
352 * only one occurence of this macro is supported.
353 * ([ls %f] results in [ls "file1" "file2" ... "lastfile"])
354 * %p command is run for each filename in turn, each instance replaced with single filename.
355 * multiple occurences of this macro is supported for complex shell commands.
356 * This macro will BLOCK THE APPLICATION until it completes, since command is run once
357 * for every file in syncronous order. To avoid blocking add the %v macro, below.
358 * ([ls %p] results in [ls "file1"], [ls "file2"] ... [ls "lastfile"])
359 * none if no macro is supplied, the result is equivalent to "command %f"
360 * ([ls] results in [ls "file1" "file2" ... "lastfile"])
362 * Only one of the macros %f or %p may be used in a given commmand.
364 * %v must be the first two characters[1] in a command, causes a window to display
365 * showing the output of the command(s).
366 * %V same as %v except in the case of %p only displays a window for multiple files,
367 * operating on a single file is suppresses the output dialog.
369 * %w must be first two characters in a command, presence will disable full screen
370 * from exiting upon invocation.
373 * [1] Note: %v,%V may also be preceded by "%w".
377 gint editor_command_parse(const gchar *template, GList *list, gchar **output)
380 const gchar *p = template;
381 GString *result = NULL;
382 gchar *extensions = NULL;
385 result = g_string_new("");
387 if (!template || template[0] == '\0')
389 flags |= EDITOR_ERROR_EMPTY;
393 /* skip leading whitespaces if any */
394 while (g_ascii_isspace(*p)) p++;
402 flags |= EDITOR_KEEP_FS;
406 flags |= EDITOR_VERBOSE;
410 flags |= EDITOR_VERBOSE_MULTI;
414 flags |= EDITOR_ERROR_SYNTAX;
419 /* skip whitespaces if any */
420 while (g_ascii_isspace(*p)) p++;
428 if (output) result = g_string_append_c(result, *p);
437 /* for example "%f" or "%{.crw;.raw;.cr2}f" */
443 end = strchr(p, '}');
446 flags |= EDITOR_ERROR_SYNTAX;
450 extensions = g_strndup(p, end - p);
457 flags |= EDITOR_DEST;
460 flags |= EDITOR_FOR_EACH;
461 if (flags & EDITOR_SINGLE_COMMAND)
463 flags |= EDITOR_ERROR_INCOMPATIBLE;
468 /* use the first file from the list */
469 if (!list || !list->data)
471 flags |= EDITOR_ERROR_NO_FILE;
474 pathl = editor_command_path_parse((FileData *)list->data,
475 (flags & EDITOR_DEST) ? PATH_DEST : PATH_FILE,
479 flags |= EDITOR_ERROR_NO_FILE;
482 result = g_string_append_c(result, '"');
483 result = g_string_append(result, pathl);
485 result = g_string_append_c(result, '"');
490 flags |= EDITOR_SINGLE_COMMAND;
491 if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
493 flags |= EDITOR_ERROR_INCOMPATIBLE;
505 FileData *fd = work->data;
506 pathl = editor_command_path_parse(fd, PATH_FILE, extensions);
511 if (work != list) g_string_append_c(result, ' ');
512 result = g_string_append_c(result, '"');
513 result = g_string_append(result, pathl);
515 result = g_string_append_c(result, '"');
521 flags |= EDITOR_ERROR_NO_FILE;
527 /* %% = % escaping */
528 if (output) result = g_string_append_c(result, *p);
531 flags |= EDITOR_ERROR_SYNTAX;
534 if (extensions) g_free(extensions);
540 if (output) *output = g_string_free(result, FALSE);
547 g_string_free(result, TRUE);
550 if (extensions) g_free(extensions);
554 static void editor_child_exit_cb (GPid pid, gint status, gpointer data)
556 EditorData *ed = data;
557 g_spawn_close_pid(pid);
560 editor_command_next_finish(ed, status);
564 static gint editor_command_one(const gchar *template, GList *list, EditorData *ed)
567 FileData *fd = list->data;
569 gint standard_output;
574 ed->flags = editor_command_parse(template, list, &command);
576 ok = !(ed->flags & EDITOR_ERROR_MASK);
580 ok = (options->shell.path && *options->shell.path);
581 if (!ok) log_printf("ERROR: empty shell command\n");
585 ok = (access(options->shell.path, X_OK) == 0);
586 if (!ok) log_printf("ERROR: cannot execute shell command '%s'\n", options->shell.path);
589 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
594 gchar *working_directory;
598 working_directory = remove_level_from_path(fd->path);
599 args[n++] = options->shell.path;
600 if (options->shell.options && *options->shell.options)
601 args[n++] = options->shell.options;
605 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
606 G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
610 ed->vd ? &standard_output : NULL,
611 ed->vd ? &standard_error : NULL,
614 g_free(working_directory);
616 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
621 g_child_watch_add(pid, editor_child_exit_cb, ed);
631 buf = g_strdup_printf(_("Failed to run command:\n%s\n"), template);
632 editor_verbose_window_fill(ed->vd, buf, strlen(buf));
638 GIOChannel *channel_output;
639 GIOChannel *channel_error;
641 channel_output = g_io_channel_unix_new(standard_output);
642 g_io_channel_set_flags(channel_output, G_IO_FLAG_NONBLOCK, NULL);
644 g_io_add_watch_full(channel_output, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
645 editor_verbose_io_cb, ed, NULL);
646 g_io_channel_unref(channel_output);
648 channel_error = g_io_channel_unix_new(standard_error);
649 g_io_channel_set_flags(channel_error, G_IO_FLAG_NONBLOCK, NULL);
651 g_io_add_watch_full(channel_error, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
652 editor_verbose_io_cb, ed, NULL);
653 g_io_channel_unref(channel_error);
659 return ed->flags & EDITOR_ERROR_MASK;
662 static gint editor_command_next_start(EditorData *ed)
664 if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
666 if (ed->list && ed->count < ed->total)
675 editor_verbose_window_progress(ed, (ed->flags & EDITOR_FOR_EACH) ? fd->path : _("running..."));
679 error = editor_command_one(ed->command_template, ed->list, ed);
680 if (!error && ed->vd)
682 gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
683 if (ed->flags & EDITOR_FOR_EACH)
685 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
686 editor_verbose_window_fill(ed->vd, "\n", 1);
693 /* command was not started, call the finish immediately */
694 return editor_command_next_finish(ed, 0);
697 /* everything is done */
698 return editor_command_done(ed);
701 static gint editor_command_next_finish(EditorData *ed, gint status)
703 gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
706 ed->flags |= EDITOR_ERROR_STATUS;
708 if (ed->flags & EDITOR_FOR_EACH)
710 /* handle the first element from the list */
711 GList *fd_element = ed->list;
713 ed->list = g_list_remove_link(ed->list, fd_element);
715 cont = ed->callback(ed->list ? ed : NULL, ed->flags, fd_element, ed->data);
716 filelist_free(fd_element);
720 /* handle whole list */
722 cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
723 filelist_free(ed->list);
727 if (cont == EDITOR_CB_SUSPEND)
728 return ed->flags & EDITOR_ERROR_MASK;
729 else if (cont == EDITOR_CB_SKIP)
730 return editor_command_done(ed);
732 return editor_command_next_start(ed);
735 static gint editor_command_done(EditorData *ed)
743 if (ed->count == ed->total)
749 text = _("stopped by user");
751 editor_verbose_window_progress(ed, text);
752 editor_verbose_window_enable_close(ed->vd);
755 /* free the not-handled items */
758 ed->flags |= EDITOR_ERROR_SKIPPED;
759 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
760 filelist_free(ed->list);
766 flags = ed->flags & EDITOR_ERROR_MASK;
768 if (!ed->vd) editor_data_free(ed);
773 void editor_resume(gpointer ed)
775 editor_command_next_start(ed);
778 void editor_skip(gpointer ed)
780 editor_command_done(ed);
783 static gint editor_command_start(const gchar *template, const gchar *text, GList *list, EditorCallback cb, gpointer data)
786 gint flags = editor_command_parse(template, NULL, NULL);
788 if (flags & EDITOR_ERROR_MASK) return flags & EDITOR_ERROR_MASK;
790 ed = g_new0(EditorData, 1);
791 ed->list = filelist_copy(list);
793 ed->command_template = g_strdup(template);
794 ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
796 ed->stopping = FALSE;
800 if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
801 flags |= EDITOR_VERBOSE;
803 if (flags & EDITOR_VERBOSE)
804 editor_verbose_window(ed, text);
806 editor_command_next_start(ed);
807 /* errors from editor_command_next_start will be handled via callback */
808 return flags & EDITOR_ERROR_MASK;
811 gboolean is_valid_editor_command(gint n)
813 return (n >= 0 && n < GQ_EDITOR_SLOTS
814 && options->editor[n].command
815 && strlen(options->editor[n].command) > 0);
818 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data)
823 if (!list) return FALSE;
824 if (!is_valid_editor_command(n)) return FALSE;
826 command = g_locale_from_utf8(options->editor[n].command, -1, NULL, NULL, NULL);
827 error = editor_command_start(command, options->editor[n].name, list, cb, data);
830 if (n < GQ_EDITOR_GENERIC_SLOTS && (error & EDITOR_ERROR_MASK))
832 gchar *text = g_strdup_printf(_("%s\n#%d \"%s\":\n%s"), editor_get_error_str(error), n+1,
833 options->editor[n].name, options->editor[n].command);
835 file_util_warning_dialog(_("Invalid editor command"), text, GTK_STOCK_DIALOG_ERROR, NULL);
842 gint start_editor_from_filelist(gint n, GList *list)
844 return start_editor_from_filelist_full(n, list, NULL, NULL);
847 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data)
852 if (!fd) return FALSE;
854 list = g_list_append(NULL, fd);
855 error = start_editor_from_filelist_full(n, list, cb, data);
860 gint start_editor_from_file(gint n, FileData *fd)
862 return start_editor_from_file_full(n, fd, NULL, NULL);
865 gint editor_window_flag_set(gint n)
867 if (!is_valid_editor_command(n)) return TRUE;
869 return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_KEEP_FS);
872 gint editor_is_filter(gint n)
874 if (!is_valid_editor_command(n)) return FALSE;
876 return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_DEST);
879 const gchar *editor_get_error_str(gint flags)
881 if (flags & EDITOR_ERROR_EMPTY) return _("Editor template is empty.");
882 if (flags & EDITOR_ERROR_SYNTAX) return _("Editor template has incorrect syntax.");
883 if (flags & EDITOR_ERROR_INCOMPATIBLE) return _("Editor template uses incompatible macros.");
884 if (flags & EDITOR_ERROR_NO_FILE) return _("Can't find matching file type.");
885 if (flags & EDITOR_ERROR_CANT_EXEC) return _("Can't execute external editor.");
886 if (flags & EDITOR_ERROR_STATUS) return _("External editor returned error status.");
887 if (flags & EDITOR_ERROR_SKIPPED) return _("File was skipped.");
888 return _("Unknown error.");
891 const gchar *editor_get_name(gint n)
893 if (!is_valid_editor_command(n)) return NULL;
895 if (options->editor[n].name && strlen(options->editor[n].name) > 0)
896 return options->editor[n].name;
898 return _("(unknown)");