src/empathy-status-icon.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2007-2008 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Authors: Xavier Claessens <xclaesse@gmail.com>
  20  */
  21
  22 #include <config.h>
  23
  24 #include <string.h>
  25
  26 #include <gtk/gtk.h>
  27 #include <gdk/gdkkeysyms.h>
  28
  29 #include <libnotify/notification.h>
  30
  31 #include <libempathy/empathy-utils.h>
  32 #include <libempathy/empathy-idle.h>
  33 #include <libempathy/empathy-account-manager.h>
  34
  35 #include <libempathy-gtk/empathy-presence-chooser.h>
  36 #include <libempathy-gtk/empathy-conf.h>
  37 #include <libempathy-gtk/empathy-ui-utils.h>
  38 #include <libempathy-gtk/empathy-images.h>
  39 #include <libempathy-gtk/empathy-new-message-dialog.h>
  40
  41 #include "empathy-accounts-dialog.h"
  42 #include "empathy-status-icon.h"
  43 #include "empathy-preferences.h"
  44 #include "empathy-event-manager.h"
  45 #include "empathy-misc.h"
  46
  47 #define DEBUG_FLAG EMPATHY_DEBUG_DISPATCHER
  48 #include <libempathy/empathy-debug.h>
  49
  50 /* Number of ms to wait when blinking */
  51 #define BLINK_TIMEOUT 500
  52
  53 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyStatusIcon)
  54 typedef struct {
  55         GtkStatusIcon       *icon;
  56         EmpathyIdle         *idle;
  57         EmpathyAccountManager *account_manager;
  58         gboolean             showing_event_icon;
  59         guint                blink_timeout;
  60         EmpathyEventManager *event_manager;
  61         EmpathyEvent        *event;
  62         NotifyNotification  *notification;
  63
  64         GtkWindow           *window;
  65         GtkUIManager        *ui_manager;
  66         GtkWidget           *popup_menu;
  67         GtkAction           *show_window_item;
  68         GtkAction           *new_message_item;
  69         GtkAction           *status_item;
  70 } EmpathyStatusIconPriv;
  71
  72 G_DEFINE_TYPE (EmpathyStatusIcon, empathy_status_icon, G_TYPE_OBJECT);
  73
  74 static gboolean
  75 activate_event (EmpathyEvent *event)
  76 {
  77         empathy_event_activate (event);
  78
  79         return FALSE;
  80 }
  81
  82 static void
  83 status_icon_notification_closed_cb (NotifyNotification *notification,
  84                                     EmpathyStatusIcon  *icon)
  85 {
  86         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
  87         EmpathyNotificationClosedReason reason = 0;
  88
  89 #ifdef notify_notification_get_closed_reason
  90         reason = notify_notification_get_closed_reason (notification);
  91 #endif
  92         if (priv->notification) {
  93                 g_object_unref (priv->notification);
  94                 priv->notification = NULL;
  95         }
  96
  97         if (!priv->event) {
  98                 return;
  99         }
 100
 101         /* the notification has been closed by the user, see the
 102          * DesktopNotification spec.
 103          */
 104         if (reason == EMPATHY_NOTIFICATION_CLOSED_DISMISSED) {
 105                 /* use an idle here, as this callback is called from a
 106                  * DBus signal handler inside libnotify, and we might call
 107                  * a *_run_* method when activating the event.
 108                  */
 109                 g_idle_add ((GSourceFunc) activate_event, priv->event);
 110         } else {
 111                 /* inhibit other updates for this event */
 112                 empathy_event_inhibit_updates (priv->event);
 113         }
 114 }
 115
 116 static void
 117 notification_close_helper (EmpathyStatusIconPriv *priv)
 118 {
 119         if (priv->notification) {
 120                 notify_notification_close (priv->notification, NULL);
 121                 g_object_unref (priv->notification);
 122                 priv->notification = NULL;
 123         }
 124 }
 125
 126 static void
 127 status_icon_update_notification (EmpathyStatusIcon *icon)
 128 {
 129         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 130         GdkPixbuf *pixbuf = NULL;
 131
 132         if (!empathy_notification_is_enabled ()) {
 133                 /* always close the notification if this happens */
 134                 notification_close_helper (priv);
 135                 return;
 136         }
 137
 138         if (priv->event) {
 139                 pixbuf = empathy_misc_get_pixbuf_for_notification (priv->event->contact,
 140                                                                    priv->event->icon_name);
 141
 142                 if (priv->notification) {
 143                         notify_notification_update (priv->notification,
 144                                                     priv->event->header, priv->event->message,
 145                                                     NULL);
 146                 } else {
 147                         priv->notification = notify_notification_new_with_status_icon
 148                                 (priv->event->header, priv->event->message, NULL, priv->icon);
 149                         notify_notification_set_timeout (priv->notification,
 150                                                          NOTIFY_EXPIRES_DEFAULT);
 151
 152                         g_signal_connect (priv->notification, "closed",
 153                                           G_CALLBACK (status_icon_notification_closed_cb), icon);
 154
 155                 }
 156                 /* if icon doesn't exist libnotify will crash */
 157                 if (pixbuf != NULL)
 158                         notify_notification_set_icon_from_pixbuf (priv->notification,
 159                                                           pixbuf);
 160                 notify_notification_show (priv->notification, NULL);
 161
 162                 g_object_unref (pixbuf);
 163         } else {
 164                 notification_close_helper (priv);
 165         }
 166 }
 167
 168 static void
 169 status_icon_update_tooltip (EmpathyStatusIcon *icon)
 170 {
 171         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 172         gchar                 *tooltip = NULL;
 173
 174         if (priv->event) {
 175                 if (priv->event->message != NULL)
 176                                 tooltip = g_strdup_printf ("<i>%s</i>\n%s",
 177                                                            priv->event->header,
 178                                                            priv->event->message);
 179                 else
 180                                 tooltip = g_strdup_printf ("<i>%s</i>",
 181                                                            priv->event->header);
 182                 gtk_status_icon_set_tooltip_markup (priv->icon, tooltip);
 183         } else {
 184                 tooltip = g_strdup (empathy_idle_get_status (priv->idle));
 185                 gtk_status_icon_set_tooltip_text (priv->icon, tooltip);
 186         }
 187
 188         g_free (tooltip);
 189 }
 190
 191 static void
 192 status_icon_update_icon (EmpathyStatusIcon *icon)
 193 {
 194         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 195         const gchar           *icon_name;
 196
 197         if (priv->event && priv->showing_event_icon) {
 198                 icon_name = priv->event->icon_name;
 199         } else {
 200                 TpConnectionPresenceType state;
 201
 202                 state = empathy_idle_get_state (priv->idle);
 203                 icon_name = empathy_icon_name_for_presence (state);
 204         }
 205
 206         if (icon_name != NULL)
 207                 gtk_status_icon_set_from_icon_name (priv->icon, icon_name);
 208 }
 209
 210 static gboolean
 211 status_icon_blink_timeout_cb (EmpathyStatusIcon *icon)
 212 {
 213         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 214
 215         priv->showing_event_icon = !priv->showing_event_icon;
 216         status_icon_update_icon (icon);
 217
 218         return TRUE;
 219 }
 220 static void
 221 status_icon_event_added_cb (EmpathyEventManager *manager,
 222                             EmpathyEvent        *event,
 223                             EmpathyStatusIcon   *icon)
 224 {
 225         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 226
 227         if (priv->event) {
 228                 return;
 229         }
 230
 231         DEBUG ("New event %p", event);
 232
 233         priv->event = event;
 234         if (event->must_ack) {
 235                 priv->showing_event_icon = TRUE;
 236                 status_icon_update_icon (icon);
 237                 status_icon_update_tooltip (icon);
 238         }
 239         status_icon_update_notification (icon);
 240
 241         if (!priv->blink_timeout && priv->showing_event_icon) {
 242                 priv->blink_timeout = g_timeout_add (BLINK_TIMEOUT,
 243                                                      (GSourceFunc) status_icon_blink_timeout_cb,
 244                                                      icon);
 245         }
 246 }
 247
 248 static void
 249 status_icon_event_removed_cb (EmpathyEventManager *manager,
 250                               EmpathyEvent        *event,
 251                               EmpathyStatusIcon   *icon)
 252 {
 253         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 254
 255         if (event != priv->event) {
 256                 return;
 257         }
 258
 259         priv->event = empathy_event_manager_get_top_event (priv->event_manager);
 260
 261         status_icon_update_tooltip (icon);
 262         status_icon_update_icon (icon);
 263
 264         /* update notification anyway, as it's safe and we might have been
 265          * changed presence in the meanwhile
 266          */
 267         status_icon_update_notification (icon);
 268
 269         if (!priv->event && priv->blink_timeout) {
 270                 g_source_remove (priv->blink_timeout);
 271                 priv->blink_timeout = 0;
 272         }
 273 }
 274
 275 static void
 276 status_icon_event_updated_cb (EmpathyEventManager *manager,
 277                               EmpathyEvent        *event,
 278                               EmpathyStatusIcon   *icon)
 279 {
 280         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 281
 282         if (event != priv->event) {
 283                 return;
 284         }
 285
 286         if (empathy_notification_is_enabled ()) {
 287                 status_icon_update_notification (icon);
 288         }
 289
 290         status_icon_update_tooltip (icon);
 291 }
 292
 293 static void
 294 status_icon_set_visibility (EmpathyStatusIcon *icon,
 295                             gboolean           visible,
 296                             gboolean           store)
 297 {
 298         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 299
 300         if (store) {
 301                 empathy_conf_set_bool (empathy_conf_get (),
 302                                        EMPATHY_PREFS_UI_MAIN_WINDOW_HIDDEN, !visible);
 303         }
 304
 305         if (!visible) {
 306                 empathy_window_iconify (priv->window, priv->icon);
 307         } else {
 308                 GList *accounts;
 309                 GList *l;
 310                 gboolean one_enabled = FALSE;
 311
 312                 empathy_window_present (GTK_WINDOW (priv->window), TRUE);
 313
 314                 /* Show the accounts dialog if there is no enabled accounts */
 315                 accounts = empathy_account_manager_dup_accounts (priv->account_manager);
 316                 for (l = accounts ; l != NULL ; l = g_list_next (l)) {
 317                         one_enabled = empathy_account_is_enabled (EMPATHY_ACCOUNT (l->data))
 318                                 || one_enabled;
 319                         g_object_unref (l->data);
 320                 }
 321                 g_list_free (accounts);
 322                 if (!one_enabled) {
 323                         DEBUG ("No enabled account, Showing account dialog");
 324                         empathy_accounts_dialog_show (GTK_WINDOW (priv->window), NULL);
 325                 }
 326         }
 327 }
 328
 329 static void
 330 status_icon_notify_visibility_cb (EmpathyConf *conf,
 331                                   const gchar *key,
 332                                   gpointer     user_data)
 333 {
 334         EmpathyStatusIcon *icon = user_data;
 335         gboolean           hidden = FALSE;
 336
 337         if (empathy_conf_get_bool (conf, key, &hidden)) {
 338                 status_icon_set_visibility (icon, !hidden, FALSE);
 339         }
 340 }
 341
 342 static void
 343 status_icon_toggle_visibility (EmpathyStatusIcon *icon)
 344 {
 345         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 346         gboolean               visible;
 347
 348         visible = gtk_window_is_active (priv->window);
 349         status_icon_set_visibility (icon, !visible, TRUE);
 350 }
 351
 352 static void
 353 status_icon_idle_notify_cb (EmpathyStatusIcon *icon)
 354 {
 355         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 356
 357         status_icon_update_icon (icon);
 358         status_icon_update_tooltip (icon);
 359
 360         if (!empathy_notification_is_enabled ()) {
 361                 /* dismiss the outstanding notification if present */
 362
 363                 if (priv->notification) {
 364                         notify_notification_close (priv->notification, NULL);
 365                         g_object_unref (priv->notification);
 366                         priv->notification = NULL;
 367                 }
 368         }
 369 }
 370
 371 static gboolean
 372 status_icon_delete_event_cb (GtkWidget         *widget,
 373                              GdkEvent          *event,
 374                              EmpathyStatusIcon *icon)
 375 {
 376         status_icon_set_visibility (icon, FALSE, TRUE);
 377         return TRUE;
 378 }
 379
 380 static gboolean
 381 status_icon_key_press_event_cb  (GtkWidget *window,
 382                                  GdkEventKey *event,
 383                                  EmpathyStatusIcon *icon)
 384 {
 385         if (event->keyval == GDK_Escape) {
 386                 status_icon_set_visibility (icon, FALSE, TRUE);
 387         }
 388         return FALSE;
 389 }
 390
 391 static void
 392 status_icon_activate_cb (GtkStatusIcon     *status_icon,
 393                          EmpathyStatusIcon *icon)
 394 {
 395         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 396
 397         DEBUG ("%s", priv->event ? "event" : "toggle");
 398
 399         if (priv->event) {
 400                 empathy_event_activate (priv->event);
 401         } else {
 402                 status_icon_toggle_visibility (icon);
 403         }
 404 }
 405
 406 static void
 407 status_icon_show_hide_window_cb (GtkToggleAction   *action,
 408                                  EmpathyStatusIcon *icon)
 409 {
 410         gboolean visible;
 411
 412         visible = gtk_toggle_action_get_active (action);
 413         status_icon_set_visibility (icon, visible, TRUE);
 414 }
 415
 416 static void
 417 status_icon_new_message_cb (GtkAction         *action,
 418                             EmpathyStatusIcon *icon)
 419 {
 420         empathy_new_message_dialog_show (NULL);
 421 }
 422
 423 static void
 424 status_icon_quit_cb (GtkAction         *action,
 425                      EmpathyStatusIcon *icon)
 426 {
 427         gtk_main_quit ();
 428 }
 429
 430 static void
 431 status_icon_popup_menu_cb (GtkStatusIcon     *status_icon,
 432                            guint              button,
 433                            guint              activate_time,
 434                            EmpathyStatusIcon *icon)
 435 {
 436         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 437         GtkWidget             *menu_item;
 438         GtkWidget             *submenu;
 439         gboolean               show;
 440
 441         show = empathy_window_get_is_visible (GTK_WINDOW (priv->window));
 442
 443         g_signal_handlers_block_by_func (priv->show_window_item,
 444                                          status_icon_show_hide_window_cb,
 445                                          icon);
 446         gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (priv->show_window_item),
 447                                       show);
 448         g_signal_handlers_unblock_by_func (priv->show_window_item,
 449                                            status_icon_show_hide_window_cb,
 450                                            icon);
 451
 452         menu_item = gtk_ui_manager_get_widget (priv->ui_manager, "/menu/status");
 453         submenu = empathy_presence_chooser_create_menu ();
 454         gtk_menu_item_set_submenu (GTK_MENU_ITEM (menu_item), submenu);
 455
 456         gtk_menu_popup (GTK_MENU (priv->popup_menu),
 457                         NULL, NULL,
 458                         gtk_status_icon_position_menu,
 459                         priv->icon,
 460                         button,
 461                         activate_time);
 462 }
 463
 464 static void
 465 status_icon_create_menu (EmpathyStatusIcon *icon)
 466 {
 467         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 468         GtkBuilder            *gui;
 469         gchar                 *filename;
 470
 471         filename = empathy_file_lookup ("empathy-status-icon.ui", "src");
 472         gui = empathy_builder_get_file (filename,
 473                                         "ui_manager", &priv->ui_manager,
 474                                         "menu", &priv->popup_menu,
 475                                         "show_list", &priv->show_window_item,
 476                                         "new_message", &priv->new_message_item,
 477                                         "status", &priv->status_item,
 478                                        NULL);
 479         g_free (filename);
 480
 481         empathy_builder_connect (gui, icon,
 482                               "show_list", "toggled", status_icon_show_hide_window_cb,
 483                               "new_message", "activate", status_icon_new_message_cb,
 484                               "quit", "activate", status_icon_quit_cb,
 485                               NULL);
 486
 487         g_object_ref (priv->ui_manager);
 488         g_object_unref (gui);
 489 }
 490
 491 static void
 492 status_icon_connection_changed_cb (EmpathyAccountManager *manager,
 493                                    EmpathyAccount *account,
 494                                    TpConnectionStatusReason reason,
 495                                    TpConnectionStatus current,
 496                                    TpConnectionStatus previous,
 497                                    EmpathyStatusIcon *icon)
 498 {
 499         EmpathyStatusIconPriv *priv = GET_PRIV (icon);
 500         int connected_accounts;
 501
 502         /* Check for a connected account */
 503         connected_accounts = empathy_account_manager_get_connected_accounts (manager);
 504
 505         gtk_action_set_sensitive (priv->new_message_item, connected_accounts > 0);
 506 }
 507
 508 static void
 509 status_icon_finalize (GObject *object)
 510 {
 511         EmpathyStatusIconPriv *priv = GET_PRIV (object);
 512
 513         if (priv->blink_timeout) {
 514                 g_source_remove (priv->blink_timeout);
 515         }
 516
 517         g_signal_handlers_disconnect_by_func (priv->account_manager,
 518                                               status_icon_connection_changed_cb,
 519                                               object);
 520
 521         if (priv->notification) {
 522                 notify_notification_close (priv->notification, NULL);
 523                 g_object_unref (priv->notification);
 524                 priv->notification = NULL;
 525         }
 526
 527         g_object_unref (priv->icon);
 528         g_object_unref (priv->idle);
 529         g_object_unref (priv->account_manager);
 530         g_object_unref (priv->event_manager);
 531         g_object_unref (priv->ui_manager);
 532 }
 533
 534 static void
 535 empathy_status_icon_class_init (EmpathyStatusIconClass *klass)
 536 {
 537         GObjectClass *object_class = G_OBJECT_CLASS (klass);
 538
 539         object_class->finalize = status_icon_finalize;
 540
 541         g_type_class_add_private (object_class, sizeof (EmpathyStatusIconPriv));
 542 }
 543
 544 static void
 545 empathy_status_icon_init (EmpathyStatusIcon *icon)
 546 {
 547         EmpathyStatusIconPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (icon,
 548                 EMPATHY_TYPE_STATUS_ICON, EmpathyStatusIconPriv);
 549
 550         icon->priv = priv;
 551         priv->icon = gtk_status_icon_new ();
 552         priv->account_manager = empathy_account_manager_dup_singleton ();
 553         priv->idle = empathy_idle_dup_singleton ();
 554         priv->event_manager = empathy_event_manager_dup_singleton ();
 555
 556         g_signal_connect (priv->account_manager,
 557                           "account-connection-changed",
 558                           G_CALLBACK (status_icon_connection_changed_cb), icon);
 559
 560         /* make icon listen and respond to MAIN_WINDOW_HIDDEN changes */
 561         empathy_conf_notify_add (empathy_conf_get (),
 562                                  EMPATHY_PREFS_UI_MAIN_WINDOW_HIDDEN,
 563                                  status_icon_notify_visibility_cb,
 564                                  icon);
 565
 566         status_icon_create_menu (icon);
 567         status_icon_idle_notify_cb (icon);
 568
 569         g_signal_connect_swapped (priv->idle, "notify",
 570                                   G_CALLBACK (status_icon_idle_notify_cb),
 571                                   icon);
 572         g_signal_connect (priv->event_manager, "event-added",
 573                           G_CALLBACK (status_icon_event_added_cb),
 574                           icon);
 575         g_signal_connect (priv->event_manager, "event-removed",
 576                           G_CALLBACK (status_icon_event_removed_cb),
 577                           icon);
 578         g_signal_connect (priv->event_manager, "event-updated",
 579                           G_CALLBACK (status_icon_event_updated_cb),
 580                           icon);
 581         g_signal_connect (priv->icon, "activate",
 582                           G_CALLBACK (status_icon_activate_cb),
 583                           icon);
 584         g_signal_connect (priv->icon, "popup-menu",
 585                           G_CALLBACK (status_icon_popup_menu_cb),
 586                           icon);
 587 }
 588
 589 EmpathyStatusIcon *
 590 empathy_status_icon_new (GtkWindow *window, gboolean hide_contact_list)
 591 {
 592         EmpathyStatusIconPriv *priv;
 593         EmpathyStatusIcon     *icon;
 594         gboolean               should_hide;
 595
 596         g_return_val_if_fail (GTK_IS_WINDOW (window), NULL);
 597
 598         icon = g_object_new (EMPATHY_TYPE_STATUS_ICON, NULL);
 599         priv = GET_PRIV (icon);
 600
 601         priv->window = g_object_ref (window);
 602
 603         g_signal_connect_after (priv->window, "key-press-event",
 604                           G_CALLBACK (status_icon_key_press_event_cb),
 605                           icon);
 606
 607         g_signal_connect (priv->window, "delete-event",
 608                           G_CALLBACK (status_icon_delete_event_cb),
 609                           icon);
 610
 611         if (!hide_contact_list) {
 612                 empathy_conf_get_bool (empathy_conf_get (),
 613                                        EMPATHY_PREFS_UI_MAIN_WINDOW_HIDDEN,
 614                                        &should_hide);
 615         } else {
 616                 should_hide = TRUE;
 617         }
 618
 619         if (gtk_window_is_active (priv->window) == should_hide) {
 620                 status_icon_set_visibility (icon, !should_hide, FALSE);
 621         }
 622
 623         return icon;
 624 }
 625