Fix a bunch of bugs in the MSN plugin (duplicated in the Growl plugin)
[vlc.git] / modules / misc / growl.c
1 /*****************************************************************************
2  * growl.c : growl 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 #include <stdlib.h>                                      /* malloc(), free() */
28
29 #include <vlc/vlc.h>
30 #include <vlc/intf.h>
31 #include <vlc_meta.h>
32 #include <network.h>
33 #include <errno.h>
34 #include <vlc_md5.h>
35
36 /*****************************************************************************
37  * Local prototypes
38  *****************************************************************************/
39 static int  Open    ( vlc_object_t * );
40 static void Close   ( vlc_object_t * );
41 static void Run     ( intf_thread_t * );
42
43 static int ItemChange( vlc_object_t *, const char *,
44                        vlc_value_t, vlc_value_t, void * );
45
46 static int RegisterToGrowl( vlc_object_t *p_this );
47 static int NotifyToGrowl( vlc_object_t *p_this, char *psz_type,
48                             char *psz_title, char *psz_desc );
49 static int CheckAndSend( vlc_object_t *p_this, uint8_t* p_data, int i_offset );
50 #define GROWL_MAX_LENGTH 256
51
52 /*****************************************************************************
53  * Module descriptor
54  *****************************************************************************
55  * This module should be used on windows with MSN (i think that you need to
56  * have MSN 7 or newer) to "advertise" what you are playing in VLC.
57  * You need to enable the "What I'm Listening To" option in MSN.
58  *****************************************************************************/
59 #define SERVER_DEFAULT "127.0.0.1"
60 #define SERVER_TEXT N_("Growl server")
61 #define SERVER_LONGTEXT N_("Growl server receiving notifications.")
62 #define PASS_DEFAULT ""
63 #define PASS_TEXT N_("Growl password")
64 #define PASS_LONGTEXT N_("Growl password on the server.")
65 #define PORT_TEXT N_("Growl UDP port")
66 #define PORT_LONGTEXT N_("Growl UPD port on the server.")
67 #define TTL_TEXT N_("Growl TTL")
68 #define TTL_LONGTEXT N_("Growl TTL.")
69
70 vlc_module_begin();
71     set_category( CAT_INTERFACE );
72     set_subcategory( SUBCAT_INTERFACE_CONTROL );
73     set_shortname( N_( "growl" ) );
74     set_description( _("Growl Notification Plugin") );
75
76     add_string( "growl-server", SERVER_DEFAULT, NULL,
77                 SERVER_TEXT, SERVER_LONGTEXT, VLC_FALSE );
78     add_string( "growl-password", PASS_DEFAULT, NULL,
79                 PASS_TEXT, PASS_LONGTEXT, VLC_FALSE );
80     add_integer( "growl-port", 9887, NULL,
81                 PORT_TEXT, PORT_LONGTEXT, VLC_TRUE );
82     add_integer( "growl-ttl", 12, NULL,
83                 TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
84
85     set_capability( "interface", 0 );
86     set_callbacks( Open, Close );
87 vlc_module_end();
88
89 /*****************************************************************************
90  * Open: initialize and create stuff
91  *****************************************************************************/
92 static int Open( vlc_object_t *p_this )
93 {
94     intf_thread_t *p_intf = (intf_thread_t *)p_this;
95
96     playlist_t *p_playlist = (playlist_t *)vlc_object_find(
97         p_intf, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
98
99     if( !p_playlist )
100     {
101         msg_Err( p_intf, "could not find playlist object" );
102         return VLC_ENOOBJ;
103     }
104
105     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
106     vlc_object_release( p_playlist );
107
108     RegisterToGrowl( p_this );
109     p_intf->pf_run = Run;
110
111     return VLC_SUCCESS;
112 }
113
114 /*****************************************************************************
115  * Close: destroy interface stuff
116  *****************************************************************************/
117 static void Close( vlc_object_t *p_this )
118 {
119     playlist_t *p_playlist = (playlist_t *)vlc_object_find(
120         p_this, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
121
122     if( p_playlist )
123     {
124         var_DelCallback( p_playlist, "playlist-current", ItemChange, p_this );
125         vlc_object_release( p_playlist );
126         return VLC_EGENERIC;
127     }
128
129
130 }
131
132 /*****************************************************************************
133  * Run
134  *****************************************************************************/
135 static void Run( intf_thread_t *p_intf )
136 {
137     msleep( INTF_IDLE_SLEEP );
138 }
139
140 /*****************************************************************************
141  * ItemChange: Playlist item change callback
142  *****************************************************************************/
143 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
144                        vlc_value_t oldval, vlc_value_t newval, void *param )
145 {
146     char psz_tmp[GROWL_MAX_LENGTH];
147     playlist_t *p_playlist;
148     char *psz_title = NULL;
149     char *psz_artist = NULL;
150     char *psz_album = NULL;
151     input_thread_t *p_input;
152
153     p_playlist = (playlist_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
154                                                 FIND_ANYWHERE );
155     if( !p_playlist ) return VLC_EGENERIC;
156
157     p_input = p_playlist->p_input;
158     vlc_object_release( p_playlist );
159     if( !p_input ) return VLC_SUCCESS;
160     vlc_object_yield( p_input );
161
162     if( p_input->b_dead || !p_input->input.p_item->psz_name )
163     {
164         /* Not playing anything ... */
165         vlc_object_release( p_input );
166         return VLC_SUCCESS;
167     }
168
169     /* Playing something ... */
170     psz_artist = vlc_input_item_GetInfo( p_input->input.p_item,
171                                          _("Meta-information"),
172                                          _(VLC_META_ARTIST) );
173     psz_album = vlc_input_item_GetInfo( p_input->input.p_item,
174                                          _("Meta-information"),
175                                          _("Album/movie/show title" ) );
176     psz_title = strdup( p_input->input.p_item->psz_name );
177     if( psz_title == NULL ) psz_title = strdup( N_("(no title)") );
178     if( psz_artist == NULL ) psz_artist = strdup( N_("(no artist)") );
179     if( psz_album == NULL ) psz_album = strdup( N_("(no album)") );
180     snprintf( psz_tmp, GROWL_MAX_LENGTH, "%s %s %s",
181               psz_title, psz_artist, psz_album );
182     free( psz_title );
183     free( psz_artist );
184     free( psz_album );
185
186     NotifyToGrowl( p_this, "Now Playing", "Now Playing", psz_tmp );
187
188     vlc_object_release( p_input );
189     return VLC_SUCCESS;
190 }
191
192 /*****************************************************************************
193  * Growl specific functions
194  *****************************************************************************/
195 #define GROWL_PROTOCOL_VERSION (1)
196 #define GROWL_TYPE_REGISTRATION (0)
197 #define GROWL_TYPE_NOTIFICATION (1)
198 #define APPLICATION_NAME "VLC media player"
199
200 #define insertstrlen( psz ) \
201 { \
202     uint16_t i_size = strlen( psz ); \
203     psz_encoded[i++] = (i_size>>8)&0xFF; \
204     psz_encoded[i++] = i_size&0xFF; \
205 }
206 /*****************************************************************************
207  * RegisterToGrowl
208  *****************************************************************************/
209 static int RegisterToGrowl( vlc_object_t *p_this )
210 {
211     uint8_t *psz_encoded = malloc(100);
212     uint8_t i_defaults = 0;
213     char *psz_notifications[] = {"Now Playing", NULL};
214     vlc_bool_t pb_defaults[] = {VLC_TRUE, VLC_FALSE};
215     int i = 0, j;
216     if( psz_encoded == NULL )
217         return VLC_FALSE;
218
219     memset( psz_encoded, 0, sizeof(psz_encoded) );
220     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
221     psz_encoded[i++] = GROWL_TYPE_REGISTRATION;
222     insertstrlen(APPLICATION_NAME);
223     i+=2;
224     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
225     i += strlen(APPLICATION_NAME);
226     for( j = 0 ; psz_notifications[j] != NULL ; j++)
227     {
228         insertstrlen(psz_notifications[j]);
229         strcpy( (char*)(psz_encoded+i), psz_notifications[j] );
230         i += strlen(psz_notifications[j]);
231     }
232     psz_encoded[4] = j;
233     for( j = 0 ; psz_notifications[j] != NULL ; j++)
234         if(pb_defaults[j] == VLC_TRUE)
235         {
236             psz_encoded[i++] = (uint8_t)j;
237             i_defaults++;
238         }
239     psz_encoded[5] = i_defaults;
240
241     CheckAndSend(p_this, psz_encoded, i);
242     free( psz_encoded );
243     return VLC_SUCCESS;
244 }
245
246 static int NotifyToGrowl( vlc_object_t *p_this, char *psz_type,
247                             char *psz_title, char *psz_desc )
248 {
249     uint8_t *psz_encoded = malloc(GROWL_MAX_LENGTH + 42);
250     uint16_t flags;
251     int i = 0;
252     if( psz_encoded == NULL )
253         return VLC_FALSE;
254
255     memset( psz_encoded, 0, sizeof(psz_encoded) );
256     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
257     psz_encoded[i++] = GROWL_TYPE_NOTIFICATION;
258     flags = 0;
259     psz_encoded[i++] = (flags>>8)&0xFF;
260     psz_encoded[i++] = flags&0xFF;
261     insertstrlen(psz_type);
262     insertstrlen(psz_title);
263     insertstrlen(psz_desc);
264     insertstrlen(APPLICATION_NAME);
265     strcpy( (char*)(psz_encoded+i), psz_type );
266     i += strlen(psz_type);
267     strcpy( (char*)(psz_encoded+i), psz_title );
268     i += strlen(psz_title);
269     strcpy( (char*)(psz_encoded+i), psz_desc );
270     i += strlen(psz_desc);
271     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
272     i += strlen(APPLICATION_NAME);
273
274     CheckAndSend(p_this, psz_encoded, i);
275     free( psz_encoded );
276     return VLC_SUCCESS;
277 }
278
279 static int CheckAndSend( vlc_object_t *p_this, uint8_t* p_data, int i_offset )
280 {
281     int i, i_handle;
282     struct md5_s md5;
283     intf_thread_t *p_intf = (intf_thread_t *)p_this;
284     char *psz_password = config_GetPsz( p_intf, "growl-password" );
285     char *psz_server = config_GetPsz( p_intf, "growl-server" );
286     int i_port = config_GetInt( p_intf, "growl-port" );
287     int i_ttl = config_GetInt( p_intf, "growl-ttl" );
288     strcpy( (char*)(p_data+i_offset), psz_password );
289     i = i_offset + strlen(psz_password);
290
291     InitMD5( &md5 );
292     AddMD5( &md5, p_data, i );
293     EndMD5( &md5 );
294
295     for( i = 0 ; i < 4 ; i++ )
296     {
297         md5.p_digest[i] = md5.p_digest[i];
298         p_data[i_offset++] =  md5.p_digest[i]     &0xFF;
299         p_data[i_offset++] = (md5.p_digest[i]>> 8)&0xFF;
300         p_data[i_offset++] = (md5.p_digest[i]>>16)&0xFF;
301         p_data[i_offset++] = (md5.p_digest[i]>>24)&0xFF;
302     }
303
304     i_handle = net_ConnectUDP( p_this, psz_server, i_port, i_ttl );
305     if( i_handle == -1 )
306     {
307          msg_Err( p_this, "failed to open a connection (udp)" );
308          free( psz_password);
309          free( psz_server);
310          return VLC_EGENERIC;
311     }
312
313     net_StopRecv( i_handle );
314     if( send( i_handle, p_data, i_offset, 0 )
315           == -1 )
316     {
317         msg_Warn( p_this, "send error: %s", strerror(errno) );
318     }
319     net_Close( i_handle );
320
321     free( psz_password);
322     free( psz_server);
323     return VLC_SUCCESS;
324 }
325
326 #undef GROWL_PROTOCOL_VERSION
327 #undef GROWL_TYPE_REGISTRATION
328 #undef GROWL_TYPE_NOTIFICATION
329 #undef APPLICATION_NAME
330 #undef insertstrlen