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!
22 #include "layout_image.h"
23 #include "slideshow.h"
24 #include "ui_fileops.h"
26 #include <sys/types.h>
27 #include <sys/socket.h>
33 #define SERVER_MAX_CLIENTS 8
35 #define REMOTE_SERVER_BACKLOG 4
39 #define UNIX_PATH_MAX 108
43 static RemoteConnection *remote_client_open(const gchar *path);
44 static gint remote_client_send(RemoteConnection *rc, const gchar *text);
47 typedef struct _RemoteClient RemoteClient;
48 struct _RemoteClient {
54 typedef struct _RemoteData RemoteData;
56 CollectionData *command_collection;
60 static gboolean remote_server_client_cb(GIOChannel *source, GIOCondition condition, gpointer data)
62 RemoteClient *client = data;
67 if (condition & G_IO_IN)
75 while (g_io_channel_read_line(source, &buffer, NULL, &termpos, &error) == G_IO_STATUS_NORMAL)
79 buffer[termpos] = '\0';
81 if (strlen(buffer) > 0)
83 queue = g_list_append(queue, buffer);
96 printf("error reading socket: %s\n", error->message);
103 gchar *command = work->data;
106 if (rc->read_func) rc->read_func(rc, command, rc->read_data);
113 if (condition & G_IO_HUP)
115 rc->clients = g_list_remove(rc->clients, client);
117 DEBUG_1("HUP detected, closing client.");
118 DEBUG_1("client count %d", g_list_length(rc->clients));
120 g_source_remove(client->channel_id);
128 static void remote_server_client_add(RemoteConnection *rc, int fd)
130 RemoteClient *client;
133 if (g_list_length(rc->clients) > SERVER_MAX_CLIENTS)
135 printf("maximum remote clients of %d exceeded, closing connection\n", SERVER_MAX_CLIENTS);
140 client = g_new0(RemoteClient, 1);
144 channel = g_io_channel_unix_new(fd);
145 client->channel_id = g_io_add_watch_full(channel, G_PRIORITY_DEFAULT, G_IO_IN | G_IO_HUP,
146 remote_server_client_cb, client, NULL);
147 g_io_channel_unref(channel);
149 rc->clients = g_list_append(rc->clients, client);
150 DEBUG_1("client count %d", g_list_length(rc->clients));
153 static void remote_server_clients_close(RemoteConnection *rc)
157 RemoteClient *client = rc->clients->data;
159 rc->clients = g_list_remove(rc->clients, client);
161 g_source_remove(client->channel_id);
167 static gboolean remote_server_read_cb(GIOChannel *source, GIOCondition condition, gpointer data)
169 RemoteConnection *rc = data;
173 fd = accept(rc->fd, NULL, &alen);
176 printf("error accepting socket: %s\n", strerror(errno));
180 remote_server_client_add(rc, fd);
185 static gint remote_server_exists(const gchar *path)
187 RemoteConnection *rc;
189 /* verify server up */
190 rc = remote_client_open(path);
195 /* unable to connect, remove socket file to free up address */
200 static RemoteConnection *remote_server_open(const gchar *path)
202 RemoteConnection *rc;
203 struct sockaddr_un addr;
208 if (remote_server_exists(path))
210 printf("Address already in use: %s\n", path);
214 fd = socket(PF_UNIX, SOCK_STREAM, 0);
215 if (fd == -1) return NULL;
217 addr.sun_family = AF_UNIX;
218 sun_path_len = MIN(strlen(path) + 1, UNIX_PATH_MAX);
219 strncpy(addr.sun_path, path, sun_path_len);
220 if (bind(fd, &addr, sizeof(addr)) == -1 ||
221 listen(fd, REMOTE_SERVER_BACKLOG) == -1)
223 printf("error subscribing to socket: %s\n", strerror(errno));
228 rc = g_new0(RemoteConnection, 1);
231 rc->path = g_strdup(path);
233 rc->read_func = NULL;
234 rc->read_data = NULL;
238 channel = g_io_channel_unix_new(rc->fd);
239 rc->channel_id = g_io_add_watch_full(channel, G_PRIORITY_DEFAULT, G_IO_IN,
240 remote_server_read_cb, rc, NULL);
241 g_io_channel_unref(channel);
246 static void remote_server_subscribe(RemoteConnection *rc, RemoteReadFunc *func, gpointer data)
248 if (!rc || !rc->server) return;
250 rc->read_func = func;
251 rc->read_data = data;
255 static RemoteConnection *remote_client_open(const gchar *path)
257 RemoteConnection *rc;
259 struct sockaddr_un addr;
263 if (stat(path, &st) != 0 || !S_ISSOCK(st.st_mode)) return NULL;
265 fd = socket(PF_UNIX, SOCK_STREAM, 0);
266 if (fd == -1) return NULL;
268 addr.sun_family = AF_UNIX;
269 sun_path_len = MIN(strlen(path) + 1, UNIX_PATH_MAX);
270 strncpy(addr.sun_path, path, sun_path_len);
271 if (connect(fd, &addr, sizeof(addr)) == -1)
273 DEBUG_1("error connecting to socket: %s", strerror(errno));
278 rc = g_new0(RemoteConnection, 1);
281 rc->path = g_strdup(path);
283 /* this might fix the freezes on freebsd, solaris, etc. - completely untested */
284 remote_client_send(rc, "\n");
289 static sig_atomic_t sigpipe_occured = FALSE;
291 static void sighandler_sigpipe(int sig)
293 sigpipe_occured = TRUE;
296 static gint remote_client_send(RemoteConnection *rc, const gchar *text)
298 struct sigaction new_action, old_action;
301 if (!rc || rc->server) return FALSE;
302 if (!text) return TRUE;
304 sigpipe_occured = FALSE;
306 new_action.sa_handler = sighandler_sigpipe;
307 sigemptyset(&new_action.sa_mask);
308 new_action.sa_flags = 0;
310 /* setup our signal handler */
311 sigaction(SIGPIPE, &new_action, &old_action);
313 if (write(rc->fd, text, strlen(text)) == -1 ||
314 write(rc->fd, "\n", 1) == -1)
318 printf("SIGPIPE writing to socket: %s\n", rc->path);
322 printf("error writing to socket: %s\n", strerror(errno));
331 /* restore the original signal handler */
332 sigaction(SIGPIPE, &old_action, NULL);
337 void remote_close(RemoteConnection *rc)
343 remote_server_clients_close(rc);
345 g_source_remove(rc->channel_id);
350 g_free(rc->read_data);
359 *-----------------------------------------------------------------------------
361 *-----------------------------------------------------------------------------
364 static void gr_image_next(const gchar *text, gpointer data)
366 layout_image_next(NULL);
369 static void gr_image_prev(const gchar *text, gpointer data)
371 layout_image_prev(NULL);
374 static void gr_image_first(const gchar *text, gpointer data)
376 layout_image_first(NULL);
379 static void gr_image_last(const gchar *text, gpointer data)
381 layout_image_last(NULL);
384 static void gr_fullscreen_toggle(const gchar *text, gpointer data)
386 layout_image_full_screen_toggle(NULL);
389 static void gr_fullscreen_start(const gchar *text, gpointer data)
391 layout_image_full_screen_start(NULL);
394 static void gr_fullscreen_stop(const gchar *text, gpointer data)
396 layout_image_full_screen_stop(NULL);
399 static void gr_slideshow_start_rec(const gchar *text, gpointer data)
403 list = filelist_recursive(text);
405 //printf("length: %d\n", g_list_length(list));
406 layout_image_slideshow_stop(NULL);
407 layout_image_slideshow_start_from_list(NULL, list);
410 static void gr_slideshow_toggle(const gchar *text, gpointer data)
412 layout_image_slideshow_toggle(NULL);
415 static void gr_slideshow_start(const gchar *text, gpointer data)
417 layout_image_slideshow_start(NULL);
420 static void gr_slideshow_stop(const gchar *text, gpointer data)
422 layout_image_slideshow_stop(NULL);
425 static void gr_slideshow_delay(const gchar *text, gpointer data)
429 n = strtod(text, NULL);
430 if (n < SLIDESHOW_MIN_SECONDS || n > SLIDESHOW_MAX_SECONDS)
432 printf_term("Remote slideshow delay out of range (%.1f to %.1f)\n",
433 SLIDESHOW_MIN_SECONDS, SLIDESHOW_MAX_SECONDS);
436 options->slideshow.delay = (gint)(n * 10.0 + 0.01);
439 static void gr_tools_show(const gchar *text, gpointer data)
444 if (layout_tools_float_get(NULL, &popped, &hidden) && hidden)
446 layout_tools_float_set(NULL, popped, FALSE);
450 static void gr_tools_hide(const gchar *text, gpointer data)
455 if (layout_tools_float_get(NULL, &popped, &hidden) && !hidden)
457 layout_tools_float_set(NULL, popped, TRUE);
461 static gint gr_quit_idle_cb(gpointer data)
468 static void gr_quit(const gchar *text, gpointer data)
470 /* schedule exit when idle, if done from within a
471 * remote handler remote_close will crash
473 g_idle_add(gr_quit_idle_cb, NULL);
476 static void gr_file_load(const gchar *text, gpointer data)
480 if (file_extension_match(text, ".gqv"))
482 collection_window_new(text);
486 layout_set_path(NULL, text);
489 else if (isdir(text))
491 layout_set_path(NULL, text);
495 printf("remote sent filename that does not exist:\"%s\"\n", text);
499 static void gr_file_view(const gchar *text, gpointer data)
501 view_window_new(file_data_new_simple(text));
504 static void gr_list_clear(const gchar *text, gpointer data)
506 RemoteData *remote_data = data;
508 if (remote_data->command_collection)
510 collection_unref(remote_data->command_collection);
511 remote_data->command_collection = NULL;
515 static void gr_list_add(const gchar *text, gpointer data)
517 RemoteData *remote_data = data;
520 if (!remote_data->command_collection)
524 cd = collection_new("");
529 cd->name = g_strdup(_("Command line"));
531 remote_data->command_collection = cd;
535 new = (!collection_get_first(remote_data->command_collection));
538 if (collection_add(remote_data->command_collection, file_data_new_simple(text), FALSE) && new)
540 layout_image_set_collection(NULL, remote_data->command_collection,
541 collection_get_first(remote_data->command_collection));
545 static void gr_raise(const gchar *text, gpointer data)
547 LayoutWindow *lw = NULL;
549 if (layout_valid(&lw))
551 gtk_window_present(GTK_WINDOW(lw->window));
555 typedef struct _RemoteCommandEntry RemoteCommandEntry;
556 struct _RemoteCommandEntry {
559 void (*func)(const gchar *text, gpointer data);
561 gint prefer_command_line;
565 static RemoteCommandEntry remote_commands[] = {
566 /* short, long callback, extra, prefer,description */
567 { "-n", "--next", gr_image_next, FALSE, FALSE, N_("next image") },
568 { "-b", "--back", gr_image_prev, FALSE, FALSE, N_("previous image") },
569 { NULL, "--first", gr_image_first, FALSE, FALSE, N_("first image") },
570 { NULL, "--last", gr_image_last, FALSE, FALSE, N_("last image") },
571 { "-f", "--fullscreen", gr_fullscreen_toggle, FALSE, TRUE, N_("toggle full screen") },
572 { "-fs","--fullscreen-start", gr_fullscreen_start, FALSE, FALSE, N_("start full screen") },
573 { "-fS","--fullscreen-stop", gr_fullscreen_stop, FALSE, FALSE, N_("stop full screen") },
574 { "-s", "--slideshow", gr_slideshow_toggle, FALSE, TRUE, N_("toggle slide show") },
575 { "-ss","--slideshow-start", gr_slideshow_start, FALSE, FALSE, N_("start slide show") },
576 { "-sS","--slideshow-stop", gr_slideshow_stop, FALSE, FALSE, N_("stop slide show") },
577 { "-sr","--slideshow-recurse", gr_slideshow_start_rec, TRUE, FALSE, N_("start recursive slide show") },
578 { "-d", "--delay=", gr_slideshow_delay, TRUE, FALSE, N_("set slide show delay in seconds") },
579 { "+t", "--tools-show", gr_tools_show, FALSE, TRUE, N_("show tools") },
580 { "-t", "--tools-hide", gr_tools_hide, FALSE, TRUE, N_("hide tools") },
581 { "-q", "--quit", gr_quit, FALSE, FALSE, N_("quit") },
582 { NULL, "file:", gr_file_load, TRUE, FALSE, N_("open file") },
583 { NULL, "view:", gr_file_view, TRUE, FALSE, N_("open file in new window") },
584 { NULL, "--list-clear", gr_list_clear, FALSE, FALSE, NULL },
585 { NULL, "--list-add:", gr_list_add, TRUE, FALSE, NULL },
586 { NULL, "raise", gr_raise, FALSE, FALSE, NULL },
587 { NULL, NULL, NULL, FALSE, FALSE, NULL }
590 static RemoteCommandEntry *remote_command_find(const gchar *text, const gchar **offset)
596 while (!match && remote_commands[i].func != NULL)
598 if (remote_commands[i].needs_extra)
600 if (remote_commands[i].opt_s &&
601 strncmp(remote_commands[i].opt_s, text, strlen(remote_commands[i].opt_s)) == 0)
603 if (offset) *offset = text + strlen(remote_commands[i].opt_s);
604 return &remote_commands[i];
606 else if (remote_commands[i].opt_l &&
607 strncmp(remote_commands[i].opt_l, text, strlen(remote_commands[i].opt_l)) == 0)
609 if (offset) *offset = text + strlen(remote_commands[i].opt_l);
610 return &remote_commands[i];
615 if ((remote_commands[i].opt_s && strcmp(remote_commands[i].opt_s, text) == 0) ||
616 (remote_commands[i].opt_l && strcmp(remote_commands[i].opt_l, text) == 0))
618 if (offset) *offset = text;
619 return &remote_commands[i];
629 static void remote_cb(RemoteConnection *rc, const gchar *text, gpointer data)
631 RemoteCommandEntry *entry;
634 entry = remote_command_find(text, &offset);
635 if (entry && entry->func)
637 entry->func(offset, data);
641 printf("unknown remote command:%s\n", text);
645 void remote_help(void)
649 print_term(_("Remote command list:\n"));
652 while (remote_commands[i].func != NULL)
654 if (remote_commands[i].description)
656 printf_term(" %-3s%s %-20s %s\n",
657 (remote_commands[i].opt_s) ? remote_commands[i].opt_s : "",
658 (remote_commands[i].opt_s && remote_commands[i].opt_l) ? "," : " ",
659 (remote_commands[i].opt_l) ? remote_commands[i].opt_l : "",
660 _(remote_commands[i].description));
666 GList *remote_build_list(GList *list, int argc, char *argv[], GList **errors)
673 RemoteCommandEntry *entry;
675 entry = remote_command_find(argv[i], NULL);
678 list = g_list_append(list, argv[i]);
682 *errors = g_list_append(*errors, argv[i]);
690 void remote_control(const gchar *arg_exec, GList *remote_list, const gchar *path,
691 GList *cmd_list, GList *collection_list)
693 RemoteConnection *rc;
694 gint started = FALSE;
697 buf = g_strconcat(homedir(), "/", GQ_RC_DIR, "/.command", NULL);
698 rc = remote_client_open(buf);
703 gint retry_count = 12;
706 printf_term(_("Remote %s not running, starting..."), GQ_APPNAME);
708 command = g_string_new(arg_exec);
714 RemoteCommandEntry *entry;
719 entry = remote_command_find(text, NULL);
722 if (entry->prefer_command_line)
724 remote_list = g_list_remove(remote_list, text);
725 g_string_append(command, " ");
726 g_string_append(command, text);
728 if (entry->opt_l && strcmp(entry->opt_l, "file:") == 0)
735 if (blank || cmd_list || path) g_string_append(command, " --blank");
736 if (get_debug_level()) g_string_append(command, " --debug");
738 g_string_append(command, " &");
739 system(command->str);
740 g_string_free(command, TRUE);
742 while (!rc && retry_count > 0)
744 usleep((retry_count > 10) ? 500000 : 1000000);
745 rc = remote_client_open(buf);
746 if (!rc) print_term(".");
760 gint use_path = TRUE;
767 RemoteCommandEntry *entry;
772 entry = remote_command_find(text, NULL);
775 strcmp(entry->opt_l, "file:") == 0) use_path = FALSE;
777 remote_client_send(rc, text);
782 if (cmd_list && cmd_list->next)
784 prefix = "--list-add:";
785 remote_client_send(rc, "--list-clear");
801 text = g_strconcat(prefix, fd->path, NULL);
802 remote_client_send(rc, text);
808 if (path && !cmd_list && use_path)
812 text = g_strdup_printf("file:%s", path);
813 remote_client_send(rc, text);
819 work = collection_list;
828 text = g_strdup_printf("file:%s", name);
829 remote_client_send(rc, text);
835 if (!started && !sent)
837 remote_client_send(rc, "raise");
842 print_term(_("Remote not available\n"));
848 RemoteConnection *remote_server_init(gchar *path, CollectionData *command_collection)
850 RemoteConnection *remote_connection = remote_server_open(path);
851 RemoteData *remote_data = g_new(RemoteData, 1);
853 remote_data->command_collection = command_collection;
855 remote_server_subscribe(remote_connection, remote_cb, remote_data);
856 return remote_connection;