git.sesse.net Git - vlc/blob - modules/misc/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 /*****************************************************************************
  42  * Module descriptor
  43  ****************************************************************************/
  44 static int  Open    ( vlc_object_t * );
  45 static void Close   ( vlc_object_t * );
  46
  47 #define APPLICATION_NAME "VLC media player"
  48
  49 #define TIMEOUT_TEXT N_("Timeout (ms)")
  50 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
  51
  52 vlc_module_begin ()
  53     set_category( CAT_INTERFACE )
  54     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  55     set_shortname( N_( "Notify" ) )
  56     set_description( N_("LibNotify Notification Plugin") )
  57
  58     add_integer( "notify-timeout", 4000, NULL,
  59                  TIMEOUT_TEXT, TIMEOUT_LONGTEXT, true )
  60
  61     set_capability( "interface", 0 )
  62     set_callbacks( Open, Close )
  63 vlc_module_end ()
  64
  65
  66 /*****************************************************************************
  67  * Local prototypes
  68  *****************************************************************************/
  69 static int ItemChange( vlc_object_t *, const char *,
  70                        vlc_value_t, vlc_value_t, void * );
  71 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
  72 #define MAX_LENGTH 256
  73
  74 struct intf_sys_t
  75 {
  76     NotifyNotification *notification;
  77     vlc_mutex_t     lock;
  78     bool            b_has_actions;
  79 };
  80
  81 /*****************************************************************************
  82  * Open: initialize and create stuff
  83  *****************************************************************************/
  84 static int Open( vlc_object_t *p_this )
  85 {
  86     intf_thread_t   *p_intf = (intf_thread_t *)p_this;
  87     intf_sys_t      *p_sys  = malloc( sizeof( *p_sys ) );
  88
  89     if( !p_sys )
  90         return VLC_ENOMEM;
  91
  92     if( !notify_init( APPLICATION_NAME ) )
  93     {
  94         free( p_sys );
  95         msg_Err( p_intf, "can't find notification daemon" );
  96         return VLC_EGENERIC;
  97     }
  98     p_intf->p_sys = p_sys;
  99
 100     vlc_mutex_init( &p_sys->lock );
 101     p_sys->notification = NULL;
 102     p_sys->b_has_actions = false;
 103
 104     GList *p_caps = notify_get_server_caps ();
 105     if( p_caps )
 106     {
 107         for( GList *c = p_caps; c != NULL; c = c->next )
 108         {
 109             if( !strcmp( (char*)c->data, "actions" ) )
 110             {
 111                 p_sys->b_has_actions = true;
 112                 break;
 113             }
 114         }
 115         g_list_foreach( p_caps, (GFunc)g_free, NULL );
 116         g_list_free( p_caps );
 117     }
 118
 119     /* */
 120     var_AddCallback( pl_Get( p_intf ), "item-current", ItemChange, p_intf );
 121
 122     return VLC_SUCCESS;
 123 }
 124
 125 /*****************************************************************************
 126  * Close: destroy interface stuff
 127  *****************************************************************************/
 128 static void Close( vlc_object_t *p_this )
 129 {
 130     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
 131     intf_sys_t      *p_sys  = p_intf->p_sys;
 132
 133     var_DelCallback( pl_Get( p_this ), "item-current", ItemChange, p_this );
 134
 135     if( p_sys->notification )
 136     {
 137         GError *p_error = NULL;
 138         notify_notification_close( p_sys->notification, &p_error );
 139         g_object_unref( p_sys->notification );
 140     }
 141
 142     vlc_mutex_destroy( &p_sys->lock );
 143     free( p_sys );
 144     notify_uninit();
 145 }
 146
 147 /*****************************************************************************
 148  * ItemChange: Playlist item change callback
 149  *****************************************************************************/
 150 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 151                        vlc_value_t oldval, vlc_value_t newval, void *param )
 152 {
 153     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 154     char           psz_tmp[MAX_LENGTH];
 155     char           psz_notify[MAX_LENGTH];
 156     char           *psz_title;
 157     char           *psz_artist;
 158     char           *psz_album;
 159     char           *psz_arturl;
 160     input_thread_t *p_input = playlist_CurrentInput( (playlist_t*)p_this );
 161     intf_thread_t  *p_intf  = param;
 162     intf_sys_t     *p_sys   = p_intf->p_sys;
 163
 164     if( !p_input )
 165         return VLC_SUCCESS;
 166
 167     if( p_input->b_dead )
 168     {
 169         /* Not playing anything ... */
 170         vlc_object_release( p_input );
 171         return VLC_SUCCESS;
 172     }
 173
 174     /* Wait a tad so the meta has been fetched
 175      * FIXME that's awfully wrong */
 176     msleep( 10000 );
 177
 178     /* Playing something ... */
 179     input_item_t *p_input_item = input_GetItem( p_input );
 180     psz_title = input_item_GetTitleFbName( p_input_item );
 181
 182     /* We need at least a title */
 183     if( EMPTY_STR( psz_title ) )
 184     {
 185         free( psz_title );
 186         vlc_object_release( p_input );
 187         return VLC_SUCCESS;
 188     }
 189
 190     psz_artist = input_item_GetArtist( p_input_item );
 191     psz_album = input_item_GetAlbum( p_input_item );
 192
 193     if( !EMPTY_STR( psz_artist ) )
 194     {
 195         if( !EMPTY_STR( psz_album ) )
 196             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
 197                       psz_title, psz_artist, psz_album );
 198         else
 199             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
 200                       psz_title, psz_artist );
 201     }
 202     else
 203         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
 204
 205     free( psz_title );
 206     free( psz_artist );
 207     free( psz_album );
 208
 209     GdkPixbuf *pix = NULL;
 210     psz_arturl = input_item_GetArtURL( p_input_item );
 211     vlc_object_release( p_input );
 212
 213     if( psz_arturl )
 214     {
 215         char *psz = make_path( 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( p_this );
 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     vlc_object_t *p_object = (vlc_object_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     vlc_object_t *p_object = (vlc_object_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, NULL );
 316     notify_notification_set_timeout( notification,
 317                                 var_InheritInteger(p_this, "notify-timeout") );
 318     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
 319     if( pix )
 320     {
 321         notify_notification_set_icon_from_pixbuf( notification, pix );
 322         gdk_pixbuf_unref( pix );
 323     }
 324
 325     /* Adds previous and next buttons in the notification if actions are supported. */
 326     if( p_sys->b_has_actions )
 327     {
 328       notify_notification_add_action( notification, "previous", _("Previous"), Prev,
 329                                       (gpointer*)p_intf, NULL );
 330       notify_notification_add_action( notification, "next", _("Next"), Next,
 331                                       (gpointer*)p_intf, NULL );
 332     }
 333
 334     notify_notification_show( notification, NULL);
 335
 336     /* Stores the notification to be able to close it */
 337     p_sys->notification = notification;
 338     return VLC_SUCCESS;
 339 }
 340