avahi.c 11 KB
Newer Older
1
/*****************************************************************************
2
 * avahi.c: Bonjour services discovery module
3
 *****************************************************************************
4
 * Copyright (C) 2005-2009, 2016 VideoLAN and VLC authors
5 6
 *
 * Authors: Jon Lech Johansen <jon@nanocrew.net>
7
 *          Jean-Baptiste Kempf <jb@videolan.org>
8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Includes
 *****************************************************************************/

28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
33
#include <vlc_common.h>
34
#include <vlc_plugin.h>
35
#include <vlc_services_discovery.h>
36 37

#include <avahi-client/client.h>
38 39
#include <avahi-client/publish.h>
#include <avahi-client/lookup.h>
40
#include <avahi-common/thread-watch.h>
41 42 43 44 45 46 47 48
#include <avahi-common/malloc.h>
#include <avahi-common/error.h>

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/

/* Callbacks */
49 50
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );
51

52
VLC_SD_PROBE_HELPER("avahi", N_("Zeroconf network services"), SD_CAT_LAN)
53

54
vlc_module_begin ()
55 56
    set_shortname( "Avahi" )
    set_description( N_("Zeroconf services") )
57 58 59 60
    set_category( CAT_PLAYLIST )
    set_subcategory( SUBCAT_PLAYLIST_SD )
    set_capability( "services_discovery", 0 )
    set_callbacks( Open, Close )
61
    add_shortcut( "mdns", "avahi" )
62 63

    VLC_SD_PROBE_SUBMODULE
64
vlc_module_end ()
65 66 67 68 69 70 71

/*****************************************************************************
 * Local structures
 *****************************************************************************/

struct services_discovery_sys_t
{
72
    AvahiThreadedPoll   *poll;
73
    AvahiClient         *client;
74
    vlc_dictionary_t    services_name_to_input_item;
75 76
};

77 78 79 80 81
static const struct
{
    const char *psz_protocol;
    const char *psz_service_name;
} protocols[] = {
82 83 84 85
    { "ftp", "_ftp._tcp" },
    { "smb", "_smb._tcp" },
    { "nfs", "_nfs._tcp" },
    { "sftp", "_sftp-ssh._tcp" },
86
    { "rtsp", "_rtsp._tcp" },
87 88
};
#define NB_PROTOCOLS (sizeof(protocols) / sizeof(*protocols))
89 90 91 92 93 94 95 96 97 98

/*****************************************************************************
 * client_callback
 *****************************************************************************/
static void client_callback( AvahiClient *c, AvahiClientState state,
                             void * userdata )
{
    services_discovery_t *p_sd = ( services_discovery_t* )userdata;
    services_discovery_sys_t *p_sys = p_sd->p_sys;

99 100
    if( state == AVAHI_CLIENT_FAILURE &&
        (avahi_client_errno(c) == AVAHI_ERR_DISCONNECTED) )
101 102
    {
        msg_Err( p_sd, "avahi client disconnected" );
103
        avahi_threaded_poll_quit( p_sys->poll );
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    }
}

/*****************************************************************************
 * resolve_callback
 *****************************************************************************/
static void resolve_callback(
    AvahiServiceResolver *r,
    AvahiIfIndex interface,
    AvahiProtocol protocol,
    AvahiResolverEvent event,
    const char *name,
    const char *type,
    const char *domain,
    const char *host_name,
    const AvahiAddress *address,
    uint16_t port,
    AvahiStringList *txt,
122
    AvahiLookupResultFlags flags,
123 124 125 126
    void* userdata )
{
    services_discovery_t *p_sd = ( services_discovery_t* )userdata;
    services_discovery_sys_t *p_sys = p_sd->p_sys;
127

128 129
    VLC_UNUSED(interface); VLC_UNUSED(host_name);
    VLC_UNUSED(flags);
130

131
    if( event == AVAHI_RESOLVER_FAILURE )
132 133 134 135 136 137 138 139 140
    {
        msg_Err( p_sd,
                 "failed to resolve service '%s' of type '%s' in domain '%s'",
                 name, type, domain );
    }
    else if( event == AVAHI_RESOLVER_FOUND )
    {
        char a[128];
        char *psz_uri = NULL;
141 142
        char *psz_addr = NULL;
        AvahiStringList *asl = NULL;
143
        input_item_t *p_input = NULL;
144

145 146
        msg_Err( p_sd, "service '%s' of type '%s' in domain '%s' port %i",
                 name, type, domain, port );
147 148

        avahi_address_snprint(a, (sizeof(a)/sizeof(a[0]))-1, address);
149
        if( protocol == AVAHI_PROTO_INET6 )
150 151
            if( asprintf( &psz_addr, "[%s]", a ) == -1 )
                return;
152

153 154 155 156 157 158 159 160 161
        const char *psz_protocol = NULL;
        for( unsigned int i = 0; i < NB_PROTOCOLS; i++ )
        {
            if( !strcmp(type, protocols[i].psz_service_name) )
                psz_protocol = protocols[i].psz_protocol;
        }
        if( psz_protocol == NULL )
            return;

162 163
        if( txt != NULL )
            asl = avahi_string_list_find( txt, "path" );
164 165 166 167 168
        if( asl != NULL )
        {
            size_t size;
            char *key = NULL;
            char *value = NULL;
169 170 171
            if( avahi_string_list_get_pair( asl, &key, &value, &size ) == 0 &&
                value != NULL )
            {
172 173 174 175
                if( asprintf( &psz_uri, "%s://%s:%d%s",
                          psz_protocol,
                          psz_addr != NULL ? psz_addr : a,
                          port, value ) == -1 )
176 177 178 179
                {
                    free( psz_addr );
                    return;
                }
180 181 182 183 184
            }
            if( key != NULL )
                avahi_free( (void *)key );
            if( value != NULL )
                avahi_free( (void *)value );
185 186 187
        }
        else
        {
188 189
            if( asprintf( &psz_uri, "%s://%s:%d",
                      psz_protocol,
190 191 192 193 194
                      psz_addr != NULL ? psz_addr : a, port ) == -1 )
            {
                free( psz_addr );
                return;
            }
195 196
        }

Rémi Duraffort's avatar
Rémi Duraffort committed
197
        free( psz_addr );
198

199
        if( psz_uri != NULL )
200
        {
201
            p_input = input_item_New( psz_uri, name );
Rémi Duraffort's avatar
Rémi Duraffort committed
202
            free( psz_uri );
203
        }
204
        if( p_input != NULL )
205
        {
206 207 208
            vlc_dictionary_insert( &p_sys->services_name_to_input_item,
                name, p_input );
            services_discovery_AddItem( p_sd, p_input, NULL /* no category */ );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
209
            vlc_gc_decref( p_input );
210
       }
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
    }

    avahi_service_resolver_free( r );
}

/*****************************************************************************
 * browser_callback
 *****************************************************************************/
static void browse_callback(
    AvahiServiceBrowser *b,
    AvahiIfIndex interface,
    AvahiProtocol protocol,
    AvahiBrowserEvent event,
    const char *name,
    const char *type,
    const char *domain,
227
    AvahiLookupResultFlags flags,
228 229
    void* userdata )
{
230 231
    VLC_UNUSED(b);
    VLC_UNUSED(flags);
232 233 234 235 236 237
    services_discovery_t *p_sd = ( services_discovery_t* )userdata;
    services_discovery_sys_t *p_sys = p_sd->p_sys;
    if( event == AVAHI_BROWSER_NEW )
    {
        if( avahi_service_resolver_new( p_sys->client, interface, protocol,
                                        name, type, domain, AVAHI_PROTO_UNSPEC,
238
                                        0,
239 240 241 242 243 244
                                        resolve_callback, userdata ) == NULL )
        {
            msg_Err( p_sd, "failed to resolve service '%s': %s", name,
                     avahi_strerror( avahi_client_errno( p_sys->client ) ) );
        }
    }
245
    else if( name )
246
    {
247
        /** \todo Store the input id and search it, rather than searching the items */
248 249 250 251 252
        input_item_t *p_item;
        p_item = vlc_dictionary_value_for_key(
                        &p_sys->services_name_to_input_item,
                        name );
        if( !p_item )
253 254 255
            msg_Err( p_sd, "failed to find service '%s' in playlist", name );
        else
        {
256 257 258
            services_discovery_RemoveItem( p_sd, p_item );
            vlc_dictionary_remove_value_for_key(
                        &p_sys->services_name_to_input_item,
259
                        name, NULL, NULL );
260 261 262 263 264 265 266 267 268 269 270 271 272
        }
    }
}

/*****************************************************************************
 * Open: initialize and create stuff
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
    services_discovery_t *p_sd = ( services_discovery_t* )p_this;
    services_discovery_sys_t *p_sys;
    int err;

Rémi Duraffort's avatar
Rémi Duraffort committed
273
    p_sd->p_sys = p_sys = calloc( 1, sizeof( services_discovery_sys_t ) );
274 275
    if( !p_sys )
        return VLC_ENOMEM;
276

277 278
    p_sd->description = _("Zeroconf network services");

279 280
    vlc_dictionary_init( &p_sys->services_name_to_input_item, 1 );

281 282
    p_sys->poll = avahi_threaded_poll_new();
    if( p_sys->poll == NULL )
283
    {
284
        msg_Err( p_sd, "failed to create Avahi threaded poll" );
285 286 287
        goto error;
    }

288
    p_sys->client = avahi_client_new( avahi_threaded_poll_get(p_sys->poll),
289
                                      0, client_callback, p_sd, &err );
290 291 292 293 294 295 296
    if( p_sys->client == NULL )
    {
        msg_Err( p_sd, "failed to create avahi client: %s",
                 avahi_strerror( err ) );
        goto error;
    }

297
    for( unsigned i = 0; i < NB_PROTOCOLS; i++ )
298
    {
299 300
        AvahiServiceBrowser *sb;
        sb = avahi_service_browser_new( p_sys->client, AVAHI_IF_UNSPEC,
301 302 303
                AVAHI_PROTO_UNSPEC,
                protocols[i].psz_service_name, NULL,
                0, browse_callback, p_sd );
304
        if( sb == NULL )
305 306 307 308
        {
            msg_Err( p_sd, "failed to create avahi service browser %s", avahi_strerror( avahi_client_errno(p_sys->client) ) );
            goto error;
        }
309 310
    }

311 312
    avahi_threaded_poll_start( p_sys->poll );

313 314 315 316 317
    return VLC_SUCCESS;

error:
    if( p_sys->client != NULL )
        avahi_client_free( p_sys->client );
318 319
    if( p_sys->poll != NULL )
        avahi_threaded_poll_free( p_sys->poll );
320

321
    vlc_dictionary_clear( &p_sys->services_name_to_input_item, NULL, NULL );
322
    free( p_sys );
323 324 325 326 327 328 329 330 331 332 333

    return VLC_EGENERIC;
}

/*****************************************************************************
 * Close: cleanup
 *****************************************************************************/
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;
334
    avahi_threaded_poll_stop( p_sys->poll );
335 336

    avahi_client_free( p_sys->client );
337
    avahi_threaded_poll_free( p_sys->poll );
338

339
    vlc_dictionary_clear( &p_sys->services_name_to_input_item, NULL, NULL );
340 341
    free( p_sys );
}