rbox 0.1.7

Rust library for interacting with the local and export data of Pioneers Rekordbox DJ software
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

// Copyright (C) 2026 Dylan Jones
// SPDX-License-Identifier: GPL-3.0-only

use diesel::prelude::*;
#[cfg(feature = "napi")]
use napi_derive::napi;
#[cfg(feature = "pyo3")]
use pyo3::prelude::*;
#[cfg(feature = "pyo3")]
use rbox_derives::PyMutableMapping;

use super::schema::artist;
use crate::model_traits::{Model, ModelDelete, ModelInsert, ModelUpdate};
#[cfg(feature = "pyo3")]
use crate::util::{PyItemsIter, PyObjectIter, PyStrIter};

/// Represents the `artist` table in the Rekordbox One Library database.
///
/// This struct maps to the `artist` table in the One Library export database.
/// It stores artist-related data, allowing multiple tracks to be associated with the same artist.
///
/// # Referenced by
/// * [`Album`] via `artist_id` foreign key.
/// * [`Content`] via `artist_id`, `remixer_id`, `original_artist_id`, `composer_id` and `lyricist_id` foreign keys.
#[derive(Debug, Clone, PartialEq, HasQuery, Identifiable, AsChangeset)]
#[diesel(table_name = artist)]
#[diesel(primary_key(id))]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct Artist {
    /// The unique identifier of the artist.
    pub id: i32,
    /// The name of the artist.
    pub name: String,
    /// An optional field for storing a search-optimized version of the artist name.
    pub name_for_search: Option<String>,
}

impl Model for Artist {
    type Id = i32;

    fn all(conn: &mut SqliteConnection) -> QueryResult<Vec<Self>> {
        Self::query().load(conn)
    }

    fn find(conn: &mut SqliteConnection, id: &Self::Id) -> QueryResult<Option<Self>> {
        Self::query().find(id).first(conn).optional()
    }

    fn id_exists(conn: &mut SqliteConnection, id: &Self::Id) -> QueryResult<bool> {
        diesel::dsl::select(diesel::dsl::exists(Self::query().find(id))).get_result(conn)
    }
}

impl ModelUpdate for Artist {
    fn update(self, conn: &mut SqliteConnection) -> QueryResult<Self> {
        diesel::update(artist::table.find(self.id.clone()))
            .set(self)
            .get_result(conn)
    }
}

impl ModelDelete for Artist {
    fn delete(conn: &mut SqliteConnection, id: &Self::Id) -> QueryResult<usize> {
        let mut result = diesel::delete(artist::table.find(id)).execute(conn)?;
        // Remove any references to the artist in the content table
        result += diesel::sql_query(
            "UPDATE content
             SET artist_id_artist         = CASE WHEN artist_id_artist          =? THEN NULL ELSE artist_id_artist END,
                 artist_id_remixer        = CASE WHEN artist_id_remixer         =? THEN NULL ELSE artist_id_remixer END,
                 artist_id_originalArtist = CASE WHEN artist_id_originalArtist  =? THEN NULL ELSE artist_id_originalArtist END,
                 artist_id_composer       = CASE WHEN artist_id_composer        =? THEN NULL ELSE artist_id_composer END,
                 artist_id_lyricist       = CASE WHEN artist_id_lyricist        =? THEN NULL ELSE artist_id_lyricist END
             WHERE artist_id_artist         =?
                OR artist_id_remixer        =?
                OR artist_id_originalArtist =?
                OR artist_id_composer       =?
                OR artist_id_lyricist       =?"
        )
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .bind::<diesel::sql_types::Integer, _>(id)
            .execute(conn)?;
        Ok(result)
    }

    fn delete_all(conn: &mut SqliteConnection, ids: Vec<&Self::Id>) -> QueryResult<usize> {
        let mut result =
            diesel::delete(artist::table.filter(artist::id.eq_any(&ids))).execute(conn)?;
        // Remove any references to the artists in the content table
        let ids_json = serde_json::to_string(&ids)
            .map_err(|e| diesel::result::Error::DeserializationError(Box::new(e)))?;
        result += diesel::sql_query(
            "WITH ids(val) AS (SELECT value FROM json_each(?))
            UPDATE content
            SET artist_id_artist          = CASE WHEN artist_id_artist          IN (SELECT val FROM ids) THEN NULL ELSE artist_id_artist END,
                artist_id_remixer         = CASE WHEN artist_id_remixer         IN (SELECT val FROM ids) THEN NULL ELSE artist_id_remixer END,
                artist_id_originalArtist  = CASE WHEN artist_id_originalArtist  IN (SELECT val FROM ids) THEN NULL ELSE artist_id_originalArtist END,
                artist_id_composer        = CASE WHEN artist_id_composer        IN (SELECT val FROM ids) THEN NULL ELSE artist_id_composer END,
                artist_id_lyricist        = CASE WHEN artist_id_lyricist        IN (SELECT val FROM ids) THEN NULL ELSE artist_id_lyricist END
            WHERE artist_id_artist         IN (SELECT val FROM ids)
               OR artist_id_remixer        IN (SELECT val FROM ids)
               OR artist_id_originalArtist IN (SELECT val FROM ids)
               OR artist_id_composer       IN (SELECT val FROM ids)
               OR artist_id_lyricist       IN (SELECT val FROM ids)"
        )
            .bind::<diesel::sql_types::Text, _>(ids_json)
            .execute(conn)?;
        Ok(result)
    }
}

impl Artist {
    /// Queries a record from the `artist` table by its `name`.
    pub fn find_by_name(conn: &mut SqliteConnection, name: &str) -> QueryResult<Option<Self>> {
        Self::query()
            .filter(artist::name.eq(name))
            .first(conn)
            .optional()
    }

    /// Checks if a record with the given `name` exists in the `artist` table.
    pub fn name_exists(conn: &mut SqliteConnection, name: &str) -> QueryResult<bool> {
        let query = Self::query().filter(artist::name.eq(name));
        diesel::dsl::select(diesel::dsl::exists(query)).get_result(conn)
    }
}

/// Represents a new record insertale to the `artist` table.
///
/// Implements the builder pattern for optional values of the new record.
///
/// # Examples
/// ```rust
/// use rbox::one_library::models::NewArtist;
///
/// let new = NewArtist::new("Name").name_for_search("Name");
/// println!("{:?}", new);
/// ```
#[derive(Debug, Clone, PartialEq, Default, Insertable)]
#[diesel(table_name = artist)]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct NewArtist {
    /// The name of the artist.
    pub name: String,
    /// An optional field for storing a search-optimized version of the artist name.
    pub name_for_search: Option<String>,
}

impl ModelInsert for NewArtist {
    type Model = Artist;

    fn insert(self, conn: &mut SqliteConnection) -> QueryResult<Self::Model> {
        diesel::insert_into(artist::table)
            .values(self)
            .get_result(conn)
    }

    fn insert_all(conn: &mut SqliteConnection, items: Vec<Self>) -> QueryResult<Vec<Self::Model>> {
        diesel::insert_into(artist::table)
            .values(items)
            .get_results(conn)
    }
}

impl NewArtist {
    /// Creates a new artist record with the required fields.
    pub fn new<S: Into<String>>(name: S) -> Self {
        Self {
            name: name.into(),
            ..Default::default()
        }
    }

    /// Builder for `name_for_search`.
    pub fn name_for_search<S: Into<String>>(mut self, search_str: S) -> Self {
        self.name_for_search = Some(search_str.into());
        self
    }
}

#[cfg(feature = "master-db")]
impl Into<NewArtist> for crate::masterdb::models::DjmdArtist {
    fn into(self) -> NewArtist {
        NewArtist {
            name: self.name,
            name_for_search: self.search_str,
        }
    }
}

// Clones of Artist for associating with Content

#[derive(Debug, Clone, PartialEq, HasQuery, Identifiable)]
#[diesel(table_name = artist)]
#[diesel(primary_key(id))]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct Remixer {
    pub id: i32,
    pub name: String,
    pub name_for_search: Option<String>,
}

#[derive(Debug, Clone, PartialEq, HasQuery, Identifiable)]
#[diesel(table_name = artist)]
#[diesel(primary_key(id))]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct OriginalArtist {
    pub id: i32,
    pub name: String,
    pub name_for_search: Option<String>,
}

#[derive(Debug, Clone, PartialEq, HasQuery, Identifiable)]
#[diesel(table_name = artist)]
#[diesel(primary_key(id))]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct Composer {
    pub id: i32,
    pub name: String,
    pub name_for_search: Option<String>,
}

#[derive(Debug, Clone, PartialEq, HasQuery, Identifiable)]
#[diesel(table_name = artist)]
#[diesel(primary_key(id))]
#[diesel(check_for_backend(diesel::sqlite::Sqlite))]
#[cfg_attr(feature = "pyo3", pyclass(get_all, set_all, mapping))]
#[cfg_attr(feature = "pyo3", derive(PyMutableMapping))]
#[cfg_attr(feature = "napi", napi(object))]
pub struct Lyricist {
    pub id: i32,
    pub name: String,
    pub name_for_search: Option<String>,
}