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