Eric Coissac
60785745aa
- Correction des erreurs dans la génération des éléments XML pour les conteneurs - Amélioration de la gestion des caches (cover et audio) dans ParadiseStreaming - Optimisation des annonces SSDP avec des messages plus clairs - Ajout de logs de debug pour faciliter le débogage - Correction de la gestion des notifications GENA pour le ContentDirectory - Amélioration de la documentation et des commentaires dans les fichiers modifiés
529 lines
17 KiB
Rust
529 lines
17 KiB
Rust
//! Extension UPnP pour pmoserver.
|
|
//!
|
|
//! Ce module fournit le trait `UpnpServer` qui étend `pmoserver::Server`
|
|
//! avec des fonctionnalités UPnP spécifiques.
|
|
//!
|
|
//! # Design Pattern
|
|
//!
|
|
//! Suit le pattern d'extension utilisé dans PMOMusic :
|
|
//! - `pmoserver::Server` reste agnostique d'UPnP
|
|
//! - Le trait `UpnpServer` ajoute les méthodes UPnP spécifiques
|
|
//! - Un `DeviceRegistry` est associé au serveur pour l'introspection
|
|
//!
|
|
//! # Architecture
|
|
//!
|
|
//! ```text
|
|
//! pmoserver::Server
|
|
//! + UpnpServer trait
|
|
//! + DeviceRegistry (thread_local storage)
|
|
//! ```
|
|
|
|
use once_cell::sync::Lazy;
|
|
use std::sync::Arc;
|
|
use std::sync::RwLock;
|
|
|
|
use pmoserver::Server;
|
|
use utoipa::OpenApi;
|
|
|
|
use crate::UpnpModel;
|
|
use crate::devices::errors::DeviceError;
|
|
use crate::devices::{Device, DeviceInstance, DeviceRegistry};
|
|
use crate::ssdp::SsdpServer;
|
|
use crate::upnp_api::UpnpApiExt;
|
|
|
|
use pmoaudiocache::Cache as AudioCache;
|
|
use pmocovers::Cache as CoverCache;
|
|
use pmoutils::{TransportProtocol, find_process_using_port};
|
|
|
|
/// Registre de devices global et thread-safe.
|
|
///
|
|
/// Utilise Lazy pour une initialisation paresseuse et RwLock pour le partage entre threads.
|
|
/// Ceci permet aux API handlers (qui s'exécutent dans des threads différents) d'accéder
|
|
/// au même registre de devices.
|
|
static DEVICE_REGISTRY: Lazy<RwLock<DeviceRegistry>> =
|
|
Lazy::new(|| RwLock::new(DeviceRegistry::new()));
|
|
|
|
/// Serveur SSDP global et thread-safe.
|
|
///
|
|
/// Utilise Lazy pour une initialisation paresseuse et RwLock pour le partage entre threads.
|
|
/// Permet l'annonce automatique des devices UPnP sur le réseau.
|
|
static SSDP_SERVER: Lazy<RwLock<Option<SsdpServer>>> = Lazy::new(|| RwLock::new(None));
|
|
|
|
/// Trait pour étendre un serveur avec des fonctionnalités UPnP.
|
|
///
|
|
/// Ce trait ajoute :
|
|
/// - Enregistrement de devices UPnP
|
|
/// - Accès au registre centralisé de devices
|
|
///
|
|
/// # Design Pattern
|
|
///
|
|
/// Ce trait suit le pattern d'extension utilisé dans PMOMusic,
|
|
/// permettant d'ajouter des fonctionnalités UPnP sans modifier `pmoserver`.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```rust,ignore
|
|
/// use pmoupnp::UpnpServer;
|
|
/// use pmoupnp::devices::Device;
|
|
/// use pmoserver::ServerBuilder;
|
|
/// use std::sync::Arc;
|
|
///
|
|
/// let mut server = ServerBuilder::new_configured().build();
|
|
///
|
|
/// // Enregistrement de devices via le trait UpnpServer
|
|
/// let device = Arc::new(Device::new(
|
|
/// "MediaRenderer".to_string(),
|
|
/// "MediaRenderer".to_string(),
|
|
/// "My Renderer".to_string()
|
|
/// ));
|
|
/// server.register_device(device).await?;
|
|
///
|
|
/// // Introspection via le trait UpnpServer
|
|
/// let devices = server.device_registry().list_devices();
|
|
/// ```
|
|
#[async_trait::async_trait]
|
|
pub trait UpnpServerExt {
|
|
// ========= Device Management (existant) =========
|
|
|
|
/// Enregistre un device UPnP et toutes ses URLs.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `device` - Le modèle du device à enregistrer
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// L'instance du device créée et enregistrée.
|
|
async fn register_device(
|
|
&mut self,
|
|
device: Arc<Device>,
|
|
) -> Result<Arc<DeviceInstance>, DeviceError>;
|
|
|
|
/// Retourne le nombre de devices enregistrés.
|
|
fn device_count(&self) -> usize;
|
|
|
|
/// Liste tous les devices enregistrés.
|
|
fn list_devices(&self) -> Vec<Arc<DeviceInstance>>;
|
|
|
|
/// Récupère un device par son UDN.
|
|
fn get_device(&self, udn: &str) -> Option<Arc<DeviceInstance>>;
|
|
|
|
// ========= Cache Management (NOUVEAU) =========
|
|
|
|
/// Initialiser le cache de couvertures centralisé
|
|
///
|
|
/// Crée le cache et enregistre les routes HTTP.
|
|
/// Toutes les sources musicales utiliseront ce cache partagé.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `cache_dir` - Répertoire de stockage
|
|
/// * `limit` - Limite de taille (nombre d'images)
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// Instance partagée du cache
|
|
async fn init_cover_cache(
|
|
&mut self,
|
|
cache_dir: &str,
|
|
limit: usize,
|
|
) -> Result<Arc<CoverCache>, anyhow::Error>;
|
|
|
|
/// Initialiser le cache audio centralisé
|
|
///
|
|
/// Crée le cache et enregistre les routes HTTP.
|
|
/// Toutes les sources musicales utiliseront ce cache partagé.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `cache_dir` - Répertoire de stockage
|
|
/// * `limit` - Limite de taille (nombre de pistes)
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// Instance partagée du cache
|
|
async fn init_audio_cache(
|
|
&mut self,
|
|
cache_dir: &str,
|
|
limit: usize,
|
|
) -> Result<Arc<AudioCache>, anyhow::Error>;
|
|
|
|
/// Initialiser les caches depuis la configuration
|
|
///
|
|
/// Utilise pmoconfig pour charger les paramètres et initialiser
|
|
/// automatiquement les deux caches.
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// Tuple (cache de couvertures, cache audio)
|
|
async fn init_caches(&mut self) -> Result<(Arc<CoverCache>, Arc<AudioCache>), anyhow::Error>;
|
|
|
|
/// Récupérer le cache de couvertures
|
|
fn cover_cache(&self) -> Option<Arc<CoverCache>>;
|
|
|
|
/// Récupérer le cache audio
|
|
fn audio_cache(&self) -> Option<Arc<AudioCache>>;
|
|
|
|
// ========= SSDP Management (NOUVEAU) =========
|
|
|
|
/// Initialise et démarre le serveur SSDP
|
|
///
|
|
/// Cette méthode crée et démarre le serveur SSDP qui gère les annonces
|
|
/// UPnP sur le réseau (NOTIFY alive/byebye, réponses M-SEARCH).
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// `Ok(())` si l'initialisation réussit, `Err` sinon.
|
|
///
|
|
/// # Note
|
|
///
|
|
/// Cette méthode peut être appelée plusieurs fois sans effet si SSDP
|
|
/// est déjà initialisé.
|
|
fn init_ssdp(&self) -> Result<(), std::io::Error>;
|
|
|
|
/// Vérifie si le serveur SSDP est initialisé
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// `true` si SSDP est actif, `false` sinon
|
|
fn ssdp_enabled(&self) -> bool;
|
|
|
|
/// Crée et initialise le serveur UPnP global (factory method)
|
|
///
|
|
/// Cette méthode factory initialise le **singleton global** du serveur avec
|
|
/// l'infrastructure UPnP complète :
|
|
/// - Serveur HTTP (via pmoserver singleton)
|
|
/// - Caches (couvertures + audio)
|
|
/// - Logging
|
|
/// - Serveur SSDP
|
|
///
|
|
/// Cette fonction est **idempotente** : elle peut être appelée plusieurs fois.
|
|
/// Si le serveur est déjà initialisé, elle retourne simplement la référence existante.
|
|
///
|
|
/// Après cette méthode, l'utilisateur doit :
|
|
/// - Enregistrer ses devices via `register_device()`
|
|
/// - Enregistrer ses sources musicales (via fonctions globales)
|
|
/// - Appeler `start()` puis `wait()` pour attendre l'arrêt
|
|
///
|
|
/// # Returns
|
|
///
|
|
/// Une référence Arc vers le serveur UPnP global, prêt à l'emploi
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Retourne une erreur si l'initialisation échoue (config, caches, SSDP, etc.)
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```ignore
|
|
/// use pmoupnp::UpnpServerExt;
|
|
/// use pmoserver::Server;
|
|
///
|
|
/// let server = Server::create_upnp_server().await?;
|
|
/// server.write().await.register_device(my_device).await?;
|
|
/// server.read().await.wait().await;
|
|
/// ```
|
|
async fn create_upnp_server() -> Result<Arc<tokio::sync::RwLock<Server>>, anyhow::Error>;
|
|
}
|
|
|
|
// Implémentation du trait UpnpServer pour pmoserver::Server
|
|
#[async_trait::async_trait]
|
|
impl UpnpServerExt for Server {
|
|
async fn register_device(
|
|
&mut self,
|
|
device: Arc<Device>,
|
|
) -> Result<Arc<DeviceInstance>, DeviceError> {
|
|
use tracing::info;
|
|
|
|
// Créer l'instance (retourne déjà un Arc<DeviceInstance>)
|
|
let mut di = device.create_instance();
|
|
|
|
// Normaliser la base URL HTTP avant tout enregistrement.
|
|
let server_base_url = self.base_url();
|
|
if let Some(instance) = Arc::get_mut(&mut di) {
|
|
instance.set_server_base_url(server_base_url);
|
|
} else {
|
|
tracing::warn!(
|
|
"Unable to set base URL on device {} before registration; keeping existing value",
|
|
di.udn()
|
|
);
|
|
}
|
|
|
|
// Enregistrer les URLs dans le serveur web
|
|
tracing::warn!("🔍 DEBUG: About to register_urls for device {}", di.udn());
|
|
di.register_urls(self).await?;
|
|
tracing::warn!("🔍 DEBUG: register_urls completed for device {}", di.udn());
|
|
|
|
// Ajouter au registre pour l'introspection
|
|
tracing::warn!("🔍 DEBUG: Adding to DEVICE_REGISTRY...");
|
|
DEVICE_REGISTRY
|
|
.write()
|
|
.unwrap()
|
|
.register(di.clone())
|
|
.map_err(|e| DeviceError::UrlRegistrationError(e))?;
|
|
tracing::warn!("🔍 DEBUG: Added to DEVICE_REGISTRY");
|
|
|
|
// Annoncer via SSDP (si initialisé)
|
|
tracing::warn!("🔍 DEBUG: Checking SSDP...");
|
|
if self.ssdp_enabled() {
|
|
tracing::warn!("🔍 DEBUG: SSDP enabled, getting lock...");
|
|
let ssdp_opt = SSDP_SERVER.read().unwrap();
|
|
if let Some(ref ssdp) = *ssdp_opt {
|
|
tracing::warn!("🔍 DEBUG: SSDP server exists, announcing...");
|
|
use crate::config_ext::UpnpConfigExt;
|
|
let config = pmoconfig::get_config();
|
|
let manufacturer = config
|
|
.get_upnp_manufacturer()
|
|
.unwrap_or_else(|_| "PMOMusic".to_string());
|
|
let ssdp_device = di.to_ssdp_device(&manufacturer, "1.0");
|
|
ssdp.add_device(ssdp_device);
|
|
info!("✅ SSDP announcement for {}", di.udn());
|
|
tracing::warn!("🔍 DEBUG: SSDP announcement complete");
|
|
}
|
|
}
|
|
tracing::warn!("🔍 DEBUG: Returning device instance");
|
|
|
|
Ok(di)
|
|
}
|
|
|
|
fn device_count(&self) -> usize {
|
|
DEVICE_REGISTRY.read().unwrap().count()
|
|
}
|
|
|
|
fn list_devices(&self) -> Vec<Arc<DeviceInstance>> {
|
|
DEVICE_REGISTRY.read().unwrap().list_devices()
|
|
}
|
|
|
|
fn get_device(&self, udn: &str) -> Option<Arc<DeviceInstance>> {
|
|
DEVICE_REGISTRY.read().unwrap().get_device(udn)
|
|
}
|
|
|
|
// ========= Cache Management Implementation =========
|
|
|
|
async fn init_cover_cache(
|
|
&mut self,
|
|
cache_dir: &str,
|
|
limit: usize,
|
|
) -> Result<Arc<CoverCache>, anyhow::Error> {
|
|
// Délègue à l'implémentation pmocovers (qui enregistre WebP + JPEG + API)
|
|
|
|
let cache = pmocovers::CoverCacheExt::init_cover_cache(self, cache_dir, limit).await?;
|
|
Ok(cache)
|
|
}
|
|
|
|
async fn init_audio_cache(
|
|
&mut self,
|
|
cache_dir: &str,
|
|
limit: usize,
|
|
) -> Result<Arc<AudioCache>, anyhow::Error> {
|
|
use pmoaudiocache::new_cache;
|
|
use pmocache::pmoserver_ext::{create_api_router, create_file_router};
|
|
|
|
let cache = Arc::new(new_cache(cache_dir, limit)?);
|
|
|
|
// Routes de fichiers pour servir les pistes FLAC
|
|
let file_router = create_file_router(cache.clone(), "audio/flac");
|
|
self.add_router("/", file_router).await;
|
|
|
|
// API REST générique (pmocache)
|
|
let api_router = create_api_router(cache.clone());
|
|
let openapi = pmoaudiocache::ApiDoc::openapi();
|
|
self.add_openapi(api_router, openapi, "audio").await;
|
|
|
|
// API playlists (SSE + OpenAPI)
|
|
#[cfg(feature = "server")]
|
|
{
|
|
use pmoplaylist::{openapi::ApiDoc, playlist_api_router, playlist_events_router};
|
|
// API REST + SSE sous /api/playlists
|
|
let router = playlist_api_router().merge(playlist_events_router());
|
|
self.add_router("/api/playlists", router).await;
|
|
// OpenAPI pour playlists
|
|
let openapi = ApiDoc::openapi();
|
|
self.add_openapi(axum::Router::new(), openapi, "playlists")
|
|
.await;
|
|
}
|
|
|
|
// Enregistrer le cache dans le registre global
|
|
pmoaudiocache::register_audio_cache(cache.clone());
|
|
|
|
Ok(cache)
|
|
}
|
|
|
|
async fn init_caches(&mut self) -> Result<(Arc<CoverCache>, Arc<AudioCache>), anyhow::Error> {
|
|
use pmoaudiocache::AudioCacheConfigExt;
|
|
use pmocovers::CoverCacheConfigExt;
|
|
|
|
let config = pmoconfig::get_config();
|
|
|
|
let cover_cache = self
|
|
.init_cover_cache(&config.get_covers_dir()?, config.get_covers_size()?)
|
|
.await?;
|
|
|
|
let audio_cache = self
|
|
.init_audio_cache(&config.get_audiocache_dir()?, config.get_audiocache_size()?)
|
|
.await?;
|
|
|
|
Ok((cover_cache, audio_cache))
|
|
}
|
|
|
|
fn cover_cache(&self) -> Option<Arc<CoverCache>> {
|
|
pmocovers::get_cover_cache()
|
|
}
|
|
|
|
fn audio_cache(&self) -> Option<Arc<AudioCache>> {
|
|
pmoaudiocache::get_audio_cache()
|
|
}
|
|
|
|
// ========= SSDP Management Implementation =========
|
|
|
|
fn init_ssdp(&self) -> Result<(), std::io::Error> {
|
|
use tracing::info;
|
|
|
|
let mut ssdp_opt = SSDP_SERVER.write().unwrap();
|
|
if ssdp_opt.is_some() {
|
|
// Déjà initialisé
|
|
return Ok(());
|
|
}
|
|
|
|
let mut ssdp = SsdpServer::new();
|
|
ssdp.start()?;
|
|
*ssdp_opt = Some(ssdp);
|
|
|
|
info!("✅ SSDP server initialized");
|
|
Ok(())
|
|
}
|
|
|
|
fn ssdp_enabled(&self) -> bool {
|
|
SSDP_SERVER.read().unwrap().is_some()
|
|
}
|
|
|
|
async fn create_upnp_server() -> Result<Arc<tokio::sync::RwLock<Server>>, anyhow::Error> {
|
|
use tracing::{error, info, warn};
|
|
|
|
// 1. Initialiser le serveur global singleton
|
|
info!("🔧 Initializing global UPnP server from configuration...");
|
|
let server_arc = pmoserver::init_server();
|
|
|
|
// 2. Initialiser le logging HTTP (routes de logs + tracing)
|
|
info!("📝 Initializing logging...");
|
|
server_arc.write().await.init_logging().await;
|
|
|
|
// 3. Initialiser les caches
|
|
info!("💾 Initializing caches...");
|
|
match server_arc.write().await.init_caches().await {
|
|
Ok(_) => {
|
|
info!("✅ Caches initialized");
|
|
}
|
|
Err(e) => {
|
|
warn!("❌ Cache initialization failed: {}", e);
|
|
return Err(e);
|
|
}
|
|
}
|
|
|
|
// 4. Le serveur HTTP n'est PAS encore démarré
|
|
// Il sera démarré après l'enregistrement des devices et routes
|
|
let base_url = server_arc.read().await.info().base_url;
|
|
info!("🌐 HTTP server configured at {}", base_url);
|
|
|
|
// 5. Enregistrer l'API d'introspection UPnP
|
|
info!("📡 Registering UPnP API...");
|
|
server_arc.write().await.register_upnp_api().await;
|
|
|
|
// 6. Initialiser SSDP
|
|
info!("📡 Initializing SSDP discovery...");
|
|
match server_arc.write().await.init_ssdp() {
|
|
Ok(_) => info!("✅ SSDP server initialized"),
|
|
Err(e) => {
|
|
let kind = e.kind();
|
|
if kind == std::io::ErrorKind::AddrInUse {
|
|
let port = crate::ssdp::SSDP_PORT;
|
|
if let Some(process) = find_process_using_port(port, TransportProtocol::Udp) {
|
|
error!(
|
|
"❌ SSDP initialization failed: port {} is already in use by \
|
|
PID {} ({}) owned by {}: {}",
|
|
port, process.pid, process.process_name, process.owner, e
|
|
);
|
|
} else {
|
|
error!(
|
|
"❌ SSDP initialization failed: port {} is already in use. \
|
|
Unable to identify the blocking process automatically. \
|
|
Check manually with `lsof -nP -i UDP:{}`: {}",
|
|
port, port, e
|
|
);
|
|
}
|
|
} else {
|
|
error!("❌ SSDP initialization failed: {}", e);
|
|
}
|
|
return Err(e.into());
|
|
}
|
|
}
|
|
|
|
info!("🎉 UPnP server infrastructure ready");
|
|
info!("📝 Next: Register devices and music sources");
|
|
Ok(server_arc)
|
|
}
|
|
}
|
|
|
|
/// Fonctions helper pour accéder au registre depuis les handlers.
|
|
///
|
|
/// Ces fonctions permettent d'accéder au registre global depuis
|
|
/// n'importe où dans le code, notamment depuis les handlers Axum.
|
|
|
|
/// Exécute une closure avec un accès en lecture seule aux devices.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```rust,ignore
|
|
/// use pmoupnp::upnp_server::with_devices;
|
|
///
|
|
/// let device_count = with_devices(|devices| devices.len());
|
|
/// ```
|
|
pub fn with_devices<F, R>(f: F) -> R
|
|
where
|
|
F: FnOnce(&Vec<Arc<DeviceInstance>>) -> R,
|
|
{
|
|
let devices = DEVICE_REGISTRY.read().unwrap().list_devices();
|
|
f(&devices)
|
|
}
|
|
|
|
/// Récupère un device par son UDN.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```rust,ignore
|
|
/// use pmoupnp::upnp_server::get_device_by_udn;
|
|
///
|
|
/// if let Some(device) = get_device_by_udn("uuid:...") {
|
|
/// println!("Found device: {}", device.get_name());
|
|
/// }
|
|
/// ```
|
|
pub fn get_device_by_udn(udn: &str) -> Option<Arc<DeviceInstance>> {
|
|
DEVICE_REGISTRY.read().unwrap().get_device(udn)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use pmoserver::ServerBuilder;
|
|
|
|
#[tokio::test]
|
|
async fn test_device_registration() {
|
|
let mut server = ServerBuilder::new("TestServer", "http://localhost:8080", 8080).build();
|
|
|
|
let device = Arc::new(Device::new(
|
|
"TestDevice".to_string(),
|
|
"MediaRenderer".to_string(),
|
|
"Test Renderer".to_string(),
|
|
));
|
|
|
|
let instance = server.register_device(device).await.unwrap();
|
|
|
|
// Vérifier que le device est dans le registre
|
|
assert_eq!(server.device_count(), 1);
|
|
|
|
// Vérifier qu'on peut le retrouver par UDN
|
|
let retrieved = server.get_device(instance.udn());
|
|
assert!(retrieved.is_some());
|
|
}
|
|
}
|