]> git.sesse.net Git - vlc/blobdiff - modules/services_discovery/sap.c
* backport of [11257] to trunk
[vlc] / modules / services_discovery / sap.c
index f866cfc8b65203cdd3fcfd246c460fa33b11d865..f671119be7d27f96528585ae5d0c66f536cc32f0 100644 (file)
@@ -4,7 +4,7 @@
  * Copyright (C) 2004-2005 VideoLAN
  * $Id$
  *
- * Authors: Clément Stenac <zorglub@videolan.org>
+ * Authors: Clément Stenac <zorglub@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -34,7 +34,8 @@
 #include "network.h"
 #include "charset.h"
 
-#include <errno.h>                                                 /* ENOMEM */
+#include <ctype.h>
+#include <errno.h>
 
 #ifdef HAVE_UNISTD_H
 #    include <unistd.h>
 
 /* SAP is always on that port */
 #define SAP_PORT 9875
-#define SAP_V4_ADDRESS "224.2.127.254"
+/* Global-scope SAP address */
+#define SAP_V4_GLOBAL_ADDRESS   "224.2.127.254"
+/* Organization-local SAP address */
+#define SAP_V4_ORG_ADDRESS      "239.195.255.255"
+/* Local (smallest non-link-local scope) SAP address */
+#define SAP_V4_LOCAL_ADDRESS    "239.255.255.255"
+/* Link-local SAP address */
+#define SAP_V4_LINK_ADDRESS     "224.0.0.255"
 #define ADD_SESSION 1
 
-#define IPV6_ADDR_1 "FF0"  /* Scope is inserted between them */
-#define IPV6_ADDR_2 "::2:7FFE"
+#define SAP_V6_1 "FF0"
+/* Scope is inserted between them */
+#define SAP_V6_2 "::2:7FFE"
+/* See RFC3513 for list of valid scopes */
+static const char ipv6_scopes[] = "12456789ABCDE";
 
 
 /*****************************************************************************
 #define SAP_IPV4_TEXT N_( "IPv4-SAP listening" )
 #define SAP_IPV4_LONGTEXT N_( \
       "Set this if you want the SAP module to listen to IPv4 announces " \
-      "on the standard address" )
+      "on the standard address." )
 #define SAP_IPV6_TEXT N_( "IPv6-SAP listening" )
 #define SAP_IPV6_LONGTEXT N_( \
       "Set this if you want the SAP module to listen to IPv6 announces " \
-      "on the standard address" )
+      "on the standard address." )
 #define SAP_SCOPE_TEXT N_( "IPv6 SAP scope" )
 #define SAP_SCOPE_LONGTEXT N_( \
-       "Sets the scope for IPv6 announces (default is 8)" )
+       "Sets the scope for IPv6 announces (default is 8)." )
 #define SAP_TIMEOUT_TEXT N_( "SAP timeout (seconds)" )
 #define SAP_TIMEOUT_LONGTEXT N_( \
        "Sets the time before SAP items get deleted if no new announce " \
 #define SAP_PARSE_TEXT N_( "Try to parse the SAP" )
 #define SAP_PARSE_LONGTEXT N_( \
        "When SAP can it will try to parse the SAP. If you don't select " \
-       "this, all announces will be parsed by the livedotcom module" )
+       "this, all announces will be parsed by the livedotcom module." )
 #define SAP_STRICT_TEXT N_( "SAP Strict mode" )
 #define SAP_STRICT_LONGTEXT N_( \
        "When this is set, the SAP parser will discard some non-compliant " \
-       "announces" )
+       "announces." )
 #define SAP_CACHE_TEXT N_("Use SAP cache")
 #define SAP_CACHE_LONGTEXT N_( \
-       "If this option is selected, a SAP caching mechanism will be used." \
+       "If this option is selected, a SAP caching mechanism will be used. " \
        "This will result in lower SAP startup time, but you could end up " \
         "with items corresponding to legacy streams." )
 
@@ -112,10 +123,8 @@ vlc_module_begin();
                 SAP_ADDR_TEXT, SAP_ADDR_LONGTEXT, VLC_TRUE );
     add_bool( "sap-ipv4", 1 , NULL,
                SAP_IPV4_TEXT,SAP_IPV4_LONGTEXT, VLC_TRUE );
-    add_bool( "sap-ipv6", 0 , NULL,
+    add_bool( "sap-ipv6", 1 , NULL,
               SAP_IPV6_TEXT, SAP_IPV6_LONGTEXT, VLC_TRUE );
-    add_string( "sap-ipv6-scope", "8" , NULL,
-                SAP_SCOPE_TEXT, SAP_SCOPE_LONGTEXT, VLC_TRUE);
     add_integer( "sap-timeout", 1800, NULL,
                  SAP_TIMEOUT_TEXT, SAP_TIMEOUT_LONGTEXT, VLC_TRUE );
     add_bool( "sap-parse", 1 , NULL,
@@ -191,7 +200,8 @@ struct sap_announce_t
     /* SAP annnounces must only contain one SDP */
     sdp_t       *p_sdp;
 
-    playlist_item_t *p_item;
+    int i_item_id;
+//    playlist_item_t *p_item;
 };
 
 struct services_discovery_sys_t
@@ -202,6 +212,7 @@ struct services_discovery_sys_t
 
     /* playlist node */
     playlist_item_t *p_node;
+    playlist_t *p_playlist;
 
     /* charset conversion */
     vlc_iconv_t iconvHandle;
@@ -250,11 +261,11 @@ struct demux_sys_t
     static int InitSocket( services_discovery_t *p_sd, char *psz_address, int i_port );
 #ifdef HAVE_ZLIB_H
     static int Decompress( unsigned char *psz_src, unsigned char **_dst, int i_len );
-    static void FreeSDP( sdp_t *p_sdp );
 #endif
+    static void FreeSDP( sdp_t *p_sdp );
 
 /* Detect multicast addresses */
-static int  ismult( char * );
+static vlc_bool_t ismult( char * );
 
 #define FREE( p ) \
     if( p ) { free( p ); (p) = NULL; }
@@ -267,7 +278,6 @@ static int Open( vlc_object_t *p_this )
     services_discovery_sys_t *p_sys  = (services_discovery_sys_t *)
                                 malloc( sizeof( services_discovery_sys_t ) );
 
-    playlist_t          *p_playlist;
     playlist_view_t     *p_view;
     char                *psz_addr, *psz_charset;
     vlc_value_t         val;
@@ -279,7 +289,8 @@ static int Open( vlc_object_t *p_this )
     free( psz_charset );
     if( p_sys->iconvHandle == (vlc_iconv_t)(-1) )
     {
-        msg_Warn( p_sd, "Unable to do requested conversion" );
+        msg_Err( p_sd, "unable to perform characters conversion" );
+       return VLC_EGENERIC;
     }
 
     p_sd->pf_run = Run;
@@ -298,26 +309,21 @@ static int Open( vlc_object_t *p_this )
 
     if( var_CreateGetInteger( p_sd, "sap-ipv4" ) )
     {
-        InitSocket( p_sd, SAP_V4_ADDRESS, SAP_PORT );
+        InitSocket( p_sd, SAP_V4_GLOBAL_ADDRESS, SAP_PORT );
+        InitSocket( p_sd, SAP_V4_ORG_ADDRESS, SAP_PORT );
+        InitSocket( p_sd, SAP_V4_LOCAL_ADDRESS, SAP_PORT );
+        InitSocket( p_sd, SAP_V4_LINK_ADDRESS, SAP_PORT );
     }
     if( var_CreateGetInteger( p_sd, "sap-ipv6" ) )
     {
-        /* [ + 8x4+7*':' + ] */
-        char psz_address[42];
-        char c_scope;
-        char *psz_scope = var_CreateGetString( p_sd, "sap-ipv6-scope" );
+        char psz_address[] = SAP_V6_1"0"SAP_V6_2;
+        const char *c_scope;
 
-        if( psz_scope == NULL || *psz_scope == '\0')
+        for( c_scope = ipv6_scopes; *c_scope; c_scope++ )
         {
-            c_scope = '8';
+            psz_address[sizeof(SAP_V6_1) - 1] = *c_scope;
+            InitSocket( p_sd, psz_address, SAP_PORT );
         }
-        else
-        {
-            c_scope = psz_scope[0];
-        }
-        snprintf( psz_address, 42, "[%s%c%s]", IPV6_ADDR_1, c_scope,
-                                               IPV6_ADDR_2 );
-        InitSocket( p_sd, psz_address, SAP_PORT );
     }
 
     psz_addr = var_CreateGetString( p_sd, "sap-addr" );
@@ -333,22 +339,22 @@ static int Open( vlc_object_t *p_this )
     }
 
     /* Create our playlist node */
-    p_playlist = (playlist_t *)vlc_object_find( p_sd, VLC_OBJECT_PLAYLIST,
-                                                FIND_ANYWHERE );
-    if( !p_playlist )
+    p_sys->p_playlist = (playlist_t *)vlc_object_find( p_sd,
+                                                       VLC_OBJECT_PLAYLIST,
+                                                       FIND_ANYWHERE );
+    if( !p_sys->p_playlist )
     {
         msg_Warn( p_sd, "unable to find playlist, cancelling SAP listening");
         return VLC_EGENERIC;
     }
 
-    p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
-    p_sys->p_node = playlist_NodeCreate( p_playlist, VIEW_CATEGORY,
+    p_view = playlist_ViewFind( p_sys->p_playlist, VIEW_CATEGORY );
+    p_sys->p_node = playlist_NodeCreate( p_sys->p_playlist, VIEW_CATEGORY,
                                          _("SAP"), p_view->p_root );
     p_sys->p_node->i_flags |= PLAYLIST_RO_FLAG;
+    p_sys->p_node->i_flags =~ PLAYLIST_SKIP_FLAG;
     val.b_bool = VLC_TRUE;
-    var_Set( p_playlist, "intf-change", val );
-
-    vlc_object_release( p_playlist );
+    var_Set( p_sys->p_playlist, "intf-change", val );
 
     p_sys->i_announces = 0;
     p_sys->pp_announces = NULL;
@@ -454,7 +460,6 @@ static void Close( vlc_object_t *p_this )
     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
     services_discovery_sys_t    *p_sys  = p_sd->p_sys;
 
-    playlist_t *p_playlist;
     int i;
 
     for( i = p_sys->i_fd-1 ; i >= 0 ; i-- )
@@ -474,17 +479,14 @@ static void Close( vlc_object_t *p_this )
     }
     FREE( p_sys->pp_announces );
 
-    p_playlist = (playlist_t *) vlc_object_find( p_sd, VLC_OBJECT_PLAYLIST,
-                                                 FIND_ANYWHERE );
-
-    if( p_playlist )
+    if( p_sys->p_playlist )
     {
-        playlist_NodeDelete( p_playlist, p_sys->p_node, VLC_TRUE , VLC_TRUE );
-        vlc_object_release( p_playlist );
+        playlist_NodeDelete( p_sys->p_playlist, p_sys->p_node, VLC_TRUE,
+                             VLC_TRUE );
+        vlc_object_release( p_sys->p_playlist );
     }
 
-    if( p_sys->iconvHandle != (vlc_iconv_t)(-1) )
-        vlc_iconv_close( p_sys->iconvHandle );
+    vlc_iconv_close( p_sys->iconvHandle );
 
     free( p_sys );
 }
@@ -507,21 +509,12 @@ static void CloseDemux( vlc_object_t *p_this )
 static void Run( services_discovery_t *p_sd )
 {
     int                i;
-    uint8_t     *p_buffer;
-    playlist_t  *p_playlist;
 
     /* read SAP packets */
     while( !p_sd->b_die )
     {
         int i_read;
-        p_buffer = (uint8_t *)malloc( MAX_SAP_BUFFER );
-
-        if( !p_buffer )
-        {
-            msg_Err( p_sd, "out of memory");
-            p_sd->b_die = VLC_TRUE;
-            continue;
-        }
+       uint8_t p_buffer[MAX_SAP_BUFFER];
 
         i_read = net_Select( p_sd, p_sd->p_sys->pi_fd, NULL,
                              p_sd->p_sys->i_fd, p_buffer,
@@ -537,18 +530,9 @@ static void Run( services_discovery_t *p_sd )
                 struct sap_announce_t *p_announce;
                 p_announce = p_sd->p_sys->pp_announces[i];
 
-                msg_Dbg( p_sd, "Time out for %s, deleting (%i/%i)",
-                        p_announce->p_item->input.psz_name,
-                        i , p_sd->p_sys->i_announces );
-
                 /* Remove the playlist item */
-                p_playlist = vlc_object_find( p_sd, VLC_OBJECT_PLAYLIST,
-                              FIND_ANYWHERE );
-                if( p_playlist )
-                {
-                    playlist_Delete( p_playlist, p_announce->p_item->input.i_id );
-                    vlc_object_release( p_playlist );
-                }
+                playlist_LockDelete( p_sd->p_sys->p_playlist,
+                                     p_announce->i_item_id );
 
                 /* Remove the sap_announce from the array */
                 REMOVE_ELEM( p_sd->p_sys->pp_announces,
@@ -565,7 +549,6 @@ static void Run( services_discovery_t *p_sd )
             {
                 msg_Warn( p_sd, "socket read error" );
             }
-            free( p_buffer );
             continue;
         }
 
@@ -573,8 +556,6 @@ static void Run( services_discovery_t *p_sd )
 
         /* Parse the packet */
         ParseSAP( p_sd, p_buffer, i_read );
-
-        free( p_buffer );
     }
 }
 
@@ -795,7 +776,6 @@ static int ParseSAP( services_discovery_t *p_sd, uint8_t *p_buffer, int i_read )
 sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
                                 sdp_t *p_sdp )
 {
-    playlist_t          *p_playlist;
     playlist_item_t     *p_item, *p_child;
     char                *psz_value;
     sap_announce_t *p_sap = (sap_announce_t *)malloc(
@@ -804,16 +784,14 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     psz_value = convert_from_utf8( p_sd, p_sdp->psz_sessionname );
     if( p_sap == NULL || psz_value == NULL )
     {
-        msg_Err( p_sd, "out of memory");
         FREE( p_sap );
         FREE( psz_value );
-        p_sd->b_die = VLC_TRUE;
         return NULL;
     }
     p_sap->i_last = mdate();
     p_sap->i_hash = i_hash;
     p_sap->p_sdp = p_sdp;
-    p_sap->p_item = NULL;
+    p_sap->i_item_id = -1;
 
     /* Create the playlist item here */
     p_item = playlist_ItemNew( p_sd, p_sap->p_sdp->psz_uri, psz_value );
@@ -844,15 +822,6 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
         psz_value = GetAttribute( p_sap->p_sdp, "plgroup" );
     }
 
-    p_playlist = (playlist_t *)vlc_object_find( p_sd, VLC_OBJECT_PLAYLIST,
-                                                FIND_ANYWHERE );
-    if( !p_playlist )
-    {
-        msg_Err( p_sd, "playlist not found" );
-        free( p_sap );
-        return NULL;
-    }
-
     if( psz_value != NULL )
     {
         char *psz_grp = convert_from_utf8( p_sd, psz_value );
@@ -863,13 +832,16 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
                                                 psz_grp );
 
             if( p_child == NULL )
-                p_child = playlist_NodeCreate( p_playlist, VIEW_CATEGORY,
-                                               psz_grp, p_sd->p_sys->p_node );
+            {
+                p_child = playlist_NodeCreate( p_sd->p_sys->p_playlist,
+                                               VIEW_CATEGORY, psz_grp,
+                                               p_sd->p_sys->p_node );
+                p_child->i_flags =~ PLAYLIST_SKIP_FLAG;
+            }
             free( psz_grp );
         }
         else
         {
-            vlc_object_release( p_playlist );
             msg_Err( p_sd, "out of memory");
             free( p_sap );
             return NULL;
@@ -883,12 +855,10 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     p_item->i_flags &= ~PLAYLIST_SKIP_FLAG;
     p_item->i_flags &= ~PLAYLIST_SAVE_FLAG;
 
-    playlist_NodeAddItem( p_playlist, p_item, VIEW_CATEGORY, p_child,
-                          PLAYLIST_APPEND, PLAYLIST_END );
-
-    vlc_object_release( p_playlist );
+    playlist_NodeAddItem( p_sd->p_sys->p_playlist, p_item, VIEW_CATEGORY,
+                              p_child, PLAYLIST_APPEND, PLAYLIST_END );
 
-    p_sap->p_item = p_item;
+    p_sap->i_item_id = p_item->input.i_id;
 
     TAB_APPEND( p_sd->p_sys->i_announces,
                 p_sd->p_sys->pp_announces, p_sap );
@@ -1276,29 +1246,48 @@ static char *convert_from_utf8( struct services_discovery_t *p_sd,
 {
     char *psz_local, *psz_in, *psz_out;
     size_t ret, i_in, i_out;
+    vlc_bool_t b_warn = VLC_FALSE;
 
     if( psz_unicode == NULL )
         return NULL;
-    if ( p_sd->p_sys->iconvHandle == (vlc_iconv_t)(-1) )
-        return strdup( psz_unicode );
 
     psz_in = psz_unicode;
     i_in = strlen( psz_unicode );
 
-    i_out = 2 * i_in;
+#ifndef MB_CUR_MAX
+    i_out = 6 * i_in;
+#else
+    i_out = MB_CUR_MAX * i_in;
+#endif
     psz_local = malloc( i_out + 1 );
     if( psz_local == NULL )
-        return strdup( psz_unicode );
+        return NULL;
     psz_out = psz_local;
 
-    ret = vlc_iconv( p_sd->p_sys->iconvHandle,
-                     &psz_in, &i_in, &psz_out, &i_out);
-    if( ret == (size_t)(-1) || i_in )
+    do
     {
-        msg_Warn( p_sd, "Failed to convert \"%s\" from UTF-8", psz_unicode );
-        free( psz_local );
-        return strdup( psz_unicode );
+        ret = vlc_iconv( p_sd->p_sys->iconvHandle,
+                         &psz_in, &i_in, &psz_out, &i_out);
+        if( i_in )
+        {
+            *psz_in = '?';
+            b_warn = VLC_TRUE;
+        }
+        else
+        if( ret == (size_t)(-1) )
+        {
+            msg_Err( p_sd, "character conversion failure : %s",
+                     strerror( errno ) );
+            free( psz_local );
+            return NULL;
+        }
     }
+    while( i_in );
+
+    if( b_warn )
+        msg_Warn( p_sd, "in \"%s\" : %s", psz_unicode, 
+                  strerror( errno ) );
+
     *psz_out = '\0';
     return psz_local;
 }
@@ -1307,26 +1296,26 @@ static char *convert_from_utf8( struct services_discovery_t *p_sd,
 /***********************************************************************
  * ismult: returns true if we have a multicast address
  ***********************************************************************/
-static int ismult( char *psz_uri )
+static vlc_bool_t ismult( char *psz_uri )
 {
     char *psz_end;
     int  i_value;
 
-    i_value = strtol( psz_uri, &psz_end, 0 );
-
     /* IPv6 */
     if( psz_uri[0] == '[')
     {
       if( strncasecmp( &psz_uri[1], "FF0" , 3) ||
-          strncasecmp( &psz_uri[2], "FF0" , 3))
+          ( !isalnum( psz_uri[1]) && strncasecmp( &psz_uri[2], "FF0" , 3) ) )
             return( VLC_TRUE );
         else
             return( VLC_FALSE );
     }
+    
+    i_value = strtol( psz_uri, &psz_end, 0 );
 
     if( *psz_end != '.' ) { return( VLC_FALSE ); }
 
-    return( i_value < 224 ? VLC_FALSE : VLC_TRUE );
+    return ( ( i_value < 224 ) || ( i_value >= 240 ) ) ? VLC_FALSE : VLC_TRUE;
 }
 
 static int InitSocket( services_discovery_t *p_sd, char *psz_address,
@@ -1432,20 +1421,12 @@ static int RemoveAnnounce( services_discovery_t *p_sd,
                            sap_announce_t *p_announce )
 {
     int i;
-    playlist_t *p_playlist = (playlist_t *)vlc_object_find( p_sd,
-                                          VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 
     if( p_announce->p_sdp ) FreeSDP( p_announce->p_sdp );
 
-    if( !p_playlist )
+    if( p_announce->i_item_id > -1 )
     {
-        free( p_announce );
-        return VLC_EGENERIC;
-    }
-
-    if( p_announce->p_item )
-    {
-        playlist_LockDelete( p_playlist, p_announce->p_item->input.i_id );
+        playlist_LockDelete( p_sd->p_sys->p_playlist, p_announce->i_item_id );
     }
 
     for( i = 0; i< p_sd->p_sys->i_announces; i++)
@@ -1458,8 +1439,6 @@ static int RemoveAnnounce( services_discovery_t *p_sd,
         }
     }
 
-    vlc_object_release( p_playlist );
-
     free( p_announce );
 
     return VLC_SUCCESS;