Make editor menu initially hidden
[geany-mirror.git] / src / socket.c
blob92432fc4b4e3081eda1ac9d8244b4f2cb29d9e80
1 /*
2 * socket.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2011 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
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 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.
55 #include "geany.h"
57 #ifdef HAVE_SOCKET
59 #ifndef G_OS_WIN32
60 # include <sys/time.h>
61 # include <sys/types.h>
62 # include <sys/socket.h>
63 # include <sys/un.h>
64 # include <netinet/in.h>
65 # include <glib/gstdio.h>
66 #else
67 # include <gdk/gdkwin32.h>
68 # include <windows.h>
69 # include <winsock2.h>
70 # include <ws2tcpip.h>
71 #endif
72 #include <string.h>
73 #include <stdlib.h>
74 #include <unistd.h>
75 #include <fcntl.h>
77 #ifdef GDK_WINDOWING_X11
78 #include <gdk/gdkx.h>
79 #endif
81 #include "main.h"
82 #include "socket.h"
83 #include "document.h"
84 #include "support.h"
85 #include "ui_utils.h"
86 #include "utils.h"
87 #include "dialogs.h"
88 #include "encodings.h"
92 #ifdef G_OS_WIN32
93 #define REMOTE_CMD_PORT 49876
94 #define SOCKET_IS_VALID(s) ((s) != INVALID_SOCKET)
95 #else
96 #define SOCKET_IS_VALID(s) ((s) >= 0)
97 #define INVALID_SOCKET (-1)
98 #endif
99 #define BUFFER_LENGTH 4096
101 struct socket_info_struct socket_info;
104 #ifdef G_OS_WIN32
105 static gint socket_fd_connect_inet (gushort port);
106 static gint socket_fd_open_inet (gushort port);
107 static void socket_init_win32 (void);
108 #else
109 static gint socket_fd_connect_unix (const gchar *path);
110 static gint socket_fd_open_unix (const gchar *path);
111 #endif
113 static gint socket_fd_write (gint sock, const gchar *buf, gint len);
114 static gint socket_fd_write_all (gint sock, const gchar *buf, gint len);
115 static gint socket_fd_gets (gint sock, gchar *buf, gint len);
116 static gint socket_fd_check_io (gint fd, GIOCondition cond);
117 static gint socket_fd_read (gint sock, gchar *buf, gint len);
118 static gint socket_fd_recv (gint fd, gchar *buf, gint len, gint flags);
119 static gint socket_fd_close (gint sock);
123 static void send_open_command(gint sock, gint argc, gchar **argv)
125 gint i;
126 gchar *filename;
128 g_return_if_fail(argc > 1);
129 geany_debug("using running instance of Geany");
131 if (cl_options.goto_line >= 0)
133 gchar *line = g_strdup_printf("%d\n", cl_options.goto_line);
134 socket_fd_write_all(sock, "line\n", 5);
135 socket_fd_write_all(sock, line, strlen(line));
136 socket_fd_write_all(sock, ".\n", 2);
137 g_free(line);
140 if (cl_options.goto_column >= 0)
142 gchar *col = g_strdup_printf("%d\n", cl_options.goto_column);
143 socket_fd_write_all(sock, "column\n", 7);
144 socket_fd_write_all(sock, col, strlen(col));
145 socket_fd_write_all(sock, ".\n", 2);
146 g_free(col);
149 if (cl_options.readonly) /* append "ro" to denote readonly status for new docs */
150 socket_fd_write_all(sock, "openro\n", 7);
151 else
152 socket_fd_write_all(sock, "open\n", 5);
154 for (i = 1; i < argc && argv[i] != NULL; i++)
156 filename = main_get_argv_filename(argv[i]);
158 /* if the filename is valid or if a new file should be opened is check on the other side */
159 if (filename != NULL)
161 socket_fd_write_all(sock, filename, strlen(filename));
162 socket_fd_write_all(sock, "\n", 1);
164 else
166 g_printerr(_("Could not find file '%s'."), filename);
167 g_printerr("\n"); /* keep translation from open_cl_files() in main.c. */
169 g_free(filename);
171 socket_fd_write_all(sock, ".\n", 2);
175 #ifndef G_OS_WIN32
176 static void remove_socket_link_full(void)
178 gchar real_path[512];
179 gsize len;
181 real_path[0] = '\0';
183 /* read the contents of the symbolic link socket_info.file_name and delete it
184 * readlink should return something like "/tmp/geany_socket.499602d2" */
185 len = readlink(socket_info.file_name, real_path, sizeof(real_path) - 1);
186 if ((gint) len > 0)
188 real_path[len] = '\0';
189 g_unlink(real_path);
191 g_unlink(socket_info.file_name);
193 #endif
196 static void socket_get_document_list(gint sock)
198 gchar doc_list[BUFFER_LENGTH];
199 gint doc_list_len;
201 if (sock < 0)
202 return;
204 socket_fd_write_all(sock, "doclist\n", 8);
206 doc_list_len = socket_fd_read(sock, doc_list, sizeof(doc_list));
207 if (doc_list_len >= BUFFER_LENGTH)
208 doc_list_len = BUFFER_LENGTH -1;
209 doc_list[doc_list_len] = '\0';
210 /* if we received ETX (end-of-text), there were no open files, so print only otherwise */
211 if (! utils_str_equal(doc_list, "\3"))
212 printf("%s", doc_list);
216 #ifndef G_OS_WIN32
217 static void check_socket_permissions(void)
219 struct stat socket_stat;
221 if (g_lstat(socket_info.file_name, &socket_stat) == 0)
222 { /* If the user id of the process is not the same as the owner of the socket
223 * file, then ignore this socket and start a new session. */
224 if (socket_stat.st_uid != getuid())
226 const gchar *msg = _(
227 /* TODO maybe this message needs a rewording */
228 "Geany tried to access the Unix Domain socket of another instance running as another user.\n"
229 "This is a fatal error and Geany will now quit.");
230 g_warning("%s", msg);
231 dialogs_show_msgbox(GTK_MESSAGE_ERROR, "%s", msg);
232 exit(1);
236 #endif
239 /* (Unix domain) socket support to replace the old FIFO code
240 * (taken from Sylpheed, thanks)
241 * Returns the created socket, -1 if an error occurred or -2 if another socket exists and files
242 * were sent to it. */
243 gint socket_init(gint argc, gchar **argv)
245 gint sock;
246 #ifdef G_OS_WIN32
247 HANDLE hmutex;
248 HWND hwnd;
249 socket_init_win32();
250 hmutex = CreateMutexA(NULL, FALSE, "Geany");
251 if (! hmutex)
253 geany_debug("cannot create Mutex\n");
254 return -1;
256 if (GetLastError() != ERROR_ALREADY_EXISTS)
258 /* To support multiple instances with different configuration directories (as we do on
259 * non-Windows systems) we would need to use different port number s but it might be
260 * difficult to get a port number which is unique for a configuration directory (path)
261 * and which is unused. This port number has to be guessed by the first and new instance
262 * and the only data is the configuration directory path.
263 * For now we use one port number, that is we support only one instance at all. */
264 sock = socket_fd_open_inet(REMOTE_CMD_PORT);
265 if (sock < 0)
266 return 0;
267 return sock;
270 sock = socket_fd_connect_inet(REMOTE_CMD_PORT);
271 if (sock < 0)
272 return -1;
273 #else
274 gchar *display_name = gdk_get_display();
275 gchar *hostname = utils_get_hostname();
276 gchar *p;
278 if (display_name == NULL)
279 display_name = g_strdup("NODISPLAY");
281 /* these lines are taken from dcopc.c in kdelibs */
282 if ((p = strrchr(display_name, '.')) > strrchr(display_name, ':') && p != NULL)
283 *p = '\0';
284 while ((p = strchr(display_name, ':')) != NULL)
285 *p = '_';
287 if (socket_info.file_name == NULL)
288 socket_info.file_name = g_strdup_printf("%s%cgeany_socket_%s_%s",
289 app->configdir, G_DIR_SEPARATOR, hostname, display_name);
291 g_free(display_name);
292 g_free(hostname);
294 /* check whether the real user id is the same as this of the socket file */
295 check_socket_permissions();
297 sock = socket_fd_connect_unix(socket_info.file_name);
298 if (sock < 0)
300 remove_socket_link_full(); /* deletes the socket file and the symlink */
301 return socket_fd_open_unix(socket_info.file_name);
303 #endif
305 /* remote command mode, here we have another running instance and want to use it */
307 #ifdef G_OS_WIN32
308 /* first we send a request to retrieve the window handle and focus the window */
309 socket_fd_write_all(sock, "window\n", 7);
310 if (socket_fd_read(sock, (gchar *)&hwnd, sizeof(hwnd)) == sizeof(hwnd))
311 SetForegroundWindow(hwnd);
312 #endif
313 /* now we send the command line args */
314 if (argc > 1)
316 send_open_command(sock, argc, argv);
319 if (cl_options.list_documents)
321 socket_get_document_list(sock);
324 socket_fd_close(sock);
325 return -2;
329 gint socket_finalize(void)
331 if (socket_info.lock_socket < 0)
332 return -1;
334 if (socket_info.lock_socket_tag > 0)
335 g_source_remove(socket_info.lock_socket_tag);
336 if (socket_info.read_ioc)
338 g_io_channel_shutdown(socket_info.read_ioc, FALSE, NULL);
339 g_io_channel_unref(socket_info.read_ioc);
340 socket_info.read_ioc = NULL;
343 #ifdef G_OS_WIN32
344 WSACleanup();
345 #else
346 if (socket_info.file_name != NULL)
348 remove_socket_link_full(); /* deletes the socket file and the symlink */
349 g_free(socket_info.file_name);
351 #endif
353 return 0;
357 #ifdef G_OS_UNIX
358 static gint socket_fd_connect_unix(const gchar *path)
360 gint sock;
361 struct sockaddr_un addr;
363 sock = socket(PF_UNIX, SOCK_STREAM, 0);
364 if (sock < 0)
366 perror("fd_connect_unix(): socket");
367 return -1;
370 memset(&addr, 0, sizeof(addr));
371 addr.sun_family = AF_UNIX;
372 strncpy(addr.sun_path, path, sizeof(addr.sun_path) - 1);
374 if (connect(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
376 socket_fd_close(sock);
377 return -1;
380 return sock;
384 static gint socket_fd_open_unix(const gchar *path)
386 gint sock;
387 struct sockaddr_un addr;
388 gint val;
389 gchar *real_path;
391 sock = socket(PF_UNIX, SOCK_STREAM, 0);
393 if (sock < 0)
395 perror("sock_open_unix(): socket");
396 return -1;
399 val = 1;
400 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val)) < 0)
402 perror("setsockopt");
403 socket_fd_close(sock);
404 return -1;
407 /* fix for #1888561:
408 * in case the configuration directory is located on a network file system or any other
409 * file system which doesn't support sockets, we just link the socket there and create the
410 * real socket in the system's tmp directory assuming it supports sockets */
411 real_path = g_strdup_printf("%s%cgeany_socket.%08x",
412 g_get_tmp_dir(), G_DIR_SEPARATOR, g_random_int());
414 if (utils_is_file_writable(real_path) != 0)
415 { /* if real_path is not writable for us, fall back to ~/.config/geany/geany_socket_*_* */
416 /* instead of creating a symlink and print a warning */
417 g_warning("Socket %s could not be written, using %s as fallback.", real_path, path);
418 setptr(real_path, g_strdup(path));
420 /* create a symlink in e.g. ~/.config/geany/geany_socket_hostname__0 to /tmp/geany_socket.499602d2 */
421 else if (symlink(real_path, path) != 0)
423 perror("symlink");
424 socket_fd_close(sock);
425 return -1;
428 memset(&addr, 0, sizeof(addr));
429 addr.sun_family = AF_UNIX;
430 strncpy(addr.sun_path, real_path, sizeof(addr.sun_path) - 1);
432 if (bind(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
434 perror("bind");
435 socket_fd_close(sock);
436 return -1;
439 if (listen(sock, 1) < 0)
441 perror("listen");
442 socket_fd_close(sock);
443 return -1;
446 g_chmod(real_path, 0600);
448 g_free(real_path);
450 return sock;
452 #endif
454 static gint socket_fd_close(gint fd)
456 #ifdef G_OS_WIN32
457 return closesocket(fd);
458 #else
459 return close(fd);
460 #endif
464 #ifdef G_OS_WIN32
465 static gint socket_fd_open_inet(gushort port)
467 SOCKET sock;
468 struct sockaddr_in addr;
469 gchar val;
471 sock = socket(AF_INET, SOCK_STREAM, 0);
472 if (G_UNLIKELY(! SOCKET_IS_VALID(sock)))
474 geany_debug("fd_open_inet(): socket() failed: %d\n", WSAGetLastError());
475 return -1;
478 val = 1;
479 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val)) < 0)
481 perror("setsockopt");
482 socket_fd_close(sock);
483 return -1;
486 memset(&addr, 0, sizeof(addr));
487 addr.sin_family = AF_INET;
488 addr.sin_port = htons(port);
489 addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
491 if (bind(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
493 perror("bind");
494 socket_fd_close(sock);
495 return -1;
498 if (listen(sock, 1) < 0)
500 perror("listen");
501 socket_fd_close(sock);
502 return -1;
505 return sock;
509 static gint socket_fd_connect_inet(gushort port)
511 SOCKET sock;
512 struct sockaddr_in addr;
514 sock = socket(AF_INET, SOCK_STREAM, 0);
515 if (G_UNLIKELY(! SOCKET_IS_VALID(sock)))
517 geany_debug("fd_connect_inet(): socket() failed: %d\n", WSAGetLastError());
518 return -1;
521 memset(&addr, 0, sizeof(addr));
522 addr.sin_family = AF_INET;
523 addr.sin_port = htons(port);
524 addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
526 if (connect(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
528 socket_fd_close(sock);
529 return -1;
532 return sock;
536 static void socket_init_win32(void)
538 WSADATA wsadata;
540 if (WSAStartup(MAKEWORD(2, 2), &wsadata) != NO_ERROR)
541 geany_debug("WSAStartup() failed\n");
543 return;
545 #endif
548 static void handle_input_filename(const gchar *buf)
550 gchar *utf8_filename, *locale_filename;
552 /* we never know how the input is encoded, so do the best auto detection we can */
553 if (! g_utf8_validate(buf, -1, NULL))
554 utf8_filename = encodings_convert_to_utf8(buf, (gsize) -1, NULL);
555 else
556 utf8_filename = g_strdup(buf);
558 locale_filename = utils_get_locale_from_utf8(utf8_filename);
559 if (locale_filename)
561 if (g_str_has_suffix(locale_filename, ".geany"))
562 main_load_project_from_command_line(locale_filename, TRUE);
563 else
564 main_handle_filename(locale_filename);
566 g_free(utf8_filename);
567 g_free(locale_filename);
571 static gchar *build_document_list(void)
573 GString *doc_list = g_string_new(NULL);
574 guint i;
575 const gchar *filename;
577 foreach_document(i)
579 filename = DOC_FILENAME(documents[i]);
580 g_string_append(doc_list, filename);
581 g_string_append_c(doc_list, '\n');
583 return g_string_free(doc_list, FALSE);
587 gboolean socket_lock_input_cb(GIOChannel *source, GIOCondition condition, gpointer data)
589 gint fd, sock;
590 gchar buf[BUFFER_LENGTH];
591 struct sockaddr_in caddr;
592 socklen_t caddr_len = sizeof(caddr);
593 GtkWidget *window = data;
594 gboolean popup = FALSE;
596 fd = g_io_channel_unix_get_fd(source);
597 sock = accept(fd, (struct sockaddr *)&caddr, &caddr_len);
599 /* first get the command */
600 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1)
602 if (strncmp(buf, "open", 4) == 0)
604 cl_options.readonly = strncmp(buf+4, "ro", 2) == 0; /* open in readonly? */
605 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
607 handle_input_filename(g_strstrip(buf));
609 popup = TRUE;
611 else if (strncmp(buf, "doclist", 7) == 0)
613 gchar *doc_list = build_document_list();
614 if (NZV(doc_list))
615 socket_fd_write_all(sock, doc_list, strlen(doc_list));
616 else
617 /* send ETX (end-of-text) in case we have no open files, we must send anything
618 * otherwise the client would hang on reading */
619 socket_fd_write_all(sock, "\3", 1);
620 g_free(doc_list);
622 else if (strncmp(buf, "line", 4) == 0)
624 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
626 g_strstrip(buf); /* remove \n char */
627 /* on any error we get 0 which should be safe enough as fallback */
628 cl_options.goto_line = atoi(buf);
631 else if (strncmp(buf, "column", 6) == 0)
633 while (socket_fd_gets(sock, buf, sizeof(buf)) != -1 && *buf != '.')
635 g_strstrip(buf); /* remove \n char */
636 /* on any error we get 0 which should be safe enough as fallback */
637 cl_options.goto_column = atoi(buf);
640 #ifdef G_OS_WIN32
641 else if (strncmp(buf, "window", 6) == 0)
643 HWND hwnd = (HWND) gdk_win32_drawable_get_handle(
644 GDK_DRAWABLE(gtk_widget_get_window(window)));
645 socket_fd_write(sock, (gchar *)&hwnd, sizeof(hwnd));
647 #endif
650 if (popup)
652 #ifdef GDK_WINDOWING_X11
653 /* Set the proper interaction time on the window. This seems necessary to make
654 * gtk_window_present() really bring the main window into the foreground on some
655 * window managers like Gnome's metacity.
656 * Code taken from Gedit. */
657 gdk_x11_window_set_user_time(gtk_widget_get_window(window),
658 gdk_x11_get_server_time(gtk_widget_get_window(window)));
659 #endif
660 gtk_window_present(GTK_WINDOW(window));
661 #ifdef G_OS_WIN32
662 gdk_window_show(gtk_widget_get_window(window));
663 #endif
666 socket_fd_close(sock);
668 return TRUE;
672 static gint socket_fd_gets(gint fd, gchar *buf, gint len)
674 gchar *newline, *bp = buf;
675 gint n;
677 if (--len < 1)
678 return -1;
681 if ((n = socket_fd_recv(fd, bp, len, MSG_PEEK)) <= 0)
682 return -1;
683 if ((newline = memchr(bp, '\n', n)) != NULL)
684 n = newline - bp + 1;
685 if ((n = socket_fd_read(fd, bp, n)) < 0)
686 return -1;
687 bp += n;
688 len -= n;
689 } while (! newline && len);
691 *bp = '\0';
692 return bp - buf;
696 static gint socket_fd_recv(gint fd, gchar *buf, gint len, gint flags)
698 if (socket_fd_check_io(fd, G_IO_IN) < 0)
699 return -1;
701 return recv(fd, buf, len, flags);
705 static gint socket_fd_read(gint fd, gchar *buf, gint len)
707 if (socket_fd_check_io(fd, G_IO_IN) < 0)
708 return -1;
710 #ifdef G_OS_WIN32
711 return recv(fd, buf, len, 0);
712 #else
713 return read(fd, buf, len);
714 #endif
718 static gint socket_fd_check_io(gint fd, GIOCondition cond)
720 struct timeval timeout;
721 fd_set fds;
722 #ifdef G_OS_UNIX
723 gint flags;
724 #endif
726 timeout.tv_sec = 60;
727 timeout.tv_usec = 0;
729 #ifdef G_OS_UNIX
730 /* checking for non-blocking mode */
731 flags = fcntl(fd, F_GETFL, 0);
732 if (flags < 0)
734 perror("fcntl");
735 return 0;
737 if ((flags & O_NONBLOCK) != 0)
738 return 0;
739 #endif
741 FD_ZERO(&fds);
742 FD_SET(fd, &fds);
744 if (cond == G_IO_IN)
746 select(fd + 1, &fds, NULL, NULL, &timeout);
748 else
750 select(fd + 1, NULL, &fds, NULL, &timeout);
753 if (FD_ISSET(fd, &fds))
755 return 0;
757 else
759 geany_debug("Socket IO timeout");
760 return -1;
765 static gint socket_fd_write_all(gint fd, const gchar *buf, gint len)
767 gint n, wrlen = 0;
769 while (len)
771 n = socket_fd_write(fd, buf, len);
772 if (n <= 0)
773 return -1;
774 len -= n;
775 wrlen += n;
776 buf += n;
779 return wrlen;
783 gint socket_fd_write(gint fd, const gchar *buf, gint len)
785 if (socket_fd_check_io(fd, G_IO_OUT) < 0)
786 return -1;
788 #ifdef G_OS_WIN32
789 return send(fd, buf, len, 0);
790 #else
791 return write(fd, buf, len);
792 #endif
796 #endif