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