server/client: use $WAYLAND_DISPLAY instead of $XDG_SESSION_ID in default socket path

Foot is a Wayland client and cannot be run outside of a Wayland
session. As such, it makes more sense to use $WAYLAND_SESSION instead
of $XDG_SESSION_ID in the default socket path since this makes it
clearer which Wayland session we belong to.

Closes #55.
This commit is contained in:
Daniel Eklöf 2020-08-02 13:10:31 +02:00
parent 387e8de751
commit 5e26d3ef47
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
7 changed files with 26 additions and 17 deletions

View file

@ -40,6 +40,8 @@
* Configuration errors are no longer fatal; foot will start and print
an error inside the terminal (and of course still log errors on
stderr).
* Default `--server` socket path to use `$WAYLAND_DISPLAY` instead of
`$XDG_SESSION_ID` (https://codeberg.org/dnkl/foot/issues/55).
### Fixed

View file

@ -38,7 +38,7 @@ print_usage(const char *prog_name)
" --maximized start in maximized mode\n"
" --fullscreen start in fullscreen mode\n"
" --login-shell start shell as a login shell\n"
" -s,--server-socket=PATH path to the server UNIX domain socket (default=$XDG_RUNTIME_DIR/foot-$XDG_SESSION_ID.sock)\n"
" -s,--server-socket=PATH path to the server UNIX domain socket (default=$XDG_RUNTIME_DIR/foot-$WAYLAND_DISPLAY.sock)\n"
" --hold remain open after child process exits\n"
" -l,--log-colorize=[never|always|auto] enable/disable colorization of log output on stderr\n"
" -v,--version show the version number and quit\n");
@ -172,13 +172,16 @@ main(int argc, char *const *argv)
} else {
bool connected = false;
const char *xdg_session_id = getenv("XDG_SESSION_ID");
const char *xdg_runtime = getenv("XDG_RUNTIME_DIR");
if (xdg_runtime != NULL) {
if (xdg_session_id == NULL)
xdg_session_id = "no-session";
const char *wayland_display = getenv("WAYLAND_DISPLAY");
if (wayland_display != NULL)
snprintf(addr.sun_path, sizeof(addr.sun_path),
"%s/foot-%s.sock", xdg_runtime, wayland_display);
else
snprintf(addr.sun_path, sizeof(addr.sun_path),
"%s/foot.sock", xdg_runtime);
snprintf(addr.sun_path, sizeof(addr.sun_path), "%s/foot-%s.sock", xdg_runtime, xdg_session_id);
if (connect(fd, (const struct sockaddr *)&addr, sizeof(addr)) == 0)
connected = true;
else

View file

@ -8,7 +8,7 @@ _arguments \
'--maximized[start in maximized mode]' \
'--fullscreen[start in fullscreen mode]' \
'--login-shell[start shell as a login shell]' \
'(-s --server-socket)'{-s,--server-socket}'[override the default path to the foot server socket (XDG_RUNTIME_DIR/foot.sock)]:server:_files' \
'(-s --server-socket)'{-s,--server-socket}'[override the default path to the foot server socket ($XDG_RUNTIME_DIR/foot-$WAYLAND_DISPLAY.sock)]:server:_files' \
'--hold[remain open after child process exits]' \
'(-l --log-colorize)'{-l,--log-colorize}'[enable or disable colorization of log output on stderr]:logcolor:(never always auto)' \
'(-v --version)'{-v,--version}'[show the version number and quit]' \

View file

@ -1188,16 +1188,19 @@ err:
static char *
get_server_socket_path(void)
{
const char *xdg_session_id = getenv("XDG_SESSION_ID");
const char *xdg_runtime = getenv("XDG_RUNTIME_DIR");
if (xdg_runtime == NULL)
return strdup("/tmp/foot.sock");
if (xdg_session_id == NULL)
xdg_session_id = "no-session";
const char *wayland_display = getenv("WAYLAND_DISPLAY");
if (wayland_display == NULL) {
char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot.sock") + 1);
sprintf(path, "%s/foot.sock", xdg_runtime);
return path;
}
char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot-.sock") + strlen(xdg_session_id) + 1);
sprintf(path, "%s/foot-%s.sock", xdg_runtime, xdg_session_id);
char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot-.sock") + strlen(wayland_display) + 1);
sprintf(path, "%s/foot-%s.sock", xdg_runtime, wayland_display);
return path;
}

View file

@ -81,13 +81,13 @@ arguments, to execute (instead of the default shell).
others with it.
The default path is
*$XDG\_RUNTIME\_DIR/foot-$XDG\_SESSION\_ID.sock*.
*$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*.
If *$XDG_RUNTIME_DIR* is not set, the default path is instead
If *$XDG\_RUNTIME\_DIR* is not set, the default path is instead
*/tmp/foot.sock*.
If *$XDG_RUNTIME_DIR* is set, but *$XDG_SESSION_ID* is not, the
default path is *$XDG_RUNTIME_DIR/foot-no-session.sock*.
If *$XDG\_RUNTIME\_DIR* is set, but *$WAYLAND\_DISPLAY* is not,
the default path is *$XDG\_RUNTIME\_DIR/foot.sock*.
Note that if you change the default, you will also need to use the
*--server-socket* option in *footclient*(1) and point it to your

View file

@ -34,7 +34,8 @@ arguments, to execute (instead of the default shell).
Start a login shell, by prepending a '-' to argv[0].
*-s*,*--server-socket*=_PATH_
Connect to _PATH_ instead of _XDG\_RUNTIME\_DIR/foot.sock_.
Connect to _PATH_ instead of
*$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*.
*--hold*
Remain open after child process exits.

2
main.c
View file

@ -56,7 +56,7 @@ print_usage(const char *prog_name)
" --login-shell start shell as a login shell\n"
" -g,--geometry=WIDTHxHEIGHT set initial width and height\n"
" -s,--server[=PATH] run as a server (use 'footclient' to start terminals).\n"
" Without PATH, $XDG_RUNTIME_DIR/foot-$XDG_SESSION_ID.sock will be used.\n"
" Without PATH, $XDG_RUNTIME_DIR/foot-$WAYLAND_DISPLAY.sock will be used.\n"
" --hold remain open after child process exits\n"
" -p,--print-pid=FILE|FD print PID to file or FD (only applicable in server mode)\n"
" -l,--log-colorize=[never|always|auto] enable/disable colorization of log output on stderr\n"