7 * This software is released under the GNU General Public License (GNU GPL).
8 * Please read the included file COPYING for more information.
9 * This software comes with no warranty of any kind, use at your own risk!
17 #include "ui_fileops.h"
18 #include "ui_spinner.h"
19 #include "ui_utildlg.h"
26 #define EDITOR_WINDOW_WIDTH 500
27 #define EDITOR_WINDOW_HEIGHT 300
29 #define COMMAND_SHELL "/bin/sh"
30 #define COMMAND_OPT "-c"
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 gchar *editor_slot_defaults[GQ_EDITOR_SLOTS * 2] = {
59 N_("The Gimp"), "gimp-remote %{.cr2;.crw;.nef;.raw;*}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\"",
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_reset_defaults(void)
101 for (i = 0; i < GQ_EDITOR_SLOTS; i++)
103 g_free(options->editor_name[i]);
104 options->editor_name[i] = g_strdup(_(editor_slot_defaults[i * 2]));
105 g_free(options->editor_command[i]);
106 options->editor_command[i] = g_strdup(editor_slot_defaults[i * 2 + 1]);
110 static void editor_verbose_data_free(EditorData *ed)
117 static void editor_data_free(EditorData *ed)
119 editor_verbose_data_free(ed);
120 g_free(ed->command_template);
124 static void editor_verbose_window_close(GenericDialog *gd, gpointer data)
126 EditorData *ed = data;
128 generic_dialog_close(gd);
129 editor_verbose_data_free(ed);
130 if (ed->pid == -1) editor_data_free(ed); /* the process has already terminated */
133 static void editor_verbose_window_stop(GenericDialog *gd, gpointer data)
135 EditorData *ed = data;
138 editor_verbose_window_progress(ed, _("stopping..."));
141 static void editor_verbose_window_enable_close(EditorVerboseData *vd)
143 vd->gd->cancel_cb = editor_verbose_window_close;
145 spinner_set_interval(vd->spinner, -1);
146 gtk_widget_set_sensitive(vd->button_stop, FALSE);
147 gtk_widget_set_sensitive(vd->button_close, TRUE);
150 static EditorVerboseData *editor_verbose_window(EditorData *ed, const gchar *text)
152 EditorVerboseData *vd;
157 vd = g_new0(EditorVerboseData, 1);
159 vd->gd = file_util_gen_dlg(_("Edit command results"), GQ_WMCLASS, "editor_results",
162 buf = g_strdup_printf(_("Output of %s"), text);
163 generic_dialog_add_message(vd->gd, NULL, buf, NULL);
165 vd->button_stop = generic_dialog_add_button(vd->gd, GTK_STOCK_STOP, NULL,
166 editor_verbose_window_stop, FALSE);
167 gtk_widget_set_sensitive(vd->button_stop, FALSE);
168 vd->button_close = generic_dialog_add_button(vd->gd, GTK_STOCK_CLOSE, NULL,
169 editor_verbose_window_close, TRUE);
170 gtk_widget_set_sensitive(vd->button_close, FALSE);
172 scrolled = gtk_scrolled_window_new(NULL, NULL);
173 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
174 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
175 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
176 gtk_box_pack_start(GTK_BOX(vd->gd->vbox), scrolled, TRUE, TRUE, 5);
177 gtk_widget_show(scrolled);
179 vd->text = gtk_text_view_new();
180 gtk_text_view_set_editable(GTK_TEXT_VIEW(vd->text), FALSE);
181 gtk_widget_set_size_request(vd->text, EDITOR_WINDOW_WIDTH, EDITOR_WINDOW_HEIGHT);
182 gtk_container_add(GTK_CONTAINER(scrolled), vd->text);
183 gtk_widget_show(vd->text);
185 hbox = gtk_hbox_new(FALSE, 0);
186 gtk_box_pack_start(GTK_BOX(vd->gd->vbox), hbox, FALSE, FALSE, 0);
187 gtk_widget_show(hbox);
189 vd->progress = gtk_progress_bar_new();
190 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(vd->progress), 0.0);
191 gtk_box_pack_start(GTK_BOX(hbox), vd->progress, TRUE, TRUE, 0);
192 gtk_widget_show(vd->progress);
194 vd->spinner = spinner_new(NULL, SPINNER_SPEED);
195 gtk_box_pack_start(GTK_BOX(hbox), vd->spinner, FALSE, FALSE, 0);
196 gtk_widget_show(vd->spinner);
198 gtk_widget_show(vd->gd->dialog);
204 static void editor_verbose_window_fill(EditorVerboseData *vd, gchar *text, gint len)
206 GtkTextBuffer *buffer;
209 buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(vd->text));
210 gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
211 gtk_text_buffer_insert(buffer, &iter, text, len);
214 static void editor_verbose_window_progress(EditorData *ed, const gchar *text)
220 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(ed->vd->progress), (double)ed->count / ed->total);
223 gtk_progress_bar_set_text(GTK_PROGRESS_BAR(ed->vd->progress), (text) ? text : "");
226 static gboolean editor_verbose_io_cb(GIOChannel *source, GIOCondition condition, gpointer data)
228 EditorData *ed = data;
232 if (condition & G_IO_IN)
234 while (g_io_channel_read_chars(source, buf, sizeof(buf), &count, NULL) == G_IO_STATUS_NORMAL)
236 if (!g_utf8_validate(buf, count, NULL))
240 utf8 = g_locale_to_utf8(buf, count, NULL, NULL, NULL);
243 editor_verbose_window_fill(ed->vd, utf8, -1);
248 editor_verbose_window_fill(ed->vd, "Error converting text to valid utf8\n", -1);
253 editor_verbose_window_fill(ed->vd, buf, count);
258 if (condition & (G_IO_ERR | G_IO_HUP))
260 g_io_channel_shutdown(source, TRUE, NULL);
273 static gchar *editor_command_path_parse(const FileData *fd, PathType type, const gchar *extensions)
277 const gchar *p = NULL;
279 string = g_string_new("");
281 if (type == PATH_FILE)
283 GList *ext_list = filter_to_list(extensions);
284 GList *work = ext_list;
293 gchar *ext = work->data;
296 if (strcmp(ext, "*") == 0 ||
297 strcasecmp(ext, fd->extension) == 0)
303 work2 = fd->sidecar_files;
306 FileData *sfd = work2->data;
309 if (strcasecmp(ext, sfd->extension) == 0)
317 string_list_free(ext_list);
321 else if (type == PATH_DEST)
323 if (fd->change && fd->change->dest)
324 p = fd->change->dest;
331 /* must escape \, ", `, and $ to avoid problems,
332 * we assume system shell supports bash-like escaping
334 if (strchr("\\\"`$", *p) != NULL)
336 string = g_string_append_c(string, '\\');
338 string = g_string_append_c(string, *p);
342 pathl = path_from_utf8(string->str);
343 g_string_free(string, TRUE);
350 * The supported macros for editor commands:
352 * %f first occurence replaced by quoted sequence of filenames, command is run once.
353 * only one occurence of this macro is supported.
354 * ([ls %f] results in [ls "file1" "file2" ... "lastfile"])
355 * %p command is run for each filename in turn, each instance replaced with single filename.
356 * multiple occurences of this macro is supported for complex shell commands.
357 * This macro will BLOCK THE APPLICATION until it completes, since command is run once
358 * for every file in syncronous order. To avoid blocking add the %v macro, below.
359 * ([ls %p] results in [ls "file1"], [ls "file2"] ... [ls "lastfile"])
360 * none if no macro is supplied, the result is equivalent to "command %f"
361 * ([ls] results in [ls "file1" "file2" ... "lastfile"])
363 * Only one of the macros %f or %p may be used in a given commmand.
365 * %v must be the first two characters[1] in a command, causes a window to display
366 * showing the output of the command(s).
367 * %V same as %v except in the case of %p only displays a window for multiple files,
368 * operating on a single file is suppresses the output dialog.
370 * %w must be first two characters in a command, presence will disable full screen
371 * from exiting upon invocation.
374 * [1] Note: %v,%V may also be preceded by "%w".
378 gint editor_command_parse(const gchar *template, GList *list, gchar **output)
381 const gchar *p = template;
382 GString *result = NULL;
383 gchar *extensions = NULL;
386 result = g_string_new("");
388 if (!template || template[0] == '\0')
390 flags |= EDITOR_ERROR_EMPTY;
401 flags |= EDITOR_KEEP_FS;
405 flags |= EDITOR_VERBOSE;
409 flags |= EDITOR_VERBOSE_MULTI;
421 if (output) result = g_string_append_c(result, *p);
430 /* for example "%f" or "%{.crw;.raw;.cr2}f" */
436 end = strchr(p, '}');
439 flags |= EDITOR_ERROR_SYNTAX;
443 extensions = g_strndup(p, end - p);
450 flags |= EDITOR_DEST;
452 flags |= EDITOR_FOR_EACH;
453 if (flags & EDITOR_SINGLE_COMMAND)
455 flags |= EDITOR_ERROR_INCOMPATIBLE;
460 /* use the first file from the list */
461 if (!list || !list->data)
463 flags |= EDITOR_ERROR_NO_FILE;
466 pathl = editor_command_path_parse((FileData *)list->data, (*p == 'd') ? PATH_DEST : PATH_FILE, extensions);
469 flags |= EDITOR_ERROR_NO_FILE;
472 result = g_string_append_c(result, '"');
473 result = g_string_append(result, pathl);
475 result = g_string_append_c(result, '"');
480 flags |= EDITOR_SINGLE_COMMAND;
481 if (flags & (EDITOR_FOR_EACH | EDITOR_DEST))
483 flags |= EDITOR_ERROR_INCOMPATIBLE;
495 FileData *fd = work->data;
496 pathl = editor_command_path_parse(fd, PATH_FILE, extensions);
501 if (work != list) g_string_append_c(result, ' ');
502 result = g_string_append_c(result, '"');
503 result = g_string_append(result, pathl);
505 result = g_string_append_c(result, '"');
511 flags |= EDITOR_ERROR_NO_FILE;
517 flags |= EDITOR_ERROR_SYNTAX;
520 if (extensions) g_free(extensions);
526 if (output) *output = g_string_free(result, FALSE);
533 g_string_free(result, TRUE);
536 if (extensions) g_free(extensions);
540 static void editor_child_exit_cb (GPid pid, gint status, gpointer data)
542 EditorData *ed = data;
543 g_spawn_close_pid(pid);
546 editor_command_next_finish(ed, status);
550 static gint editor_command_one(const gchar *template, GList *list, EditorData *ed)
553 FileData *fd = list->data;
555 gint standard_output;
560 ed->flags = editor_command_parse(template, list, &command);
562 ok = !(ed->flags & EDITOR_ERROR_MASK);
566 gchar *working_directory;
569 working_directory = remove_level_from_path(fd->path);
570 args[0] = COMMAND_SHELL;
571 args[1] = COMMAND_OPT;
575 ok = g_spawn_async_with_pipes(working_directory, args, NULL,
576 G_SPAWN_DO_NOT_REAP_CHILD, /* GSpawnFlags */
580 ed->vd ? &standard_output : NULL,
581 ed->vd ? &standard_error : NULL,
584 g_free(working_directory);
586 if (!ok) ed->flags |= EDITOR_ERROR_CANT_EXEC;
591 g_child_watch_add(pid, editor_child_exit_cb, ed);
601 buf = g_strdup_printf(_("Failed to run command:\n%s\n"), template);
602 editor_verbose_window_fill(ed->vd, buf, strlen(buf));
608 GIOChannel *channel_output;
609 GIOChannel *channel_error;
611 channel_output = g_io_channel_unix_new(standard_output);
612 g_io_channel_set_flags(channel_output, G_IO_FLAG_NONBLOCK, NULL);
614 g_io_add_watch_full(channel_output, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
615 editor_verbose_io_cb, ed, NULL);
616 g_io_channel_unref(channel_output);
618 channel_error = g_io_channel_unix_new(standard_error);
619 g_io_channel_set_flags(channel_error, G_IO_FLAG_NONBLOCK, NULL);
621 g_io_add_watch_full(channel_error, G_PRIORITY_HIGH, G_IO_IN | G_IO_ERR | G_IO_HUP,
622 editor_verbose_io_cb, ed, NULL);
623 g_io_channel_unref(channel_error);
629 return ed->flags & EDITOR_ERROR_MASK;
632 static gint editor_command_next_start(EditorData *ed)
634 if (ed->vd) editor_verbose_window_fill(ed->vd, "\n", 1);
636 if (ed->list && ed->count < ed->total)
645 editor_verbose_window_progress(ed, (ed->flags & EDITOR_FOR_EACH) ? fd->path : _("running..."));
649 error = editor_command_one(ed->command_template, ed->list, ed);
650 if (!error && ed->vd)
652 gtk_widget_set_sensitive(ed->vd->button_stop, (ed->list != NULL) );
653 if (ed->flags & EDITOR_FOR_EACH)
655 editor_verbose_window_fill(ed->vd, fd->path, strlen(fd->path));
656 editor_verbose_window_fill(ed->vd, "\n", 1);
663 /* command was not started, call the finish immediately */
664 return editor_command_next_finish(ed, 0);
667 /* everything is done */
668 return editor_command_done(ed);
671 static gint editor_command_next_finish(EditorData *ed, gint status)
673 gint cont = ed->stopping ? EDITOR_CB_SKIP : EDITOR_CB_CONTINUE;
676 ed->flags |= EDITOR_ERROR_STATUS;
678 if (ed->flags & EDITOR_FOR_EACH)
680 /* handle the first element from the list */
681 GList *fd_element = ed->list;
683 ed->list = g_list_remove_link(ed->list, fd_element);
685 cont = ed->callback(ed->list ? ed : NULL, ed->flags, fd_element, ed->data);
686 filelist_free(fd_element);
690 /* handle whole list */
692 cont = ed->callback(NULL, ed->flags, ed->list, ed->data);
693 filelist_free(ed->list);
697 if (cont == EDITOR_CB_SUSPEND)
698 return ed->flags & EDITOR_ERROR_MASK;
699 else if (cont == EDITOR_CB_SKIP)
700 return editor_command_done(ed);
702 return editor_command_next_start(ed);
705 static gint editor_command_done(EditorData *ed)
713 if (ed->count == ed->total)
719 text = _("stopped by user");
721 editor_verbose_window_progress(ed, text);
722 editor_verbose_window_enable_close(ed->vd);
725 /* free the not-handled items */
728 ed->flags |= EDITOR_ERROR_SKIPPED;
729 if (ed->callback) ed->callback(NULL, ed->flags, ed->list, ed->data);
730 filelist_free(ed->list);
736 flags = ed->flags & EDITOR_ERROR_MASK;
738 if (!ed->vd) editor_data_free(ed);
743 void editor_resume(gpointer ed)
745 editor_command_next_start(ed);
748 void editor_skip(gpointer ed)
750 editor_command_done(ed);
753 static gint editor_command_start(const gchar *template, const gchar *text, GList *list, EditorCallback cb, gpointer data)
756 gint flags = editor_command_parse(template, NULL, NULL);
758 if (flags & EDITOR_ERROR_MASK) return flags & EDITOR_ERROR_MASK;
760 ed = g_new0(EditorData, 1);
761 ed->list = filelist_copy(list);
763 ed->command_template = g_strdup(template);
764 ed->total = (flags & EDITOR_SINGLE_COMMAND) ? 1 : g_list_length(list);
766 ed->stopping = FALSE;
770 if ((flags & EDITOR_VERBOSE_MULTI) && list && list->next)
771 flags |= EDITOR_VERBOSE;
773 if (flags & EDITOR_VERBOSE)
774 editor_verbose_window(ed, text);
776 editor_command_next_start(ed);
777 /* errors from editor_command_next_start will be handled via callback */
778 return flags & EDITOR_ERROR_MASK;
781 static gint is_valid_editor_command(gint n)
783 return (n >= 0 && n < GQ_EDITOR_SLOTS
784 && options->editor_command[n]
785 && strlen(options->editor_command[n]) > 0);
788 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data)
793 if (!list) return FALSE;
794 if (!is_valid_editor_command(n)) return FALSE;
796 command = g_locale_from_utf8(options->editor_command[n], -1, NULL, NULL, NULL);
797 error = editor_command_start(command, options->editor_name[n], list, cb, data);
802 gint start_editor_from_filelist(gint n, GList *list)
804 return start_editor_from_filelist_full(n, list, NULL, NULL);
807 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data)
812 if (!fd) return FALSE;
814 list = g_list_append(NULL, fd);
815 error = start_editor_from_filelist_full(n, list, cb, data);
820 gint start_editor_from_file(gint n, FileData *fd)
822 return start_editor_from_file_full(n, fd, NULL, NULL);
825 gint editor_window_flag_set(gint n)
827 if (!is_valid_editor_command(n)) return TRUE;
829 return (editor_command_parse(options->editor_command[n], NULL, NULL) & EDITOR_KEEP_FS);
832 const gchar *editor_get_error_str(gint flags)
834 if (flags & EDITOR_ERROR_EMPTY) return _("Editor template is empty.");
835 if (flags & EDITOR_ERROR_SYNTAX) return _("Editor template has incorrect syntax.");
836 if (flags & EDITOR_ERROR_INCOMPATIBLE) return _("Editor template uses incompatible macros.");
837 if (flags & EDITOR_ERROR_NO_FILE) return _("Can't find matching file type.");
838 if (flags & EDITOR_ERROR_CANT_EXEC) return _("Can't execute external editor.");
839 if (flags & EDITOR_ERROR_STATUS) return _("External editor returned error status.");
840 if (flags & EDITOR_ERROR_SKIPPED) return _("File was skipped.");
841 return _("Unknown error.");