melunko@250: /**
melunko@250:  * GMyth Library
melunko@250:  *
melunko@250:  * @file gmyth/gmyth_upnp.c
melunko@250:  * 
melunko@250:  * @brief <p> GMythUPnP allows that a MythTV frontend discovers a 
melunko@250:  * MythTV backend, using the UPnP architecture.
melunko@250:  *
melunko@250:  * Copyright (C) 2006 INdT - Instituto Nokia de Tecnologia.
melunko@250:  * @author Rosfran Lins Borges <rosfran.borges@indt.org.br>
melunko@250:  * 
melunko@250:  * This program is free software; you can redistribute it and/or modify
melunko@250:  * it under the terms of the GNU Lesser General Public License as published by
melunko@250:  * the Free Software Foundation; either version 2 of the License, or
melunko@250:  * (at your option) any later version.
melunko@250:  *
melunko@250:  * This program is distributed in the hope that it will be useful,
melunko@250:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
melunko@250:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
melunko@250:  * GNU General Public License for more details.
melunko@250:  *
melunko@250:  * You should have received a copy of the GNU Lesser General Public License
melunko@250:  * along with this program; if not, write to the Free Software
melunko@250:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
melunko@250:  *   
melunko@250:  */
melunko@250: 
melunko@250: #ifdef HAVE_CONFIG_H
melunko@250: #include "config.h"
melunko@250: #endif
melunko@250: 
melunko@250: #include "gmyth_upnp.h"
rosfran@696: #include "gmyth_upnp_marshal.h"
melunko@250: 
melunko@250: #include <arpa/inet.h>
melunko@250: #include <sys/types.h>
melunko@250: #include <sys/socket.h>
melunko@250: #include <netdb.h>
melunko@250: #include <errno.h>
melunko@250: #include <stdlib.h>
melunko@250: 
rosfran@260: #include <gmyth/gmyth_backendinfo.h>
rosfran@260: #include <gmyth/gmyth_socket.h>
rosfran@260: #include <gmyth/gmyth_uri.h>
rosfran@260: #include <gmyth/gmyth_debug.h>
melunko@250: 
rosfran@696: /* Maximum number of searches in the synchronized search */
melunko@250: #define GMYTH_UPNP_MAX_SEARCHS		10
melunko@250: 
rosfran@696: #define GMYTH_UPNP_GET_PRIVATE(obj) \
rosfran@696:     (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GMYTH_UPNP_TYPE, GMythUPnPPrivate))
rosfran@696: 
rosfran@696: struct _GMythUPnPPrivate {
rosfran@696: 	GHashTable *mythtv_servers;
rosfran@696: 	GMythUPnPDeviceStatus last_status;
rosfran@696: 	gboolean upnp_dev_found;
rosfran@696: 	gchar *udn;
rosfran@696: 	GMutex *mutex;
rosfran@696: };
rosfran@696: 
melunko@250: static void gmyth_upnp_class_init          (GMythUPnPClass *klass);
melunko@250: static void gmyth_upnp_init                (GMythUPnP *object);
melunko@250: 
melunko@250: static void gmyth_upnp_dispose  (GObject *object);
melunko@250: static void gmyth_upnp_finalize (GObject *object);
melunko@250: 
rosfran@700: static void _mythtv_device_found ( GMythUPnP *gmyth_upnp, GMythUPnPDeviceStatus status, gchar *dev );
rosfran@696: static void _clinkc_mythtv_device_found ( gchar *udn, GMythUPnPDeviceStatus status );
melunko@250: 
rosfran@696: static gboolean gmyth_upnp_initialize ( GMythUPnP *gmyth_upnp, GMythBackendInfo *gmyth_backend_info,
rosfran@696: 		GMythUPnPDeviceListener listener);
rosfran@696: 
rosfran@696: static gboolean gmyth_upnp_got_mythtv_service( CgUpnpControlPoint* controlPt, gchar **udn, 
rosfran@696: 						GHashTable **mythtv_servers_lst );
melunko@250: 
melunko@250: G_DEFINE_TYPE(GMythUPnP, gmyth_upnp, G_TYPE_OBJECT)
melunko@250: 
rosfran@696: static GMythUPnP *gmyth_upnp_static = NULL;
melunko@250: 
melunko@250: static void
melunko@250: gmyth_upnp_class_init (GMythUPnPClass *klass)
melunko@250: {
melunko@250: 	GObjectClass *gobject_class;
rosfran@696: 	GMythUPnPClass *gupnp_class;
melunko@250: 
melunko@250: 	gobject_class = (GObjectClass *) klass;
rosfran@696: 	gupnp_class = (GMythUPnPClass*) gobject_class;
melunko@250: 
melunko@250: 	gobject_class->dispose  = gmyth_upnp_dispose;
rosfran@696: 	gobject_class->finalize = gmyth_upnp_finalize;
rosfran@696: 	
rosfran@696: 	g_type_class_add_private( gobject_class, sizeof( GMythUPnPPrivate ) );
rosfran@696: 
rosfran@696: 	gupnp_class->device_found_handler = _mythtv_device_found;
rosfran@696: 
rosfran@696: 	gupnp_class->device_found_handler_signal_id =
rosfran@696: 		g_signal_new ("device-found",
rosfran@696: 				G_TYPE_FROM_CLASS (gupnp_class),
rosfran@696: 				G_SIGNAL_RUN_LAST | G_SIGNAL_NO_RECURSE |
rosfran@696: 				G_SIGNAL_NO_HOOKS, 0, NULL, NULL,
rosfran@696: 				gmyth_upnp_marshal_VOID__INT_STRING, G_TYPE_NONE, 2,
rosfran@696: 				G_TYPE_INT, G_TYPE_STRING);
rosfran@696: 
melunko@250: }
melunko@250: 
melunko@250: static void
melunko@250: gmyth_upnp_init ( GMythUPnP *gmyth_upnp )
melunko@250: {
rosfran@696: 
rosfran@696: 	gmyth_upnp->backend_info = NULL;
rosfran@696: 
melunko@250: 	gmyth_upnp->control_point = NULL;
rosfran@696: 
rosfran@696: 	gmyth_upnp->priv = GMYTH_UPNP_GET_PRIVATE(gmyth_upnp);
rosfran@696: 	gmyth_upnp->priv->mutex = g_mutex_new ();
rosfran@696: 	gmyth_upnp->priv->upnp_dev_found = FALSE;
rosfran@696: 
rosfran@696: 	g_signal_connect (G_OBJECT (gmyth_upnp), "device-found",
rosfran@696: 			(GCallback) (GMYTH_UPNP_GET_CLASS (gmyth_upnp)->
rosfran@696: 				device_found_handler), NULL);
rosfran@696: 
rosfran@696: 	gmyth_upnp_static = gmyth_upnp;
rosfran@696: 
melunko@250: }
melunko@250: 
melunko@250: /** Creates a new instance of GMythUPnP.
melunko@250:  * 
melunko@250:  * @return a new instance of GMythUPnP. 
melunko@250:  */
melunko@250: GMythUPnP *
rosfran@696: gmyth_upnp_new ( GMythBackendInfo *gmyth_backend_info, GMythUPnPDeviceListener handler ) 
melunko@250: {
melunko@250:     GMythUPnP *gmyth_upnp = GMYTH_UPNP (g_object_new (GMYTH_UPNP_TYPE, NULL));
melunko@250:     
rosfran@696:     g_object_ref( gmyth_backend_info );
rosfran@696: 
rosfran@696:     gmyth_upnp->backend_info = gmyth_backend_info;
rosfran@696: 
rosfran@696:     if ( !gmyth_upnp_initialize ( gmyth_upnp, gmyth_backend_info, handler ) )
rosfran@696:     {
rosfran@696:     	gmyth_debug( "Error initializing the GMythUPnP!!!" );
rosfran@696:     }
melunko@250:     
melunko@250:     return gmyth_upnp;
melunko@250: }
melunko@250: 
melunko@250: static void
melunko@250: gmyth_upnp_dispose  (GObject *object)
melunko@250: {
melunko@250: 	GMythUPnP *gmyth_upnp = GMYTH_UPNP(object);
melunko@250: 
melunko@250: 	if ( gmyth_upnp->control_point != NULL ) {
melunko@250: 		cg_upnp_controlpoint_stop( gmyth_upnp->control_point );
melunko@250: 		cg_upnp_controlpoint_delete( gmyth_upnp->control_point );
melunko@250: 		gmyth_upnp->control_point = NULL;
melunko@250: 	}
rosfran@696: 	
rosfran@696: 	if ( gmyth_upnp->priv->mythtv_servers != NULL )	{
rosfran@696: 		g_hash_table_destroy( gmyth_upnp->priv->mythtv_servers );
rosfran@696: 		gmyth_upnp->priv->mythtv_servers = NULL;
rosfran@696: 	}
melunko@250: 
rosfran@696: 	if ( gmyth_upnp->backend_info != NULL )	{
rosfran@696: 		g_object_unref( gmyth_upnp->backend_info );
rosfran@696: 		gmyth_upnp->backend_info = NULL;
melunko@250: 	}
rosfran@696: 
melunko@250: 	G_OBJECT_CLASS (gmyth_upnp_parent_class)->dispose (object);
melunko@250: }
melunko@250: 
melunko@250: static void
melunko@250: gmyth_upnp_finalize (GObject *object)
melunko@250: {
melunko@250: 	g_signal_handlers_destroy (object);
melunko@250: 
melunko@250: 	G_OBJECT_CLASS (gmyth_upnp_parent_class)->finalize (object);
melunko@250: }
melunko@250: 
rosfran@706: gchar *
rosfran@706: gmyth_upnp_device_status_to_string( GMythUPnPDeviceStatus status )
rosfran@706: {
rosfran@706: 	if ( status == CgUpnpDeviceStatusAdded )
rosfran@706: 		return "Added";
rosfran@706: 	else if ( status == CgUpnpDeviceStatusUpdated )
rosfran@706: 		return "Updated";
rosfran@706: 	else if ( status == CgUpnpDeviceStatusInvalid )
rosfran@706: 		return "Invalid";
rosfran@706: 	else if ( status == CgUpnpDeviceStatusRemoved )
rosfran@706: 		return "Removed";
rosfran@706: 	
rosfran@706: 	return "";
rosfran@706: }
rosfran@706: 
melunko@250: /**
rosfran@696:  * GObject's signal handler
rosfran@696:  */ 
rosfran@696: static void
rosfran@700: _mythtv_device_found( GMythUPnP *gmyth_upnp, GMythUPnPDeviceStatus status, gchar* udn )
rosfran@696: {
rosfran@706: 	g_debug( "Device: [status = %s, UDN = %s]\n", 
rosfran@706: 		gmyth_upnp_device_status_to_string( status ), udn );
rosfran@696: }
rosfran@696: 
rosfran@696: /**
rosfran@696:  * GObject's signal handler
rosfran@696:  */
rosfran@696: static void 
rosfran@696: _clinkc_mythtv_device_found ( gchar *udn, GMythUPnPDeviceStatus status )
rosfran@696: {
rosfran@699: 	if ( gmyth_upnp_static != NULL && udn != NULL )
rosfran@696: 		g_signal_emit ( gmyth_upnp_static, 
rosfran@696: 			GMYTH_UPNP_GET_CLASS (gmyth_upnp_static)->device_found_handler_signal_id, 0, /* details */
rosfran@696: 			status, udn );
rosfran@696: }
rosfran@696: 
rosfran@696: /**
melunko@250:  * Create a control point and start it.
melunko@250:  */
melunko@250: static gboolean
rosfran@696: gmyth_upnp_initialize ( GMythUPnP *gmyth_upnp, GMythBackendInfo *gmyth_backend_info, 
rosfran@696: 	GMythUPnPDeviceListener device_found_handler )
melunko@250: {
rosfran@696: 	gboolean ret = TRUE;
rosfran@696: 
melunko@250: 	g_return_val_if_fail( gmyth_backend_info != NULL, FALSE );
rosfran@696: 
melunko@250: 	/* Create the cybergarage control point */
melunko@250: 	gmyth_upnp->control_point = cg_upnp_controlpoint_new();
rosfran@696: 
rosfran@696: 	if ( device_found_handler != NULL )
rosfran@696: 	{
rosfran@696: 		GMYTH_UPNP_GET_CLASS(gmyth_upnp)->device_found_handler = device_found_handler; 
rosfran@696: 
rosfran@696: 		cg_upnp_controlpoint_setdevicelistener( gmyth_upnp->control_point, _clinkc_mythtv_device_found );
rosfran@696: 	}
rosfran@696: 
melunko@250: 	/* Start the control point */
rosfran@696: 	if ( cg_upnp_controlpoint_start( gmyth_upnp->control_point ) == FALSE)
melunko@250: 	{
rosfran@696: 		gmyth_debug( "Unable to start UPnP control point!!!" );
rosfran@696: 		ret = FALSE;
rosfran@696: 		goto done;
rosfran@696: 	}
melunko@250: 	else
melunko@250: 	{
rosfran@696: 		gmyth_debug( "Control point started." );
melunko@250: 	}
rosfran@696: 
rosfran@696: done:
rosfran@696: 
rosfran@696: 	return ret;
rosfran@696: }
rosfran@696: 
rosfran@696: static void
rosfran@696: _gmyth_foreach_key_value( gchar *udn, gchar *dev, GList *upnp_servers_list )
rosfran@696: {
rosfran@696: 	GMythUPnPDevice *gmyth_upnp = g_malloc0( sizeof( GMythUPnPDevice ) );
rosfran@696: 
rosfran@696: 	GMythURI* uri = NULL;
rosfran@696: 	gmyth_upnp->uri = (gchar*) (dev);
rosfran@696: 	uri = gmyth_uri_new_with_value( gmyth_upnp->uri );
rosfran@696: 
rosfran@696: 	gmyth_upnp->host = gmyth_uri_get_host( uri );
rosfran@696: 	gmyth_upnp->port = gmyth_uri_get_port( uri );
rosfran@696: 	gmyth_upnp->protocol = gmyth_uri_get_protocol( uri );
rosfran@696: 
rosfran@706: 	gmyth_debug("MythTV UPnP service [ %s, %d ].", gmyth_upnp->host, gmyth_upnp->port);
rosfran@706: 
rosfran@696: 	upnp_servers_list = g_list_append( upnp_servers_list, gmyth_upnp );
rosfran@696: 
rosfran@696: 	if ( uri != NULL )
rosfran@696: 	{
rosfran@696: 		g_object_unref( uri );
rosfran@696: 		uri = NULL;
rosfran@696: 	}
rosfran@696: 
rosfran@696: }
rosfran@696: 
rosfran@696: GList *
rosfran@696: gmyth_upnp_do_search_sync( GMythUPnP* gmyth_upnp )
rosfran@696: {
rosfran@696: 	GList *upnp_servers_list = NULL;
rosfran@696: 	guint iter_count = GMYTH_UPNP_MAX_SEARCHS;
rosfran@696: 	/* gmyth_upnp->priv = GMYTH_UPNP_GET_PRIVATE( gmyth_upnp ); */
rosfran@696: 
rosfran@696: 	while ( gmyth_upnp->priv->upnp_dev_found == FALSE && ( --iter_count > 0 ) ) {
rosfran@696: 
melunko@250: 		gmyth_debug( "UPnP MythTV Client control point is searching MythTV AV Device server...\n" );
rosfran@696: 
melunko@250: 		if ( gmyth_upnp->control_point != NULL )
melunko@250: 			cg_upnp_controlpoint_search ( gmyth_upnp->control_point, 
rosfran@696: 					"urn:schemas-upnp-org:service:ContentDirectory:1" );
melunko@250: 
melunko@250: 		/* just to avoid clinkc pthread concurrency faults */
melunko@250: 		cg_wait( 1000 );
rosfran@696: 
melunko@250: 		/* discover if it was found */
rosfran@696: 		gmyth_upnp->priv->upnp_dev_found = gmyth_upnp_got_mythtv_service( gmyth_upnp->control_point, &gmyth_upnp->priv->udn,
rosfran@696: 				&gmyth_upnp->priv->mythtv_servers );
rosfran@696: 
rosfran@696: 	} /* while */
rosfran@696: 
rosfran@696: 	if ( gmyth_upnp->priv->upnp_dev_found ) {
rosfran@696: 
melunko@250: 		gmyth_debug( "Found UPnP MythTV AV Device...\n" );
melunko@250: 
rosfran@696: 		g_hash_table_foreach( gmyth_upnp->priv->mythtv_servers, (GHFunc)_gmyth_foreach_key_value, upnp_servers_list );
melunko@250: 
rosfran@696: 	} /* if - found UPnP device  */
melunko@250: 
rosfran@696: 	return upnp_servers_list;
melunko@250: }
melunko@250: 
melunko@250: /** 
rosfran@696:  * Checks if got the MythTV service in the Control Point's device list.
melunko@250:  */
melunko@250: static gboolean
rosfran@696: gmyth_upnp_got_mythtv_service( CgUpnpControlPoint* controlPt, gchar **udn, 
rosfran@696: 	GHashTable **mythtv_servers_lst )
melunko@250: {
melunko@250: 	
melunko@250: 	g_return_val_if_fail( mythtv_servers_lst != NULL, FALSE );	
melunko@250: 	g_return_val_if_fail( controlPt != NULL, FALSE );
rosfran@696: 
rosfran@696: 	*mythtv_servers_lst = g_hash_table_new( g_str_hash, g_str_equal );
melunko@250: 	
rosfran@699: 	const gchar* mythtvFriendlyName = "Myth";
melunko@250: 	/* begin assertion about the size of discovered devices */
melunko@250: 	gint numDevices = cg_upnp_controlpoint_getndevices(controlPt);
melunko@250: 	gint cntDevs = 0;	
melunko@250: 	CgUpnpDevice *childDev;
melunko@250: 	gchar *devName = NULL, *dev_url = NULL;
melunko@250: 	gboolean upnp_dev_found = FALSE;
melunko@250: 	
melunko@250: 	gmyth_debug( "UPnP MythTV AV Device list size = %d\n", numDevices );
melunko@250: 	
melunko@250: 	for ( childDev = cg_upnp_controlpoint_getdevices(controlPt); childDev != NULL; 
melunko@250: 			childDev = cg_upnp_device_next(childDev) ) {
melunko@250: 		devName = cg_upnp_device_getfriendlyname(childDev);
melunko@250: 		dev_url = cg_upnp_device_getlocationfromssdppacket( childDev );
melunko@250: 		gmyth_debug( "Device's friendly name = %s, and  device's URL = %s\n", devName, dev_url );
rosfran@704: 		if ( ( g_strstr_len( devName, strlen( devName ), mythtvFriendlyName ) != NULL ) == TRUE ) 
melunko@250: 		{
rosfran@704: 			upnp_dev_found = TRUE;
rosfran@696: 			/* stores the last UDN number ID */
melunko@250: 			*udn = cg_upnp_device_getudn( childDev );
rosfran@696: 			/* *mythtv_servers_lst = g_list_append( *mythtv_servers_lst, dev_url );  */
rosfran@696: 			g_hash_table_insert( *mythtv_servers_lst, (gpointer)*udn, (gpointer)dev_url );
melunko@250: 		}
melunko@250: 		++cntDevs;
melunko@250: 	}
melunko@250: 	
melunko@250: 	if ( upnp_dev_found == TRUE ) {
melunko@250: 		gmyth_debug( "MythTV AV Device found, from a total of %d devices.\n", cntDevs );
melunko@250: 	} else if ( numDevices == cntDevs ) {
melunko@250: 		gmyth_debug( "MythTV AV Device not found, from a total of %d devices.\n", cntDevs );
melunko@250: 	} else {
melunko@250: 		gmyth_debug( "Control Point's MythTV AV Device count is wrong: iterated over %d devices, but there are %d registered devices.\n", cntDevs, numDevices );
melunko@250: 	}
melunko@250: 	
melunko@250: 	return upnp_dev_found;
melunko@250: 
melunko@250: }
melunko@250: 
melunko@250: /** Gets the UPnP AV devices server's list associated to this upnp.
melunko@250:  * 
rosfran@696:  * @return The GHashTable* containing all the URI values for each recognized UPnP device,
melunko@250:  * 			or NULL if it couldn't recognize any MythTV AV device.
melunko@250:  */
rosfran@696: GHashTable*
melunko@250: gmyth_upnp_get_servers ( GMythUPnP *gmyth_upnp )
melunko@250: {
melunko@250: 	
rosfran@696: 	if ( NULL == gmyth_upnp || NULL == gmyth_upnp->priv->mythtv_servers ) 
melunko@250: 	{
melunko@250: 		gmyth_debug ("[%s] GMythUPnP has no MythTV servers recognized.\n", __FUNCTION__);
melunko@250: 		return NULL;
melunko@250: 	}
melunko@250: 
rosfran@696: 	return gmyth_upnp->priv->mythtv_servers;
melunko@250: }
melunko@250: 
melunko@250: /** Gets the GMythBackendInfo object associated to this upnp.
melunko@250:  * 
melunko@250:  * @return The GMythBackendInfo object currently valid or NULL if the settings
melunko@250:  * were not opened.
melunko@250:  */
melunko@250: GMythBackendInfo*
melunko@250: gmyth_upnp_get_backend_info ( GMythUPnP *gmyth_upnp )
melunko@250: {
melunko@250: 	
rosfran@696: 	if ( NULL == gmyth_upnp || NULL == gmyth_upnp->backend_info ) 
melunko@250: 	{
melunko@250: 		gmyth_debug ("[%s] GMythUPnP not initialized\n", __FUNCTION__);
melunko@250: 		return NULL;
melunko@250: 	}
melunko@250: 
rosfran@696: 	return gmyth_upnp->backend_info;
melunko@250: }
melunko@250: