style: Reduce scope of several variables
[geany-mirror.git] / src / socket.c
blob5e4aa4b8c7cc2756e74dfbc1988d5b4750ddfd9e
1 /*
2 * socket.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
6 * Copyright 2006 Hiroyuki Yamamoto (author of Sylpheed)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * Socket setup and messages handling.
25 * The socket allows detection and messages to be sent to the first running instance of Geany.
26 * Only the first instance loads session files at startup, and opens files from the command-line.
30 * Little dev doc:
31 * Each command which is sent between two instances (see send_open_command and
32 * socket_lock_input_cb) should have the following scheme:
33 * command name\n
34 * data\n
35 * data\n
36 * ...
37 * .\n
38 * The first thing should be the command name followed by the data belonging to the command and
39 * to mark the end of data send a single '.'. Each message should be ended with \n.
40 * The command window is only available on Windows and takes no additional data, instead it
41 * writes back a Windows handle (HWND) for the main window to set it to the foreground (focus).
43 * At the moment the commands window, doclist, open, openro, line and column are available.
45 * About the socket files on Unix-like systems:
46 * Geany creates a socket in /tmp (or any other directory returned by g_get_tmp_dir()) and
47 * a symlink in the current configuration to the created socket file. The symlink is named
48 * geany_socket_<hostname>_<displayname> (displayname is the name of the active X display).
49 * If the socket file cannot be created in the temporary directory, Geany creates the socket file
50 * directly in the configuration directory as a fallback.
54 #ifdef HAVE_CONFIG_H
55 # include "config.h"
56 #endif
58 #ifdef HAVE_SOCKET
60 #include "socket.h"
62 #include "app.h"
63 #include "dialogs.h"
64 #include "document.h"
65 #include "encodings.h"
66 #include "main.h"
67 #include "support.h"
68 #include "utils.h"
69 #include "win32.h"
71 #include "gtkcompat.h"
74 #ifndef G_OS_WIN32
75 # include <sys/time.h>
76 # include <sys/types.h>
77 # include <sys/socket.h>
78 # include <sys/un.h>
79 # include <netinet/in.h>
80 # include <glib/gstdio.h>
81 #else
82 # include <winsock2.h>
83 # include <windows.h>
84 # include <gdk/gdkwin32.h>
85 # include <ws2tcpip.h>
86 #endif
87 #include <string.h>
88 #include <stdlib.h>
89 #include <unistd.h>
90 #include <fcntl.h>
92 #ifdef GDK_WINDOWING_X11
93 #include <gdk/gdkx.h>
94 #endif
97 #ifdef G_OS_WIN32
98 #define REMOTE_CMD_PORT 49876
99 #define SOCKET_IS_VALID(s) ((s) != INVALID_SOCKET)
100 #else
101 #define SOCKET_IS_VALID(s) ((s) >= 0)
102 #define INVALID_SOCKET (-1)
103 #endif
104 #define BUFFER_LENGTH 4096
106 struct SocketInfo socket_info;
109 #ifdef G_OS_WIN32
110 static gint socket_fd_connect_inet (gushort port);
111 static gint socket_fd_open_inet (gushort port);
112 static void socket_init_win32 (void);
113 #else
114 static gint socket_fd_connect_unix (const gchar *path);
115 static gint socket_fd_open_unix (const gchar *path);
116 #endif
118 static gint socket_fd_write (gint sock, const gchar *buf, gint len);
119 static gint socket_fd_write_all (gint sock, const gchar *buf, gint len);
120 static gint socket_fd_gets (gint sock, gchar *buf, gint len);
121 static gint socket_fd_check_io (gint fd, GIOCondition cond);
122 static gint socket_fd_read (gint sock, gchar *buf, gint len);
123 static gint socket_fd_recv (gint fd, gchar *buf, gint len, gint flags);
124 static gint socket_fd_close (gint sock);
128 static void send_open_command(gint sock, gint argc, gchar **argv)
130 gint i;
132 g_return_if_fail(argc > 1);
133 geany_debug("using running instance of Geany");
135 if (cl_options.goto_line >= 0)
137 gchar *line = g_strdup_printf("%d\n", cl_options.goto_line);
138 socket_fd_write_all(sock, "line\n", 5);
139 socket_fd_write_all(sock, line, strlen(line));
140 socket_fd_write_all(sock, ".\n", 2);
141 g_free(line);
144 if (cl_options.goto_column >= 0)
146 gchar *col = g_strdup_printf("%d\n", cl_options.goto_column);
147 socket_fd_write_all(sock, "column\n", 7);
148 socket_fd_write_all(sock, col, strlen(col));
149 socket_fd_write_all(sock, ".\n", 2);
150 g_free(col);
153 if (cl_options.readonly) /* append "ro" to denote readonly status for new docs */
154 socket_fd_write_all(sock, "openro\n", 7);
155 else
156 socket_fd_write_all(sock, "open\n", 5);
158 for (i = 1; i < argc && argv[i] != NULL; i++)
160 gchar *filename = main_get_argv_filename(argv[i]);
162 /* if the filename is valid or if a new file should be opened is check on the other side */
163 if (filename != NULL)
165 socket_fd_write_all(sock, filename, strlen(filename));
166 socket_fd_write_all(sock, "\n", 1);
168 else
170 g_printerr(_("Could not find file '%s'."), filename);
171 g_printerr("\n"); /* keep translation from open_cl_files() in main.c. */
173 g_free(filename);
175 socket_fd_write_all(sock, ".\n", 2);
179 #ifndef G_OS_WIN32
180 static void remove_socket_link_full(void)
182 gchar real_path[512];
183 gsize len;
185 real_path[0] = '\0';
187 /* read the contents of the symbolic link socket_info.file_name and delete it
188 * readlink should return something like "/tmp/geany_socket.499602d2" */
189 len = readlink(socket_info.file_name, real_path, sizeof(real_path) - 1);
190 if ((gint) len > 0)
192 real_path[len] = '\0';
193 g_unlink(real_path);
195 g_unlink(socket_info.file_name);
197 #endif
200 static void socket_get_document_list(gint sock)
202 gchar buf[BUFFER_LENGTH];
203 gint n_read;
205 if (sock < 0)
206 return;
208 socket_fd_write_all(sock, "doclist\n", 8);
212 n_read = socket_fd_read(sock, buf, BUFFER_LENGTH);
213 /* if we received ETX (end-of-text), there is nothing else to read, so cut that
214 * byte not to output it and to be sure not to validate the loop condition */
215 if (n_read > 0 && buf[n_read - 1] == '\3')
216 n_read--;
217 if (n_read > 0)
218 fwrite(buf, 1, n_read, stdout);
220 while (n_read >= BUFFER_LENGTH);
224 #ifndef G_OS_WIN32
225 static void check_socket_permissions(void)
227 GStatBuf socket_stat;
229 if (g_lstat(socket_info.file_name, &socket_stat) == 0)
230 { /* If the user id of the process is not the same as the owner of the socket
231 * file, then ignore this socket and start a new session. */
232 if (socket_stat.st_uid != getuid())
234 const gchar *msg = _(
235 /* TODO maybe this message needs a rewording */
236 "Geany tried to access the Unix Domain socket of another instance running as another user.\n"
237 "This is a fatal error and Geany will now quit.");
238 g_warning("%s", msg);
239 dialogs_show_msgbox(GTK_MESSAGE_ERROR, "%s", msg);
240 exit(1);
244 #endif
247 /* (Unix domain) socket support to replace the old FIFO code
248 * (taken from Sylpheed, thanks)
249 * Returns the created socket, -1 if an error occurred or -2 if another socket exists and files
250 * were sent to it. */
251 gint socket_init(gint argc, gchar **argv)
253 gint sock;
254 #ifdef G_OS_WIN32
255 HANDLE hmutex;
256 HWND hwnd;
257 socket_init_win32();
258 hmutex = CreateMutexA(NULL, FALSE, "Geany");
259 if (! hmutex)
261 geany_debug("cannot create Mutex\n");
262 return -1;
264 if (GetLastError() != ERROR_ALREADY_EXISTS)
266 /* To support multiple instances with different configuration directories (as we do on
267 * non-Windows systems) we would need to use different port number s but it might be
268 * difficult to get a port number which is unique for a configuration directory (path)
269 * and which is unused. This port number has to be guessed by the first and new instance
270 * and the only data is the configuration directory path.
271 * For now we use one port number, that is we support only one instance at all. */
272 sock = socket_fd_open_inet(REMOTE_CMD_PORT);
273 if (sock < 0)
274 return 0;
275 return sock;
278 sock = socket_fd_connect_inet(REMOTE_CMD_PORT);
279 if (sock < 0)
280 return -1;
281 #else
282 gchar *display_name = NULL;
283 const gchar *hostname = g_get_host_name();
284 GdkDisplay *display = gdk_display_get_default();
285 gchar *p;
287 if (display != NULL)
288 display_name = g_strdup(gdk_display_get_name(display));
289 if (display_name == NULL)
290 display_name = g_strdup("NODISPLAY");
292 /* these lines are taken from dcopc.c in kdelibs */
293 if ((p = strrchr(display_name, '.')) > strrchr(display_name, ':') && p != NULL)
294 *p = '\0';
295 /* remove characters that may not be acceptable in a filename */
296 for (p = display_name; *p; p++)
298 if (*p == ':' || *p == '/')
299 *p = '_';
302 if (socket_info.file_name == NULL)
303 socket_info.file_name = g_strdup_printf("%s%cgeany_socket_%s_%s",
304 app->configdir, G_DIR_SEPARATOR, hostname, display_name);
306 g_free(display_name);
308 /* check whether the real user id is the same as this of the socket file */
309 check_socket_permissions();
311 sock = socket_fd_connect_unix(socket_info.file_name);
312 if (sock < 0)
314 remove_socket_link_full(); /* deletes the socket file and the symlink */
315 return socket_fd_open_unix(socket_info.file_name);
317 #endif
319 /* remote command mode, here we have another running instance and want to use it */
321 #ifdef G_OS_WIN32
322 /* first we send a request to retrieve the window handle and focus the window */
323 socket_fd_write_all(sock, "window\n", 7);
324 if (socket_fd_read(sock, (gchar *)&hwnd, sizeof(hwnd)) == sizeof(hwnd))
325 SetForegroundWindow(hwnd);
326 #endif
327 /* now we send the command line args */
328 if (argc > 1)
330 send_open_command(sock, argc, argv);
333 if (cl_options.list_documents)
335 socket_get_document_list(sock);
338 socket_fd_close(sock);
339 return -2;
343 gint socket_finalize(void)
345 if (socket_info.lock_socket < 0)
346 return -1;
348 if (socket_info.lock_socket_tag > 0)
349 g_source_remove(socket_info.lock_socket_tag);
350 if (socket_info.read_ioc)
352 g_io_channel_shutdown(socket_info.read_ioc, FALSE, NULL);
353 g_io_channel_unref(socket_info.read_ioc);
354 socket_info.read_ioc = NULL;
357 #ifdef G_OS_WIN32
358 WSACleanup();
359 #else
360 if (socket_info.file_name != NULL)
362 remove_socket_link_full(); /* deletes the socket file and the symlink */
363 g_free(socket_info.file_name);
365 #endif
367 return 0;
371 #ifdef G_OS_UNIX
372 static gint socket_fd_connect_unix(const gchar *path)
374 gint sock;
375 struct sockaddr_un addr;
377 sock = socket(PF_UNIX, SOCK_STREAM, 0);
378 if (sock < 0)
380 perror("fd_connect_unix(): socket");
381 return -1;
384 memset(&addr, 0, sizeof(addr));
385 addr.sun_family = AF_UNIX;
386 strncpy(addr.sun_path, path, sizeof(addr.sun_path) - 1);
388 if (connect(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
390 socket_fd_close(sock);
391 return -1;
394 return sock;
398 static gint socket_fd_open_unix(const gchar *path)
400 gint sock;
401 struct sockaddr_un addr;
402 gint val;
403 gchar *real_path;
405 sock = socket(PF_UNIX, SOCK_STREAM, 0);
407 if (sock < 0)
409 perror("sock_open_unix(): socket");
410 return -1;
413 val = 1;
414 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val)) < 0)
416 perror("setsockopt");
417 socket_fd_close(sock);
418 return -1;
421 /* fix for #1888561:
422 * in case the configuration directory is located on a network file system or any other
423 * file system which doesn't support sockets, we just link the socket there and create the
424 * real socket in the system's tmp directory assuming it supports sockets */
425 real_path = g_strdup_printf("%s%cgeany_socket.%08x",
426 g_get_tmp_dir(), G_DIR_SEPARATOR, g_random_int());
428 if (utils_is_file_writable(real_path) != 0)
429 { /* if real_path is not writable for us, fall back to ~/.config/geany/geany_socket_*_* */
430 /* instead of creating a symlink and print a warning */
431 g_warning("Socket %s could not be written, using %s as fallback.", real_path, path);
432 SETPTR(real_path, g_strdup(path));
434 /* create a symlink in e.g. ~/.config/geany/geany_socket_hostname__0 to /tmp/geany_socket.499602d2 */
435 else if (symlink(real_path, path) != 0)
437 perror("symlink");
438 socket_fd_close(sock);
439 return -1;
442 memset(&addr, 0, sizeof(addr));
443 addr.sun_family = AF_UNIX;
444 strncpy(addr.sun_path, real_path, sizeof(addr.sun_path) - 1);
446 if (bind(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
448 perror("bind");
449 socket_fd_close(sock);
450 return -1;
453 if (listen(sock, 1) < 0)
455 perror("listen");
456 socket_fd_close(sock);
457 return -1;
460 g_chmod(real_path, 0600);
462 g_free(real_path);
464 return sock;
466 #endif
468 static gint socket_fd_close(gint fd)
470 #ifdef G_OS_WIN32
471 return closesocket(fd);
472 #else
473 return close(fd);
474 #endif
478 #ifdef G_OS_WIN32
479 static gint socket_fd_open_inet(gushort port)
481 SOCKET sock;
482 struct sockaddr_in addr;
483 gchar val;
485 sock = socket(AF_INET, SOCK_STREAM, 0);
486 if (G_UNLIKELY(! SOCKET_IS_VALID(sock)))
488 geany_debug("fd_open_inet(): socket() failed: %d\n", WSAGetLastError());
489 return -1;
492 val = 1;
493 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val)) < 0)
495 perror("setsockopt");
496 socket_fd_close(sock);
497 return -1;
500 memset(&addr, 0, sizeof(addr));
501 addr.sin_family = AF_INET;
502 addr.sin_port = htons(port);
503 addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
505 if (bind(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
507 perror("bind");
508 socket_fd_close(sock);
509 return -1;
512 if (listen(sock, 1) < 0)
514 perror("listen");
515 socket_fd_close(sock);
516 return -1;
519 return sock;
523 static gint socket_fd_connect_inet(gushort port)
525 SOCKET sock;
526 struct sockaddr_in addr;
528 sock = socket(AF_INET, SOCK_STREAM, 0);
529 if (G_UNLIKELY(! SOCKET_IS_VALID(sock)))
531 geany_debug("fd_connect_inet(): socket() failed: %d\n", WSAGetLastError());
532 return -1;
535 memset(&addr, 0, sizeof(addr));
536 addr.sin_family = AF_INET;
537 addr.sin_port = htons(port);
538 addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
540 if (connect(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
542 socket_fd_close(sock);
543 return -1;
546 return sock;
550 static void socket_init_win32(void)
552 WSADATA wsadata;
554 if (WSAStartup(MAKEWORD(2, 2), &wsadata) != NO_ERROR)
555 geany_debug("WSAStartup() failed\n");
557 return;
559 #endif
562 static void handle_input_filename(const gchar *buf)
564 gchar *utf8_filename, *locale_filename;
566 /* we never know how the input is encoded, so do the best auto detection we can */
567 if (! g_utf8_validate(buf, -1, NULL))
568 utf8_filename = encodings_convert_to_utf8(buf, -1, NULL);
569 else
570 utf8_filename = g_strdup(buf);
572 locale_filename = utils_get_locale_from_utf8(utf8_filename);
573 if (locale_filename)
575 if (g_str_has_suffix(locale_filename, ".geany"))
577 if (project_ask_close())
578 main_load_project_from_command_line(locale_filename, TRUE);
580 else
581 main_handle_filename(locale_filename);
583 g_free(utf8_filename);
584 g_free(locale_filename);
588 static gchar *build_document_list(void)
590 GString *doc_list = g_string_new(NULL);
591 guint i;
592 const gchar *filename;
594 foreach_document(i)
596 filename = DOC_FILENAME(documents[i]);
597 g_string_append(doc_list, filename);
598 g_string_append_c(doc_list, '\n');
600 return g_string_free(doc_list, FALSE);
604 gboolean socket_lock_input_cb(GIOChannel *source, GIOCondition condition, gpointer data)
606 gint fd, sock;
607 gchar buf[BUFFER_LENGTH];
608 struct sockaddr_in caddr;
609 socklen_t caddr_len = sizeof(caddr);
610 GtkWidget *window = data;
611 gboolean popup = FALSE;
613 fd = g_io_channel_unix_get_fd(source);
614 sock = accept(fd, (struct sockaddr *)&caddr, &caddr_len);
616 /* first get the command */
617 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1)
619 if (strncmp(buf, "open", 4) == 0)
621 cl_options.readonly = strncmp(buf+4, "ro", 2) == 0; /* open in readonly? */
622 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
624 gsize buf_len = strlen(buf);
626 /* remove trailing newline */
627 if (buf_len > 0 && buf[buf_len - 1] == '\n')
628 buf[buf_len - 1] = '\0';
630 handle_input_filename(buf);
632 popup = TRUE;
634 else if (strncmp(buf, "doclist", 7) == 0)
636 gchar *doc_list = build_document_list();
637 if (!EMPTY(doc_list))
638 socket_fd_write_all(sock, doc_list, strlen(doc_list));
639 /* send ETX (end-of-text) so reader knows to stop reading */
640 socket_fd_write_all(sock, "\3", 1);
641 g_free(doc_list);
643 else if (strncmp(buf, "line", 4) == 0)
645 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
647 g_strstrip(buf); /* remove \n char */
648 /* on any error we get 0 which should be safe enough as fallback */
649 cl_options.goto_line = atoi(buf);
652 else if (strncmp(buf, "column", 6) == 0)
654 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
656 g_strstrip(buf); /* remove \n char */
657 /* on any error we get 0 which should be safe enough as fallback */
658 cl_options.goto_column = atoi(buf);
661 #ifdef G_OS_WIN32
662 else if (strncmp(buf, "window", 6) == 0)
664 # if GTK_CHECK_VERSION(3, 0, 0)
665 HWND hwnd = (HWND) gdk_win32_window_get_handle(gtk_widget_get_window(window));
666 # else
667 HWND hwnd = (HWND) gdk_win32_drawable_get_handle(
668 GDK_DRAWABLE(gtk_widget_get_window(window)));
669 # endif
670 socket_fd_write(sock, (gchar *)&hwnd, sizeof(hwnd));
672 #endif
675 if (popup)
677 #ifdef GDK_WINDOWING_X11
678 GdkWindow *x11_window = gtk_widget_get_window(window);
680 /* Set the proper interaction time on the window. This seems necessary to make
681 * gtk_window_present() really bring the main window into the foreground on some
682 * window managers like Gnome's metacity.
683 * Code taken from Gedit. */
684 # if GTK_CHECK_VERSION(3, 0, 0)
685 if (GDK_IS_X11_WINDOW(x11_window))
686 # endif
688 gdk_x11_window_set_user_time(x11_window, gdk_x11_get_server_time(x11_window));
690 #endif
691 gtk_window_present(GTK_WINDOW(window));
692 #ifdef G_OS_WIN32
693 gdk_window_show(gtk_widget_get_window(window));
694 #endif
697 socket_fd_close(sock);
699 return TRUE;
703 static gint socket_fd_gets(gint fd, gchar *buf, gint len)
705 gchar *newline, *bp = buf;
706 gint n;
708 if (--len < 1)
709 return -1;
712 if ((n = socket_fd_recv(fd, bp, len, MSG_PEEK)) <= 0)
713 return -1;
714 if ((newline = memchr(bp, '\n', n)) != NULL)
715 n = newline - bp + 1;
716 if ((n = socket_fd_read(fd, bp, n)) < 0)
717 return -1;
718 bp += n;
719 len -= n;
720 } while (! newline && len);
722 *bp = '\0';
723 return bp - buf;
727 static gint socket_fd_recv(gint fd, gchar *buf, gint len, gint flags)
729 if (socket_fd_check_io(fd, G_IO_IN) < 0)
730 return -1;
732 return recv(fd, buf, len, flags);
736 static gint socket_fd_read(gint fd, gchar *buf, gint len)
738 if (socket_fd_check_io(fd, G_IO_IN) < 0)
739 return -1;
741 #ifdef G_OS_WIN32
742 return recv(fd, buf, len, 0);
743 #else
744 return read(fd, buf, len);
745 #endif
749 static gint socket_fd_check_io(gint fd, GIOCondition cond)
751 struct timeval timeout;
752 fd_set fds;
753 #ifdef G_OS_UNIX
754 gint flags;
755 #endif
757 timeout.tv_sec = 60;
758 timeout.tv_usec = 0;
760 #ifdef G_OS_UNIX
761 /* checking for non-blocking mode */
762 flags = fcntl(fd, F_GETFL, 0);
763 if (flags < 0)
765 perror("fcntl");
766 return 0;
768 if ((flags & O_NONBLOCK) != 0)
769 return 0;
770 #endif
772 FD_ZERO(&fds);
773 #ifdef G_OS_WIN32
774 FD_SET((SOCKET)fd, &fds);
775 #else
776 FD_SET(fd, &fds);
777 #endif
779 if (cond == G_IO_IN)
781 select(fd + 1, &fds, NULL, NULL, &timeout);
783 else
785 select(fd + 1, NULL, &fds, NULL, &timeout);
788 if (FD_ISSET(fd, &fds))
790 return 0;
792 else
794 geany_debug("Socket IO timeout");
795 return -1;
800 static gint socket_fd_write_all(gint fd, const gchar *buf, gint len)
802 gint n, wrlen = 0;
804 while (len)
806 n = socket_fd_write(fd, buf, len);
807 if (n <= 0)
808 return -1;
809 len -= n;
810 wrlen += n;
811 buf += n;
814 return wrlen;
818 gint socket_fd_write(gint fd, const gchar *buf, gint len)
820 if (socket_fd_check_io(fd, G_IO_OUT) < 0)
821 return -1;
823 #ifdef G_OS_WIN32
824 return send(fd, buf, len, 0);
825 #else
826 return write(fd, buf, len);
827 #endif
831 #endif