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"
28 #define EDITOR_WINDOW_WIDTH 500
29 #define EDITOR_WINDOW_HEIGHT 300
33 typedef struct _EditorVerboseData EditorVerboseData;
34 struct _EditorVerboseData {
36 GtkWidget *button_close;
37 GtkWidget *button_stop;
43 typedef struct _EditorData EditorData;
47 gchar *command_template;
52 EditorVerboseData *vd;
53 EditorCallback callback;
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"},
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" },
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 },
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 },
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);
92 *-----------------------------------------------------------------------------
93 * external editor routines
94 *-----------------------------------------------------------------------------
97 void editor_set_name(gint n, gchar *name)
99 if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
101 g_free(options->editor[n].name);
103 options->editor[n].name = name ? utf8_validate_or_convert(name) : NULL;
106 void editor_set_command(gint n, gchar *command)
108 if (n < 0 || n >= GQ_EDITOR_SLOTS) return;
110 g_free(options->editor[n].command);
111 options->editor[n].command = command ? utf8_validate_or_convert(command) : NULL;
114 void editor_reset_defaults(void)
118 for (i = 0; i < GQ_EDITOR_SLOTS; i++)
120 editor_set_name(i, _(editor_slot_defaults[i].name));
121 editor_set_command(i, _(editor_slot_defaults[i].command));
125 static void editor_verbose_data_free(EditorData *ed)
132 static void editor_data_free(EditorData *ed)
134 editor_verbose_data_free(ed);
135 g_free(ed->command_template);
139 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
141 EditorData *ed = data;
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 */
148 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
150 EditorData *ed = data;
153 editor_verbose_window_progress(ed, _("stopping..."));
156 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
158 vd->gd->cancel_cb = editor_verbose_window_close;
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);
165 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
167 EditorVerboseData *vd;
172 vd = g_new0(EditorVerboseData, 1);
174 vd->gd = file_util_gen_dlg(_("Edit command results"), GQ_WMCLASS, "editor_results",
177 buf = g_strdup_printf(_("Output of %s"), text);
178 generic_dialog_add_message(vd->gd, NULL, buf, NULL);
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);
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);
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);
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);
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);
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);
213 gtk_widget_show(vd->gd->dialog);
219 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
221 GtkTextBuffer *buffer;
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);
229 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
235 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (gdouble)ed->count / ed->total);
238 gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
241 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
243 EditorData *ed = data;
247 if (condition & G_IO_IN)
249 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
251 if (!g_utf8_validate(buf, count, NULL))
255 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
258 editor_verbose_window_fill(ed->vd, utf8, -1);
263 editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
268 editor_verbose_window_fill(ed->vd, buf, count);
273 if (condition & (G_IO_ERR | G_IO_HUP))
275 g_io_channel_shutdown(source, TRUE, NULL);
288 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const gchar *extensions)
292 const gchar *p = NULL;
294 string = g_string_new("");
296 if (type == PATH_FILE)
298 GList *ext_list = filter_to_list(extensions);
299 GList *work = ext_list;
308 gchar *ext = work->data;
311 if (strcmp(ext, "*") == 0 ||
312 strcasecmp(ext, fd->extension) == 0)
318 work2 = fd->sidecar_files;
321 FileData *sfd = work2->data;
324 if (strcasecmp(ext, sfd->extension) == 0)
332 string_list_free(ext_list);
336 else if (type == PATH_DEST)
338 if (fd->change && fd->change->dest)
339 p = fd->change->dest;
346 /* must escape \, ", `, and $ to avoid problems,
347 * we assume system shell supports bash-like escaping
349 if (strchr("\\\"`$", *p) != NULL)
351 string = g_string_append_c(string, '\\');
353 string = g_string_append_c(string, *p);
357 pathl = path_from_utf8(string->str);
358 g_string_free(string, TRUE);
365 * The supported macros for editor commands:
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"])
378 * Only one of the macros %f or %p may be used in a given commmand.
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.
385 * %w must be first two characters in a command, presence will disable full screen
386 * from exiting upon invocation.
389 * [1] Note: %v,%V may also be preceded by "%w".
393 gint editor_command_parse(const gchar *template, GList *list, gchar **output)
396 const gchar *p = template;
397 GString *result = NULL;
398 gchar *extensions = NULL;
401 result = g_string_new("");
403 if (!template || template[0] == '\0')
405 flags |= EDITOR_ERROR_EMPTY;
409 /* skip leading whitespaces if any */
410 while (g_ascii_isspace(*p)) p++;
418 flags |= EDITOR_KEEP_FS;
422 flags |= EDITOR_VERBOSE;
426 flags |= EDITOR_VERBOSE_MULTI;
430 flags |= EDITOR_ERROR_SYNTAX;
435 /* skip whitespaces if any */
436 while (g_ascii_isspace(*p)) p++;
444 if (output) result = g_string_append_c(result, *p);
453 /* for example "%f" or "%{.crw;.raw;.cr2}f" */
459 end = strchr(p, '}');
462 flags |= EDITOR_ERROR_SYNTAX;
466 extensions = g_strndup(p, end - p);
473 flags |= EDITOR_DEST;
476 flags |= EDITOR_FOR_EACH;
477 if (flags & EDITOR_SINGLE_COMMAND)
479 flags |= EDITOR_ERROR_INCOMPATIBLE;
484 /* use the first file from the list */
485 if (!list || !list->data)
487 flags |= EDITOR_ERROR_NO_FILE;
490 pathl = editor_command_path_parse((FileData *)list->data,
491 (flags & EDITOR_DEST) ? PATH_DEST : PATH_FILE,
495 flags |= EDITOR_ERROR_NO_FILE;
498 result = g_string_append_c(result, '"');
499 result = g_string_append(result, pathl);
501 result = g_string_append_c(result, '"');
506 flags |= EDITOR_SINGLE_COMMAND;
507 if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
509 flags |= EDITOR_ERROR_INCOMPATIBLE;
521 FileData *fd = work->data;
522 pathl = editor_command_path_parse(fd, PATH_FILE, extensions);
527 if (work != list) g_string_append_c(result, ' ');
528 result = g_string_append_c(result, '"');
529 result = g_string_append(result, pathl);
531 result = g_string_append_c(result, '"');
537 flags |= EDITOR_ERROR_NO_FILE;
543 /* %% = % escaping */
544 if (output) result = g_string_append_c(result, *p);
547 flags |= EDITOR_ERROR_SYNTAX;
550 if (extensions) g_free(extensions);
556 if (output) *output = g_string_free(result, FALSE);
563 g_string_free(result, TRUE);
566 if (extensions) g_free(extensions);
570 static void editor_child_exit_cb (GPid pid, gint status, gpointer data)
572 EditorData *ed = data;
573 g_spawn_close_pid(pid);
576 editor_command_next_finish(ed, status);
580 static gint editor_command_one(const gchar *template, GList *list, EditorData *ed)
583 FileData *fd = list->data;
585 gint standard_output;
590 ed->flags = editor_command_parse(template, list, &command);
592 ok = !(ed->flags & EDITOR_ERROR_MASK);
596 ok = (options->shell.path && *options->shell.path);
597 if (!ok) log_printf("ERROR: empty shell command\n");
601 ok = (access(options->shell.path, X_OK) == 0);
602 if (!ok) log_printf("ERROR: cannot execute shell command '%s'\n", options->shell.path);
605 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
610 gchar *working_directory;
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;
621 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
622 G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
626 ed->vd ? &standard_output : NULL,
627 ed->vd ? &standard_error : NULL,
630 g_free(working_directory);
632 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
637 g_child_watch_add(pid, editor_child_exit_cb, ed);
647 buf = g_strdup_printf(_("Failed to run command:\n%s\n"), template);
648 editor_verbose_window_fill(ed->vd, buf, strlen(buf));
654 GIOChannel *channel_output;
655 GIOChannel *channel_error;
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);
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);
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);
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);
677 return ed->flags & EDITOR_ERROR_MASK;
680 static gint editor_command_next_start(EditorData *ed)
682 if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
684 if (ed->list && ed->count < ed->total)
693 editor_verbose_window_progress(ed, (ed->flags & EDITOR_FOR_EACH) ? fd->path : _("running..."));
697 error = editor_command_one(ed->command_template, ed->list, ed);
698 if (!error && ed->vd)
700 gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
701 if (ed->flags & EDITOR_FOR_EACH)
703 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
704 editor_verbose_window_fill(ed->vd, "\n", 1);
711 /* command was not started, call the finish immediately */
712 return editor_command_next_finish(ed, 0);
715 /* everything is done */
716 return editor_command_done(ed);
719 static gint editor_command_next_finish(EditorData *ed, gint status)
721 gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
724 ed->flags |= EDITOR_ERROR_STATUS;
726 if (ed->flags & EDITOR_FOR_EACH)
728 /* handle the first element from the list */
729 GList *fd_element = ed->list;
731 ed->list = g_list_remove_link(ed->list, fd_element);
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;
737 filelist_free(fd_element);
741 /* handle whole list */
743 cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
744 filelist_free(ed->list);
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);
753 return editor_command_next_start(ed);
756 static gint editor_command_done(EditorData *ed)
764 if (ed->count == ed->total)
770 text = _("stopped by user");
772 editor_verbose_window_progress(ed, text);
773 editor_verbose_window_enable_close(ed->vd);
776 /* free the not-handled items */
779 ed->flags |= EDITOR_ERROR_SKIPPED;
780 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
781 filelist_free(ed->list);
787 flags = ed->flags & EDITOR_ERROR_MASK;
789 if (!ed->vd) editor_data_free(ed);
794 void editor_resume(gpointer ed)
796 editor_command_next_start(ed);
799 void editor_skip(gpointer ed)
801 editor_command_done(ed);
804 static gint editor_command_start(const gchar *template, const gchar *text, GList *list, EditorCallback cb, gpointer data)
807 gint flags = editor_command_parse(template, NULL, NULL);
809 if (flags & EDITOR_ERROR_MASK) return flags & EDITOR_ERROR_MASK;
811 ed = g_new0(EditorData, 1);
812 ed->list = filelist_copy(list);
814 ed->command_template = g_strdup(template);
815 ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
817 ed->stopping = FALSE;
821 if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
822 flags |= EDITOR_VERBOSE;
824 if (flags & EDITOR_VERBOSE)
825 editor_verbose_window(ed, text);
827 editor_command_next_start(ed);
828 /* errors from editor_command_next_start will be handled via callback */
829 return flags & EDITOR_ERROR_MASK;
832 gboolean is_valid_editor_command(gint n)
834 return (n >= 0 && n < GQ_EDITOR_SLOTS
835 && options->editor[n].command
836 && strlen(options->editor[n].command) > 0);
839 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data)
844 if (!list) return FALSE;
845 if (!is_valid_editor_command(n)) return FALSE;
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);
851 if (n < GQ_EDITOR_GENERIC_SLOTS && (error & EDITOR_ERROR_MASK))
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);
856 file_util_warning_dialog(_("Invalid editor command"), text, GTK_STOCK_DIALOG_ERROR, NULL);
863 gint start_editor_from_filelist(gint n, GList *list)
865 return start_editor_from_filelist_full(n, list, NULL, NULL);
868 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data)
873 if (!fd) return FALSE;
875 list = g_list_append(NULL, fd);
876 error = start_editor_from_filelist_full(n, list, cb, data);
881 gint start_editor_from_file(gint n, FileData *fd)
883 return start_editor_from_file_full(n, fd, NULL, NULL);
886 gint editor_window_flag_set(gint n)
888 if (!is_valid_editor_command(n)) return TRUE;
890 return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_KEEP_FS);
893 gint editor_is_filter(gint n)
895 if (!is_valid_editor_command(n)) return FALSE;
897 return (editor_command_parse(options->editor[n].command, NULL, NULL) & EDITOR_DEST);
900 const gchar *editor_get_error_str(gint flags)
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.");
912 const gchar *editor_get_name(gint n)
914 if (!is_valid_editor_command(n)) return NULL;
916 if (options->editor[n].name && strlen(options->editor[n].name) > 0)
917 return options->editor[n].name;
919 return _("(unknown)");