2022-11-15 00:22:27 +00:00
|
|
|
// Copyright (c) 2022 Marceline Cramer
|
|
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
|
2022-10-29 23:07:34 +00:00
|
|
|
use std::collections::HashMap;
|
2022-10-28 04:52:42 +00:00
|
|
|
use std::ops::{Deref, DerefMut};
|
|
|
|
use std::path::{Path, PathBuf};
|
|
|
|
use std::sync::mpsc::{channel, Receiver, Sender};
|
2022-10-29 22:54:51 +00:00
|
|
|
use std::sync::Arc;
|
2022-10-28 04:52:42 +00:00
|
|
|
use std::time::Duration;
|
2022-10-28 04:23:03 +00:00
|
|
|
|
2022-10-29 05:22:36 +00:00
|
|
|
use mio::net::{UnixListener, UnixStream};
|
2022-10-28 04:52:42 +00:00
|
|
|
use mio::{Events, Interest, Poll, Token, Waker};
|
2022-10-28 02:15:47 +00:00
|
|
|
use mio_signals::{Signal, Signals};
|
2022-10-29 22:54:51 +00:00
|
|
|
use parking_lot::RwLock;
|
2022-10-28 02:15:47 +00:00
|
|
|
use slab::Slab;
|
|
|
|
|
2022-11-17 05:17:17 +00:00
|
|
|
use crate::protocol::*;
|
2022-11-03 05:00:59 +00:00
|
|
|
use crate::service::window::{WindowMessage, WindowMessageSender};
|
2022-10-28 04:23:03 +00:00
|
|
|
|
2022-10-28 02:15:47 +00:00
|
|
|
const SOCK_NAME: &str = "magpie.sock";
|
|
|
|
|
2022-11-17 05:17:17 +00:00
|
|
|
#[derive(Debug)]
|
|
|
|
pub enum IpcMessage {
|
|
|
|
PanelMessage { window: usize, message: Vec<u8> },
|
|
|
|
}
|
2022-10-28 04:23:03 +00:00
|
|
|
|
2022-11-17 05:17:17 +00:00
|
|
|
#[derive(Clone)]
|
2022-10-28 04:52:42 +00:00
|
|
|
pub struct IpcMessageSender {
|
2022-11-17 05:17:17 +00:00
|
|
|
waker: Arc<Waker>,
|
2022-10-28 04:52:42 +00:00
|
|
|
sender: Sender<IpcMessage>,
|
|
|
|
}
|
|
|
|
|
2022-11-17 05:17:17 +00:00
|
|
|
impl IpcMessageSender {
|
|
|
|
pub fn send(&self, msg: IpcMessage) {
|
|
|
|
let _ = self.sender.send(msg);
|
|
|
|
let _ = self.waker.wake();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-10-28 02:15:47 +00:00
|
|
|
/// Wraps [mio::net::UnixListener] with automatic file deletion on drop.
|
|
|
|
pub struct Listener {
|
|
|
|
pub uds: UnixListener,
|
|
|
|
pub path: PathBuf,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Drop for Listener {
|
|
|
|
fn drop(&mut self) {
|
|
|
|
match std::fs::remove_file(&self.path) {
|
|
|
|
Ok(_) => {}
|
2022-12-06 04:53:38 +00:00
|
|
|
Err(e) => log::error!("Could not delete UnixListener {:?}", e),
|
2022-10-28 02:15:47 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Deref for Listener {
|
|
|
|
type Target = UnixListener;
|
|
|
|
|
|
|
|
fn deref(&self) -> &UnixListener {
|
|
|
|
&self.uds
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl DerefMut for Listener {
|
|
|
|
fn deref_mut(&mut self) -> &mut UnixListener {
|
|
|
|
&mut self.uds
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-12-04 05:03:55 +00:00
|
|
|
impl Listener {
|
2022-12-04 21:39:06 +00:00
|
|
|
fn new() -> std::io::Result<Self> {
|
2022-12-04 05:03:55 +00:00
|
|
|
let sock_dir = std::env::var("XDG_RUNTIME_DIR").expect("XDG_RUNTIME_DIR not set");
|
|
|
|
let sock_dir = Path::new(&sock_dir);
|
|
|
|
let sock_path = sock_dir.join(SOCK_NAME);
|
|
|
|
|
2022-12-04 21:39:06 +00:00
|
|
|
use std::io::{Error, ErrorKind};
|
2022-12-04 06:08:36 +00:00
|
|
|
match UnixStream::connect(&sock_path) {
|
|
|
|
Ok(_) => {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::warn!("Socket is already in use. Another instance of Magpie may be running.");
|
2022-12-04 06:08:36 +00:00
|
|
|
let kind = ErrorKind::AddrInUse;
|
|
|
|
let error = Error::new(kind, "Socket is already in use.");
|
|
|
|
return Err(error);
|
|
|
|
}
|
|
|
|
Err(ref err) if err.kind() == ErrorKind::ConnectionRefused => {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::warn!("Found leftover socket; removing.");
|
2022-12-04 06:08:36 +00:00
|
|
|
std::fs::remove_file(&sock_path)?;
|
|
|
|
}
|
|
|
|
Err(ref err) if err.kind() == ErrorKind::NotFound => {}
|
2022-12-04 21:39:06 +00:00
|
|
|
Err(err) => return Err(err),
|
2022-12-04 06:08:36 +00:00
|
|
|
}
|
|
|
|
|
2022-12-06 04:53:38 +00:00
|
|
|
log::info!("Making socket at: {:?}", sock_path);
|
2022-12-04 05:03:55 +00:00
|
|
|
let uds = UnixListener::bind(&sock_path)?;
|
|
|
|
let path = sock_path.to_path_buf();
|
2022-12-04 21:39:06 +00:00
|
|
|
Ok(Self { uds, path })
|
2022-12-04 05:03:55 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-10-29 22:54:51 +00:00
|
|
|
pub struct IpcData {
|
|
|
|
poll: Poll,
|
2022-11-17 05:17:17 +00:00
|
|
|
window_to_client_panel: HashMap<usize, (usize, PanelId)>,
|
2022-10-29 23:07:34 +00:00
|
|
|
next_window_id: usize,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl IpcData {
|
|
|
|
pub fn new_window_id(&mut self) -> usize {
|
|
|
|
let id = self.next_window_id;
|
|
|
|
self.next_window_id = self.next_window_id.wrapping_add(1);
|
|
|
|
id
|
|
|
|
}
|
2022-10-29 22:54:51 +00:00
|
|
|
}
|
|
|
|
|
2022-10-29 05:22:36 +00:00
|
|
|
pub struct Client {
|
2022-10-29 22:54:51 +00:00
|
|
|
data: Arc<RwLock<IpcData>>,
|
|
|
|
window_sender: WindowMessageSender,
|
2022-10-29 20:42:41 +00:00
|
|
|
messenger: ServerMessenger<UnixStream>,
|
|
|
|
token: Token,
|
2022-10-29 23:07:34 +00:00
|
|
|
id_to_window: HashMap<u32, usize>,
|
|
|
|
}
|
|
|
|
|
2022-10-29 05:22:36 +00:00
|
|
|
impl Client {
|
|
|
|
pub fn on_readable(&mut self) -> std::io::Result<bool> {
|
2022-11-17 06:04:42 +00:00
|
|
|
if let Err(err) = self.messenger.flush_recv() {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::error!("flush_recv() error: {:?}", err);
|
2022-11-17 06:04:42 +00:00
|
|
|
}
|
2022-10-29 05:22:36 +00:00
|
|
|
|
2022-11-20 18:15:50 +00:00
|
|
|
while let Some(msg) = self.messenger.try_recv() {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::debug!("Client #{}: {:?}", self.token.0, msg);
|
2022-10-29 22:54:51 +00:00
|
|
|
match msg {
|
2022-11-16 06:51:52 +00:00
|
|
|
MagpieServerMsg::CreatePanel(CreatePanel {
|
|
|
|
id,
|
|
|
|
protocol,
|
|
|
|
script,
|
2022-12-06 23:59:06 +00:00
|
|
|
init_msg,
|
2022-11-16 06:51:52 +00:00
|
|
|
}) => {
|
2022-11-17 06:04:42 +00:00
|
|
|
let mut data = self.data.write();
|
|
|
|
|
|
|
|
let window = data.new_window_id();
|
|
|
|
data.window_to_client_panel
|
|
|
|
.insert(window, (self.token.0, id));
|
2022-10-29 23:07:34 +00:00
|
|
|
|
|
|
|
if let Some(old_id) = self.id_to_window.insert(id, window) {
|
|
|
|
let msg = WindowMessage::CloseWindow { id: old_id };
|
|
|
|
let _ = self.window_sender.send_event(msg);
|
|
|
|
}
|
|
|
|
|
2022-11-16 06:51:52 +00:00
|
|
|
let msg = WindowMessage::OpenWindow {
|
|
|
|
id: window,
|
|
|
|
protocol,
|
|
|
|
script,
|
2022-12-06 23:59:06 +00:00
|
|
|
init_msg,
|
2022-11-16 06:51:52 +00:00
|
|
|
};
|
2022-10-29 22:54:51 +00:00
|
|
|
let _ = self.window_sender.send_event(msg);
|
|
|
|
}
|
2022-12-08 01:00:34 +00:00
|
|
|
MagpieServerMsg::ClosePanel(ClosePanel { id }) => {
|
|
|
|
if let Some(id) = self.id_to_window.get(&id).copied() {
|
|
|
|
let msg = WindowMessage::CloseWindow { id };
|
|
|
|
let _ = self.window_sender.send_event(msg);
|
|
|
|
}
|
|
|
|
}
|
2022-10-31 01:11:24 +00:00
|
|
|
MagpieServerMsg::SendMessage(SendMessage { id, msg }) => {
|
|
|
|
if let Some(id) = self.id_to_window.get(&id).cloned() {
|
|
|
|
let msg = WindowMessage::SendMessage { id, msg };
|
|
|
|
let _ = self.window_sender.send_event(msg);
|
|
|
|
}
|
|
|
|
}
|
2022-10-29 22:54:51 +00:00
|
|
|
}
|
2022-10-29 05:22:36 +00:00
|
|
|
}
|
|
|
|
|
2022-10-29 20:42:41 +00:00
|
|
|
Ok(self.messenger.is_closed())
|
2022-10-29 05:22:36 +00:00
|
|
|
}
|
2022-11-17 21:46:48 +00:00
|
|
|
|
|
|
|
pub fn disconnect(mut self) {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::info!("Client #{} disconnected", self.token.0);
|
2022-11-17 21:46:48 +00:00
|
|
|
|
|
|
|
let mut transport = self.messenger.into_transport();
|
|
|
|
let mut data = self.data.write();
|
|
|
|
let _ = data.poll.registry().deregister(&mut transport);
|
|
|
|
|
|
|
|
for (_id, window) in self.id_to_window.drain() {
|
|
|
|
let msg = WindowMessage::CloseWindow { id: window };
|
|
|
|
let _ = self.window_sender.send_event(msg);
|
|
|
|
data.window_to_client_panel.remove(&window);
|
|
|
|
}
|
|
|
|
}
|
2022-10-29 05:22:36 +00:00
|
|
|
}
|
2022-10-28 02:15:47 +00:00
|
|
|
|
|
|
|
pub struct Ipc {
|
2022-10-29 22:54:51 +00:00
|
|
|
pub data: Arc<RwLock<IpcData>>,
|
2022-10-28 04:23:03 +00:00
|
|
|
pub window_sender: WindowMessageSender,
|
2022-10-29 22:54:51 +00:00
|
|
|
pub message_recv: Receiver<IpcMessage>,
|
2022-10-28 02:15:47 +00:00
|
|
|
pub quit: bool,
|
|
|
|
pub listener: Listener,
|
|
|
|
pub signals: Signals,
|
|
|
|
pub listener_token: Token,
|
|
|
|
pub signals_token: Token,
|
2022-10-28 04:23:03 +00:00
|
|
|
pub message_recv_token: Token,
|
2022-10-28 02:15:47 +00:00
|
|
|
pub clients: Slab<Client>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Ipc {
|
2022-10-28 04:52:42 +00:00
|
|
|
pub fn new(window_sender: WindowMessageSender) -> std::io::Result<(Self, IpcMessageSender)> {
|
2022-12-04 05:03:55 +00:00
|
|
|
let mut listener = Listener::new()?;
|
2022-10-28 02:15:47 +00:00
|
|
|
|
|
|
|
let mut signals = Signals::new(Signal::Interrupt | Signal::Quit)?;
|
|
|
|
|
|
|
|
let poll = Poll::new()?;
|
|
|
|
let listener_token = Token(usize::MAX);
|
|
|
|
let signals_token = Token(listener_token.0 - 1);
|
2022-10-28 04:23:03 +00:00
|
|
|
let message_recv_token = Token(signals_token.0 - 1);
|
2022-10-28 02:15:47 +00:00
|
|
|
|
|
|
|
let registry = poll.registry();
|
|
|
|
let interest = Interest::READABLE;
|
|
|
|
registry.register(&mut listener.uds, listener_token, interest)?;
|
|
|
|
registry.register(&mut signals, signals_token, interest)?;
|
|
|
|
|
2022-10-28 04:52:42 +00:00
|
|
|
let (sender, message_recv) = channel();
|
|
|
|
|
|
|
|
let sender = IpcMessageSender {
|
2022-11-17 05:17:17 +00:00
|
|
|
waker: Arc::new(Waker::new(registry, message_recv_token)?),
|
2022-10-28 04:52:42 +00:00
|
|
|
sender,
|
|
|
|
};
|
|
|
|
|
2022-10-29 23:07:34 +00:00
|
|
|
let data = IpcData {
|
|
|
|
poll,
|
2022-11-17 05:17:17 +00:00
|
|
|
window_to_client_panel: HashMap::new(),
|
2022-10-29 23:07:34 +00:00
|
|
|
next_window_id: 0,
|
|
|
|
};
|
2022-10-29 22:54:51 +00:00
|
|
|
|
2022-10-28 04:52:42 +00:00
|
|
|
let ipc = Self {
|
2022-10-29 22:54:51 +00:00
|
|
|
data: Arc::new(RwLock::new(data)),
|
2022-10-28 04:23:03 +00:00
|
|
|
window_sender,
|
2022-10-29 22:54:51 +00:00
|
|
|
message_recv,
|
2022-10-28 02:15:47 +00:00
|
|
|
quit: false,
|
|
|
|
listener,
|
|
|
|
signals,
|
|
|
|
listener_token,
|
|
|
|
signals_token,
|
2022-10-28 04:23:03 +00:00
|
|
|
message_recv_token,
|
2022-10-28 02:15:47 +00:00
|
|
|
clients: Default::default(),
|
2022-10-28 04:52:42 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
Ok((ipc, sender))
|
2022-10-28 02:15:47 +00:00
|
|
|
}
|
|
|
|
|
2022-11-17 06:04:42 +00:00
|
|
|
pub fn on_message(&mut self, msg: IpcMessage) -> std::io::Result<()> {
|
|
|
|
match msg {
|
|
|
|
IpcMessage::PanelMessage { window, message } => {
|
|
|
|
let data = self.data.read();
|
|
|
|
let (client, panel) = *data.window_to_client_panel.get(&window).unwrap();
|
|
|
|
let client = self.clients.get_mut(client).unwrap();
|
|
|
|
let reply = RecvMessage {
|
|
|
|
id: panel,
|
|
|
|
msg: message,
|
|
|
|
};
|
|
|
|
client
|
|
|
|
.messenger
|
|
|
|
.send(&MagpieClientMsg::RecvMessage(reply))?;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn poll(&mut self, events: &mut Events, timeout: Option<Duration>) -> std::io::Result<()> {
|
|
|
|
self.data.write().poll.poll(events, timeout)?;
|
2022-10-28 02:15:47 +00:00
|
|
|
|
2022-11-17 06:04:42 +00:00
|
|
|
for event in events.iter() {
|
2022-10-28 02:15:47 +00:00
|
|
|
if event.token() == self.listener_token {
|
|
|
|
loop {
|
|
|
|
match self.listener.accept() {
|
2022-10-29 20:42:41 +00:00
|
|
|
Ok((mut connection, address)) => {
|
2022-10-29 05:22:36 +00:00
|
|
|
let token = Token(self.clients.vacant_key());
|
2022-12-06 04:53:38 +00:00
|
|
|
log::info!(
|
2022-10-29 05:22:36 +00:00
|
|
|
"Accepting connection (Client #{}) from {:?}",
|
2022-12-06 04:53:38 +00:00
|
|
|
token.0,
|
|
|
|
address
|
2022-10-29 05:22:36 +00:00
|
|
|
);
|
2022-10-29 20:42:41 +00:00
|
|
|
|
2022-10-29 05:22:36 +00:00
|
|
|
let interest = Interest::READABLE;
|
2022-10-29 22:54:51 +00:00
|
|
|
self.data.write().poll.registry().register(
|
|
|
|
&mut connection,
|
|
|
|
token,
|
|
|
|
interest,
|
|
|
|
)?;
|
|
|
|
|
|
|
|
self.clients.insert(Client {
|
|
|
|
messenger: ServerMessenger::new(connection),
|
|
|
|
token,
|
|
|
|
data: self.data.clone(),
|
|
|
|
window_sender: self.window_sender.clone(),
|
2022-10-29 23:07:34 +00:00
|
|
|
id_to_window: Default::default(),
|
2022-10-29 22:54:51 +00:00
|
|
|
});
|
2022-10-28 02:15:47 +00:00
|
|
|
}
|
|
|
|
Err(ref err) if err.kind() == std::io::ErrorKind::WouldBlock => break,
|
|
|
|
Err(err) => return Err(err),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else if event.token() == self.signals_token {
|
|
|
|
while let Some(received) = self.signals.receive()? {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::info!("Received {:?} signal; exiting...", received);
|
2022-10-28 04:23:03 +00:00
|
|
|
let _ = self.window_sender.send_event(WindowMessage::Quit);
|
2022-10-28 02:15:47 +00:00
|
|
|
self.quit = true;
|
|
|
|
}
|
2022-11-17 06:04:42 +00:00
|
|
|
} else if event.token() == self.message_recv_token {
|
|
|
|
while let Ok(received) = self.message_recv.try_recv() {
|
|
|
|
self.on_message(received)?;
|
|
|
|
}
|
2022-10-28 04:52:42 +00:00
|
|
|
} else if let Some(client) = self.clients.get_mut(event.token().0) {
|
2022-10-29 05:22:36 +00:00
|
|
|
let disconnected = client.on_readable()?;
|
|
|
|
if disconnected {
|
2022-11-17 21:46:48 +00:00
|
|
|
self.clients.remove(event.token().0).disconnect();
|
2022-10-29 05:22:36 +00:00
|
|
|
}
|
2022-10-28 02:15:47 +00:00
|
|
|
} else {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::error!("Unrecognized event token: {:?}", event);
|
2022-10-28 02:15:47 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn run(mut self) {
|
2022-11-17 06:04:42 +00:00
|
|
|
let mut events = Events::with_capacity(128);
|
2022-10-28 02:15:47 +00:00
|
|
|
while !self.quit {
|
|
|
|
let wait = Duration::from_millis(100);
|
2022-11-17 06:04:42 +00:00
|
|
|
match self.poll(&mut events, Some(wait)) {
|
2022-10-28 02:15:47 +00:00
|
|
|
Ok(_) => {}
|
|
|
|
Err(e) => {
|
2022-12-06 04:53:38 +00:00
|
|
|
log::error!("IPC poll error: {:?}", e);
|
2022-10-28 02:15:47 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|