modules/notify/notify.c

   1 /*****************************************************************************
   2  * notify.c : libnotify notification plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Mutricy <xtophe -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 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_interface.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_url.h>
  36
  37 #include <gtk/gtk.h>
  38 #include <gdk-pixbuf/gdk-pixbuf.h>
  39 #include <libnotify/notify.h>
  40
  41 #ifndef NOTIFY_CHECK_VERSION
  42 # define NOTIFY_CHECK_VERSION(x,y,z) 0
  43 #endif
  44
  45 /*****************************************************************************
  46  * Module descriptor
  47  ****************************************************************************/
  48 static int  Open    ( vlc_object_t * );
  49 static void Close   ( vlc_object_t * );
  50
  51 #define APPLICATION_NAME "VLC media player"
  52
  53 #define TIMEOUT_TEXT N_("Timeout (ms)")
  54 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
  55
  56 vlc_module_begin ()
  57     set_category( CAT_INTERFACE )
  58     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  59     set_shortname( N_( "Notify" ) )
  60     set_description( N_("LibNotify Notification Plugin") )
  61
  62     add_integer( "notify-timeout", 4000,
  63                  TIMEOUT_TEXT, TIMEOUT_LONGTEXT, true )
  64
  65     set_capability( "interface", 0 )
  66     set_callbacks( Open, Close )
  67 vlc_module_end ()
  68
  69
  70 /*****************************************************************************
  71  * Local prototypes
  72  *****************************************************************************/
  73 static int ItemChange( vlc_object_t *, const char *,
  74                        vlc_value_t, vlc_value_t, void * );
  75 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
  76 #define MAX_LENGTH 256
  77
  78 struct intf_sys_t
  79 {
  80     NotifyNotification *notification;
  81     vlc_mutex_t     lock;
  82     bool            b_has_actions;
  83 };
  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     intf_sys_t      *p_sys  = malloc( sizeof( *p_sys ) );
  92
  93     if( !p_sys )
  94         return VLC_ENOMEM;
  95
  96     if( !notify_init( APPLICATION_NAME ) )
  97     {
  98         free( p_sys );
  99         msg_Err( p_intf, "can't find notification daemon" );
 100         return VLC_EGENERIC;
 101     }
 102     p_intf->p_sys = p_sys;
 103
 104     vlc_mutex_init( &p_sys->lock );
 105     p_sys->notification = NULL;
 106     p_sys->b_has_actions = false;
 107
 108     GList *p_caps = notify_get_server_caps ();
 109     if( p_caps )
 110     {
 111         for( GList *c = p_caps; c != NULL; c = c->next )
 112         {
 113             if( !strcmp( (char*)c->data, "actions" ) )
 114             {
 115                 p_sys->b_has_actions = true;
 116                 break;
 117             }
 118         }
 119         g_list_foreach( p_caps, (GFunc)g_free, NULL );
 120         g_list_free( p_caps );
 121     }
 122
 123     /* */
 124     var_AddCallback( pl_Get( p_intf ), "activity", ItemChange, p_intf );
 125
 126     return VLC_SUCCESS;
 127 }
 128
 129 /*****************************************************************************
 130  * Close: destroy interface stuff
 131  *****************************************************************************/
 132 static void Close( vlc_object_t *p_this )
 133 {
 134     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
 135     intf_sys_t      *p_sys  = p_intf->p_sys;
 136
 137     var_DelCallback( pl_Get( p_this ), "activity", ItemChange, p_this );
 138
 139     if( p_sys->notification )
 140     {
 141         GError *p_error = NULL;
 142         notify_notification_close( p_sys->notification, &p_error );
 143         g_object_unref( p_sys->notification );
 144     }
 145
 146     vlc_mutex_destroy( &p_sys->lock );
 147     free( p_sys );
 148     notify_uninit();
 149 }
 150
 151 /*****************************************************************************
 152  * ItemChange: Playlist item change callback
 153  *****************************************************************************/
 154 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 155                        vlc_value_t oldval, vlc_value_t newval, void *param )
 156 {
 157     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 158     char           psz_tmp[MAX_LENGTH];
 159     char           psz_notify[MAX_LENGTH];
 160     char           *psz_title;
 161     char           *psz_artist;
 162     char           *psz_album;
 163     char           *psz_arturl;
 164     input_thread_t *p_input = playlist_CurrentInput( (playlist_t*)p_this );
 165     intf_thread_t  *p_intf  = param;
 166     intf_sys_t     *p_sys   = p_intf->p_sys;
 167
 168     if( !p_input )
 169         return VLC_SUCCESS;
 170
 171     if( p_input->b_dead )
 172     {
 173         /* Not playing anything ... */
 174         vlc_object_release( p_input );
 175         return VLC_SUCCESS;
 176     }
 177
 178     /* Wait a tad so the meta has been fetched
 179      * FIXME that's awfully wrong */
 180     msleep( 10000 );
 181
 182     /* Playing something ... */
 183     input_item_t *p_input_item = input_GetItem( p_input );
 184     psz_title = input_item_GetTitleFbName( p_input_item );
 185
 186     /* We need at least a title */
 187     if( EMPTY_STR( psz_title ) )
 188     {
 189         free( psz_title );
 190         vlc_object_release( p_input );
 191         return VLC_SUCCESS;
 192     }
 193
 194     psz_artist = input_item_GetArtist( p_input_item );
 195     psz_album = input_item_GetAlbum( p_input_item );
 196
 197     if( !EMPTY_STR( psz_artist ) )
 198     {
 199         if( !EMPTY_STR( psz_album ) )
 200             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
 201                       psz_title, psz_artist, psz_album );
 202         else
 203             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
 204                       psz_title, psz_artist );
 205     }
 206     else
 207         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
 208
 209     free( psz_title );
 210     free( psz_artist );
 211     free( psz_album );
 212
 213     GdkPixbuf *pix = NULL;
 214     psz_arturl = input_item_GetArtURL( p_input_item );
 215     vlc_object_release( p_input );
 216
 217     if( psz_arturl )
 218     {
 219         char *psz = make_path( psz_arturl );
 220         free( psz_arturl );
 221         psz_arturl = psz;
 222     }
 223
 224     if( psz_arturl )
 225     { /* scale the art to show it in notify popup */
 226         GError *p_error = NULL;
 227         pix = gdk_pixbuf_new_from_file_at_scale( psz_arturl,
 228                                                  72, 72, TRUE, &p_error );
 229     }
 230     else /* else we show state-of-the art logo */
 231     {
 232         /* First try to get an icon from the current theme. */
 233         GtkIconTheme* p_theme = gtk_icon_theme_get_default();
 234         pix = gtk_icon_theme_load_icon( p_theme, "vlc", 72, 0, NULL);
 235
 236         if( !pix )
 237         {
 238         /* Load icon from share/ */
 239             GError *p_error = NULL;
 240             char *psz_pixbuf;
 241             char *psz_data = config_GetDataDir();
 242             if( asprintf( &psz_pixbuf, "%s/icons/48x48/vlc.png", psz_data ) >= 0 )
 243             {
 244                 pix = gdk_pixbuf_new_from_file( psz_pixbuf, &p_error );
 245                 free( psz_pixbuf );
 246             }
 247             free( psz_data );
 248         }
 249     }
 250
 251     free( psz_arturl );
 252
 253     /* we need to replace '&' with '&amp;' because '&' is a keyword of
 254      * notification-daemon parser */
 255     const int i_len = strlen( psz_tmp );
 256     int i_notify = 0;
 257     for( int i = 0; i < i_len && i_notify < ( MAX_LENGTH - 5 ); i++ )
 258     { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
 259        * we will need 5 more characters: 'amp;\0' .
 260        * however that's unlikely to happen because the last char is '\0' */
 261         if( psz_tmp[i] != '&' )
 262         {
 263             psz_notify[i_notify] = psz_tmp[i];
 264         }
 265         else
 266         {
 267             strcpy( &psz_notify[i_notify], "&amp;" );
 268             i_notify += 4;
 269         }
 270         i_notify++;
 271     }
 272     psz_notify[i_notify] = '\0';
 273
 274     vlc_mutex_lock( &p_sys->lock );
 275
 276     Notify( p_this, psz_notify, pix, p_intf );
 277
 278     vlc_mutex_unlock( &p_sys->lock );
 279
 280     return VLC_SUCCESS;
 281 }
 282
 283 /* libnotify callback, called when the "Next" button is pressed */
 284 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
 285 {
 286     vlc_object_t *p_object = (vlc_object_t*)p;
 287
 288     VLC_UNUSED(psz);
 289     notify_notification_close( notification, NULL );
 290     playlist_Next( pl_Get( p_object ) );
 291 }
 292
 293 /* libnotify callback, called when the "Previous" button is pressed */
 294 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
 295 {
 296     vlc_object_t *p_object = (vlc_object_t*)p;
 297
 298     VLC_UNUSED(psz);
 299     notify_notification_close( notification, NULL );
 300     playlist_Prev( pl_Get( p_object ) );
 301 }
 302
 303 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
 304                    intf_thread_t *p_intf )
 305 {
 306     intf_sys_t *p_sys = p_intf->p_sys;
 307
 308     NotifyNotification * notification;
 309
 310     /* Close previous notification if still active */
 311     if( p_sys->notification )
 312     {
 313         GError *p_error = NULL;
 314         notify_notification_close( p_sys->notification, &p_error );
 315         g_object_unref( p_sys->notification );
 316     }
 317
 318     notification = notify_notification_new( _("Now Playing"),
 319                                             psz_temp, NULL
 320 #if NOTIFY_CHECK_VERSION (0, 7, 0)
 321                                           );
 322 #else
 323                                           , NULL );
 324 #endif
 325     notify_notification_set_timeout( notification,
 326                                 var_InheritInteger(p_this, "notify-timeout") );
 327     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
 328     if( pix )
 329     {
 330         notify_notification_set_icon_from_pixbuf( notification, pix );
 331         gdk_pixbuf_unref( pix );
 332     }
 333
 334     /* Adds previous and next buttons in the notification if actions are supported. */
 335     if( p_sys->b_has_actions )
 336     {
 337       notify_notification_add_action( notification, "previous", _("Previous"), Prev,
 338                                       (gpointer*)p_intf, NULL );
 339       notify_notification_add_action( notification, "next", _("Next"), Next,
 340                                       (gpointer*)p_intf, NULL );
 341     }
 342
 343     notify_notification_show( notification, NULL);
 344
 345     /* Stores the notification to be able to close it */
 346     p_sys->notification = notification;
 347     return VLC_SUCCESS;
 348 }
 349