git.sesse.net Git - vlc/blob - modules/misc/notify/growl_udp.c

   1 /*****************************************************************************
   2  * growl_udp.c : growl UDP notification plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jérôme Decoodt <djc -at- videolan -dot- org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_interface.h>
  35 #include <vlc_playlist.h>
  36 #include <vlc_meta.h>
  37 #include <vlc_network.h>
  38 #include <vlc_md5.h>
  39
  40 /*****************************************************************************
  41  * Local prototypes
  42  *****************************************************************************/
  43 static int  Open    ( vlc_object_t * );
  44 static void Close   ( vlc_object_t * );
  45
  46 static int ItemChange( vlc_object_t *, const char *,
  47                        vlc_value_t, vlc_value_t, void * );
  48
  49 static int RegisterToGrowl( vlc_object_t *p_this );
  50 static int NotifyToGrowl( vlc_object_t *p_this, const char *psz_desc );
  51 static int CheckAndSend( vlc_object_t *p_this, uint8_t* p_data, int i_offset );
  52 #define GROWL_MAX_LENGTH 256
  53
  54 /*****************************************************************************
  55  * Module descriptor
  56  ****************************************************************************/
  57
  58 #define SERVER_DEFAULT "127.0.0.1"
  59 #define SERVER_TEXT N_("Server")
  60 #define SERVER_LONGTEXT N_("This is the host to which Growl notifications " \
  61    "will be sent. By default, notifications are sent locally." )
  62 #define PASS_DEFAULT ""
  63 #define PASS_TEXT N_("Password")
  64 #define PASS_LONGTEXT N_("Growl password on the Growl server.")
  65 #define PORT_TEXT N_("UDP port")
  66 #define PORT_LONGTEXT N_("Growl UDP port on the Growl server.")
  67
  68 vlc_module_begin ()
  69     set_category( CAT_INTERFACE )
  70     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  71     set_shortname( "Growl-UDP" )
  72     set_description( N_("Growl UDP Notification Plugin") )
  73
  74     add_string( "growl-server", SERVER_DEFAULT, NULL,
  75                 SERVER_TEXT, SERVER_LONGTEXT, false )
  76     add_password( "growl-password", PASS_DEFAULT, NULL,
  77                 PASS_TEXT, PASS_LONGTEXT, false )
  78     add_integer( "growl-port", 9887, NULL,
  79                 PORT_TEXT, PORT_LONGTEXT, true )
  80
  81     set_capability( "interface", 0 )
  82     set_callbacks( Open, Close )
  83 vlc_module_end ()
  84
  85 /*****************************************************************************
  86  * Open: initialize and create stuff
  87  *****************************************************************************/
  88 static int Open( vlc_object_t *p_this )
  89 {
  90     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  91
  92     playlist_t *p_playlist = pl_Hold( p_intf );
  93     var_AddCallback( p_playlist, "item-current", ItemChange, p_intf );
  94     pl_Release( p_intf );
  95
  96     RegisterToGrowl( p_this );
  97     return VLC_SUCCESS;
  98 }
  99
 100 /*****************************************************************************
 101  * Close: destroy interface stuff
 102  *****************************************************************************/
 103 static void Close( vlc_object_t *p_this )
 104 {
 105     playlist_t *p_playlist = pl_Hold( p_this );
 106     var_DelCallback( p_playlist, "item-current", ItemChange, p_this );
 107     pl_Release( p_this );
 108 }
 109
 110 /*****************************************************************************
 111  * ItemChange: Playlist item change callback
 112  *****************************************************************************/
 113 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 114                        vlc_value_t oldval, vlc_value_t newval, void *param )
 115 {
 116     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 117     VLC_UNUSED(param);
 118     char psz_tmp[GROWL_MAX_LENGTH];
 119     char *psz_title = NULL;
 120     char *psz_artist = NULL;
 121     char *psz_album = NULL;
 122     input_thread_t *p_input;
 123     p_input = playlist_CurrentInput( (playlist_t*)p_this );
 124
 125     if( !p_input ) return VLC_SUCCESS;
 126
 127     char *psz_name = input_item_GetName( input_GetItem( p_input ) );
 128     if( p_input->b_dead || !psz_name )
 129     {
 130         /* Not playing anything ... */
 131         free( psz_name );
 132         vlc_object_release( p_input );
 133         return VLC_SUCCESS;
 134     }
 135     free( psz_name );
 136
 137     /* Playing something ... */
 138     input_item_t *p_item = input_GetItem( p_input );
 139
 140     psz_title = input_item_GetTitleFbName( p_item );
 141     if( EMPTY_STR( psz_title ) )
 142     {
 143         free( psz_title );
 144         vlc_object_release( p_input );
 145         return VLC_SUCCESS;
 146     }
 147
 148     psz_artist = input_item_GetArtist( p_item );
 149     if( EMPTY_STR( psz_artist ) ) FREENULL( psz_artist );
 150     psz_album = input_item_GetAlbum( p_item ) ;
 151     if( EMPTY_STR( psz_album ) ) FREENULL( psz_album );
 152
 153     if( psz_artist && psz_album )
 154         snprintf( psz_tmp, GROWL_MAX_LENGTH, "%s\n%s [%s]",
 155                 psz_title, psz_artist, psz_album );
 156     else if( psz_artist )
 157         snprintf( psz_tmp, GROWL_MAX_LENGTH, "%s\n%s", psz_title, psz_artist );
 158     else
 159         snprintf( psz_tmp, GROWL_MAX_LENGTH, "%s", psz_title );
 160
 161     free( psz_title );
 162     free( psz_artist );
 163     free( psz_album );
 164
 165     NotifyToGrowl( p_this, psz_tmp );
 166
 167     vlc_object_release( p_input );
 168     return VLC_SUCCESS;
 169 }
 170
 171 /*****************************************************************************
 172  * Growl specific functions
 173  *****************************************************************************/
 174 #define GROWL_PROTOCOL_VERSION (1)
 175 #define GROWL_TYPE_REGISTRATION (0)
 176 #define GROWL_TYPE_NOTIFICATION (1)
 177 #define APPLICATION_NAME "VLC media player"
 178
 179 #define insertstrlen( psz ) \
 180 { \
 181     uint16_t i_size = strlen( psz ); \
 182     psz_encoded[i++] = (i_size>>8)&0xFF; \
 183     psz_encoded[i++] = i_size&0xFF; \
 184 }
 185 /*****************************************************************************
 186  * RegisterToGrowl
 187  *****************************************************************************/
 188 static int RegisterToGrowl( vlc_object_t *p_this )
 189 {
 190     uint8_t *psz_encoded = malloc(100);
 191     uint8_t i_defaults = 0;
 192     static const char *psz_notifications[] = {"Now Playing", NULL};
 193     bool pb_defaults[] = {true, false};
 194     int i = 0, j;
 195     if( psz_encoded == NULL )
 196         return false;
 197
 198     memset( psz_encoded, 0, sizeof(psz_encoded) );
 199     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
 200     psz_encoded[i++] = GROWL_TYPE_REGISTRATION;
 201     insertstrlen(APPLICATION_NAME);
 202     i+=2;
 203     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
 204     i += strlen(APPLICATION_NAME);
 205     for( j = 0 ; psz_notifications[j] != NULL ; j++)
 206     {
 207         insertstrlen(psz_notifications[j]);
 208         strcpy( (char*)(psz_encoded+i), psz_notifications[j] );
 209         i += strlen(psz_notifications[j]);
 210     }
 211     psz_encoded[4] = j;
 212     for( j = 0 ; psz_notifications[j] != NULL ; j++)
 213         if(pb_defaults[j] == true)
 214         {
 215             psz_encoded[i++] = (uint8_t)j;
 216             i_defaults++;
 217         }
 218     psz_encoded[5] = i_defaults;
 219
 220     CheckAndSend(p_this, psz_encoded, i);
 221     free( psz_encoded );
 222     return VLC_SUCCESS;
 223 }
 224
 225 static int NotifyToGrowl( vlc_object_t *p_this, const char *psz_desc )
 226 {
 227     const char *psz_type = "Now Playing", *psz_title = "Now Playing";
 228     uint8_t *psz_encoded = malloc(GROWL_MAX_LENGTH + 42);
 229     uint16_t flags;
 230     int i = 0;
 231     if( psz_encoded == NULL )
 232         return false;
 233
 234     memset( psz_encoded, 0, sizeof(psz_encoded) );
 235     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
 236     psz_encoded[i++] = GROWL_TYPE_NOTIFICATION;
 237     flags = 0;
 238     psz_encoded[i++] = (flags>>8)&0xFF;
 239     psz_encoded[i++] = flags&0xFF;
 240     insertstrlen(psz_type);
 241     insertstrlen(psz_title);
 242     insertstrlen(psz_desc);
 243     insertstrlen(APPLICATION_NAME);
 244     strcpy( (char*)(psz_encoded+i), psz_type );
 245     i += strlen(psz_type);
 246     strcpy( (char*)(psz_encoded+i), psz_title );
 247     i += strlen(psz_title);
 248     strcpy( (char*)(psz_encoded+i), psz_desc );
 249     i += strlen(psz_desc);
 250     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
 251     i += strlen(APPLICATION_NAME);
 252
 253     CheckAndSend(p_this, psz_encoded, i);
 254     free( psz_encoded );
 255     return VLC_SUCCESS;
 256 }
 257
 258 static int CheckAndSend( vlc_object_t *p_this, uint8_t* p_data, int i_offset )
 259 {
 260     int i, i_handle;
 261     struct md5_s md5;
 262     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 263     char *psz_password = var_InheritString( p_intf, "growl-password" );
 264     char *psz_server = var_InheritString( p_intf, "growl-server" );
 265     int i_port = var_InheritInteger( p_intf, "growl-port" );
 266     strcpy( (char*)(p_data+i_offset), psz_password );
 267     i = i_offset + strlen(psz_password);
 268
 269     InitMD5( &md5 );
 270     AddMD5( &md5, p_data, i );
 271     EndMD5( &md5 );
 272
 273     for( i = 0 ; i < 4 ; i++ )
 274     {
 275         md5.p_digest[i] = md5.p_digest[i];
 276         p_data[i_offset++] =  md5.p_digest[i]     &0xFF;
 277         p_data[i_offset++] = (md5.p_digest[i]>> 8)&0xFF;
 278         p_data[i_offset++] = (md5.p_digest[i]>>16)&0xFF;
 279         p_data[i_offset++] = (md5.p_digest[i]>>24)&0xFF;
 280     }
 281
 282     i_handle = net_ConnectUDP( p_this, psz_server, i_port, -1 );
 283     if( i_handle == -1 )
 284     {
 285          msg_Err( p_this, "failed to open a connection (udp)" );
 286          free( psz_password);
 287          free( psz_server);
 288          return VLC_EGENERIC;
 289     }
 290
 291     shutdown( i_handle, SHUT_RD );
 292     if( send( i_handle, p_data, i_offset, 0 )
 293           == -1 )
 294     {
 295         msg_Warn( p_this, "send error: %m" );
 296     }
 297     net_Close( i_handle );
 298
 299     free( psz_password);
 300     free( psz_server);
 301     return VLC_SUCCESS;
 302 }
 303
 304 #undef GROWL_PROTOCOL_VERSION
 305 #undef GROWL_TYPE_REGISTRATION
 306 #undef GROWL_TYPE_NOTIFICATION
 307 #undef APPLICATION_NAME
 308 #undef insertstrlen