inaban/main.c

// Copyright 2019-2020 Inaban Authors <https://hacktivis.me/git/inaban>
// SPDX-License-Identifier: BSD-3-Clause
// Based on wlroots's TinyWL which is distributed under CC0

#include "inaban.h"
#include "layers.h"

#include "config.h"

#include <getopt.h>
#include <signal.h> /* signal(), SIGTERM */
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include <unistd.h> /* execvp() */
#include <unistd.h>

#define LENGTH(X) (sizeof X / sizeof X[0])

struct inaban_server server = {0};

void
spawn(const Arg *arg)
{
	if(fork() == 0)
	{
		setsid();
		execvp(((char **)arg->v)[0], (char **)arg->v);
		fprintf(stderr, "execvp %s", ((char **)arg->v)[0]);
		perror(" failed");
		exit(EXIT_SUCCESS);
	}
}

static void
focus_view(struct inaban_view *view, struct wlr_surface *surface)
{
	/* Note: this function only deals with keyboard focus. */
	if(view == NULL) return;
	struct inaban_server *server     = view->server;
	struct wlr_seat *seat            = server->seat;
	struct wlr_surface *prev_surface = seat->keyboard_state.focused_surface;
	if(prev_surface == surface) return; /* Don't re-focus an already focused surface. */
	if(prev_surface)
	{
		/*
		 * Deactivate the previously focused surface. This lets the client know
		 * it no longer has focus and the client will repaint accordingly, e.g.
		 * stop displaying a caret.
		 */
		struct wlr_xdg_surface *previous =
		    wlr_xdg_surface_from_wlr_surface(seat->keyboard_state.focused_surface);
		wlr_xdg_toplevel_set_activated(previous, false);
	}
	struct wlr_keyboard *keyboard = wlr_seat_get_keyboard(seat);
	/* Move the view to the front */
	wl_list_remove(&view->link);
	wl_list_insert(&server->views, &view->link);
	/* Activate the new surface */
	wlr_xdg_toplevel_set_activated(view->xdg_surface, true);
	/*
	 * Tell the seat to have the keyboard enter this surface. wlroots will keep
	 * track of this and automatically send key events to the appropriate
	 * clients without additional work on your part.
	 */
	wlr_seat_keyboard_notify_enter(seat,
	                               view->xdg_surface->surface,
	                               keyboard->keycodes,
	                               keyboard->num_keycodes,
	                               &keyboard->modifiers);
}

/* This event is raised when a modifier key, such as shift or alt, is pressed.
 * We simply communicate this to the client. */
static void
keyboard_handle_modifiers(struct wl_listener *listener, void *data)
{
	(void)data;
	struct inaban_keyboard *keyboard = wl_container_of(listener, keyboard, modifiers);
	/*
	 * A seat can only have one keyboard, but this is a limitation of the
	 * Wayland protocol - not wlroots. We assign all connected keyboards to the
	 * same seat. You can swap out the underlying wlr_keyboard like this and
	 * wlr_seat handles this transparently.
	 */
	wlr_seat_set_keyboard(keyboard->server->seat, keyboard->device);
	/* Send modifiers to the client. */
	wlr_seat_keyboard_notify_modifiers(keyboard->server->seat,
	                                   &keyboard->device->keyboard->modifiers);
}

/* This event is raised when a key is pressed or released. */
static void
keyboard_handle_key(struct wl_listener *listener, void *data)
{
	struct inaban_keyboard *keyboard     = wl_container_of(listener, keyboard, key);
	struct inaban_server *server         = keyboard->server;
	struct wlr_event_keyboard_key *event = data;
	struct wlr_seat *seat                = server->seat;

	/* Translate libinput keycode -> xkbcommon */
	uint32_t keycode    = event->keycode + 8;
	xkb_keysym_t keysym = xkb_state_key_get_one_sym(keyboard->device->keyboard->xkb_state, keycode);

	bool handled       = false;
	uint32_t modifiers = wlr_keyboard_get_modifiers(keyboard->device->keyboard);

	if(event->state == WLR_KEY_PRESSED)
	{
		wlr_log(WLR_DEBUG,
		        "key_pressed: {modifiers: %x, keycode: %x, keysym: %x}",
		        modifiers,
		        keycode,
		        keysym);

		for(size_t i = 0; i < LENGTH(shortcuts); i++)
			if((keysym == shortcuts[i].keysym) && (modifiers == shortcuts[i].mod) && shortcuts[i].func)
			{
				shortcuts[i].func(&(shortcuts[i].arg));
				handled = true;
			}
	}

	/* Otherwise, we pass it along to the client. */
	if(!handled)
	{
		wlr_seat_set_keyboard(seat, keyboard->device);
		wlr_seat_keyboard_notify_key(seat, event->time_msec, event->keycode, event->state);
	}
}

static void
server_new_keyboard(struct inaban_server *server, struct wlr_input_device *device)
{
	struct inaban_keyboard *keyboard = calloc(1, sizeof(struct inaban_keyboard));
	keyboard->server                 = server;
	keyboard->device                 = device;

	/* We need to prepare an XKB keymap and assign it to the keyboard. This
	 * assumes the defaults (e.g. layout = "us"). */
	struct xkb_rule_names rules = {0};
	struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
	struct xkb_keymap *keymap = xkb_map_new_from_names(context, &rules, XKB_KEYMAP_COMPILE_NO_FLAGS);

	wlr_keyboard_set_keymap(device->keyboard, keymap);
	xkb_keymap_unref(keymap);
	xkb_context_unref(context);
	wlr_keyboard_set_repeat_info(device->keyboard, 25, 600);

	/* Here we set up listeners for keyboard events. */
	keyboard->modifiers.notify = keyboard_handle_modifiers;
	wl_signal_add(&device->keyboard->events.modifiers, &keyboard->modifiers);
	keyboard->key.notify = keyboard_handle_key;
	wl_signal_add(&device->keyboard->events.key, &keyboard->key);

	wlr_seat_set_keyboard(server->seat, device);

	/* And add the keyboard to our list of keyboards */
	wl_list_insert(&server->keyboards, &keyboard->link);
}

static void
server_new_pointer(struct inaban_server *server, struct wlr_input_device *device)
{
	/* We don't do anything special with pointers. All of our pointer handling
	 * is proxied through wlr_cursor. On another compositor, you might take this
	 * opportunity to do libinput configuration on the device to set
	 * acceleration, etc. */
	wlr_cursor_attach_input_device(server->cursor, device);
}

static void
server_new_input(struct wl_listener *listener, void *data)
{
	/* This event is raised by the backend when a new input device becomes
	 * available. */
	struct inaban_server *server    = wl_container_of(listener, server, new_input);
	struct wlr_input_device *device = data;
	switch(device->type)
	{
	case WLR_INPUT_DEVICE_KEYBOARD: server_new_keyboard(server, device); break;
	case WLR_INPUT_DEVICE_POINTER: server_new_pointer(server, device); break;
	default: break;
	}
	/* We need to let the wlr_seat know what our capabilities are, which is
	 * communiciated to the client. In TinyWL we always have a cursor, even if
	 * there are no pointer devices, so we always include that capability. */
	uint32_t caps = WL_SEAT_CAPABILITY_POINTER;
	if(!wl_list_empty(&server->keyboards)) caps |= WL_SEAT_CAPABILITY_KEYBOARD;

	wlr_seat_set_capabilities(server->seat, caps);
}

static void
seat_request_cursor(struct wl_listener *listener, void *data)
{
	struct inaban_server *server = wl_container_of(listener, server, request_cursor);
	/* This event is rasied by the seat when a client provides a cursor image */
	struct wlr_seat_pointer_request_set_cursor_event *event = data;
	struct wlr_seat_client *focused_client = server->seat->pointer_state.focused_client;
	/* This can be sent by any client, so we check to make sure this one is
	 * actually has pointer focus first. */
	/* Once we've vetted the client, we can tell the cursor to use the
	 * provided surface as the cursor image. It will set the hardware cursor
	 * on the output that it's currently on and continue to do so as the
	 * cursor moves between outputs. */
	if(focused_client == event->seat_client)
		wlr_cursor_set_surface(server->cursor, event->surface, event->hotspot_x, event->hotspot_y);
}

static bool
view_at(struct inaban_view *view,
        double lx,
        double ly,
        struct wlr_surface **surface,
        double *sx,
        double *sy)
{
	/*
	 * XDG toplevels may have nested surfaces, such as popup windows for context
	 * menus or tooltips. This function tests if any of those are underneath the
	 * coordinates lx and ly (in output Layout Coordinates). If so, it sets the
	 * surface pointer to that wlr_surface and the sx and sy coordinates to the
	 * coordinates relative to that surface's top-left corner.
	 */
	double view_sx = lx - view->x;
	double view_sy = ly - view->y;

	double _sx, _sy;
	struct wlr_surface *_surface = NULL;
	_surface = wlr_xdg_surface_surface_at(view->xdg_surface, view_sx, view_sy, &_sx, &_sy);

	if(_surface != NULL)
	{
		*sx      = _sx;
		*sy      = _sy;
		*surface = _surface;
		return true;
	}

	return false;
}

static struct inaban_view *
desktop_view_at(struct inaban_server *server,
                double lx,
                double ly,
                struct wlr_surface **surface,
                double *sx,
                double *sy)
{
	/* This iterates over all of our surfaces and attempts to find one under the
	 * cursor. This relies on server->views being ordered from top-to-bottom. */
	struct inaban_view *view;
	wl_list_for_each(view, &server->views, link)
	{
		if(view_at(view, lx, ly, surface, sx, sy)) return view;
	}
	return NULL;
}

static void
process_cursor_motion(struct inaban_server *server, uint32_t time)
{
	/* Otherwise, find the view under the pointer and send the event along. */
	double sx, sy;
	struct wlr_seat *seat       = server->seat;
	struct wlr_surface *surface = NULL;
	struct inaban_view *view =
	    desktop_view_at(server, server->cursor->x, server->cursor->y, &surface, &sx, &sy);
	/* If there's no view under the cursor, set the cursor image to a
	 * default. This is what makes the cursor image appear when you move it
	 * around the screen, not over any views. */
	if(!view) wlr_xcursor_manager_set_cursor_image(server->cursor_mgr, "left_ptr", server->cursor);
	if(surface)
	{
		bool focus_changed = seat->pointer_state.focused_surface != surface;
		/*
		 * "Enter" the surface if necessary. This lets the client know that the
		 * cursor has entered one of its surfaces.
		 *
		 * Note that this gives the surface "pointer focus", which is distinct
		 * from keyboard focus. You get pointer focus by moving the pointer over
		 * a window.
		 */
		wlr_seat_pointer_notify_enter(seat, surface, sx, sy);
		/* The enter event contains coordinates, so we only need to notify
		 * on motion if the focus did not change. */
		if(!focus_changed) wlr_seat_pointer_notify_motion(seat, time, sx, sy);
	}
	else
	{
		/* Clear pointer focus so future button events and such are not sent to
		 * the last client to have the cursor over it. */
		wlr_seat_pointer_clear_focus(seat);
	}
}

static void
server_cursor_motion(struct wl_listener *listener, void *data)
{
	/* This event is forwarded by the cursor when a pointer emits a _relative_
	 * pointer motion event (i.e. a delta) */
	struct inaban_server *server           = wl_container_of(listener, server, cursor_motion);
	struct wlr_event_pointer_motion *event = data;
	/* The cursor doesn't move unless we tell it to. The cursor automatically
	 * handles constraining the motion to the output layout, as well as any
	 * special configuration applied for the specific input device which
	 * generated the event. You can pass NULL for the device if you want to move
	 * the cursor around without any input. */
	wlr_cursor_move(server->cursor, event->device, event->delta_x, event->delta_y);
	process_cursor_motion(server, event->time_msec);
}

static void
server_cursor_motion_absolute(struct wl_listener *listener, void *data)
{
	/* This event is forwarded by the cursor when a pointer emits an _absolute_
	 * motion event, from 0..1 on each axis. This happens, for example, when
	 * wlroots is running under a Wayland window rather than KMS+DRM, and you
	 * move the mouse over the window. You could enter the window from any edge,
	 * so we have to warp the mouse there. There is also some hardware which
	 * emits these events. */
	struct inaban_server *server = wl_container_of(listener, server, cursor_motion_absolute);
	struct wlr_event_pointer_motion_absolute *event = data;
	wlr_cursor_warp_absolute(server->cursor, event->device, event->x, event->y);
	process_cursor_motion(server, event->time_msec);
}

static void
server_cursor_button(struct wl_listener *listener, void *data)
{
	/* This event is forwarded by the cursor when a pointer emits a button
	 * event. */
	struct inaban_server *server           = wl_container_of(listener, server, cursor_button);
	struct wlr_event_pointer_button *event = data;
	/* Notify the client with pointer focus that a button press has occurred */
	wlr_seat_pointer_notify_button(server->seat, event->time_msec, event->button, event->state);
	double sx, sy;
	struct wlr_surface *surface;
	struct inaban_view *view =
	    desktop_view_at(server, server->cursor->x, server->cursor->y, &surface, &sx, &sy);
	focus_view(view, surface); /* Focus that client if the button was _pressed_ */
}

static void
server_cursor_axis(struct wl_listener *listener, void *data)
{
	/* This event is forwarded by the cursor when a pointer emits an axis event,
	 * for example when you move the scroll wheel. */
	struct inaban_server *server         = wl_container_of(listener, server, cursor_axis);
	struct wlr_event_pointer_axis *event = data;
	/* Notify the client with pointer focus of the axis event. */
	wlr_seat_pointer_notify_axis(server->seat,
	                             event->time_msec,
	                             event->orientation,
	                             event->delta,
	                             event->delta_discrete,
	                             event->source);
}

static void
server_cursor_frame(struct wl_listener *listener, void *data)
{
	(void)data;
	/* This event is forwarded by the cursor when a pointer emits an frame
	 * event. Frame events are sent after regular pointer events to group
	 * multiple events together. For instance, two axis events may happen at the
	 * same time, in which case a frame event won't be sent in between. */
	struct inaban_server *server = wl_container_of(listener, server, cursor_frame);
	/* Notify the client with pointer focus of the frame event. */
	wlr_seat_pointer_notify_frame(server->seat);
}

static void
xdg_surface_map(struct wl_listener *listener, void *data)
{
	(void)data;
	/* Called when the surface is mapped, or ready to display on-screen. */
	struct inaban_view *view = wl_container_of(listener, view, map);
	view->mapped             = true;
	focus_view(view, view->xdg_surface->surface);
}

static void
xdg_surface_unmap(struct wl_listener *listener, void *data)
{
	(void)data;
	/* Called when the surface is unmapped, and should no longer be shown. */
	struct inaban_view *view = wl_container_of(listener, view, unmap);
	view->mapped             = false;
}

static void
xdg_surface_destroy(struct wl_listener *listener, void *data)
{
	(void)data;
	/* Called when the surface is destroyed and should never be shown again. */
	struct inaban_view *view = wl_container_of(listener, view, destroy);
	wl_list_remove(&view->link);
	free(view);
}

static void
xdg_deny_request(struct wl_listener *listener, void *data)
{
	(void)listener;
	(void)data;
}

static void
server_new_xdg_surface(struct wl_listener *listener, void *data)
{
	/* This event is raised when wlr_xdg_shell receives a new xdg surface from a
	 * client, either a toplevel (application window) or popup. */
	struct inaban_server *server        = wl_container_of(listener, server, new_xdg_surface);
	struct wlr_xdg_surface *xdg_surface = data;
	if(xdg_surface->role != WLR_XDG_SURFACE_ROLE_TOPLEVEL) return;

	/* Allocate a inaban_view for this surface */
	struct inaban_view *view = calloc(1, sizeof(struct inaban_view));
	view->server             = server;
	view->xdg_surface        = xdg_surface;

	/* Listen to the various events it can emit */
	view->map.notify = xdg_surface_map;
	wl_signal_add(&xdg_surface->events.map, &view->map);
	view->unmap.notify = xdg_surface_unmap;
	wl_signal_add(&xdg_surface->events.unmap, &view->unmap);
	view->destroy.notify = xdg_surface_destroy;
	wl_signal_add(&xdg_surface->events.destroy, &view->destroy);

	/* cotd */
	struct wlr_xdg_toplevel *toplevel = xdg_surface->toplevel;
	view->request_move.notify         = xdg_deny_request;
	wl_signal_add(&toplevel->events.request_move, &view->request_move);
	view->request_resize.notify = xdg_deny_request;
	wl_signal_add(&toplevel->events.request_resize, &view->request_resize);

	/* Add it to the list of views. */
	wl_list_insert(&server->views, &view->link);
}

static bool
drop_permissions(void)
{
	if(getuid() != geteuid() || getgid() != getegid())
	{
		if(setuid(getuid()) != 0 || setgid(getgid()) != 0)
		{
			wlr_log(WLR_ERROR, "Unable to drop root, refusing to continue");
			return false;
		}
	}
	if(setuid(0) != -1)
	{
		wlr_log(
		    WLR_ERROR,
		    "Unable to drop root (we shouldn't be able to restore it after setuid), refusing to start");
		return false;
	}

	return true;
}

void
quit(const Arg *arg)
{
	(void)arg;
	wl_display_terminate(server.wl_display);
}

void
sigterm_handler(int signal)
{
	(void)signal;
	wl_display_terminate(server.wl_display);
}

void
usage(char *argv0)
{
	printf("Usage: %s [-s startup command]\n", argv0);
}

int
main(int argc, char *argv[])
{
	wlr_log_init(WLR_DEBUG, NULL);
	char *startup_cmdv[] = {NULL};
	int startup_cmdc     = 0;

	int c;
	while((c = getopt(argc, argv, "s:h")) != -1)
	{
		switch(c)
		{
		case 's':
			startup_cmdv[startup_cmdc] = optarg;
			startup_cmdc++;
			break;
		default: usage(argv[0]); return 0;
		}
	}
	if(optind < argc)
	{
		usage(argv[0]);
		return 0;
	}

	/* The Wayland display is managed by libwayland. It handles accepting
	 * clients from the Unix socket, manging Wayland globals, and so on. */
	server.wl_display = wl_display_create();
	/* The backend is a wlroots feature which abstracts the underlying input and
	 * output hardware. The autocreate option will choose the most suitable
	 * backend based on the current environment, such as opening an X11 window
	 * if an X11 server is running. The NULL argument here optionally allows you
	 * to pass in a custom renderer if wlr_renderer doesn't meet your needs. The
	 * backend uses the renderer, for example, to fall back to software cursors
	 * if the backend does not support hardware cursors (some older GPUs
	 * don't). */
	server.backend = wlr_backend_autocreate(server.wl_display, NULL);

	if(!drop_permissions()) abort();

	// handle SIGTERM signals
	signal(SIGTERM, sigterm_handler);

	/* If we don't provide a renderer, autocreate makes a GLES2 renderer for us.
	 * The renderer is responsible for defining the various pixel formats it
	 * supports for shared memory, this configures that for clients. */
	server.renderer = wlr_backend_get_renderer(server.backend);
	wlr_renderer_init_wl_display(server.renderer, server.wl_display);

	/* This creates some hands-off wlroots interfaces. The compositor is
	 * necessary for clients to allocate surfaces and the data device manager
	 * handles the clipboard. Each of these wlroots interfaces has room for you
	 * to dig your fingers in and play with their behavior if you want. */
	wlr_compositor_create(server.wl_display, server.renderer);
	wlr_data_device_manager_create(server.wl_display);

	/* Creates an output layout, which a wlroots utility for working with an
	 * arrangement of screens in a physical layout. */
	server.output_layout = wlr_output_layout_create();

	/* Configure a listener to be notified when new outputs are available on the
	 * backend. */
	wl_list_init(&server.outputs);
	server.new_output.notify = server_new_output;
	wl_signal_add(&server.backend->events.new_output, &server.new_output);

	/* Set up our list of views and the xdg-shell. The xdg-shell is a Wayland
	 * protocol which is used for application windows. For more detail on
	 * shells, refer to my article:
	 *
	 * https://drewdevault.com/2018/07/29/Wayland-shells.html
	 */
	wl_list_init(&server.views);
	server.xdg_shell              = wlr_xdg_shell_create(server.wl_display);
	server.new_xdg_surface.notify = server_new_xdg_surface;
	wl_signal_add(&server.xdg_shell->events.new_surface, &server.new_xdg_surface);

	server.layer_shell              = wlr_layer_shell_v1_create(server.wl_display);
	server.new_layer_surface.notify = server_new_layer_surface;
	wl_signal_add(&server.xdg_shell->events.new_surface, &server.new_layer_surface);

	/*
	 * Creates a cursor, which is a wlroots utility for tracking the cursor
	 * image shown on screen.
	 */
	server.cursor = wlr_cursor_create();
	wlr_cursor_attach_output_layout(server.cursor, server.output_layout);

	/* Creates an xcursor manager, another wlroots utility which loads up
	 * Xcursor themes to source cursor images from and makes sure that cursor
	 * images are available at all scale factors on the screen (necessary for
	 * HiDPI support). We add a cursor theme at scale factor 1 to begin with. */
	server.cursor_mgr = wlr_xcursor_manager_create(NULL, 24);
	wlr_xcursor_manager_load(server.cursor_mgr, 1);

	/*
	 * wlr_cursor *only* displays an image on screen. It does not move around
	 * when the pointer moves. However, we can attach input devices to it, and
	 * it will generate aggregate events for all of them. In these events, we
	 * can choose how we want to process them, forwarding them to clients and
	 * moving the cursor around. More detail on this process is described in my
	 * input handling blog post:
	 *
	 * https://drewdevault.com/2018/07/17/Input-handling-in-wlroots.html
	 *
	 * And more comments are sprinkled throughout the notify functions above.
	 */
	server.cursor_motion.notify = server_cursor_motion;
	wl_signal_add(&server.cursor->events.motion, &server.cursor_motion);
	server.cursor_motion_absolute.notify = server_cursor_motion_absolute;
	wl_signal_add(&server.cursor->events.motion_absolute, &server.cursor_motion_absolute);
	server.cursor_button.notify = server_cursor_button;
	wl_signal_add(&server.cursor->events.button, &server.cursor_button);
	server.cursor_axis.notify = server_cursor_axis;
	wl_signal_add(&server.cursor->events.axis, &server.cursor_axis);
	server.cursor_frame.notify = server_cursor_frame;
	wl_signal_add(&server.cursor->events.frame, &server.cursor_frame);

	/*
	 * Configures a seat, which is a single "seat" at which a user sits and
	 * operates the computer. This conceptually includes up to one keyboard,
	 * pointer, touch, and drawing tablet device. We also rig up a listener to
	 * let us know when new input devices are available on the backend.
	 */
	wl_list_init(&server.keyboards);
	server.new_input.notify = server_new_input;
	wl_signal_add(&server.backend->events.new_input, &server.new_input);
	server.seat                  = wlr_seat_create(server.wl_display, "seat0");
	server.request_cursor.notify = seat_request_cursor;
	wl_signal_add(&server.seat->events.request_set_cursor, &server.request_cursor);

	/* Add a Unix socket to the Wayland display. */
	const char *socket = wl_display_add_socket_auto(server.wl_display);
	if(!socket)
	{
		wlr_backend_destroy(server.backend);
		return 1;
	}

	/* Start the backend. This will enumerate outputs and inputs, become the DRM
	 * master, etc */
	if(!wlr_backend_start(server.backend))
	{
		wlr_backend_destroy(server.backend);
		wl_display_destroy(server.wl_display);
		return 1;
	}

	/* Set the WAYLAND_DISPLAY environment variable to our socket and run the
	 * startup command if requested. */
	setenv("WAYLAND_DISPLAY", socket, true);
	for(int i = 0; i < startup_cmdc; i++)
	{
		if(fork() == 0)
		{
			unsetenv("DISPLAY");
			execl("/bin/sh", "/bin/sh", "-c", startup_cmdv[i], (void *)NULL);
		}
	}
	/* Run the Wayland event loop. This does not return until you exit the
	 * compositor. Starting the backend rigged up all of the necessary event
	 * loop configuration to listen to libinput events, DRM events, generate
	 * frame events at the refresh rate, and so on. */
	wlr_log(WLR_INFO, "Running Wayland compositor on WAYLAND_DISPLAY=%s", socket);
	wl_display_run(server.wl_display);

	/* Once wl_display_run returns, we shut down the server. */
	wl_display_destroy_clients(server.wl_display);
	wl_display_destroy(server.wl_display);
	return 0;
}