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