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.
31 * Each command which is sent between two instances (see send_open_command and
32 * socket_lock_input_cb) should have the following scheme:
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.
60 # include <sys/time.h>
61 # include <sys/types.h>
62 # include <sys/socket.h>
64 # include <netinet/in.h>
65 # include <glib/gstdio.h>
67 # include <gdk/gdkwin32.h>
69 # include <winsock2.h>
70 # include <ws2tcpip.h>
77 #ifdef GDK_WINDOWING_X11
88 #include "encodings.h"
93 #define REMOTE_CMD_PORT 49876
94 #define SOCKET_IS_VALID(s) ((s) != INVALID_SOCKET)
96 #define SOCKET_IS_VALID(s) ((s) >= 0)
97 #define INVALID_SOCKET (-1)
99 #define BUFFER_LENGTH 4096
101 struct socket_info_struct socket_info
;
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);
109 static gint
socket_fd_connect_unix (const gchar
*path
);
110 static gint
socket_fd_open_unix (const gchar
*path
);
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
)
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);
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);
149 if (cl_options
.readonly
) /* append "ro" to denote readonly status for new docs */
150 socket_fd_write_all(sock
, "openro\n", 7);
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);
166 g_printerr(_("Could not find file '%s'."), filename
);
167 g_printerr("\n"); /* keep translation from open_cl_files() in main.c. */
171 socket_fd_write_all(sock
, ".\n", 2);
176 static void remove_socket_link_full(void)
178 gchar real_path
[512];
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);
188 real_path
[len
] = '\0';
191 g_unlink(socket_info
.file_name
);
196 static void socket_get_document_list(gint sock
)
198 gchar doc_list
[BUFFER_LENGTH
];
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
);
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
);
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
)
250 hmutex
= CreateMutexA(NULL
, FALSE
, "Geany");
253 geany_debug("cannot create Mutex\n");
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
);
270 sock
= socket_fd_connect_inet(REMOTE_CMD_PORT
);
274 gchar
*display_name
= gdk_get_display();
275 gchar
*hostname
= utils_get_hostname();
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
)
284 /* remove characters that may not be acceptable in a filename */
285 for (p
= display_name
; *p
; p
++)
287 if (*p
== ':' || *p
== '/')
291 if (socket_info
.file_name
== NULL
)
292 socket_info
.file_name
= g_strdup_printf("%s%cgeany_socket_%s_%s",
293 app
->configdir
, G_DIR_SEPARATOR
, hostname
, display_name
);
295 g_free(display_name
);
298 /* check whether the real user id is the same as this of the socket file */
299 check_socket_permissions();
301 sock
= socket_fd_connect_unix(socket_info
.file_name
);
304 remove_socket_link_full(); /* deletes the socket file and the symlink */
305 return socket_fd_open_unix(socket_info
.file_name
);
309 /* remote command mode, here we have another running instance and want to use it */
312 /* first we send a request to retrieve the window handle and focus the window */
313 socket_fd_write_all(sock
, "window\n", 7);
314 if (socket_fd_read(sock
, (gchar
*)&hwnd
, sizeof(hwnd
)) == sizeof(hwnd
))
315 SetForegroundWindow(hwnd
);
317 /* now we send the command line args */
320 send_open_command(sock
, argc
, argv
);
323 if (cl_options
.list_documents
)
325 socket_get_document_list(sock
);
328 socket_fd_close(sock
);
333 gint
socket_finalize(void)
335 if (socket_info
.lock_socket
< 0)
338 if (socket_info
.lock_socket_tag
> 0)
339 g_source_remove(socket_info
.lock_socket_tag
);
340 if (socket_info
.read_ioc
)
342 g_io_channel_shutdown(socket_info
.read_ioc
, FALSE
, NULL
);
343 g_io_channel_unref(socket_info
.read_ioc
);
344 socket_info
.read_ioc
= NULL
;
350 if (socket_info
.file_name
!= NULL
)
352 remove_socket_link_full(); /* deletes the socket file and the symlink */
353 g_free(socket_info
.file_name
);
362 static gint
socket_fd_connect_unix(const gchar
*path
)
365 struct sockaddr_un addr
;
367 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
370 perror("fd_connect_unix(): socket");
374 memset(&addr
, 0, sizeof(addr
));
375 addr
.sun_family
= AF_UNIX
;
376 strncpy(addr
.sun_path
, path
, sizeof(addr
.sun_path
) - 1);
378 if (connect(sock
, (struct sockaddr
*)&addr
, sizeof(addr
)) < 0)
380 socket_fd_close(sock
);
388 static gint
socket_fd_open_unix(const gchar
*path
)
391 struct sockaddr_un addr
;
395 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
399 perror("sock_open_unix(): socket");
404 if (setsockopt(sock
, SOL_SOCKET
, SO_REUSEADDR
, &val
, sizeof(val
)) < 0)
406 perror("setsockopt");
407 socket_fd_close(sock
);
412 * in case the configuration directory is located on a network file system or any other
413 * file system which doesn't support sockets, we just link the socket there and create the
414 * real socket in the system's tmp directory assuming it supports sockets */
415 real_path
= g_strdup_printf("%s%cgeany_socket.%08x",
416 g_get_tmp_dir(), G_DIR_SEPARATOR
, g_random_int());
418 if (utils_is_file_writable(real_path
) != 0)
419 { /* if real_path is not writable for us, fall back to ~/.config/geany/geany_socket_*_* */
420 /* instead of creating a symlink and print a warning */
421 g_warning("Socket %s could not be written, using %s as fallback.", real_path
, path
);
422 SETPTR(real_path
, g_strdup(path
));
424 /* create a symlink in e.g. ~/.config/geany/geany_socket_hostname__0 to /tmp/geany_socket.499602d2 */
425 else if (symlink(real_path
, path
) != 0)
428 socket_fd_close(sock
);
432 memset(&addr
, 0, sizeof(addr
));
433 addr
.sun_family
= AF_UNIX
;
434 strncpy(addr
.sun_path
, real_path
, sizeof(addr
.sun_path
) - 1);
436 if (bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
)) < 0)
439 socket_fd_close(sock
);
443 if (listen(sock
, 1) < 0)
446 socket_fd_close(sock
);
450 g_chmod(real_path
, 0600);
458 static gint
socket_fd_close(gint fd
)
461 return closesocket(fd
);
469 static gint
socket_fd_open_inet(gushort port
)
472 struct sockaddr_in addr
;
475 sock
= socket(AF_INET
, SOCK_STREAM
, 0);
476 if (G_UNLIKELY(! SOCKET_IS_VALID(sock
)))
478 geany_debug("fd_open_inet(): socket() failed: %d\n", WSAGetLastError());
483 if (setsockopt(sock
, SOL_SOCKET
, SO_REUSEADDR
, &val
, sizeof(val
)) < 0)
485 perror("setsockopt");
486 socket_fd_close(sock
);
490 memset(&addr
, 0, sizeof(addr
));
491 addr
.sin_family
= AF_INET
;
492 addr
.sin_port
= htons(port
);
493 addr
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
495 if (bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
)) < 0)
498 socket_fd_close(sock
);
502 if (listen(sock
, 1) < 0)
505 socket_fd_close(sock
);
513 static gint
socket_fd_connect_inet(gushort port
)
516 struct sockaddr_in addr
;
518 sock
= socket(AF_INET
, SOCK_STREAM
, 0);
519 if (G_UNLIKELY(! SOCKET_IS_VALID(sock
)))
521 geany_debug("fd_connect_inet(): socket() failed: %d\n", WSAGetLastError());
525 memset(&addr
, 0, sizeof(addr
));
526 addr
.sin_family
= AF_INET
;
527 addr
.sin_port
= htons(port
);
528 addr
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
530 if (connect(sock
, (struct sockaddr
*)&addr
, sizeof(addr
)) < 0)
532 socket_fd_close(sock
);
540 static void socket_init_win32(void)
544 if (WSAStartup(MAKEWORD(2, 2), &wsadata
) != NO_ERROR
)
545 geany_debug("WSAStartup() failed\n");
552 static void handle_input_filename(const gchar
*buf
)
554 gchar
*utf8_filename
, *locale_filename
;
556 /* we never know how the input is encoded, so do the best auto detection we can */
557 if (! g_utf8_validate(buf
, -1, NULL
))
558 utf8_filename
= encodings_convert_to_utf8(buf
, -1, NULL
);
560 utf8_filename
= g_strdup(buf
);
562 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
565 if (g_str_has_suffix(locale_filename
, ".geany"))
567 if (project_ask_close())
568 main_load_project_from_command_line(locale_filename
, TRUE
);
571 main_handle_filename(locale_filename
);
573 g_free(utf8_filename
);
574 g_free(locale_filename
);
578 static gchar
*build_document_list(void)
580 GString
*doc_list
= g_string_new(NULL
);
582 const gchar
*filename
;
586 filename
= DOC_FILENAME(documents
[i
]);
587 g_string_append(doc_list
, filename
);
588 g_string_append_c(doc_list
, '\n');
590 return g_string_free(doc_list
, FALSE
);
594 gboolean
socket_lock_input_cb(GIOChannel
*source
, GIOCondition condition
, gpointer data
)
597 gchar buf
[BUFFER_LENGTH
];
598 struct sockaddr_in caddr
;
599 socklen_t caddr_len
= sizeof(caddr
);
600 GtkWidget
*window
= data
;
601 gboolean popup
= FALSE
;
603 fd
= g_io_channel_unix_get_fd(source
);
604 sock
= accept(fd
, (struct sockaddr
*)&caddr
, &caddr_len
);
606 /* first get the command */
607 while (socket_fd_gets(sock
, buf
, sizeof(buf
)) != -1)
609 if (strncmp(buf
, "open", 4) == 0)
611 cl_options
.readonly
= strncmp(buf
+4, "ro", 2) == 0; /* open in readonly? */
612 while (socket_fd_gets(sock
, buf
, sizeof(buf
)) != -1 && *buf
!= '.')
614 gsize buf_len
= strlen(buf
);
616 /* remove trailing newline */
617 if (buf_len
> 0 && buf
[buf_len
- 1] == '\n')
618 buf
[buf_len
- 1] = '\0';
620 handle_input_filename(buf
);
624 else if (strncmp(buf
, "doclist", 7) == 0)
626 gchar
*doc_list
= build_document_list();
628 socket_fd_write_all(sock
, doc_list
, strlen(doc_list
));
630 /* send ETX (end-of-text) in case we have no open files, we must send anything
631 * otherwise the client would hang on reading */
632 socket_fd_write_all(sock
, "\3", 1);
635 else if (strncmp(buf
, "line", 4) == 0)
637 while (socket_fd_gets(sock
, buf
, sizeof(buf
)) != -1 && *buf
!= '.')
639 g_strstrip(buf
); /* remove \n char */
640 /* on any error we get 0 which should be safe enough as fallback */
641 cl_options
.goto_line
= atoi(buf
);
644 else if (strncmp(buf
, "column", 6) == 0)
646 while (socket_fd_gets(sock
, buf
, sizeof(buf
)) != -1 && *buf
!= '.')
648 g_strstrip(buf
); /* remove \n char */
649 /* on any error we get 0 which should be safe enough as fallback */
650 cl_options
.goto_column
= atoi(buf
);
654 else if (strncmp(buf
, "window", 6) == 0)
656 HWND hwnd
= (HWND
) gdk_win32_drawable_get_handle(
657 GDK_DRAWABLE(gtk_widget_get_window(window
)));
658 socket_fd_write(sock
, (gchar
*)&hwnd
, sizeof(hwnd
));
665 #ifdef GDK_WINDOWING_X11
666 /* Set the proper interaction time on the window. This seems necessary to make
667 * gtk_window_present() really bring the main window into the foreground on some
668 * window managers like Gnome's metacity.
669 * Code taken from Gedit. */
670 gdk_x11_window_set_user_time(gtk_widget_get_window(window
),
671 gdk_x11_get_server_time(gtk_widget_get_window(window
)));
673 gtk_window_present(GTK_WINDOW(window
));
675 gdk_window_show(gtk_widget_get_window(window
));
679 socket_fd_close(sock
);
685 static gint
socket_fd_gets(gint fd
, gchar
*buf
, gint len
)
687 gchar
*newline
, *bp
= buf
;
694 if ((n
= socket_fd_recv(fd
, bp
, len
, MSG_PEEK
)) <= 0)
696 if ((newline
= memchr(bp
, '\n', n
)) != NULL
)
697 n
= newline
- bp
+ 1;
698 if ((n
= socket_fd_read(fd
, bp
, n
)) < 0)
702 } while (! newline
&& len
);
709 static gint
socket_fd_recv(gint fd
, gchar
*buf
, gint len
, gint flags
)
711 if (socket_fd_check_io(fd
, G_IO_IN
) < 0)
714 return recv(fd
, buf
, len
, flags
);
718 static gint
socket_fd_read(gint fd
, gchar
*buf
, gint len
)
720 if (socket_fd_check_io(fd
, G_IO_IN
) < 0)
724 return recv(fd
, buf
, len
, 0);
726 return read(fd
, buf
, len
);
731 static gint
socket_fd_check_io(gint fd
, GIOCondition cond
)
733 struct timeval timeout
;
743 /* checking for non-blocking mode */
744 flags
= fcntl(fd
, F_GETFL
, 0);
750 if ((flags
& O_NONBLOCK
) != 0)
759 select(fd
+ 1, &fds
, NULL
, NULL
, &timeout
);
763 select(fd
+ 1, NULL
, &fds
, NULL
, &timeout
);
766 if (FD_ISSET(fd
, &fds
))
772 geany_debug("Socket IO timeout");
778 static gint
socket_fd_write_all(gint fd
, const gchar
*buf
, gint len
)
784 n
= socket_fd_write(fd
, buf
, len
);
796 gint
socket_fd_write(gint fd
, const gchar
*buf
, gint len
)
798 if (socket_fd_check_io(fd
, G_IO_OUT
) < 0)
802 return send(fd
, buf
, len
, 0);
804 return write(fd
, buf
, len
);