koan_core/remote/

link.rs

//! A koan client's standing connection to the koan server it syncs from.
//!
//! The server can then act on the client: play a list of tracks on a phone, or
//! pause it. Subsonic has no way for a server to reach a client, so this is a
//! koan extension: a WebSocket at `/rest/koanLink`, authenticated like every
//! other `/rest` call, carrying [`LinkCommand`]s as JSON text frames from the
//! server. Track ids are the server's, which a synced client holds as each
//! track's `remote_id`.

use std::collections::HashMap;
use std::net::TcpStream;
use std::os::fd::RawFd;
use std::path::Path;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::{Arc, LazyLock};
use std::time::{Duration, Instant};

use parking_lot::{Condvar, Mutex};
use serde::{Deserialize, Serialize};
use tungstenite::stream::MaybeTlsStream;

use crate::config::{self, Config};
use crate::helpers::{subsonic_auth, subsonic_client};
use crate::player::state::QueueMode;
use crate::remote::client::SubsonicAuth;
pub use crate::remote::outputs::{LinkOutput, LinkOutputs, OutputChoice};
use crate::remote::profile;
use crate::remote::wire::{self, Waker};

/// What a server asks a linked client to do.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum LinkCommand {
    /// Replace the queue with these tracks and play from `start_at`,
    /// `position_ms` into it — or load it there paused, when `paused`.
    #[serde(rename_all = "camelCase")]
    Play {
        track_ids: Vec<String>,
        #[serde(default)]
        start_at: u32,
        #[serde(default, skip_serializing_if = "is_zero")]
        position_ms: u64,
        #[serde(default, skip_serializing_if = "std::ops::Not::not")]
        paused: bool,
        /// Sent by a device handing its music over. One that receives it
        /// while controlling another device takes control back: the music
        /// is here now, so this device is what the person is listening to.
        /// A plain play leaves control alone, so two devices can still
        /// control each other on purpose.
        #[serde(default, skip_serializing_if = "std::ops::Not::not")]
        handoff: bool,
        /// Whether to reset the play mode, as a play from a play button
        /// does. Absent, the modes are kept.
        #[serde(default, skip_serializing_if = "QueueMode::is_keep")]
        mode: QueueMode,
    },
    /// Append these tracks to the queue.
    #[serde(rename_all = "camelCase")]
    Enqueue {
        track_ids: Vec<String>,
    },
    /// Insert these tracks after the current one.
    #[serde(rename_all = "camelCase")]
    PlayNext {
        track_ids: Vec<String>,
    },
    /// Take every queue entry for these tracks out of the queue.
    #[serde(rename_all = "camelCase")]
    Remove {
        track_ids: Vec<String>,
    },
    Clear,
    /// Pull what the server has changed: library, favourites and playlists.
    /// The library is walked only if the server says it moved, unless `full`,
    /// which walks it regardless.
    Sync {
        #[serde(default)]
        full: bool,
    },
    /// Delete the downloaded copies of these tracks, so the next play fetches
    /// them again: for a copy that was cached while the server's was bad.
    #[serde(rename_all = "camelCase")]
    Evict {
        track_ids: Vec<String>,
    },
    /// Play this track: from where it sits in the queue, or slotted in after
    /// the current one when the queue does not hold it.
    #[serde(rename_all = "camelCase")]
    JumpTo {
        track_id: String,
    },
    #[serde(rename_all = "camelCase")]
    Seek {
        position_ms: u64,
    },
    Pause,
    Resume,
    Next,
    Previous,
    /// Play this queue entry, by the id the device reported it under. Unlike
    /// `JumpTo` it names one entry of a track queued twice, and reaches a file
    /// only that device has.
    PlayItem {
        id: String,
    },
    RemoveItems {
        ids: Vec<String>,
    },
    /// Move these queue entries before or after `target`, in the order given.
    MoveItems {
        ids: Vec<String>,
        target: String,
        after: bool,
    },
    /// Insert these tracks after the queue entry `after`.
    #[serde(rename_all = "camelCase")]
    Insert {
        track_ids: Vec<String>,
        after: String,
    },
    Undo,
    Redo,
    /// Turn shuffle on or off. The queue keeps its order; shuffle picks
    /// which track yet to play this pass plays next.
    Shuffle {
        on: bool,
    },
    /// What follows a track at its end: `off`, `queue` or `one`.
    Repeat {
        mode: crate::player::state::Repeat,
    },
    /// Set the sleep timer, or with none cancel it.
    SleepTimer {
        timer: Option<crate::player::state::SleepTimer>,
    },
    /// Send this device's queue and playhead to the device `to`, as a `play`,
    /// and pause here. The device holding the queue does it, so taking music
    /// from another device and sending it there are one command.
    HandOff {
        to: String,
    },
    /// The account's other devices, as they are now. News rather than a
    /// command: sent whenever one of them changes, to links that asked for it.
    Devices {
        devices: Vec<LinkDevice>,
    },
    /// The public keys the account's devices, and devices shared with it,
    /// prove themselves with on the local network (`koanDeviceKeys`). News,
    /// as `Devices` is: sent when a device that registered a key links, and
    /// whenever the account's keys change. From the server alone, never from
    /// the network: it is what the network's claims are checked against.
    DeviceKeys {
        keys: Vec<LinkDeviceKey>,
    },
    /// The accounts this device lets control it. News, as `Devices` is: sent
    /// when it links and whenever the list changes.
    Shares {
        grantees: Vec<String>,
        /// Why the last request to share or stop sharing was refused.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        error: Option<String>,
        /// Every account on the server, to choose from.
        #[serde(default, skip_serializing_if = "Vec::is_empty")]
        accounts: Vec<String>,
    },
    /// `command`, sent by another account this device is shared with: run as
    /// that account's request, from the playback set (`allowed_playback`).
    Shared {
        command: Box<LinkCommand>,
    },
    /// `device` was forgotten: drop it, however it was last heard of. News,
    /// as `Devices` is.
    Forgotten {
        device: String,
    },
    /// The account's play history on the server moved: a play recorded or
    /// forgotten on one of its devices. The device reads what changed
    /// (`remote::history::sync`).
    HistoryChanged,
    /// The account's EQ profiles kept everywhere moved on the server: one
    /// changed or deleted on another of its devices. The device reads what
    /// changed (`remote::dsp_sync::sync`).
    DspProfilesChanged,
    /// Play through this output from now on, carrying on from where the music
    /// is, as the device's own output menu would.
    SetOutput {
        output: OutputChoice,
    },
    /// List the outputs again, and publish them if they moved: a controller
    /// has opened its output menu. Cheap, and answered by the link state.
    RefreshOutputs,
    /// The volume of the renderer the device plays to, 0–100.
    SetRendererVolume {
        volume: u8,
    },
    /// Play the output `device` through the DSP profile `profile`, or
    /// untouched with `None`. A renderer is named by its UDN.
    SetPreset {
        device: String,
        profile: Option<String>,
    },
    /// Send this device's audio levels (`LinkReport::Levels`) while `on`: a
    /// controller has playing bars on screen. A device on the same network may
    /// ask; levels say no more than the now-playing it already sees.
    WatchLevels {
        on: bool,
    },
    /// A frame of the levels of `from`, a device this one watches, relayed by
    /// the server. News, like `Devices`.
    Levels {
        from: String,
        f: crate::remote::levels::Frame,
    },
    /// The device `from` answered the command this device sent it under
    /// `ack`: see `remote::acks`. Relayed by the server; news, like `Levels`.
    Acked {
        from: String,
        ack: u64,
        outcome: crate::remote::acks::AckOutcome,
    },
}

fn is_zero(n: &u64) -> bool {
    *n == 0
}

impl LinkCommand {
    /// What a device that is not this account's may have it do: play, pause,
    /// skip and seek, change the queue, jump, set the volume and the sleep
    /// timer, choose the output and the preset, and move the music here or
    /// away. What it asks for runs as the asker's request, never with this
    /// account's powers: nothing here changes the library, the config beyond
    /// the output in use, or the account's favourites, playlists or history,
    /// and a track it names that the library lacks is not synced for (see
    /// `CommandSource`).
    /// For a device shared with another account, and one on the local network
    /// under Full control.
    pub fn allowed_playback(&self) -> bool {
        match self {
            Self::Play { .. }
            | Self::Enqueue { .. }
            | Self::PlayNext { .. }
            | Self::Remove { .. }
            | Self::Clear
            | Self::JumpTo { .. }
            | Self::Seek { .. }
            | Self::Pause
            | Self::Resume
            | Self::Next
            | Self::Previous
            | Self::PlayItem { .. }
            | Self::RemoveItems { .. }
            | Self::MoveItems { .. }
            | Self::Insert { .. }
            | Self::Undo
            | Self::Redo
            | Self::Shuffle { .. }
            | Self::Repeat { .. }
            | Self::SleepTimer { .. }
            | Self::HandOff { .. }
            | Self::SetOutput { .. }
            | Self::RefreshOutputs
            | Self::SetRendererVolume { .. }
            | Self::SetPreset { .. }
            | Self::WatchLevels { .. } => true,
            // The library, and the server's own news.
            Self::Sync { .. }
            | Self::Evict { .. }
            | Self::Devices { .. }
            | Self::DeviceKeys { .. }
            | Self::Shares { .. }
            | Self::Shared { .. }
            | Self::Forgotten { .. }
            | Self::HistoryChanged
            | Self::DspProfilesChanged
            | Self::Levels { .. }
            | Self::Acked { .. } => false,
        }
    }

    /// How a command from a device on the local network runs here, if at
    /// all: with `full` control (this device's setting) the playback set, as
    /// `Nearby`; without, a stranger's narrower set, as `Stranger`.
    pub fn from_the_network(&self, full: bool) -> Option<CommandSource> {
        if full {
            self.allowed_playback().then_some(CommandSource::Nearby)
        } else {
            self.allowed_nearby().then_some(CommandSource::Stranger)
        }
    }

    /// Whether a client may have the server relay this to another device:
    /// the commands one device gives another. The server's own news (the
    /// device list, the device keys, shares, forgettings, history) it alone
    /// originates; relayed, a forged copy would read as the server's. Levels
    /// go only between live links, by their own route. Exhaustive, so a new
    /// variant is relayable only once someone decides it is.
    pub fn relayable(&self) -> bool {
        match self {
            Self::Play { .. }
            | Self::Enqueue { .. }
            | Self::PlayNext { .. }
            | Self::Remove { .. }
            | Self::Clear
            | Self::Sync { .. }
            | Self::Evict { .. }
            | Self::JumpTo { .. }
            | Self::Seek { .. }
            | Self::Pause
            | Self::Resume
            | Self::Next
            | Self::Previous
            | Self::PlayItem { .. }
            | Self::RemoveItems { .. }
            | Self::MoveItems { .. }
            | Self::Insert { .. }
            | Self::Undo
            | Self::Redo
            | Self::Shuffle { .. }
            | Self::Repeat { .. }
            | Self::SleepTimer { .. }
            | Self::HandOff { .. }
            | Self::SetOutput { .. }
            | Self::RefreshOutputs
            | Self::SetRendererVolume { .. }
            | Self::SetPreset { .. } => true,
            Self::Devices { .. }
            | Self::DeviceKeys { .. }
            | Self::Acked { .. }
            | Self::Shares { .. }
            | Self::Shared { .. }
            | Self::Forgotten { .. }
            | Self::HistoryChanged
            | Self::DspProfilesChanged
            | Self::WatchLevels { .. }
            | Self::Levels { .. } => false,
        }
    }

    /// Only worth saying to a device that is there to hear it: sent over a
    /// live route or not at all, never queued for an absent device and never
    /// a push to wake one.
    pub fn live_only(&self) -> bool {
        match self {
            Self::Shared { command } => command.live_only(),
            cmd => matches!(cmd, Self::WatchLevels { .. } | Self::RefreshOutputs),
        }
    }

    /// Whether a device on the same network, which may belong to anyone, may
    /// send this under Playback only. Playback and the queue; nothing that touches the library or
    /// the files on disk.
    ///
    /// Where the sound goes is not playback: an output switch reaches into
    /// the room, and a preset into the config. Those are the account's own.
    pub fn allowed_nearby(&self) -> bool {
        !matches!(
            self,
            Self::Sync { .. }
                | Self::Evict { .. }
                | Self::Devices { .. }
                | Self::DeviceKeys { .. }
                | Self::Forgotten { .. }
                | Self::HistoryChanged
                | Self::DspProfilesChanged
                | Self::Levels { .. }
                | Self::Acked { .. }
                | Self::SetOutput { .. }
                | Self::RefreshOutputs
                | Self::SetRendererVolume { .. }
                | Self::SetPreset { .. }
                | Self::Shares { .. }
                | Self::Shared { .. }
        )
    }

    /// The server's ids for the tracks this command names, if any.
    pub fn track_ids(&self) -> &[String] {
        match self {
            Self::Play { track_ids, .. }
            | Self::Enqueue { track_ids }
            | Self::PlayNext { track_ids }
            | Self::Remove { track_ids }
            | Self::Evict { track_ids }
            | Self::Insert { track_ids, .. } => track_ids,
            Self::JumpTo { track_id } => std::slice::from_ref(track_id),
            Self::Shared { command } => command.track_ids(),
            _ => &[],
        }
    }
}

/// Where a command came from, which decides what it may cost.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CommandSource {
    /// The signed-in server, or this person's own devices through it. The
    /// only source that may cost a sync.
    Account,
    /// Another account this device is shared with, through the server: the
    /// playback set (`allowed_playback`), as that account.
    Shared,
    /// A device on the local network, with this device set to Full control:
    /// the playback set, whoever is signed in there.
    Nearby,
    /// A device on the local network, with this device set to Playback only:
    /// a stranger's set (`allowed_nearby`), and a hand-off that stays on the
    /// network.
    Stranger,
}

/// A device's public key, as `LinkCommand::DeviceKeys` carries it.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct LinkDeviceKey {
    /// The device's id.
    pub id: String,
    /// Base64 of its 32-byte Ed25519 public key.
    pub key: String,
    /// The account it belongs to, for a device shared with this one's: `None`
    /// for the account's own.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub owner: Option<String>,
}

/// Whether `key` is a public key a device may register: base64 of 32 bytes,
/// the size of an Ed25519 public key.
pub fn valid_device_key(key: &str) -> bool {
    use base64::Engine as _;
    base64::engine::general_purpose::STANDARD
        .decode(key)
        .is_ok_and(|bytes| bytes.len() == 32)
}

/// Another device on the same account, as the server sends it.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkDevice {
    /// The device's own id: stable across its reconnects.
    pub id: String,
    pub name: String,
    pub platform: String,
    /// Linked now. A device that is not is one iOS has suspended: a command
    /// wakes it, and music reaches it as a notification to tap.
    pub linked: bool,
    /// What it last reported, with the playhead placed as of sending. `None`
    /// until it has reported at all.
    pub state: Option<LinkState>,
    /// Unix seconds when it last held a link, for one that does not now.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub last_seen: Option<i64>,
    /// Whether the server can wake it once it is not linked: it gave a push
    /// token, and the server has a push key. `None` from a server older than
    /// this, which listed an absent device only when it had a token.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub wakeable: Option<bool>,
    /// The account it belongs to, for a device another account shares: `None`
    /// for the account's own.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub owner: Option<String>,
    /// It answers commands sent with an id, which the server relays: see
    /// `remote::acks`. False from a server or a device that predates that.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub acks: bool,
}

impl LinkCommand {
    /// Every track id the command carries, for translating between the
    /// server's row ids and the uids it publishes.
    pub fn track_ids_mut(&mut self) -> Vec<&mut String> {
        match self {
            Self::Play { track_ids, .. }
            | Self::Enqueue { track_ids }
            | Self::PlayNext { track_ids }
            | Self::Remove { track_ids }
            | Self::Evict { track_ids }
            | Self::Insert { track_ids, .. } => track_ids.iter_mut().collect(),
            Self::JumpTo { track_id } => vec![track_id],
            Self::Shared { command } => command.track_ids_mut(),
            Self::PlayItem { .. }
            | Self::RemoveItems { .. }
            | Self::MoveItems { .. }
            | Self::Undo
            | Self::Redo
            | Self::Shuffle { .. }
            | Self::Repeat { .. }
            | Self::SleepTimer { .. }
            | Self::HandOff { .. }
            | Self::Devices { .. }
            | Self::DeviceKeys { .. }
            | Self::Shares { .. }
            | Self::Forgotten { .. }
            | Self::HistoryChanged
            | Self::DspProfilesChanged
            | Self::WatchLevels { .. }
            | Self::Levels { .. }
            | Self::Acked { .. }
            | Self::SetOutput { .. }
            | Self::RefreshOutputs
            | Self::SetRendererVolume { .. }
            | Self::SetPreset { .. }
            | Self::Clear
            | Self::Sync { .. }
            | Self::Seek { .. }
            | Self::Pause
            | Self::Resume
            | Self::Next
            | Self::Previous => Vec::new(),
        }
    }
}

/// What a linked client tells the server about itself, as it changes.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkState {
    pub playing: bool,
    pub title: Option<String>,
    pub artist: Option<String>,
    #[serde(default)]
    pub album: Option<String>,
    /// Into the current track, as of when this was sent.
    #[serde(default)]
    pub position_ms: u64,
    #[serde(default)]
    pub duration_ms: u64,
    /// The queue, or the part of it around the current track when it is long.
    #[serde(default)]
    pub queue: Vec<LinkQueueEntry>,
    /// What the device can play through, for the device controlling it.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub outputs: Option<LinkOutputs>,
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub shuffle: bool,
    #[serde(default, skip_serializing_if = "crate::player::state::Repeat::is_off")]
    pub repeat: crate::player::state::Repeat,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sleep: Option<crate::player::state::Sleep>,
    /// The sleep timer is fading playback out.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub sleep_fading: bool,
}

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkQueueEntry {
    /// The queue entry's own id on that device, for `playItem` and the rest.
    #[serde(default)]
    pub id: Option<String>,
    /// The server's id for the track; `None` for a file only this device has.
    pub track_id: Option<String>,
    pub title: String,
    pub artist: String,
    #[serde(default)]
    pub album: String,
    #[serde(default)]
    pub duration_ms: u64,
    pub current: bool,
}

impl LinkState {
    /// Whether `self` says something `sent`, reported `elapsed` ago, did not.
    /// A playhead moving at one second per second is not news; a seek, a
    /// pause, another track or an edited queue is.
    pub fn differs(&self, sent: &LinkState, elapsed: Duration) -> bool {
        let strip = |s: &LinkState| LinkState {
            position_ms: 0,
            ..s.clone()
        };
        if strip(self) != strip(sent) {
            return true;
        }
        let expected = if sent.playing {
            sent.position_ms + elapsed.as_millis() as u64
        } else {
            sent.position_ms
        };
        self.position_ms.abs_diff(expected) > 3000
    }
}

/// A message from a client, up the same socket.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum LinkReport {
    State(LinkState),
    /// Where Apple's push service reaches this device, so the server can wake
    /// it once iOS has suspended it and the socket is gone. `sandbox` for a
    /// development build, whose tokens only the sandbox gateway accepts.
    Push {
        token: String,
        sandbox: bool,
    },
    /// Send `command` to the device `to` on the same account. `ack` asks the
    /// server to relay `to`'s answer: see `remote::acks`. A server that
    /// predates it ignores it.
    Command {
        to: String,
        command: LinkCommand,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        ack: Option<u64>,
    },
    /// A command sent under `ack` has come off this device's link, before
    /// it is acted on: what tells the server the link is alive, however long
    /// the command then takes.
    Received {
        ack: u64,
    },
    /// This device's answer to a command sent to it under `ack`.
    Ack {
        ack: u64,
        outcome: crate::remote::acks::AckOutcome,
    },
    /// Where to push updates to a Live Activity showing the device `device`;
    /// `None` for both when the activity has ended.
    Activity {
        token: Option<String>,
        device: Option<String>,
        #[serde(default)]
        sandbox: bool,
    },
    /// Who is at the other end of a connection made on the local network.
    Hello(LinkHello),
    /// Wake the device `to`, which is not linked: with a background push, or
    /// with `notify` a notification to tap, for when the push has not done it.
    Wake {
        to: String,
        #[serde(default)]
        notify: bool,
    },
    /// Let the account `grantee` control this device, or with `allow` false
    /// stop letting it. Only ever about the device sending it.
    Share {
        grantee: String,
        allow: bool,
    },
    /// Forget `device`, one of this account's that is not linked: its record
    /// and its push token. It is listed again if it links again.
    Forget {
        device: String,
    },
    /// A frame of this device's audio levels, while it is watched: see
    /// `LinkCommand::WatchLevels`. Sent at the analyser's rate, so short.
    Levels {
        f: crate::remote::levels::Frame,
    },
}

/// How a device introduces itself to one that connected to it over the local
/// network, before anything else.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkHello {
    pub id: String,
    pub name: String,
    pub platform: String,
    /// Which library it plays from, as `library_fingerprint` gives it; `None`
    /// when it is signed in to none. Two devices with the same one share track
    /// ids, so music can be handed between them.
    pub library: Option<String>,
    /// It answers commands sent with an id: see `remote::acks`. False from a
    /// device that predates that.
    #[serde(default)]
    pub acks: bool,
    /// From a listener that proves itself and asks the same of whoever
    /// dialled it: the nonce to sign over. See `remote::proof`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nonce: Option<String>,
}

/// The server this client plays from, as something two devices can compare
/// without either saying its address to the network.
pub fn library_fingerprint(cfg: &Config) -> Option<String> {
    let auth = subsonic_auth(cfg)?;
    let url = auth.base_url.trim_end_matches('/').to_ascii_lowercase();
    Some(format!("{:x}", md5::compute(url.as_bytes())))
}

/// This device's push token, once the OS has issued one. Set by the app; sent
/// up each link as it opens, and again if it changes.
static PUSH_TOKEN: Mutex<Option<(String, bool)>> = Mutex::new(None);

/// A Live Activity on this device showing another: its push token, the device
/// it shows, and whether the token is the sandbox's. Sent up each link as it
/// opens, and again when it changes; `None` once the activity has ended.
type ActivityToken = (String, String, bool);
static ACTIVITY: Mutex<Option<Option<ActivityToken>>> = Mutex::new(None);

/// Record where the server should push updates to this device's Live
/// Activity, or that there is none now.
pub fn set_activity(activity: Option<ActivityToken>) {
    *ACTIVITY.lock() = Some(activity);
    if let Some(up) = LINK.lock().as_ref() {
        up.waker.wake();
    }
}

/// A command as a push notification carries it: the same JSON as over the
/// link.
pub fn parse_command(json: &str) -> Result<LinkCommand, String> {
    serde_json::from_str(json).map_err(|e| e.to_string())
}

/// Record the push token the OS issued this app, and link now to send it.
pub fn set_push_token(token: String, sandbox: bool) {
    *PUSH_TOKEN.lock() = Some((token, sandbox));
    nudge();
    if let Some(up) = LINK.lock().as_ref() {
        up.waker.wake();
    }
}

/// How a client describes itself when it links.
#[derive(Debug, Clone)]
pub struct LinkIdentity {
    /// Shown to whoever picks a client to play on: "James's iPhone".
    pub name: String,
    /// `ios`, `macos` or `linux`.
    pub platform: String,
    /// Stable across restarts, so a reconnect replaces its own entry on the
    /// server rather than listing the device twice.
    pub device_id: String,
}

impl LinkIdentity {
    /// This machine, named `name` or else by its hostname.
    pub fn this_device(name: Option<String>) -> Self {
        let (platform, label) = if cfg!(target_os = "ios") {
            ("ios", "iPhone")
        } else if cfg!(target_os = "tvos") {
            ("tvos", "Apple TV")
        } else if cfg!(target_os = "macos") {
            ("macos", "Mac")
        } else {
            ("linux", "Linux")
        };
        Self {
            name: name
                .filter(|n| !n.trim().is_empty())
                .or_else(hostname)
                .unwrap_or_else(|| label.to_string()),
            platform: platform.to_string(),
            device_id: device_id(&config::config_dir()),
        }
    }
}

/// What this device offers whatever controls it: who it is, what it is doing,
/// and what to do with a command. The link to the server and the connections
/// made on the local network all serve the same one.
#[derive(Clone)]
pub struct Local {
    pub identity: LinkIdentity,
    pub state: Arc<dyn Fn() -> LinkState + Send + Sync>,
    /// Act on a command. With a `Pending`, the sender waits for the answer:
    /// finish it with the outcome once the command has been acted on.
    pub on_command:
        Arc<dyn Fn(LinkCommand, CommandSource, Option<crate::remote::acks::Pending>) + Send + Sync>,
}

/// Keep a link open to the configured server for as long as the process runs,
/// handing each command to `on_command` on the link's own thread, and telling
/// the server what `state` says whenever it changes: which of a person's
/// devices is the one playing is how the server picks where to send music.
///
/// Reads the config before every attempt, so signing in later links without a
/// restart. Links only to a server whose profile says it can: Navidrome has no
/// such endpoint.
pub fn spawn(local: Local) {
    std::thread::Builder::new()
        .name("koan-link".into())
        .spawn(move || run(local))
        .expect("failed to spawn the link thread");
}

const RETRY_MIN: Duration = Duration::from_secs(2);
const RETRY_MAX: Duration = Duration::from_secs(60);

/// Moved at every sign-in and sign-out. A link opened under an earlier one
/// is the last account's, and closes, to open again as whoever is signed in.
static SIGN_IN: AtomicU64 = AtomicU64::new(0);

/// The account changed: close the link that is up, which was opened for the
/// last one, and link again now as the new one. A link carries an account's
/// news, its device keys among them, and none of it is the next account's.
pub fn relink() {
    SIGN_IN.fetch_add(1, Ordering::SeqCst);
    if let Some(up) = LINK.lock().as_ref() {
        up.waker.wake();
    }
    nudge();
}

fn run(local: Local) {
    let mut wait = RETRY_MIN;
    loop {
        crate::quiet::wait_until_awake();
        // Before the config is read: a sign-in after this closes the link
        // about to open with what it read.
        let signed_in = SIGN_IN.load(Ordering::SeqCst);
        let cfg = Config::load().unwrap_or_default();
        let account = crate::remote::proof::account_of(&cfg);
        let Some(auth) = subsonic_auth(&cfg) else {
            rest(RETRY_MAX);
            continue;
        };
        match profile::for_auth(&auth) {
            Some(p) if p.links() => {}
            // Not a server that links; asked again when the sign-in changes.
            Some(_) => {
                rest(RETRY_MAX);
                continue;
            }
            None => {
                rest(wait);
                wait = (wait * 2).min(RETRY_MAX);
                continue;
            }
        }

        match connect(&auth, &local.identity) {
            Ok((mut socket, fd)) => {
                log::info!("link: connected to {}", auth.base_url);
                // The server is answering: downloads waiting out an outage
                // against it need not wait for their backoff to find out.
                if let Some(client) = crate::helpers::subsonic_client(&cfg) {
                    client.outage().retry_now();
                }
                wait = RETRY_MIN;
                if let Err(e) = serve(&mut socket, fd, &local, signed_in, account) {
                    log::info!("link: closed: {e}");
                }
                *LINK.lock() = None;
                crate::remote::devices::set_linked(false);
            }
            Err(e) => {
                log::warn!("link: {e}");
                // Asked again before the next attempt: the server may have
                // been replaced by one that does not link. Not after a link
                // that simply dropped, which is every time iOS suspends the
                // app: re-asking then would put two round trips in front of
                // every reconnect.
                profile::forget();
            }
        }
        if rest(wait) {
            wait = RETRY_MIN;
            continue;
        }
        wait = (wait * 2).min(RETRY_MAX);
    }
}

static NUDGE: (Mutex<bool>, Condvar) = (Mutex::new(false), Condvar::new());

/// Try to link again now, rather than when the backoff runs out.
///
/// For an app coming back to the foreground: iOS suspends a backgrounded app,
/// its link dies with it, and the retry it was sleeping towards can be a minute
/// away. Does nothing to a link that is up.
pub fn nudge() {
    *NUDGE.0.lock() = true;
    NUDGE.1.notify_all();
}

/// Wait `d`, or less if nudged. True when nudged.
fn rest(d: Duration) -> bool {
    let mut nudged = NUDGE.0.lock();
    if !*nudged {
        NUDGE.1.wait_for(&mut nudged, d);
    }
    std::mem::replace(&mut *nudged, false)
}

/// Close the link, if it is up: the app has nothing to keep it open for.
pub fn hang_up() {
    if let Some(up) = LINK.lock().as_ref() {
        up.waker.wake();
    }
}

/// The link while it is up: what waits to go up it, and how to wake it.
struct Up {
    waker: Arc<Waker>,
    outbox: Vec<LinkReport>,
}

static LINK: Mutex<Option<Up>> = Mutex::new(None);

/// Send `report` up the link. False when the link is down.
pub fn report(report: LinkReport) -> bool {
    let mut link = LINK.lock();
    let Some(up) = link.as_mut() else {
        return false;
    };
    up.outbox.push(report);
    up.waker.wake();
    true
}

type Socket = tungstenite::WebSocket<MaybeTlsStream<TcpStream>>;

fn connect(auth: &SubsonicAuth, identity: &LinkIdentity) -> Result<(Socket, RawFd), String> {
    let url = link_url(auth, identity)?;
    let (socket, _) = tungstenite::connect(url).map_err(|e| e.to_string())?;
    let fd = wire::prepare(socket.get_ref())?;
    Ok((socket, fd))
}

/// `/rest/koanLink` with the same credentials every other call carries.
fn link_url(auth: &SubsonicAuth, identity: &LinkIdentity) -> Result<String, String> {
    let base = if let Some(rest) = auth.base_url.strip_prefix("https://") {
        format!("wss://{rest}")
    } else if let Some(rest) = auth.base_url.strip_prefix("http://") {
        format!("ws://{rest}")
    } else {
        return Err(format!("not an http(s) server: {}", auth.base_url));
    };
    let mut query = auth.query().map_err(|e| e.to_string())?;
    // What this device proves itself with on the local network, registered
    // against the API key the link signs in with. A server that predates
    // device keys ignores it.
    let device_key = crate::remote::proof::public_key().unwrap_or_default();
    for (k, v) in [
        ("client", identity.name.as_str()),
        ("platform", identity.platform.as_str()),
        ("device", identity.device_id.as_str()),
        // Send this link the account's other devices. A server that predates
        // them ignores it.
        ("devices", "1"),
        // Answer commands sent with an id. A server that predates it ignores
        // it, and relays none.
        ("acks", "1"),
        ("deviceKey", device_key.as_str()),
    ] {
        if v.is_empty() {
            continue;
        }
        query.push('&');
        query.push_str(k);
        query.push('=');
        query.push_str(&percent_encode(v));
    }
    Ok(format!("{base}/rest/koanLink?{query}"))
}

fn serve(
    socket: &mut Socket,
    fd: RawFd,
    local: &Local,
    signed_in: u64,
    account: Option<String>,
) -> Result<(), String> {
    let waker = Waker::new().map_err(|e| e.to_string())?;
    let watcher = waker.clone();
    wire::wake_on_engine_change(&waker);
    *LINK.lock() = Some(Up {
        waker: waker.clone(),
        outbox: Vec::new(),
    });
    crate::remote::devices::set_linked(true);
    let mut session = LinkSession {
        local,
        sent: None,
        sent_push: None,
        sent_activity: None,
        waker: watcher,
        levels: None,
        signed_in,
        account,
    };
    wire::drive(socket, fd, &waker, &mut session)
}

struct LinkSession<'a> {
    local: &'a Local,
    sent: Option<(LinkState, Instant)>,
    sent_push: Option<(String, bool)>,
    sent_activity: Option<Option<ActivityToken>>,
    waker: Arc<Waker>,
    /// Set while the server says a device of the account is watching this
    /// one's levels. It counts the watchers; this link holds one watch.
    levels: Option<crate::remote::levels::Watch>,
    /// `SIGN_IN` when the config this link signed in with was read.
    signed_in: u64,
    /// The account it signed in as, which the device keys it is sent are
    /// for (`proof::account_of`).
    account: Option<String>,
}

impl wire::Session for LinkSession<'_> {
    fn outgoing(&mut self) -> Vec<String> {
        let mut out = Vec::new();
        let push = PUSH_TOKEN.lock().clone();
        if let Some((token, sandbox)) = push.clone()
            && push != self.sent_push
        {
            out.push(LinkReport::Push { token, sandbox });
            self.sent_push = push;
        }
        let activity = ACTIVITY.lock().clone();
        if activity.is_some() && activity != self.sent_activity {
            let (token, device, sandbox) = match activity.clone().flatten() {
                Some((t, d, s)) => (Some(t), Some(d), s),
                None => (None, None, false),
            };
            out.push(LinkReport::Activity {
                token,
                device,
                sandbox,
            });
            self.sent_activity = activity;
        }
        if let Some(up) = LINK.lock().as_mut() {
            out.append(&mut up.outbox);
        }
        let now = (self.local.state)();
        if self
            .sent
            .as_ref()
            .is_none_or(|(s, at)| now.differs(s, at.elapsed()))
        {
            out.push(LinkReport::State(now.clone()));
            self.sent = Some((now, Instant::now()));
        }
        if let Some(f) = self.levels.as_mut().and_then(|w| w.take()) {
            out.push(LinkReport::Levels { f });
        }
        out.iter()
            .filter_map(|r| serde_json::to_string(r).ok())
            .collect()
    }

    fn incoming(&mut self, text: &str) {
        let envelope = match serde_json::from_str::<crate::remote::acks::Envelope>(text) {
            Ok(envelope) => envelope,
            Err(e) => {
                log::warn!("link: not a command ({e}): {text}");
                return;
            }
        };
        if let Some(ack) = envelope.ack {
            report(LinkReport::Received { ack });
        }
        // Answered up this link, whichever thread finishes it.
        let Some((command, pending)) = crate::remote::acks::take(envelope, |ack, outcome| {
            report(LinkReport::Ack { ack, outcome });
        }) else {
            return;
        };
        match command {
            LinkCommand::Acked { from, ack, outcome } => {
                crate::remote::acks::resolve(ack, &from, outcome);
            }
            LinkCommand::Devices { devices } => {
                crate::remote::devices::set_account(devices);
            }
            LinkCommand::DeviceKeys { keys } => {
                crate::remote::proof::keep(keys, self.account.clone());
            }
            LinkCommand::Shares {
                grantees,
                error,
                accounts,
            } => {
                crate::remote::devices::set_shares(grantees, error, accounts);
            }
            LinkCommand::Shared { command } => {
                // Checked by the server, and again here: this device decides
                // what another account may have it do.
                if command.allowed_playback() {
                    (self.local.on_command)(*command, CommandSource::Shared, pending);
                } else {
                    log::warn!("link: refused from a shared account: {command:?}");
                    if let Some(pending) = pending {
                        pending.finish(crate::remote::acks::AckOutcome::Refused {
                            reason: "not allowed from another account".into(),
                        });
                    }
                }
            }
            LinkCommand::Forgotten { device } => {
                crate::remote::devices::forgotten(&device);
            }
            LinkCommand::WatchLevels { on } => {
                self.levels = on.then(|| crate::remote::levels::feed().watch(&self.waker));
            }
            LinkCommand::Levels { from, f } => {
                crate::remote::levels::remote().received(&from, f);
            }
            cmd => (self.local.on_command)(cmd, CommandSource::Account, pending),
        }
    }

    fn done(&self) -> bool {
        !crate::quiet::awake() || SIGN_IN.load(Ordering::SeqCst) != self.signed_in
    }
}

/// This library's tracks for the server's ids, in the order given, and
/// whether a sync ran to find them.
///
/// A koan server names a track by its uid, which this library adopted when it
/// synced the track; another server by the id it issued. A server can name a
/// track added since the last sync; if any are missing and `may_sync`, an
/// sync runs first, and whatever is still missing after it is left
/// out. An id a sync already failed to find does not start another for a
/// while: a command naming a track deleted on the server would otherwise sync
/// every time it arrived.
pub fn resolve_tracks(
    db: &crate::db::connection::Database,
    remote_ids: &[String],
    may_sync: bool,
) -> (Vec<i64>, bool) {
    let lookup = |db: &crate::db::connection::Database| {
        let mut stmt = db
            .conn
            .prepare_cached(
                "SELECT id FROM tracks WHERE uid = ?1
                 UNION ALL SELECT id FROM tracks WHERE remote_id = ?1 LIMIT 1",
            )
            .ok();
        remote_ids
            .iter()
            .map(|rid| {
                stmt.as_mut()
                    .and_then(|s| s.query_row([rid], |r| r.get::<_, i64>(0)).ok())
            })
            .collect::<Vec<_>>()
    };
    let found = lookup(db);
    let missing: Vec<&String> = remote_ids
        .iter()
        .zip(&found)
        .filter(|(_, f)| f.is_none())
        .map(|(id, _)| id)
        .collect();
    if missing.is_empty() || !may_sync || missing.iter().all(|id| recently_missed(id)) {
        return (found.into_iter().flatten().collect(), false);
    }
    sync(db, crate::helpers::Walk::IfChanged);
    let found = lookup(db);
    let mut missed = MISSED.lock();
    let now = Instant::now();
    missed.retain(|_, at| now.duration_since(*at) < MISS_TTL);
    for (id, _) in remote_ids.iter().zip(&found).filter(|(_, f)| f.is_none()) {
        missed.insert(id.clone(), now);
    }
    (found.into_iter().flatten().collect(), true)
}

/// Ids a sync looked for and did not find, and when.
static MISSED: LazyLock<Mutex<HashMap<String, Instant>>> = LazyLock::new(Default::default);
const MISS_TTL: Duration = Duration::from_secs(300);

fn recently_missed(id: &str) -> bool {
    MISSED
        .lock()
        .get(id)
        .is_some_and(|at| at.elapsed() < MISS_TTL)
}

/// A sync from the configured server, as the app runs its own: the library,
/// then favourites and playlists.
pub fn sync(db: &crate::db::connection::Database, walk: crate::helpers::Walk) {
    let cfg = Config::load().unwrap_or_default();
    if let Some(client) = subsonic_client(&cfg)
        && let Err(e) = crate::helpers::sync_remote(
            db,
            &client,
            walk,
            &cfg.remote.url,
            &cfg.remote.username,
            &|_| {},
        )
    {
        log::warn!("link: sync failed: {e}");
    }
}

/// A random id kept in the config directory, and on iOS in the Keychain as
/// well: deleting an app empties its container but not its Keychain items, so
/// a reinstalled app keeps its id rather than appearing as a second device.
fn device_id(dir: &Path) -> String {
    #[cfg(any(target_os = "ios", target_os = "tvos"))]
    {
        use security_framework::passwords::{get_generic_password, set_generic_password};
        const SERVICE: &str = "cc.blit.koan.link";
        if let Some(id) = get_generic_password(SERVICE, "device-id")
            .ok()
            .and_then(|b| String::from_utf8(b).ok())
            .filter(|id| !id.trim().is_empty())
        {
            return id;
        }
        let id = file_device_id(dir);
        let _ = set_generic_password(SERVICE, "device-id", id.as_bytes());
        id
    }
    #[cfg(not(any(target_os = "ios", target_os = "tvos")))]
    file_device_id(dir)
}

fn file_device_id(dir: &Path) -> String {
    let path = dir.join("device-id");
    if let Ok(id) = std::fs::read_to_string(&path) {
        let id = id.trim();
        if !id.is_empty() {
            return id.to_string();
        }
    }
    let id = uuid::Uuid::now_v7().to_string();
    let _ = std::fs::create_dir_all(dir);
    let _ = std::fs::write(&path, &id);
    id
}

fn hostname() -> Option<String> {
    let mut buf = [0u8; 256];
    // SAFETY: the buffer is valid for its whole length, and gethostname
    // writes at most that many bytes.
    let ok = unsafe { libc::gethostname(buf.as_mut_ptr().cast(), buf.len()) } == 0;
    if !ok {
        return None;
    }
    let end = buf.iter().position(|&b| b == 0).unwrap_or(buf.len());
    let name = String::from_utf8_lossy(&buf[..end]);
    let name = name.trim_end_matches(".local").trim();
    (!name.is_empty() && name != "localhost").then(|| name.to_string())
}

fn percent_encode(s: &str) -> String {
    let mut out = String::with_capacity(s.len());
    for b in s.bytes() {
        if b.is_ascii_alphanumeric() || matches!(b, b'-' | b'_' | b'.' | b'~') {
            out.push(b as char);
        } else {
            out.push_str(&format!("%{b:02X}"));
        }
    }
    out
}

#[cfg(test)]
mod tests {

    #[test]
    fn levels_cross_the_link_compactly() {
        use crate::remote::levels::Frame;
        let f = Frame(61_250, 512, 300, 40);

        let report = serde_json::to_string(&LinkReport::Levels { f }).unwrap();
        assert_eq!(report, r#"{"type":"levels","f":[61250,512,300,40]}"#);
        assert_eq!(
            serde_json::from_str::<LinkReport>(&report).unwrap(),
            LinkReport::Levels { f }
        );

        let relayed = LinkCommand::Levels {
            from: "dev-phone".into(),
            f,
        };
        let text = serde_json::to_string(&relayed).unwrap();
        assert!(text.len() < 80, "{} bytes: {text}", text.len());
        assert_eq!(serde_json::from_str::<LinkCommand>(&text).unwrap(), relayed);

        let watch = LinkCommand::WatchLevels { on: true };
        let text = serde_json::to_string(&watch).unwrap();
        assert_eq!(serde_json::from_str::<LinkCommand>(&text).unwrap(), watch);
        assert!(watch.allowed_nearby(), "a stranger may watch the bars");
        assert!(!relayed.allowed_nearby(), "only the server relays frames");
    }
    use super::*;

    #[test]
    fn a_sleep_timer_travels_as_playback_and_comes_back_in_the_state() {
        use crate::player::state::{Sleep, SleepTimer};
        let cmd: LinkCommand =
            serde_json::from_str(r#"{"type":"sleepTimer","timer":{"kind":"after","minutes":30}}"#)
                .unwrap();
        assert_eq!(
            cmd,
            LinkCommand::SleepTimer {
                timer: Some(SleepTimer::After { minutes: 30 })
            }
        );
        let cancel: LinkCommand =
            serde_json::from_str(r#"{"type":"sleepTimer","timer":null}"#).unwrap();
        assert_eq!(cancel, LinkCommand::SleepTimer { timer: None });
        for cmd in [cmd, cancel] {
            assert!(cmd.allowed_playback() && cmd.allowed_nearby(), "{cmd:?}");
        }

        let state = LinkState {
            sleep: Some(Sleep::EndOfRecord),
            ..Default::default()
        };
        let json = serde_json::to_string(&state).unwrap();
        assert!(json.contains(r#""sleep":{"kind":"endOfRecord"}"#), "{json}");
        assert_eq!(serde_json::from_str::<LinkState>(&json).unwrap(), state);
        assert!(
            !serde_json::to_string(&LinkState::default())
                .unwrap()
                .contains("sleep"),
            "nothing said with none set"
        );
    }

    /// Another account, or a device on the network under Full control, gets
    /// the playback set: more than a stranger (outputs, presets, volume,
    /// hand-off), and nothing of the library or the server's news.
    #[test]
    fn the_playback_set_is_playback_and_nothing_of_the_library() {
        let ids = vec!["t".to_string()];
        for cmd in [
            LinkCommand::Pause,
            LinkCommand::JumpTo {
                track_id: "t".into(),
            },
            LinkCommand::Enqueue {
                track_ids: ids.clone(),
            },
            LinkCommand::HandOff { to: "x".into() },
            LinkCommand::SetRendererVolume { volume: 1 },
        ] {
            assert!(cmd.allowed_playback(), "{cmd:?}");
            assert_eq!(cmd.from_the_network(true), Some(CommandSource::Nearby));
        }
        for cmd in [
            LinkCommand::Sync { full: false },
            LinkCommand::Evict {
                track_ids: ids.clone(),
            },
            LinkCommand::Devices { devices: vec![] },
            LinkCommand::Shares {
                grantees: vec![],
                error: None,
                accounts: vec![],
            },
            LinkCommand::Shared {
                command: Box::new(LinkCommand::Pause),
            },
        ] {
            assert!(!cmd.allowed_playback(), "{cmd:?}");
            assert_eq!(cmd.from_the_network(true), None, "{cmd:?}");
            assert_eq!(cmd.from_the_network(false), None, "{cmd:?}");
        }
        // Playback only: a stranger's set, run as a stranger.
        assert_eq!(
            LinkCommand::Pause.from_the_network(false),
            Some(CommandSource::Stranger)
        );
        assert_eq!(
            LinkCommand::SetRendererVolume { volume: 1 }.from_the_network(false),
            None
        );
    }

    // Neither case may reach `sync`: a test has no business reading the
    // machine's config and syncing against the server it names.
    #[test]
    fn unknown_ids_sync_only_when_allowed_and_not_recently_missed() {
        let dir = tempfile::tempdir().unwrap();
        let db = crate::db::connection::Database::open(&dir.path().join("koan.db")).unwrap();

        let (found, synced) = resolve_tracks(&db, &["from-a-stranger".into()], false);
        assert!(found.is_empty());
        assert!(!synced, "a nearby peer's unknown id must not start a sync");

        MISSED
            .lock()
            .insert("deleted-on-server".into(), Instant::now());
        let (_, synced) = resolve_tracks(&db, &["deleted-on-server".into()], true);
        assert!(
            !synced,
            "an id a sync just failed to find does not start another"
        );
    }

    #[test]
    fn commands_name_their_tracks() {
        let play: LinkCommand =
            serde_json::from_str(r#"{"type":"play","trackIds":["a","b"]}"#).unwrap();
        assert_eq!(play.track_ids(), ["a", "b"]);
        let jump: LinkCommand = serde_json::from_str(r#"{"type":"jumpTo","trackId":"c"}"#).unwrap();
        assert_eq!(jump.track_ids(), ["c"]);
        assert!(LinkCommand::Pause.track_ids().is_empty());
    }

    #[test]
    fn a_push_token_is_a_tagged_report() {
        let report = LinkReport::Push {
            token: "ab12".into(),
            sandbox: true,
        };
        let text = serde_json::to_string(&report).unwrap();
        assert_eq!(text, r#"{"type":"push","token":"ab12","sandbox":true}"#);
        assert_eq!(serde_json::from_str::<LinkReport>(&text).unwrap(), report);
    }

    #[test]
    fn commands_are_tagged_json() {
        let play = LinkCommand::Play {
            track_ids: vec!["12".into(), "34".into()],
            start_at: 1,
            position_ms: 0,
            paused: false,
            handoff: false,
            mode: QueueMode::Keep,
        };
        let json = serde_json::to_string(&play).unwrap();
        assert_eq!(
            json,
            r#"{"type":"play","trackIds":["12","34"],"startAt":1}"#
        );
        assert_eq!(serde_json::from_str::<LinkCommand>(&json).unwrap(), play);
        let held = LinkCommand::Play {
            track_ids: vec!["12".into()],
            start_at: 0,
            position_ms: 61_250,
            paused: true,
            handoff: false,
            mode: QueueMode::Keep,
        };
        let json = serde_json::to_string(&held).unwrap();
        assert_eq!(
            json,
            r#"{"type":"play","trackIds":["12"],"startAt":0,"positionMs":61250,"paused":true}"#
        );
        assert_eq!(serde_json::from_str::<LinkCommand>(&json).unwrap(), held);
        assert_eq!(
            serde_json::from_str::<LinkCommand>(r#"{"type":"pause"}"#).unwrap(),
            LinkCommand::Pause
        );
        let report = LinkReport::State(LinkState {
            playing: true,
            title: Some("Portions for Foxes".into()),
            ..Default::default()
        });
        let json = serde_json::to_string(&report).unwrap();
        assert!(json.starts_with(r#"{"type":"state","playing":true,"title":"Portions for Foxes""#));
        assert_eq!(serde_json::from_str::<LinkReport>(&json).unwrap(), report);
    }

    #[test]
    fn a_playhead_moving_on_time_is_not_news() {
        let sent = LinkState {
            playing: true,
            position_ms: 10_000,
            ..Default::default()
        };
        let later = |pos| LinkState {
            position_ms: pos,
            ..sent.clone()
        };
        let five = Duration::from_secs(5);
        assert!(!later(15_000).differs(&sent, five));
        assert!(later(60_000).differs(&sent, five), "a seek");
        let paused = LinkState {
            playing: false,
            ..later(15_000)
        };
        assert!(paused.differs(&sent, five));
    }

    #[test]
    fn the_url_follows_the_scheme_and_names_the_device() {
        let identity = LinkIdentity {
            name: "J's iPhone".into(),
            platform: "ios".into(),
            device_id: "abc".into(),
        };
        let url = link_url(
            &SubsonicAuth::new("https://music.example.com", "j", "pw"),
            &identity,
        )
        .unwrap();
        assert!(url.starts_with("wss://music.example.com/rest/koanLink?"));
        assert!(url.contains("client=J%27s%20iPhone"));
        assert!(url.contains("device=abc"));
        assert!(url.contains("devices=1"));
        assert!(
            link_url(&SubsonicAuth::new("http://h:4000", "j", "pw"), &identity)
                .unwrap()
                .starts_with("ws://h:4000/")
        );
    }

    #[test]
    fn a_relayed_command_nests_the_command() {
        let report = LinkReport::Command {
            to: "phone".into(),
            command: LinkCommand::HandOff { to: "mac".into() },
            ack: None,
        };
        let json = serde_json::to_string(&report).unwrap();
        assert_eq!(
            json,
            r#"{"type":"command","to":"phone","command":{"type":"handOff","to":"mac"}}"#
        );
        assert_eq!(serde_json::from_str::<LinkReport>(&json).unwrap(), report);
    }

    #[test]
    fn an_older_queue_entry_still_reads() {
        let e: LinkQueueEntry =
            serde_json::from_str(r#"{"trackId":"7","title":"t","artist":"a","current":true}"#)
                .unwrap();
        assert_eq!(e.id, None);
        assert_eq!(e.duration_ms, 0);
    }

    #[test]
    fn strangers_cannot_touch_the_library() {
        assert!(LinkCommand::Pause.allowed_nearby());
        assert!(LinkCommand::HandOff { to: "x".into() }.allowed_nearby());
        assert!(!LinkCommand::Sync { full: true }.allowed_nearby());
        assert!(!LinkCommand::Evict { track_ids: vec![] }.allowed_nearby());
    }

    #[test]
    fn the_device_id_is_kept() {
        let dir = tempfile::tempdir().unwrap();
        let first = device_id(dir.path());
        assert_eq!(device_id(dir.path()), first);
    }
}

#[cfg(test)]
mod device_key_tests {
    use super::*;

    /// The keys are what a network peer's claims are checked against, so no
    /// peer may send them: not a stranger, not under Full control, not a
    /// shared account.
    #[test]
    fn device_keys_come_from_the_server_alone() {
        let cmd = LinkCommand::DeviceKeys { keys: vec![] };
        assert!(!cmd.allowed_nearby());
        assert!(!cmd.allowed_playback());
        assert_eq!(cmd.from_the_network(true), None);
        assert_eq!(cmd.from_the_network(false), None);
    }

    #[test]
    fn the_server_never_relays_its_own_news() {
        for news in [
            LinkCommand::DeviceKeys { keys: vec![] },
            LinkCommand::Devices { devices: vec![] },
            LinkCommand::HistoryChanged,
            LinkCommand::DspProfilesChanged,
            LinkCommand::Shared {
                command: Box::new(LinkCommand::Pause),
            },
        ] {
            assert!(!news.relayable(), "{news:?}");
        }
        assert!(LinkCommand::Pause.relayable());
    }

    #[test]
    fn a_device_key_is_32_bytes_of_base64() {
        use base64::Engine as _;
        let b64 = base64::engine::general_purpose::STANDARD;
        assert!(valid_device_key(&b64.encode([7u8; 32])));
        assert!(!valid_device_key(&b64.encode([7u8; 31])));
        assert!(!valid_device_key(&b64.encode([7u8; 33])));
        assert!(!valid_device_key("not base64!"));
        assert!(!valid_device_key(""));
    }
}