Refactorisation complète de la crate `pmoradiofrance` pour simplifier l'architecture autour d'un cache de métadonnées centralisé avec système d'événements.
## Objectifs
1. Simplifier les structures de stations (supprimer StationType)
2. Créer un cache de métadonnées in-memory avec TTL basé sur `end_time`
3. Maintenir le cache de stations persistant (pmoconfig, TTL 1 semaine)
4. Implémenter un système d'événements pour la synchronisation GENA
5. Unifier les méthodes `to_didl()` pour retourner des Containers DIDL
6. Gérer automatiquement le cache des covers via pmocovers
## Changements architecturaux majeurs
### 1. Nouveau fichier: metadata_cache.rs
**Créé**: `pmoradiofrance/src/metadata_cache.rs`
Contient deux structures principales:
- **CachedMetadata**: Stocke uniquement les données nécessaires au DIDL (titre, artiste, album, cover, stream URL, etc.)
- **MetadataCache**: Gère le cache in-memory avec TTL + cache persistant des stations + système d'événements
**Fonctionnalités**:
- TTL basé sur `end_time` de l'API Radio France
- Gestion automatique du cache de covers via pmocovers
- Système subscribe/notify pour les événements
- Graceful degradation si API Radio France down
- Méthode `to_didl()` retournant une playlist à un item avec métadonnées identiques
### 2. Suppression: stateful_client.rs
**Supprimé**: `pmoradiofrance/src/stateful_client.rs`
Raison: Complètement redondant avec `MetadataCache`. Toute la logique a été déplacée dans le nouveau module.
### 3. Simplification: models.rs
**Modifications**:
- Supprimé `StationType` enum
- Simplifié `Station` struct (juste `slug` + `name`)
- Supprimé méthodes `is_main()`, `is_webradio()`, `is_local_radio()`, `base_station()`
- Conservé structures d'API (`LiveResponse`, `ShowMetadata`, etc.)
### 4. Simplification: playlist.rs
**Modifications**:
- Supprimé `StationPlaylist` complètement
- Simplifié `StationGroup` et `StationGroups`
- **Important**: `to_didl()` retourne `Container` (pas `Vec<Container>`)
- Logique unifiée: ICI fonctionne comme FIP (plus de traitement spécial)
- Préservé les règles de mapping RF → UPnP existantes
### 5. Refactoring: source.rs
**Modifications**:
- Utilise uniquement `MetadataCache` (plus de `stateful_client`)
- Simplifié `browse()` en 3 cas simples
- Abonnement aux événements du cache pour GENA
- Retourne des `Container` (cohérence avec to_didl)
### 6. Adaptation: config_ext.rs
**Modifications**:
- Format simplifié: `Vec<Station>` au lieu de `CachedStationList`
- TTL reste à 7 jours (1 semaine)
### 7. Mise à jour: lib.rs
**Modifications**:
- Ajouté `pub mod metadata_cache;`
- Supprimé export de `stateful_client`
- Ajouté exports: `MetadataCache`, `CachedMetadata`
## Hiérarchie de browse
**Niveau 0**: `radiofrance`
- Retourne UN Container contenant les containers de groupes
- Exemple: Container "FIP", Container "France Culture", Container "ICI"
**Niveau 1**: `radiofrance:group:fip` ou `radiofrance:ici`
- Si 1 station: retourne directement la playlist (Container playlistContainer)
- Si plusieurs stations: retourne un container contenant les playlists
**Niveau 2**: `radiofrance:fip`
- Retourne Container playlistContainer avec 1 item
- Métadonnées identiques entre playlist et item
## Règles de mapping préservées
Les règles existantes de transformation RF → UPnP ont été préservées:
- Radio musicale avec song → métadonnées du morceau
- Radio parlée → agrégation émission/producteur
- Éviter duplications du nom de station
- Calcul de duration depuis end_time
## Système d'événements
**Flux**:
1. `MetadataCache` rafraîchit les métadonnées d'un slug
2. Notifie tous les abonnés via `notify(slug)`
3. `RadioFranceSource` reçoit l'événement
4. Émet un événement GENA UPnP pour la playlist `radiofrance:{slug}`
5. Le Control Point reçoit la notification et peut se mettre à jour
## Fichiers modifiés
### Créés
- `pmoradiofrance/src/metadata_cache.rs`
### Supprimés
- `pmoradiofrance/src/stateful_client.rs`
### Modifiés
- `pmoradiofrance/src/models.rs`
- `pmoradiofrance/src/playlist.rs`
- `pmoradiofrance/src/source.rs`
- `pmoradiofrance/src/config_ext.rs`
- `pmoradiofrance/src/lib.rs`
### Inchangés
- `pmoradiofrance/src/client.rs`
- `pmoradiofrance/src/error.rs`
## Points de vigilance
1. **Migration**: Le cache pmoconfig existant sera invalidé (nouveau format)
2. **Covers**: Nécessite que pmocovers soit initialisé via cache_registry
3. **Thread safety**: Utilisation d'Arc<RwLock> pour la sécurité thread
4. **Graceful degradation**: Retourne cache expiré si API Radio France down
## Prochaines étapes
1. Tester le cache de métadonnées (TTL, refresh, graceful degradation)
2. Tester le système d'événements
3. Tester le browse sur les 3 niveaux
4. Vérifier les événements GENA
5. Vérifier que les covers sont correctement cachées
266 lines
7.8 KiB
Rust
266 lines
7.8 KiB
Rust
//! # Sources Registration API - Endpoints d'enregistrement dynamique des sources
|
|
//!
|
|
//! Ce module étend l'API de base de `pmosource` avec des endpoints d'enregistrement
|
|
//! spécifiques pour chaque type de source musicale (Qobuz, Paradise, etc.).
|
|
//!
|
|
//! ## Routes additionnelles
|
|
//!
|
|
//! - `POST /sources/qobuz` - Enregistrer Qobuz (feature "qobuz")
|
|
//! - `POST /sources/paradise` - Enregistrer Radio Paradise (feature "paradise")
|
|
//!
|
|
//! ## Architecture
|
|
//!
|
|
//! Ces endpoints sont définis ici plutôt que dans `pmosource` pour éviter les
|
|
//! dépendances circulaires (pmoqobuz et pmoparadise dépendent de pmosource).
|
|
|
|
use axum::{Router, extract::Json, http::StatusCode, response::IntoResponse, routing::post};
|
|
use pmosource::MusicSource;
|
|
use serde::{Deserialize, Serialize};
|
|
use std::sync::Arc;
|
|
|
|
/// Credentials pour Qobuz
|
|
#[cfg(feature = "qobuz")]
|
|
#[derive(Debug, Deserialize, utoipa::ToSchema)]
|
|
pub struct QobuzCredentials {
|
|
/// Nom d'utilisateur Qobuz (optionnel, lu depuis la config si absent)
|
|
pub username: Option<String>,
|
|
/// Mot de passe Qobuz (optionnel, lu depuis la config si absent)
|
|
pub password: Option<String>,
|
|
/// URL de base du serveur (optionnelle, "http://localhost:8080" par défaut)
|
|
#[serde(default)]
|
|
pub base_url: Option<String>,
|
|
}
|
|
|
|
/// Paramètres pour Radio Paradise
|
|
#[cfg(feature = "paradise")]
|
|
#[derive(Debug, Deserialize, utoipa::ToSchema)]
|
|
pub struct ParadiseParams {
|
|
/// Capacité FIFO (optionnelle, 50 par défaut)
|
|
#[serde(default)]
|
|
pub fifo_capacity: Option<usize>,
|
|
|
|
/// URL de base du serveur (optionnelle, "http://localhost:8080" par défaut)
|
|
#[serde(default)]
|
|
pub base_url: Option<String>,
|
|
}
|
|
|
|
/// Réponse d'enregistrement de source
|
|
#[derive(Debug, Serialize, utoipa::ToSchema)]
|
|
pub struct SourceRegisteredResponse {
|
|
/// Message de succès
|
|
pub message: String,
|
|
/// ID de la source enregistrée
|
|
pub source_id: String,
|
|
}
|
|
|
|
/// Message d'erreur
|
|
#[derive(Debug, Serialize, utoipa::ToSchema)]
|
|
pub struct ErrorResponse {
|
|
/// Message d'erreur
|
|
pub error: String,
|
|
}
|
|
|
|
/// Enregistre une source Qobuz
|
|
///
|
|
/// Enregistre une nouvelle source Qobuz avec les credentials fournis ou depuis la config.
|
|
#[cfg(feature = "qobuz")]
|
|
#[utoipa::path(
|
|
post,
|
|
path = "/sources/qobuz",
|
|
request_body = QobuzCredentials,
|
|
responses(
|
|
(status = 201, description = "Source enregistrée", body = SourceRegisteredResponse),
|
|
(status = 400, description = "Erreur d'enregistrement", body = ErrorResponse),
|
|
),
|
|
tag = "sources"
|
|
)]
|
|
async fn register_qobuz(Json(creds): Json<QobuzCredentials>) -> impl IntoResponse {
|
|
use pmoqobuz::{QobuzClient, QobuzSource};
|
|
use pmosource::api::register_source;
|
|
|
|
// Utiliser l'URL de base depuis les params ou une valeur par défaut
|
|
let base_url = creds
|
|
.base_url
|
|
.unwrap_or_else(|| "http://localhost:8080".to_string());
|
|
|
|
// Créer le client selon les credentials fournis
|
|
let client_result = if let (Some(username), Some(password)) = (creds.username, creds.password) {
|
|
QobuzClient::new(&username, &password).await
|
|
} else {
|
|
QobuzClient::from_config().await
|
|
};
|
|
|
|
let client = match client_result {
|
|
Ok(c) => c,
|
|
Err(e) => {
|
|
return (
|
|
StatusCode::BAD_REQUEST,
|
|
Json(ErrorResponse {
|
|
error: format!("Failed to create Qobuz client: {}", e),
|
|
}),
|
|
)
|
|
.into_response();
|
|
}
|
|
};
|
|
|
|
// Créer et enregistrer la source depuis le registry
|
|
let source = match QobuzSource::from_registry(client, base_url) {
|
|
Ok(s) => Arc::new(s),
|
|
Err(e) => {
|
|
return (
|
|
StatusCode::INTERNAL_SERVER_ERROR,
|
|
Json(ErrorResponse {
|
|
error: format!("Failed to create source: {}", e),
|
|
}),
|
|
)
|
|
.into_response();
|
|
}
|
|
};
|
|
let source_id = source.as_ref().id().to_string();
|
|
|
|
register_source(source).await;
|
|
|
|
(
|
|
StatusCode::CREATED,
|
|
Json(SourceRegisteredResponse {
|
|
message: "Qobuz source registered successfully".to_string(),
|
|
source_id,
|
|
}),
|
|
)
|
|
.into_response()
|
|
}
|
|
|
|
/// Enregistre une source Radio Paradise
|
|
///
|
|
/// Enregistre une nouvelle source Radio Paradise (ne nécessite pas d'authentification).
|
|
#[cfg(feature = "paradise")]
|
|
#[utoipa::path(
|
|
post,
|
|
path = "/sources/paradise",
|
|
request_body = ParadiseParams,
|
|
responses(
|
|
(status = 201, description = "Source enregistrée", body = SourceRegisteredResponse),
|
|
(status = 400, description = "Erreur d'enregistrement", body = ErrorResponse),
|
|
),
|
|
tag = "sources"
|
|
)]
|
|
async fn register_paradise(Json(params): Json<ParadiseParams>) -> impl IntoResponse {
|
|
use pmoparadise::RadioParadiseSource;
|
|
use pmosource::api::register_source;
|
|
|
|
// Utiliser l'URL de base depuis les params ou une valeur par défaut
|
|
let base_url = params
|
|
.base_url
|
|
.unwrap_or_else(|| "http://localhost:8080".to_string());
|
|
|
|
// Créer la source Radio Paradise (utilise le singleton PlaylistManager)
|
|
let source = Arc::new(RadioParadiseSource::new(base_url));
|
|
|
|
let source_id = source.as_ref().id().to_string();
|
|
|
|
register_source(source).await;
|
|
|
|
(
|
|
StatusCode::CREATED,
|
|
Json(SourceRegisteredResponse {
|
|
message: "Radio Paradise source registered successfully".to_string(),
|
|
source_id,
|
|
}),
|
|
)
|
|
.into_response()
|
|
}
|
|
|
|
/// Crée un router avec les endpoints d'enregistrement des sources
|
|
///
|
|
/// Ce router doit être combiné avec le router de base de `pmosource::api::create_sources_router()`
|
|
/// pour obtenir une API complète.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```ignore
|
|
/// use pmomediaserver::sources_api::create_registration_router;
|
|
/// use pmosource::api::create_sources_router;
|
|
/// use axum::Router;
|
|
///
|
|
/// let sources_router = create_sources_router();
|
|
/// let registration_router = create_registration_router();
|
|
/// let combined = sources_router.merge(registration_router);
|
|
/// ```
|
|
pub fn create_registration_router() -> Router {
|
|
let mut router = Router::new();
|
|
|
|
#[cfg(feature = "qobuz")]
|
|
{
|
|
router = router.route("/sources/qobuz", post(register_qobuz));
|
|
}
|
|
|
|
#[cfg(feature = "paradise")]
|
|
{
|
|
router = router.route("/sources/paradise", post(register_paradise));
|
|
}
|
|
|
|
router
|
|
}
|
|
|
|
/// Structure pour la documentation OpenAPI des endpoints d'enregistrement (Qobuz + Paradise)
|
|
#[cfg(all(feature = "qobuz", feature = "paradise"))]
|
|
#[derive(utoipa::OpenApi)]
|
|
#[openapi(
|
|
paths(
|
|
register_qobuz,
|
|
register_paradise,
|
|
),
|
|
components(
|
|
schemas(
|
|
SourceRegisteredResponse,
|
|
ErrorResponse,
|
|
QobuzCredentials,
|
|
ParadiseParams,
|
|
)
|
|
),
|
|
tags(
|
|
(name = "sources", description = "Enregistrement dynamique des sources musicales")
|
|
)
|
|
)]
|
|
pub struct SourceRegistrationApiDoc;
|
|
|
|
/// Structure pour la documentation OpenAPI (Qobuz uniquement)
|
|
#[cfg(all(feature = "qobuz", not(feature = "paradise")))]
|
|
#[derive(utoipa::OpenApi)]
|
|
#[openapi(
|
|
paths(
|
|
register_qobuz,
|
|
),
|
|
components(
|
|
schemas(
|
|
SourceRegisteredResponse,
|
|
ErrorResponse,
|
|
QobuzCredentials,
|
|
)
|
|
),
|
|
tags(
|
|
(name = "sources", description = "Enregistrement dynamique des sources musicales")
|
|
)
|
|
)]
|
|
pub struct SourceRegistrationApiDoc;
|
|
|
|
/// Structure pour la documentation OpenAPI (Paradise uniquement)
|
|
#[cfg(all(feature = "paradise", not(feature = "qobuz")))]
|
|
#[derive(utoipa::OpenApi)]
|
|
#[openapi(
|
|
paths(
|
|
register_paradise,
|
|
),
|
|
components(
|
|
schemas(
|
|
SourceRegisteredResponse,
|
|
ErrorResponse,
|
|
ParadiseParams,
|
|
)
|
|
),
|
|
tags(
|
|
(name = "sources", description = "Enregistrement dynamique des sources musicales")
|
|
)
|
|
)]
|
|
pub struct SourceRegistrationApiDoc;
|