1 /*	$OpenBSD: control.c,v 1.8 2021/03/02 04:10:07 jsg Exp $	*/
2 
3 /*
4  * Copyright (c) 2022, 2023 Omar Polo <op@omarpolo.com>
5  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include "config.h"
21 
22 #include <sys/stat.h>
23 #include <sys/socket.h>
24 #include <sys/un.h>
25 
26 #include <netinet/in.h>
27 #include <net/if.h>
28 
29 #include <errno.h>
30 #include <fcntl.h>
31 #include <limits.h>
32 #include <poll.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <unistd.h>
37 
38 #include "amused.h"
39 #include "ev.h"
40 #include "log.h"
41 #include "control.h"
42 #include "playlist.h"
43 
44 #define	CONTROL_BACKLOG	5
45 
46 struct {
47 	int		fd;
48 	struct playlist	play;
49 	int		tx;
50 } control_state = {.fd = -1, .tx = -1};
51 
52 struct ctl_conn {
53 	TAILQ_ENTRY(ctl_conn)	entry;
54 	int			monitor; /* 1 if client is in monitor mode */
55 	struct imsgev		iev;
56 };
57 
58 TAILQ_HEAD(ctl_conns, ctl_conn)	ctl_conns = TAILQ_HEAD_INITIALIZER(ctl_conns);
59 
60 struct ctl_conn	*control_connbyfd(int);
61 struct ctl_conn	*control_connbypid(pid_t);
62 void		 control_close(int);
63 
64 int
65 control_init(char *path)
66 {
67 	struct sockaddr_un	 sun;
68 	int			 fd, flags;
69 	mode_t			 old_umask;
70 
71 	if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
72 		log_warn("%s: socket", __func__);
73 		return (-1);
74 	}
75 
76 	if ((flags = fcntl(fd, F_GETFL)) == -1 ||
77 	    fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1)
78 		fatal("fcntl(O_NONBLOCK)");
79 
80 	if (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
81 		fatal("fcntl(CLOEXEC)");
82 
83 	memset(&sun, 0, sizeof(sun));
84 	sun.sun_family = AF_UNIX;
85 	strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
86 
87 	if (unlink(path) == -1)
88 		if (errno != ENOENT) {
89 			log_warn("%s: unlink %s", __func__, path);
90 			close(fd);
91 			return (-1);
92 		}
93 
94 	old_umask = umask(S_IXUSR|S_IXGRP|S_IWOTH|S_IROTH|S_IXOTH);
95 	if (bind(fd, (struct sockaddr *)&sun, sizeof(sun)) == -1) {
96 		log_warn("%s: bind: %s", __func__, path);
97 		close(fd);
98 		umask(old_umask);
99 		return (-1);
100 	}
101 	umask(old_umask);
102 
103 	if (chmod(path, S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP) == -1) {
104 		log_warn("%s: chmod", __func__);
105 		close(fd);
106 		(void)unlink(path);
107 		return (-1);
108 	}
109 
110 	return (fd);
111 }
112 
113 static void
114 enable_accept(int fd, int ev, void *bula)
115 {
116 	ev_add(control_state.fd, POLLIN, control_accept, NULL);
117 }
118 
119 int
120 control_listen(int fd)
121 {
122 	if (control_state.fd != -1)
123 		fatalx("%s: received unexpected controlsock", __func__);
124 
125 	control_state.fd = fd;
126 	if (listen(control_state.fd, CONTROL_BACKLOG) == -1) {
127 		log_warn("%s: listen", __func__);
128 		return (-1);
129 	}
130 
131 	enable_accept(-1, 0, NULL);
132 	return (0);
133 }
134 
135 void
136 control_accept(int listenfd, int event, void *bula)
137 {
138 	int			 connfd, flags;
139 	socklen_t		 len;
140 	struct sockaddr_un	 sun;
141 	struct ctl_conn		*c;
142 
143 	len = sizeof(sun);
144 	if ((connfd = accept(listenfd, (struct sockaddr *)&sun, &len)) == -1) {
145 		/*
146 		 * Pause accept if we are out of file descriptors, or
147 		 * libevent will haunt us here too.
148 		 */
149 		if (errno == ENFILE || errno == EMFILE) {
150 			struct timeval evtpause = { 1, 0 };
151 
152 			ev_del(control_state.fd);
153 			ev_timer(&evtpause, enable_accept, NULL);
154 		} else if (errno != EWOULDBLOCK && errno != EINTR &&
155 		    errno != ECONNABORTED)
156 			log_warn("%s: accept4", __func__);
157 		return;
158 	}
159 
160 	if ((flags = fcntl(connfd, F_GETFL)) == -1 ||
161 	    fcntl(connfd, F_SETFL, flags | O_NONBLOCK) == -1)
162 		fatal("fcntl(O_NONBLOCK)");
163 	if (fcntl(connfd, F_SETFD, FD_CLOEXEC) == -1)
164 		fatal("fcntl(CLOEXEC)");
165 
166 	if ((c = calloc(1, sizeof(struct ctl_conn))) == NULL) {
167 		log_warn("%s: calloc", __func__);
168 		close(connfd);
169 		return;
170 	}
171 
172 	imsg_init(&c->iev.imsgbuf, connfd);
173 	c->iev.handler = control_dispatch_imsg;
174 	c->iev.events = POLLIN;
175 	ev_add(c->iev.imsgbuf.fd, c->iev.events, c->iev.handler, &c->iev);
176 
177 	TAILQ_INSERT_TAIL(&ctl_conns, c, entry);
178 }
179 
180 struct ctl_conn *
181 control_connbyfd(int fd)
182 {
183 	struct ctl_conn	*c;
184 
185 	TAILQ_FOREACH(c, &ctl_conns, entry) {
186 		if (c->iev.imsgbuf.fd == fd)
187 			break;
188 	}
189 
190 	return (c);
191 }
192 
193 struct ctl_conn *
194 control_connbypid(pid_t pid)
195 {
196 	struct ctl_conn	*c;
197 
198 	TAILQ_FOREACH(c, &ctl_conns, entry) {
199 		if (c->iev.imsgbuf.pid == pid)
200 			break;
201 	}
202 
203 	return (c);
204 }
205 
206 void
207 control_close(int fd)
208 {
209 	struct ctl_conn	*c;
210 
211 	if ((c = control_connbyfd(fd)) == NULL) {
212 		log_warnx("%s: fd %d: not found", __func__, fd);
213 		return;
214 	}
215 
216 	/* abort the transaction if running by this user */
217 	if (control_state.tx != -1 && c->iev.imsgbuf.fd == control_state.tx) {
218 		playlist_free(&control_state.play);
219 		control_state.tx = -1;
220 	}
221 
222 	msgbuf_clear(&c->iev.imsgbuf.w);
223 	TAILQ_REMOVE(&ctl_conns, c, entry);
224 
225 	ev_del(c->iev.imsgbuf.fd);
226 	close(c->iev.imsgbuf.fd);
227 
228 	/* Some file descriptors are available again. */
229 	if (ev_timer_pending()) {
230 		ev_timer(NULL, NULL, NULL);
231 		ev_add(control_state.fd, POLLIN, control_accept, NULL);
232 	}
233 
234 	free(c);
235 }
236 
237 void
238 control_notify(int type)
239 {
240 	struct ctl_conn *c;
241 	struct player_event ev;
242 
243 	memset(&ev, 0, sizeof(ev));
244 	ev.event = type;
245 	ev.position = current_position;
246 	ev.duration = current_duration;
247 	ev.mode.repeat_one = repeat_one;
248 	ev.mode.repeat_all = repeat_all;
249 	ev.mode.consume = consume;
250 
251 	TAILQ_FOREACH(c, &ctl_conns, entry) {
252 		if (!c->monitor)
253 			continue;
254 
255 		imsg_compose_event(&c->iev, IMSG_CTL_MONITOR, 0, 0,
256 		    -1, &ev, sizeof(ev));
257 	}
258 }
259 
260 static int
261 new_mode(int val, int newval)
262 {
263 	if (newval == MODE_UNDEF)
264 		return val;
265 	if (newval == MODE_TOGGLE)
266 		return !val;
267 	return !!newval;
268 }
269 
270 void
271 control_dispatch_imsg(int fd, int event, void *bula)
272 {
273 	struct ctl_conn		*c;
274 	struct imsgbuf		*imsgbuf;
275 	struct imsg		 imsg;
276 	struct player_mode	 mode;
277 	struct player_seek	 seek;
278 	ssize_t		 	 n, off;
279 
280 	if ((c = control_connbyfd(fd)) == NULL) {
281 		log_warnx("%s: fd %d: not found", __func__, fd);
282 		return;
283 	}
284 
285 	imsgbuf = &c->iev.imsgbuf;
286 
287 	if (event & POLLIN) {
288 		if (((n = imsg_read(imsgbuf)) == -1 && errno != EAGAIN) ||
289 		    n == 0) {
290 			control_close(fd);
291 			return;
292 		}
293 	}
294 	if (event & POLLOUT) {
295 		if (msgbuf_write(&imsgbuf->w) <= 0 && errno != EAGAIN) {
296 			control_close(fd);
297 			return;
298 		}
299 	}
300 
301 	for (;;) {
302 		if ((n = imsg_get(imsgbuf, &imsg)) == -1) {
303 			control_close(fd);
304 			return;
305 		}
306 		if (n == 0)
307 			break;
308 
309 		switch (imsg.hdr.type) {
310 		case IMSG_CTL_PLAY:
311 			switch (play_state) {
312 			case STATE_STOPPED:
313 				main_playlist_resume();
314 				break;
315 			case STATE_PLAYING:
316 				/* do nothing */
317 				break;
318 			case STATE_PAUSED:
319 				play_state = STATE_PLAYING;
320 				main_send_player(IMSG_RESUME, -1, NULL ,0);
321 				break;
322 			}
323 			control_notify(imsg.hdr.type);
324 			break;
325 		case IMSG_CTL_TOGGLE_PLAY:
326 			switch (play_state) {
327 			case STATE_STOPPED:
328 				control_notify(IMSG_CTL_PLAY);
329 				main_playlist_resume();
330 				break;
331 			case STATE_PLAYING:
332 				control_notify(IMSG_CTL_PAUSE);
333 				play_state = STATE_PAUSED;
334 				main_send_player(IMSG_PAUSE, -1, NULL, 0);
335 				break;
336 			case STATE_PAUSED:
337 				control_notify(IMSG_CTL_PLAY);
338 				play_state = STATE_PLAYING;
339 				main_send_player(IMSG_RESUME, -1, NULL, 0);
340 				break;
341 			}
342 			break;
343 		case IMSG_CTL_PAUSE:
344 			if (play_state != STATE_PLAYING)
345 				break;
346 			play_state = STATE_PAUSED;
347 			main_send_player(IMSG_PAUSE, -1, NULL, 0);
348 			control_notify(imsg.hdr.type);
349 			break;
350 		case IMSG_CTL_STOP:
351 			if (play_state == STATE_STOPPED)
352 				break;
353 			play_state = STATE_STOPPED;
354 			main_send_player(IMSG_STOP, -1, NULL, 0);
355 			control_notify(imsg.hdr.type);
356 			break;
357 		case IMSG_CTL_FLUSH:
358 			playlist_truncate();
359 			control_notify(IMSG_CTL_COMMIT);
360 			break;
361 		case IMSG_CTL_SHOW:
362 			main_send_playlist(&c->iev);
363 			break;
364 		case IMSG_CTL_STATUS:
365 			main_send_status(&c->iev);
366 			break;
367 		case IMSG_CTL_NEXT:
368 			control_notify(imsg.hdr.type);
369 			main_send_player(IMSG_STOP, -1, NULL, 0);
370 			main_playlist_advance();
371 			break;
372 		case IMSG_CTL_PREV:
373 			control_notify(imsg.hdr.type);
374 			main_send_player(IMSG_STOP, -1, NULL, 0);
375 			main_playlist_previous();
376 			break;
377 		case IMSG_CTL_JUMP:
378 			main_playlist_jump(&c->iev, &imsg);
379 			break;
380 		case IMSG_CTL_MODE:
381 			if (imsg_get_data(&imsg, &mode, sizeof(mode)) == -1) {
382 				log_warnx("%s: got wrong size", __func__);
383 				break;
384 			}
385 			consume = new_mode(consume, mode.consume);
386 			repeat_all = new_mode(repeat_all, mode.repeat_all);
387 			repeat_one = new_mode(repeat_one, mode.repeat_one);
388 			control_notify(imsg.hdr.type);
389 			break;
390 		case IMSG_CTL_BEGIN:
391 			if (control_state.tx != -1) {
392 				main_senderr(&c->iev, "locked");
393 				break;
394 			}
395 			control_state.tx = imsgbuf->fd;
396 			imsg_compose_event(&c->iev, IMSG_CTL_BEGIN, 0, 0, -1,
397 			    NULL, 0);
398 			break;
399 		case IMSG_CTL_ADD:
400 			if (control_state.tx != -1 &&
401 			    control_state.tx != imsgbuf->fd) {
402 				main_senderr(&c->iev, "locked");
403 				break;
404 			}
405 			main_enqueue(control_state.tx != -1,
406 			   &control_state.play,&c->iev, &imsg);
407 			if (control_state.tx == -1)
408 				control_notify(imsg.hdr.type);
409 			break;
410 		case IMSG_CTL_COMMIT:
411 			if (control_state.tx != imsgbuf->fd) {
412 				main_senderr(&c->iev, "locked");
413 				break;
414 			}
415 			if (imsg_get_data(&imsg, &off, sizeof(off)) == -1) {
416 				main_senderr(&c->iev, "wrong size");
417 				break;
418 			}
419 			playlist_swap(&control_state.play, off);
420 			memset(&control_state.play, 0,
421 			    sizeof(control_state.play));
422 			control_state.tx = -1;
423 			imsg_compose_event(&c->iev, IMSG_CTL_COMMIT, 0, 0, -1,
424 			    NULL, 0);
425 			control_notify(imsg.hdr.type);
426 			break;
427 		case IMSG_CTL_MONITOR:
428 			c->monitor = 1;
429 			break;
430 		case IMSG_CTL_SEEK:
431 			if (imsg_get_data(&imsg, &seek, sizeof(seek)) == -1) {
432 				main_senderr(&c->iev, "wrong size");
433 				break;
434 			}
435 			main_seek(&seek);
436 			break;
437 		default:
438 			log_debug("%s: error handling imsg %d", __func__,
439 			    imsg.hdr.type);
440 			break;
441 		}
442 		imsg_free(&imsg);
443 	}
444 
445 	imsg_event_add(&c->iev);
446 }