upnp: move UpnpInstanceWrapper to upnp-wrapper
[vlc.git] / modules / services_discovery / upnp-wrapper.cpp
1 /*****************************************************************************
2  * upnp-wrapper.cpp :  UPnP Instance Wrapper class
3  *****************************************************************************
4  * Copyright © 2004-2018 VLC authors and VideoLAN
5  *
6  * Authors: Rémi Denis-Courmont <rem # videolan.org> (original plugin)
7  *          Christian Henz <henz # c-lab.de>
8  *          Mirsal Ennaime <mirsal dot ennaime at gmail dot com>
9  *          Hugo Beauzée-Luyssen <hugo@beauzee.fr>
10  *          Shaleen Jain <shaleen@jain.sh>
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #include "upnp-wrapper.hpp"
28
29 UpnpInstanceWrapper* UpnpInstanceWrapper::s_instance;
30 UpnpInstanceWrapper::Listeners UpnpInstanceWrapper::s_listeners;
31 vlc_mutex_t UpnpInstanceWrapper::s_lock = VLC_STATIC_MUTEX;
32
33 UpnpInstanceWrapper::UpnpInstanceWrapper()
34     : m_handle( -1 )
35     , m_refcount( 0 )
36 {
37 }
38
39 UpnpInstanceWrapper::~UpnpInstanceWrapper()
40 {
41     UpnpUnRegisterClient( m_handle );
42     UpnpFinish();
43 }
44
45 UpnpInstanceWrapper *UpnpInstanceWrapper::get(vlc_object_t *p_obj)
46 {
47     vlc_mutex_locker lock( &s_lock );
48     if ( s_instance == NULL )
49     {
50         UpnpInstanceWrapper* instance = new(std::nothrow) UpnpInstanceWrapper;
51         if ( unlikely( !instance ) )
52         {
53             return NULL;
54         }
55
56     #ifdef UPNP_ENABLE_IPV6
57         char* psz_miface = var_InheritString( p_obj, "miface" );
58         if (psz_miface == NULL)
59             psz_miface = getPreferedAdapter();
60         msg_Info( p_obj, "Initializing libupnp on '%s' interface", psz_miface ? psz_miface : "default" );
61         int i_res = UpnpInit2( psz_miface, 0 );
62         free( psz_miface );
63     #else
64         /* If UpnpInit2 isnt available, initialize on first IPv4-capable interface */
65         char *psz_hostip = getIpv4ForMulticast();
66         int i_res = UpnpInit( psz_hostip, 0 );
67         free(psz_hostip);
68     #endif /* UPNP_ENABLE_IPV6 */
69         if( i_res != UPNP_E_SUCCESS )
70         {
71             msg_Err( p_obj, "Initialization failed: %s", UpnpGetErrorMessage( i_res ) );
72             delete instance;
73             return NULL;
74         }
75
76         ixmlRelaxParser( 1 );
77
78         /* Register a control point */
79         i_res = UpnpRegisterClient( Callback, instance, &instance->m_handle );
80         if( i_res != UPNP_E_SUCCESS )
81         {
82             msg_Err( p_obj, "Client registration failed: %s", UpnpGetErrorMessage( i_res ) );
83             delete instance;
84             return NULL;
85         }
86
87         /* libupnp does not treat a maximum content length of 0 as unlimited
88          * until 64dedf (~ pupnp v1.6.7) and provides no sane way to discriminate
89          * between versions */
90         if( (i_res = UpnpSetMaxContentLength( INT_MAX )) != UPNP_E_SUCCESS )
91         {
92             msg_Err( p_obj, "Failed to set maximum content length: %s",
93                     UpnpGetErrorMessage( i_res ));
94             delete instance;
95             return NULL;
96         }
97         s_instance = instance;
98     }
99     s_instance->m_refcount++;
100     return s_instance;
101 }
102
103 void UpnpInstanceWrapper::release()
104 {
105     UpnpInstanceWrapper *p_delete = NULL;
106     vlc_mutex_lock( &s_lock );
107     if (--s_instance->m_refcount == 0)
108     {
109         p_delete = s_instance;
110         s_instance = NULL;
111     }
112     vlc_mutex_unlock( &s_lock );
113     delete p_delete;
114 }
115
116 UpnpClient_Handle UpnpInstanceWrapper::handle() const
117 {
118     return m_handle;
119 }
120
121 int UpnpInstanceWrapper::Callback(Upnp_EventType event_type, UpnpEventPtr p_event, void *p_user_data)
122 {
123     for (Listeners::iterator iter = s_listeners.begin(); iter != s_listeners.end(); ++iter)
124     {
125         (*iter)->onEvent(event_type, p_event, p_user_data);
126     }
127
128     return 0;
129 }
130
131 void UpnpInstanceWrapper::addListener(ListenerPtr listener)
132 {
133     vlc_mutex_lock( &s_lock );
134     if ( std::find( s_listeners.begin(), s_listeners.end(), listener) != s_listeners.end() )
135     {
136         vlc_mutex_unlock( &s_lock );
137         return;
138     }
139     s_listeners.push_back( std::move(listener) );
140     vlc_mutex_unlock( &s_lock );
141 }
142
143 void UpnpInstanceWrapper::removeListener(ListenerPtr listener)
144 {
145     vlc_mutex_lock( &s_lock );
146     Listeners::iterator iter = std::find( s_listeners.begin(), s_listeners.end(), listener );
147     if ( iter == s_listeners.end() )
148     {
149         vlc_mutex_unlock( &s_lock );
150         return;
151     }
152
153     s_listeners.erase( iter );
154     vlc_mutex_unlock( &s_lock );
155 }