koan-core 0.66.4

use rusqlite::{Connection, OptionalExtension, params};

use crate::db::connection::DbError;

use super::ArtistRow;

/// Escape SQL LIKE wildcard characters in user input.
pub(super) fn escape_like(s: &str) -> String {
    s.replace('\\', "\\\\")
        .replace('%', "\\%")
        .replace('_', "\\_")
}

/// Get or create an artist by name. Returns the artist ID.
///
/// Names that differ only in letter case are one artist: tags spell the same
/// act "The Squire Of Gothos" on one record and "of" on the next, and two rows
/// split its albums from its tracks. An exact match wins over a case-folded one.
pub fn get_or_create_artist(
    conn: &Connection,
    name: &str,
    remote_id: Option<&str>,
) -> Result<i64, DbError> {
    let key = super::sources::fold(name);
    let existing: Option<(i64, Option<String>)> = conn
        .prepare_cached("SELECT id, remote_id FROM artists WHERE name_key = ?1")?
        .query_row(params![key], |row| Ok((row.get(0)?, row.get(1)?)))
        .optional()?;

    if let Some((id, stored)) = existing {
        // The server's current id wins: one that renumbers its library would
        // otherwise leave the artist under an id it no longer answers to.
        if let Some(rid) = remote_id {
            if stored.as_deref() != Some(rid) {
                conn.prepare_cached("UPDATE artists SET remote_id = ?1 WHERE id = ?2")?
                    .execute(params![rid, id])?;
            }
            super::adopt_uid(conn, super::UidKind::Artist, id, rid)?;
        }
        return Ok(id);
    }

    let uid = super::free_uid(conn, super::UidKind::Artist, remote_id)?;
    conn.prepare_cached(
        "INSERT INTO artists (name, name_key, remote_id, uid) VALUES (?1, ?2, ?3, ?4)",
    )?
    .execute(params![name, key, remote_id, uid])?;
    let id = conn.last_insert_rowid();
    if let Some(rid) = remote_id {
        super::adopt_uid(conn, super::UidKind::Artist, id, rid)?;
    }
    Ok(id)
}

/// How to order the artist listing.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ArtistOrder {
    /// By name, as it reads. Sort names from tags are too erratic to order by.
    #[default]
    Name,
    /// Most albums first.
    AlbumCount,
    /// The artist whose newest album arrived most recently first.
    RecentlyAdded,
    /// Insertion order, for an offset walk that must not skip or repeat.
    Id,
    /// Most recently played first. Only with `ArtistQuery::played`, which is
    /// what knows when; without it, `Name`.
    LastPlayed,
    /// The closest match to `ArtistQuery::search` first (see
    /// `search::match_rank`), then by name. Without a search, in the order of
    /// `ArtistQuery::ids`; without either, `Name`.
    Relevance,
}

impl ArtistOrder {
    fn clause(self) -> &'static str {
        match self {
            Self::Name | Self::Relevance => "a.name COLLATE LIBRARY",
            Self::AlbumCount => "COUNT(DISTINCT al.id) DESC, a.name COLLATE LIBRARY",
            Self::RecentlyAdded => "COALESCE(MAX(al.added_at), '') DESC, a.name COLLATE LIBRARY",
            Self::Id => "a.id",
            Self::LastPlayed => "MAX(p.last) DESC, MAX(p.last_id) DESC",
        }
    }
}

/// What to list. Artists are always album artists — a track-only credit (a
/// featured guest) appears inline in the queue, not as a shelf of its own.
#[derive(Debug, Clone, Copy, Default)]
pub struct ArtistQuery<'a> {
    /// Only these artists.
    pub ids: Option<&'a [i64]>,
    /// Case-insensitive substring over the name. When no artist's name holds
    /// it, the closest fuzzy matches instead (`search::fuzzy_ids`).
    pub search: Option<&'a str>,
    /// Only artists this user has favourited.
    pub favourites_of: Option<i64>,
    /// Only artists with a record played since then, by its album artist.
    pub played: Option<super::history::PlayedSince>,
    /// Albums that count; an artist with none left is not listed, and the
    /// counts are of what is left.
    pub filter: super::albums::AlbumFilter<'a>,
    pub order: ArtistOrder,
    /// Leave `track_count` at zero rather than read every track in the library
    /// to count them.
    pub without_track_counts: bool,
    /// `None` for the whole listing. A client that scrolls should page.
    pub limit: Option<u32>,
    pub offset: u32,
}

/// Artists with their album and track counts, narrowed, ordered and paged by
/// the database.
pub fn list_artists(conn: &Connection, q: &ArtistQuery) -> Result<Vec<ArtistRow>, DbError> {
    if let Some(ids) = fuzzy_fallback(conn, q)? {
        return list_artists(
            conn,
            &ArtistQuery {
                search: None,
                ids: Some(&ids),
                ..*q
            },
        );
    }
    let columns = if q.without_track_counts {
        "a.id, a.name, a.sort_name, a.remote_id, COUNT(al.id), 0"
    } else {
        "a.id, a.name, a.sort_name, a.remote_id, COUNT(DISTINCT al.id), COUNT(t.id)"
    };
    let (body, mut params) = artist_body(conn, q)?;
    let order = match q.order {
        ArtistOrder::LastPlayed if q.played.is_none() => ArtistOrder::Name,
        order => order,
    };
    let order_by = match (order, q.search, q.ids) {
        (ArtistOrder::Relevance, Some(query), _) => {
            params.extend(
                super::search::match_rank_binds(query)
                    .map(|b| Box::new(b) as Box<dyn rusqlite::ToSql>),
            );
            format!(
                "{}, a.name COLLATE LIBRARY",
                super::search::match_rank("a.name")
            )
        }
        (ArtistOrder::Relevance, None, Some(_)) => "MIN(r.key)".into(),
        (order, ..) => order.clause().into(),
    };
    let mut sql = format!("SELECT {columns} {body} ORDER BY {order_by}");
    if let Some(limit) = q.limit {
        params.push(Box::new(limit as i64));
        params.push(Box::new(q.offset as i64));
        sql.push_str(" LIMIT ? OFFSET ?");
    }

    let mut stmt = conn.prepare(&sql)?;
    let rows = stmt
        .query_map(rusqlite::params_from_iter(params.iter()), artist_row)?
        .collect::<Result<Vec<_>, _>>()?;
    Ok(rows)
}

/// How many artists `list_artists` would list for `q`, ignoring its paging.
pub fn count_artists(conn: &Connection, q: &ArtistQuery) -> Result<u64, DbError> {
    if let Some(ids) = fuzzy_fallback(conn, q)? {
        return count_artists(
            conn,
            &ArtistQuery {
                search: None,
                ids: Some(&ids),
                ..*q
            },
        );
    }
    let (body, params) = artist_body(conn, q)?;
    let n: i64 = conn.query_row(
        &format!("SELECT COUNT(*) FROM (SELECT a.id {body})"),
        rusqlite::params_from_iter(params.iter()),
        |r| r.get(0),
    )?;
    Ok(n as u64)
}

/// Whether `q` lists its ids in their own order: `Relevance` with no search.
fn ranked_by_ids(q: &ArtistQuery) -> bool {
    q.order == ArtistOrder::Relevance && q.search.is_none()
}

/// What `q`'s search lists when no artist's name holds it: the fuzzy matches,
/// best first. `None` when it has no search or the search finds something.
fn fuzzy_fallback(conn: &Connection, q: &ArtistQuery) -> Result<Option<Vec<i64>>, DbError> {
    let Some(query) = q.search else {
        return Ok(None);
    };
    let (body, params) = artist_body(conn, q)?;
    let found: bool = conn.query_row(
        &format!("SELECT EXISTS (SELECT 1 {body})"),
        rusqlite::params_from_iter(params.iter()),
        |r| r.get(0),
    )?;
    if found {
        return Ok(None);
    }
    let mut ids = super::search::fuzzy_ids(conn, super::search::CorpusKind::Artist, query)?;
    if let Some(only) = q.ids {
        ids.retain(|id| only.contains(id));
    }
    Ok(Some(ids))
}

/// The FROM, WHERE and GROUP BY that `list_artists` and `count_artists`
/// share, and their parameters, in order.
fn artist_body(
    conn: &Connection,
    q: &ArtistQuery,
) -> Result<(String, Vec<Box<dyn rusqlite::ToSql>>), DbError> {
    // An album is under each artist its credits name, and the artist list
    // leaves out a credit string standing for artists credited one by one.
    // A shelf of what someone hearted or played keeps it: they chose it.
    let listed = if q.favourites_of.is_some() || q.played.is_some() {
        ""
    } else {
        " AND l.listed"
    };
    let mut sql = format!(
        "FROM artists a
         INNER JOIN album_artist_links l ON l.artist_id = a.id{listed}
         INNER JOIN albums al ON al.id = l.album_id{}",
        if q.without_track_counts {
            ""
        } else {
            "
         LEFT JOIN tracks t ON t.album_id = al.id"
        }
    );
    let mut params: Vec<Box<dyn rusqlite::ToSql>> = Vec::new();
    if let Some(user) = q.favourites_of {
        params.push(Box::new(super::auth::resolve_user(conn, user)?));
        sql.push_str(" JOIN favourite_artists f ON f.artist_id = a.id AND f.user_id = ?");
    }
    if let Some(played) = q.played {
        params.push(Box::new(super::auth::resolve_user(conn, played.user)?));
        params.push(Box::new(played.since));
        sql.push_str(
            " JOIN (SELECT pal.artist_id AS id, MAX(h.played_at) AS last, MAX(h.id) AS last_id
                      FROM play_history h
                      JOIN tracks pt ON pt.id = h.track_id
                      JOIN albums pal ON pal.id = pt.album_id
                     WHERE h.user_id = ? AND h.played_at >= ?
                     GROUP BY pal.artist_id) p ON p.id = a.id",
        );
    }
    let mut wheres: Vec<String> = Vec::new();
    match q.ids {
        // Joined once rather than looked up per row, so the order of the ids
        // is `r.key`.
        Some(ids) if ranked_by_ids(q) => {
            params.push(Box::new(super::json_list(ids)));
            sql.push_str(" JOIN json_each(?) r ON r.value = a.id");
        }
        Some(ids) => {
            params.push(Box::new(super::json_list(ids)));
            wheres.push("a.id IN (SELECT value FROM json_each(?))".into());
        }
        None => {}
    }
    if let Some(query) = q.search {
        params.push(Box::new(format!("%{}%", escape_like(query))));
        wheres.push("a.name LIKE ? COLLATE NOCASE ESCAPE '\\'".into());
    }
    q.filter.push(&mut wheres, &mut params);
    if !wheres.is_empty() {
        sql.push_str(" WHERE ");
        sql.push_str(&wheres.join(" AND "));
    }
    sql.push_str(" GROUP BY a.id");
    Ok((sql, params))
}

fn artist_row(row: &rusqlite::Row) -> rusqlite::Result<ArtistRow> {
    Ok(ArtistRow {
        id: row.get(0)?,
        name: row.get(1)?,
        sort_name: row.get(2)?,
        remote_id: row.get(3)?,
        album_count: row.get(4)?,
        track_count: row.get(5)?,
    })
}

/// One artist, with its counts. An artist credited only on other people's
/// albums (a feature, a compilation track) owns none, and is still an artist:
/// its track count is every track credited to it or on its albums.
pub fn get_artist(conn: &Connection, artist_id: i64) -> Result<Option<ArtistRow>, DbError> {
    Ok(conn
        .query_row(
            "SELECT a.id, a.name, a.sort_name, a.remote_id,
                    (SELECT COUNT(DISTINCT album_id) FROM album_artist_links
                      WHERE artist_id = a.id),
                    (SELECT COUNT(*) FROM tracks
                      WHERE artist_id = a.id
                         OR id IN (SELECT track_id FROM track_credits WHERE artist_id = a.id)
                         OR album_id IN (SELECT album_id FROM album_artist_links
                                          WHERE artist_id = a.id))
             FROM artists a
             WHERE a.id = ?1",
            params![artist_id],
            artist_row,
        )
        .ok())
}

/// Find artists by name (case-insensitive substring match).
pub fn find_artists(conn: &Connection, query: &str) -> Result<Vec<ArtistRow>, DbError> {
    list_artists(
        conn,
        &ArtistQuery {
            search: Some(query),
            ..Default::default()
        },
    )
}

/// Every album artist, sorted by name.
pub fn all_artists(conn: &Connection) -> Result<Vec<ArtistRow>, DbError> {
    list_artists(conn, &ArtistQuery::default())
}

/// Record what the server knows about an artist beyond its name.
///
/// Fills blanks rather than overwriting: a local scan may have set a sort name
/// from tags, and the server's should not clobber it. Matched on `remote_id`,
/// which the artist already has from the track upserts.
pub fn enrich_remote_artist(
    conn: &Connection,
    remote_id: &str,
    mbid: Option<&str>,
    sort_name: Option<&str>,
) -> Result<(), DbError> {
    conn.execute(
        "UPDATE artists SET
             mbid      = COALESCE(mbid, ?2),
             sort_name = COALESCE(sort_name, ?3)
         WHERE remote_id = ?1",
        params![remote_id, mbid, sort_name],
    )?;
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::db::connection::Database;

    fn test_db() -> Database {
        let conn = rusqlite::Connection::open_in_memory().unwrap();
        conn.pragma_update(None, "foreign_keys", "on").unwrap();
        crate::db::schema::create_tables(&conn).unwrap();
        Database { conn }
    }

    /// Artists only appear once they own an album, so the fixture goes in
    /// through a track.
    fn stocked_db() -> Database {
        use crate::db::queries::{sample_meta, upsert_track};
        let db = test_db();
        for (i, artist) in ["Autechre", "Boards of Canada", "Coil", "Dopplereffekt"]
            .iter()
            .enumerate()
        {
            let mut m = sample_meta("t", artist, "Album");
            m.path = Some(format!("/music/{i}/t.flac"));
            upsert_track(&db.conn, &m).unwrap();
        }
        db
    }

    const DUCHAMP: &str = "Orchestre Tout Puissant Marcel Duchamp";
    const ATLAS: &str = "Frànçois & the Atlas Mountains";

    /// The Duchamp × Atlas Mountains EP as sift tags it: the credit as it
    /// reads, and each artist with their MusicBrainz id beside it. Each
    /// artist also has an album of their own.
    fn collaboration_db(credited: bool) -> Database {
        use crate::db::queries::{Credit, Credits, sample_meta, upsert_track};
        let db = test_db();
        for (i, artist) in [DUCHAMP, ATLAS].iter().enumerate() {
            let mut m = sample_meta("t", artist, &format!("Own {i}"));
            m.path = Some(format!("/music/own{i}.flac"));
            upsert_track(&db.conn, &m).unwrap();
        }
        let credit = format!("{DUCHAMP} × {ATLAS}");
        let both = vec![
            Credit {
                name: DUCHAMP.into(),
                mbid: Some("177de814-d272-43ef-a42d-fb2ed79a0f78".into()),
                remote_id: None,
            },
            Credit {
                name: ATLAS.into(),
                mbid: Some("63862e0f-4e06-458e-88d7-2baabbf27398".into()),
                remote_id: None,
            },
        ];
        for (n, title) in [(1, "Revenant du nord"), (2, "Siilent")] {
            let mut m = sample_meta(title, &credit, "Revenant du nord / Siilent");
            m.track_number = Some(n);
            m.path = Some(format!("/music/ep/{n}.mp3"));
            if credited {
                m.credits = Credits {
                    artists: both.clone(),
                    album_artists: both.clone(),
                };
            }
            upsert_track(&db.conn, &m).unwrap();
        }
        db
    }

    fn artist_id(db: &Database, name: &str) -> i64 {
        db.conn
            .query_row("SELECT id FROM artists WHERE name = ?1", [name], |r| {
                r.get(0)
            })
            .unwrap()
    }

    fn album_titles(db: &Database, artist: i64) -> Vec<String> {
        crate::db::queries::list_albums(
            &db.conn,
            &crate::db::queries::AlbumQuery {
                artist_id: Some(artist),
                ..Default::default()
            },
        )
        .unwrap()
        .into_iter()
        .map(|a| a.title)
        .collect()
    }

    #[test]
    fn a_collaboration_is_listed_under_each_artist_it_credits() {
        let db = collaboration_db(true);
        let ep = "Revenant du nord / Siilent".to_string();
        for name in [DUCHAMP, ATLAS] {
            let id = artist_id(&db, name);
            assert!(album_titles(&db, id).contains(&ep), "{name}");
            let tracks = crate::db::queries::tracks_for_artist(&db.conn, id).unwrap();
            assert_eq!(tracks.len(), 3, "{name}: own track and the EP's two");
            assert_eq!(get_artist(&db.conn, id).unwrap().unwrap().album_count, 2);
        }
        let names: Vec<_> = all_artists(&db.conn)
            .unwrap()
            .into_iter()
            .map(|a| a.name)
            .collect();
        assert_eq!(
            names,
            [ATLAS, DUCHAMP],
            "the credit string is not an artist"
        );
        let credit = artist_id(&db, &format!("{DUCHAMP} × {ATLAS}"));
        assert_eq!(
            album_titles(&db, credit),
            [ep],
            "its page still holds the EP"
        );
        let mbid: Option<String> = db
            .conn
            .query_row(
                "SELECT mbid FROM artists WHERE id = ?1",
                [artist_id(&db, ATLAS)],
                |r| r.get(0),
            )
            .unwrap();
        assert_eq!(
            mbid.as_deref(),
            Some("63862e0f-4e06-458e-88d7-2baabbf27398")
        );
    }

    #[test]
    fn retagging_without_the_lists_takes_the_credits_away() {
        use crate::db::queries::{sample_meta, upsert_track};
        let db = collaboration_db(true);
        let credit = format!("{DUCHAMP} × {ATLAS}");
        for (n, title) in [(1, "Revenant du nord"), (2, "Siilent")] {
            let mut m = sample_meta(title, &credit, "Revenant du nord / Siilent");
            m.track_number = Some(n);
            m.path = Some(format!("/music/ep/{n}.mp3"));
            upsert_track(&db.conn, &m).unwrap();
        }
        assert_eq!(album_titles(&db, artist_id(&db, ATLAS)), ["Own 1"]);
        let links: i64 = db
            .conn
            .query_row(
                "SELECT (SELECT COUNT(*) FROM track_credits) + (SELECT COUNT(*) FROM album_credits)",
                [],
                |r| r.get(0),
            )
            .unwrap();
        assert_eq!(links, 0);
        assert!(
            all_artists(&db.conn)
                .unwrap()
                .iter()
                .any(|a| a.name == credit),
            "the credit is an artist again"
        );
    }

    #[test]
    fn a_credit_named_only_as_a_string_is_left_as_it_was() {
        let db = collaboration_db(false);
        let credit = format!("{DUCHAMP} × {ATLAS}");
        let names: Vec<_> = all_artists(&db.conn)
            .unwrap()
            .into_iter()
            .map(|a| a.name)
            .collect();
        assert_eq!(names, [ATLAS, DUCHAMP, credit.as_str()]);
        assert_eq!(album_titles(&db, artist_id(&db, ATLAS)), ["Own 1"]);
        let links: i64 = db
            .conn
            .query_row(
                "SELECT (SELECT COUNT(*) FROM track_credits) + (SELECT COUNT(*) FROM album_credits)",
                [],
                |r| r.get(0),
            )
            .unwrap();
        assert_eq!(links, 0);
    }

    #[test]
    fn paging_walks_the_listing_without_repeating() {
        let db = stocked_db();
        let page = |offset| {
            list_artists(
                &db.conn,
                &ArtistQuery {
                    limit: Some(2),
                    offset,
                    ..Default::default()
                },
            )
            .unwrap()
            .into_iter()
            .map(|a| a.name)
            .collect::<Vec<_>>()
        };
        assert_eq!(page(0), ["Autechre", "Boards of Canada"]);
        assert_eq!(page(2), ["Coil", "Dopplereffekt"]);
        assert!(page(4).is_empty());
    }

    #[test]
    fn favourites_only_lists_what_was_hearted() {
        use crate::db::queries::toggle_favourite_artist;
        let db = stocked_db();
        let coil: i64 = db
            .conn
            .query_row("SELECT id FROM artists WHERE name = 'Coil'", [], |r| {
                r.get(0)
            })
            .unwrap();
        toggle_favourite_artist(&db.conn, crate::db::queries::LOCAL_USER, coil).unwrap();
        let rows = list_artists(
            &db.conn,
            &ArtistQuery {
                favourites_of: Some(crate::db::queries::LOCAL_USER),
                ..Default::default()
            },
        )
        .unwrap();
        assert_eq!(
            rows.iter().map(|a| a.name.as_str()).collect::<Vec<_>>(),
            ["Coil"]
        );
    }

    #[test]
    fn spellings_that_differ_only_in_case_are_one_artist() {
        let db = stocked_db();
        let a = get_or_create_artist(&db.conn, "The Squire of Gothos", None).unwrap();
        let b = get_or_create_artist(&db.conn, "The Squire Of Gothos", None).unwrap();
        assert_eq!(a, b);
    }

    #[test]
    fn an_artist_with_tracks_but_no_albums_is_still_an_artist() {
        let db = stocked_db();
        let guest = get_or_create_artist(&db.conn, "A Guest", None).unwrap();
        let album: i64 = db
            .conn
            .query_row("SELECT id FROM albums LIMIT 1", [], |r| r.get(0))
            .unwrap();
        db.conn
            .execute(
                "INSERT INTO tracks (title, album_id, artist_id, path) VALUES ('Feature', ?1, ?2, '/f.flac')",
                params![album, guest],
            )
            .unwrap();
        let artist = get_artist(&db.conn, guest)
            .unwrap()
            .expect("credited on a track");
        assert_eq!((artist.album_count, artist.track_count), (0, 1));
    }

    #[test]
    fn one_artist_carries_its_counts() {
        let db = stocked_db();
        let id = find_artists(&db.conn, "Coil").unwrap()[0].id;
        let artist = get_artist(&db.conn, id)
            .unwrap()
            .expect("Coil owns an album");
        assert_eq!(artist.name, "Coil");
        assert_eq!(artist.album_count, 1);
        assert_eq!(artist.track_count, 1);
        assert!(get_artist(&db.conn, 9999).unwrap().is_none());
    }

    #[test]
    fn test_artist_create_and_dedup() {
        let db = test_db();
        let id1 = get_or_create_artist(&db.conn, "Aphex Twin", None).unwrap();
        let id2 = get_or_create_artist(&db.conn, "Aphex Twin", None).unwrap();
        assert_eq!(id1, id2);

        let id3 = get_or_create_artist(&db.conn, "Squarepusher", None).unwrap();
        assert_ne!(id1, id3);
    }
}