5e128e09d178aae0a5f30b746401f064ec15e161
[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 -1;
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 0;
112 }
113
114 /*****************************************************************************
115  * Close: destroy interface stuff
116  *****************************************************************************/
117 static void Close( vlc_object_t *p_this )
118 {
119 }
120
121 /*****************************************************************************
122  * Run
123  *****************************************************************************/
124 static void Run( intf_thread_t *p_intf )
125 {
126     msleep( INTF_IDLE_SLEEP );
127 }
128
129 /*****************************************************************************
130  * ItemChange: Playlist item change callback
131  *****************************************************************************/
132 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
133                        vlc_value_t oldval, vlc_value_t newval, void *param )
134 {
135     char psz_tmp[GROWL_MAX_LENGTH];
136     char *psz_title = NULL;
137     char *psz_artist = NULL;
138     char *psz_album = NULL;
139
140     input_thread_t *p_input =
141         (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
142                                            FIND_ANYWHERE );
143     if( !p_input || p_input->b_dead || !p_input->input.p_item->psz_name )
144     {
145         /* Not playing anything ... */
146         return VLC_SUCCESS;
147     }
148
149     /* Playing something ... */
150     psz_artist = vlc_input_item_GetInfo( p_input->input.p_item,
151                                          _("Meta-information"),
152                                          VLC_META_ARTIST);
153     psz_album = vlc_input_item_GetInfo( p_input->input.p_item,
154                                          _("Meta-information"),
155                                          _("Album/movie/show title" ) );
156     psz_title = strdup( p_input->input.p_item->psz_name );
157     if( psz_title == NULL ) psz_title = strdup( N_("(no title)") );
158     if( psz_artist == NULL ) psz_artist = strdup( N_("(no artist)") );
159     if( psz_album == NULL ) psz_album = strdup( N_("(no album)") );
160     snprintf( psz_tmp, GROWL_MAX_LENGTH, "%s %s %s",
161               psz_title, psz_artist, psz_album );
162     free( psz_title );
163     free( psz_artist );
164     free( psz_album );
165
166     NotifyToGrowl( p_this, "Now Playing", "Now Playing", psz_tmp );
167
168     vlc_object_release( p_input );
169     return VLC_SUCCESS;
170 }
171
172 /*****************************************************************************
173  * Growl specific functions
174  *****************************************************************************/
175 #define GROWL_PROTOCOL_VERSION (1)
176 #define GROWL_TYPE_REGISTRATION (0)
177 #define GROWL_TYPE_NOTIFICATION (1)
178 #define APPLICATION_NAME "VLC media player"
179
180 #define insertstrlen( psz ) \
181 { \
182     uint16_t i_size = strlen( psz ); \
183     psz_encoded[i++] = (i_size>>8)&0xFF; \
184     psz_encoded[i++] = i_size&0xFF; \
185 }
186 /*****************************************************************************
187  * RegisterToGrowl
188  *****************************************************************************/
189 static int RegisterToGrowl( vlc_object_t *p_this )
190 {
191     uint8_t *psz_encoded = malloc(100);
192     uint8_t i_defaults = 0;
193     char *psz_notifications[] = {"Now Playing", NULL};
194     vlc_bool_t pb_defaults[] = {VLC_TRUE, VLC_FALSE};
195     int i = 0, j;
196     if( psz_encoded == NULL )
197         return VLC_FALSE;
198
199     memset( psz_encoded, 0, sizeof(psz_encoded) );
200     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
201     psz_encoded[i++] = GROWL_TYPE_REGISTRATION;
202     insertstrlen(APPLICATION_NAME);
203     i+=2;
204     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
205     i += strlen(APPLICATION_NAME);
206     for( j = 0 ; psz_notifications[j] != NULL ; j++)
207     {
208         insertstrlen(psz_notifications[j]);
209         strcpy( (char*)(psz_encoded+i), psz_notifications[j] );
210         i += strlen(psz_notifications[j]);
211     }
212     psz_encoded[4] = j;
213     for( j = 0 ; psz_notifications[j] != NULL ; j++)
214         if(pb_defaults[j] == VLC_TRUE)
215         {
216             psz_encoded[i++] = (uint8_t)j;
217             i_defaults++;
218         }
219     psz_encoded[5] = i_defaults;
220
221     CheckAndSend(p_this, psz_encoded, i);
222     free( psz_encoded );
223     return VLC_SUCCESS;
224 }
225
226 static int NotifyToGrowl( vlc_object_t *p_this, char *psz_type,
227                             char *psz_title, char *psz_desc )
228 {
229     uint8_t *psz_encoded = malloc(GROWL_MAX_LENGTH + 42);
230     uint16_t flags;
231     int i = 0;
232     if( psz_encoded == NULL )
233         return VLC_FALSE;
234
235     memset( psz_encoded, 0, sizeof(psz_encoded) );
236     psz_encoded[i++] = GROWL_PROTOCOL_VERSION;
237     psz_encoded[i++] = GROWL_TYPE_NOTIFICATION;
238     flags = 0;
239     psz_encoded[i++] = (flags>>8)&0xFF;
240     psz_encoded[i++] = flags&0xFF;
241     insertstrlen(psz_type);
242     insertstrlen(psz_title);
243     insertstrlen(psz_desc);
244     insertstrlen(APPLICATION_NAME);
245     strcpy( (char*)(psz_encoded+i), psz_type );
246     i += strlen(psz_type);
247     strcpy( (char*)(psz_encoded+i), psz_title );
248     i += strlen(psz_title);
249     strcpy( (char*)(psz_encoded+i), psz_desc );
250     i += strlen(psz_desc);
251     strcpy( (char*)(psz_encoded+i), APPLICATION_NAME );
252     i += strlen(APPLICATION_NAME);
253
254     CheckAndSend(p_this, psz_encoded, i);
255     free( psz_encoded );
256     return VLC_SUCCESS;
257 }
258
259 static int CheckAndSend( vlc_object_t *p_this, uint8_t* p_data, int i_offset )
260 {
261     int i, i_handle;
262     struct md5_s md5;
263     intf_thread_t *p_intf = (intf_thread_t *)p_this;
264     char *psz_password = config_GetPsz( p_intf, "growl-password" );
265     char *psz_server = config_GetPsz( p_intf, "growl-server" );
266     int i_port = config_GetInt( p_intf, "growl-port" );
267     int i_ttl = config_GetInt( p_intf, "growl-ttl" );
268     strcpy( (char*)(p_data+i_offset), psz_password );
269     i = i_offset + strlen(psz_password);
270
271     InitMD5( &md5 );
272     AddMD5( &md5, p_data, i );
273     EndMD5( &md5 );
274
275     for( i = 0 ; i < 4 ; i++ )
276     {
277         md5.p_digest[i] = md5.p_digest[i];
278         p_data[i_offset++] =  md5.p_digest[i]     &0xFF;
279         p_data[i_offset++] = (md5.p_digest[i]>> 8)&0xFF;
280         p_data[i_offset++] = (md5.p_digest[i]>>16)&0xFF;
281         p_data[i_offset++] = (md5.p_digest[i]>>24)&0xFF;
282     }
283
284     i_handle = net_ConnectUDP( p_this, psz_server, i_port, i_ttl );
285     if( i_handle == -1 )
286     {
287          msg_Err( p_this, "failed to open a connection (udp)" );
288          free( psz_password);
289          free( psz_server);
290          return VLC_EGENERIC;
291     }
292
293     net_StopRecv( i_handle );
294     if( send( i_handle, p_data, i_offset, 0 )
295           == -1 )
296     {
297         msg_Warn( p_this, "send error: %s", strerror(errno) );
298     }
299     net_Close( i_handle );
300
301     free( psz_password);
302     free( psz_server);
303     return VLC_SUCCESS;
304 }
305
306 #undef GROWL_PROTOCOL_VERSION
307 #undef GROWL_TYPE_REGISTRATION
308 #undef GROWL_TYPE_NOTIFICATION
309 #undef APPLICATION_NAME
310 #undef insertstrlen