git.sesse.net Git - vlc/blob - modules/misc/notify/growl.m

   1 /*****************************************************************************
   2  * growl.m : growl notification plugin
   3  *****************************************************************************
   4  * VLC specific code:
   5  *
   6  * Copyright © 2008 the VideoLAN team
   7  * $Id$
   8  *
   9  * Authors: Rafaël Carré <funman@videolanorg>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *
  25  * Growl specific code, ripped from growlnotify:
  26  *
  27  * Copyright (c) The Growl Project, 2004-2005
  28  * All rights reserved.
  29  *
  30  * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
  31  *
  32  * 1. Redistributions of source code must retain the above copyright
  33  notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  notice, this list of conditions and the following disclaimer in the
  36  documentation and/or other materials provided with the distribution.
  37  * 3. Neither the name of Growl nor the names of its contributors
  38  may be used to endorse or promote products derived from this software
  39  without specific prior written permission.
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42  *
  43  *****************************************************************************/
  44
  45 /*****************************************************************************
  46  * Preamble
  47  *****************************************************************************/
  48
  49 #ifdef HAVE_CONFIG_H
  50 # include "config.h"
  51 #endif
  52
  53 #import <Foundation/Foundation.h>
  54 #import <Growl/GrowlDefines.h>
  55
  56 #include <vlc_common.h>
  57 #include <vlc_plugin.h>
  58 #include <vlc_playlist.h>
  59 #include <vlc_meta.h>
  60 #include <vlc_interface.h>
  61 #include <vlc_url.h>
  62
  63
  64 /*****************************************************************************
  65  * intf_sys_t
  66  *****************************************************************************/
  67 struct intf_sys_t
  68 {
  69     CFDataRef           default_icon;
  70     NSAutoreleasePool   *p_pool;
  71     CFStringRef         app_name;
  72     CFStringRef         notification_type;
  73 };
  74
  75 /*****************************************************************************
  76  * Local prototypes
  77  *****************************************************************************/
  78 static int  Open    ( vlc_object_t * );
  79 static void Close   ( vlc_object_t * );
  80
  81 static int ItemChange( vlc_object_t *, const char *,
  82                        vlc_value_t, vlc_value_t, void * );
  83
  84 static void RegisterToGrowl( vlc_object_t * );
  85 static void NotifyToGrowl( intf_thread_t *, const char *, CFDataRef );
  86
  87 static CFDataRef readFile(const char *);
  88
  89 /*****************************************************************************
  90  * Module descriptor
  91  ****************************************************************************/
  92
  93 vlc_module_begin ()
  94     set_category( CAT_INTERFACE )
  95     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  96     set_shortname( "Growl" )
  97     set_description( N_("Growl Notification Plugin") )
  98     set_capability( "interface", 0 )
  99     set_callbacks( Open, Close )
 100 vlc_module_end ()
 101
 102 /*****************************************************************************
 103  * Open: initialize and create stuff
 104  *****************************************************************************/
 105 static int Open( vlc_object_t *p_this )
 106 {
 107     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 108     intf_sys_t    *p_sys;
 109
 110     p_sys = p_intf->p_sys = calloc( 1, sizeof(intf_sys_t) );
 111     if( !p_sys )
 112         return VLC_ENOMEM;
 113
 114     p_sys->p_pool = [[NSAutoreleasePool alloc] init];
 115     p_sys->app_name = CFSTR( "VLC media player" );
 116     p_sys->notification_type = CFSTR( "New input playing" );
 117
 118     char *data_path = config_GetDataDir ( p_this );
 119     char buf[strlen (data_path) + sizeof ("/vlc48x48.png")];
 120     snprintf (buf, sizeof (buf), "%s/vlc48x48.png", data_path);
 121     free( data_path );
 122     p_sys->default_icon = (CFDataRef) readFile( buf );
 123
 124     var_AddCallback( pl_Get( p_intf ), "item-current", ItemChange, p_intf );
 125
 126     RegisterToGrowl( p_this );
 127     return VLC_SUCCESS;
 128 }
 129
 130 /*****************************************************************************
 131  * Close: destroy interface stuff
 132  *****************************************************************************/
 133 static void Close( vlc_object_t *p_this )
 134 {
 135     intf_sys_t *p_sys = ((intf_thread_t*)p_this)->p_sys;
 136
 137     var_DelCallback( pl_Get( p_this ), "item-current", ItemChange, p_this );
 138
 139     CFRelease( p_sys->default_icon );
 140     CFRelease( p_sys->app_name );
 141     CFRelease( p_sys->notification_type );
 142     [p_sys->p_pool release];
 143     free( p_sys );
 144 }
 145
 146 /*****************************************************************************
 147  * ItemChange: Playlist item change callback
 148  *****************************************************************************/
 149 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 150                        vlc_value_t oldval, vlc_value_t newval, void *param )
 151 {
 152     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 153
 154     intf_thread_t *p_intf   = (intf_thread_t*)param;
 155     char *psz_tmp           = NULL;
 156     char *psz_title         = NULL;
 157     char *psz_artist        = NULL;
 158     char *psz_album         = NULL;
 159     input_thread_t *p_input;
 160     p_input = playlist_CurrentInput( (playlist_t*)p_this );
 161
 162     if( !p_input ) return VLC_SUCCESS;
 163
 164     char *psz_name = input_item_GetName( input_GetItem( p_input ) );
 165     if( p_input->b_dead || !psz_name )
 166     {
 167         /* Not playing anything ... */
 168         free( psz_name );
 169         vlc_object_release( p_input );
 170         return VLC_SUCCESS;
 171     }
 172     free( psz_name );
 173
 174     /* Playing something ... */
 175     input_item_t *p_item = input_GetItem( p_input );
 176
 177     psz_title = input_item_GetTitleFbName( p_item );
 178     if( EMPTY_STR( psz_title ) )
 179     {
 180         free( psz_title );
 181         vlc_object_release( p_input );
 182         return VLC_SUCCESS;
 183     }
 184
 185     psz_artist = input_item_GetArtist( p_item );
 186     if( EMPTY_STR( psz_artist ) ) FREENULL( psz_artist );
 187     psz_album = input_item_GetAlbum( p_item ) ;
 188     if( EMPTY_STR( psz_album ) ) FREENULL( psz_album );
 189
 190     int i_ret;
 191     if( psz_artist && psz_album )
 192         i_ret = asprintf( &psz_tmp, "%s\n%s [%s]",
 193                 psz_title, psz_artist, psz_album );
 194     else if( psz_artist )
 195         i_ret = asprintf( &psz_tmp, "%s\n%s", psz_title, psz_artist );
 196     else
 197     {
 198         psz_tmp = strdup( psz_title );
 199         if( psz_tmp == NULL )
 200            i_ret = -1;
 201     }
 202
 203     if( i_ret == -1 )
 204     {
 205         free( psz_title );
 206         free( psz_artist );
 207         free( psz_album );
 208         vlc_object_release( p_input );
 209         return VLC_ENOMEM;
 210     }
 211
 212     char *psz_arturl = input_item_GetArtURL( p_item );
 213     if( psz_arturl )
 214     {
 215         char *psz = make_path( psz_arturl );
 216         free( psz_arturl );
 217         psz_arturl = psz;
 218     }
 219     CFDataRef art = NULL;
 220     if( psz_arturl )
 221         art = (CFDataRef) readFile( psz_arturl );
 222
 223     free( psz_title );
 224     free( psz_artist );
 225     free( psz_album );
 226     free( psz_arturl );
 227
 228     NotifyToGrowl( p_intf, psz_tmp, art );
 229
 230     if( art ) CFRelease( art );
 231     free( psz_tmp );
 232
 233     vlc_object_release( p_input );
 234     return VLC_SUCCESS;
 235 }
 236
 237 /*****************************************************************************
 238  * RegisterToGrowl
 239  *****************************************************************************/
 240 static void RegisterToGrowl( vlc_object_t *p_this )
 241 {
 242     intf_sys_t *p_sys = ((intf_thread_t *)p_this)->p_sys;
 243
 244     CFArrayRef defaultAndAllNotifications = CFArrayCreate(
 245         kCFAllocatorDefault, (const void **)&(p_sys->notification_type), 1,
 246         &kCFTypeArrayCallBacks );
 247
 248     CFTypeRef registerKeys[4] = {
 249         GROWL_APP_NAME,
 250         GROWL_NOTIFICATIONS_ALL,
 251         GROWL_NOTIFICATIONS_DEFAULT,
 252         GROWL_APP_ICON
 253     };
 254
 255     CFTypeRef registerValues[4] = {
 256         p_sys->app_name,
 257         defaultAndAllNotifications,
 258         defaultAndAllNotifications,
 259         p_sys->default_icon
 260     };
 261
 262     CFDictionaryRef registerInfo = CFDictionaryCreate(
 263         kCFAllocatorDefault, registerKeys, registerValues, 4,
 264         &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks );
 265
 266     CFRelease( defaultAndAllNotifications );
 267
 268     CFNotificationCenterPostNotificationWithOptions(
 269         CFNotificationCenterGetDistributedCenter(),
 270         (CFStringRef)GROWL_APP_REGISTRATION, NULL, registerInfo,
 271         kCFNotificationPostToAllSessions );
 272     CFRelease( registerInfo );
 273 }
 274
 275 static void NotifyToGrowl( intf_thread_t *p_intf, const char *psz_desc, CFDataRef art )
 276 {
 277     intf_sys_t *p_sys = p_intf->p_sys;
 278
 279     CFStringRef title = CFStringCreateWithCString( kCFAllocatorDefault, _("Now playing"), kCFStringEncodingUTF8 );
 280     CFStringRef desc = CFStringCreateWithCString( kCFAllocatorDefault, psz_desc, kCFStringEncodingUTF8 );
 281
 282     CFMutableDictionaryRef notificationInfo = CFDictionaryCreateMutable(
 283         kCFAllocatorDefault, 5, &kCFTypeDictionaryKeyCallBacks,
 284         &kCFTypeDictionaryValueCallBacks);
 285
 286     CFDictionarySetValue( notificationInfo, GROWL_NOTIFICATION_NAME, p_sys->notification_type );
 287     CFDictionarySetValue( notificationInfo, GROWL_APP_NAME, p_sys->app_name );
 288     CFDictionarySetValue( notificationInfo, GROWL_NOTIFICATION_TITLE, title );
 289     CFDictionarySetValue( notificationInfo, GROWL_NOTIFICATION_DESCRIPTION, desc );
 290
 291     CFDictionarySetValue( notificationInfo, GROWL_NOTIFICATION_ICON,
 292         art ? art : p_sys->default_icon );
 293
 294     CFRelease( title );
 295     CFRelease( desc );
 296
 297     CFNotificationCenterPostNotificationWithOptions(
 298         CFNotificationCenterGetDistributedCenter(),
 299         (CFStringRef)GROWL_NOTIFICATION, NULL, notificationInfo,
 300         kCFNotificationPostToAllSessions );
 301
 302     CFRelease( notificationInfo );
 303 }
 304
 305 /* Ripped from CFGrowlAdditions.c
 306  * Strangely, this function does exist in Growl shared library, but is not
 307  * defined in public header files */
 308 static CFDataRef readFile(const char *filename)
 309 {
 310     CFDataRef data;
 311     // read the file into a CFDataRef
 312     FILE *fp = fopen(filename, "r");
 313     if( !fp )
 314     return NULL;
 315
 316     fseek(fp, 0, SEEK_END);
 317     long dataLength = ftell(fp);
 318     fseek(fp, 0, SEEK_SET);
 319     unsigned char *fileData = malloc(dataLength);
 320     fread(fileData, 1, dataLength, fp);
 321     fclose(fp);
 322     return CFDataCreateWithBytesNoCopy(kCFAllocatorDefault, fileData,
 323         dataLength, kCFAllocatorMalloc);
 324 }
 325