1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
|
/*
An indicator to show information that is in messaging applications
that the user is using.
Copyright 2009 Canonical Ltd.
Authors:
Ted Gould <ted@canonical.com>
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License version 3, as published
by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranties of
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <glib/gi18n.h>
#include <libdbusmenu-glib/client.h>
#include <libindicate/indicator.h>
#include <libindicate/indicator-messages.h>
#include <libindicate/listener.h>
#include "im-menu-item.h"
#include "dbus-data.h"
enum {
TIME_CHANGED,
ATTENTION_CHANGED,
LAST_SIGNAL
};
static guint signals[LAST_SIGNAL] = { 0 };
typedef struct _ImMenuItemPrivate ImMenuItemPrivate;
struct _ImMenuItemPrivate
{
IndicateListener * listener;
IndicateListenerServer * server;
IndicateListenerIndicator * indicator;
glong creation_seconds;
glong seconds;
gchar * count;
gulong indicator_changed;
gboolean attention;
gboolean show;
guint time_update_min;
};
#define IM_MENU_ITEM_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), IM_MENU_ITEM_TYPE, ImMenuItemPrivate))
/* Prototypes */
static void im_menu_item_class_init (ImMenuItemClass *klass);
static void im_menu_item_init (ImMenuItem *self);
static void im_menu_item_dispose (GObject *object);
static void im_menu_item_finalize (GObject *object);
static void sender_cb (IndicateListener * listener,
IndicateListenerServer * server,
IndicateListenerIndicator * indicator,
gchar * property,
const gchar * propertydata,
gpointer data);
static void time_cb (IndicateListener * listener,
IndicateListenerServer * server,
IndicateListenerIndicator * indicator,
gchar * property,
const GTimeVal * propertydata,
gpointer data);
static void icon_cb (IndicateListener * listener,
IndicateListenerServer * server,
IndicateListenerIndicator * indicator,
gchar * property,
const gchar * propertydata,
gpointer data);
static void activate_cb (ImMenuItem * self,
guint timestamp,
gpointer data);
static void indicator_modified_cb (IndicateListener * listener,
IndicateListenerServer * server,
IndicateListenerIndicator * indicator,
gchar * property,
ImMenuItem * self);
G_DEFINE_TYPE (ImMenuItem, im_menu_item, DBUSMENU_TYPE_MENUITEM);
static void
im_menu_item_class_init (ImMenuItemClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
g_type_class_add_private (klass, sizeof (ImMenuItemPrivate));
object_class->dispose = im_menu_item_dispose;
object_class->finalize = im_menu_item_finalize;
signals[TIME_CHANGED] = g_signal_new(IM_MENU_ITEM_SIGNAL_TIME_CHANGED,
G_TYPE_FROM_CLASS(klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (ImMenuItemClass, time_changed),
NULL, NULL,
g_cclosure_marshal_VOID__LONG,
G_TYPE_NONE, 1, G_TYPE_LONG);
signals[ATTENTION_CHANGED] = g_signal_new(IM_MENU_ITEM_SIGNAL_ATTENTION_CHANGED,
G_TYPE_FROM_CLASS(klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (ImMenuItemClass, attention_changed),
NULL, NULL,
g_cclosure_marshal_VOID__BOOLEAN,
G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
return;
}
static void
im_menu_item_init (ImMenuItem *self)
{
g_debug("Building new IM Menu Item");
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
/* Set the variables to NULL, but they should be
configured further down the line. */
priv->listener = NULL;
priv->server = NULL;
priv->indicator = NULL;
/* A sane default, but look below */
priv->creation_seconds = 0;
priv->seconds = 0;
/* Set the seconds to be the time when the item was
created incase we're not given a better time. */
GTimeVal current_time;
g_get_current_time(¤t_time);
priv->creation_seconds = current_time.tv_sec;
return;
}
static void
im_menu_item_dispose (GObject *object)
{
G_OBJECT_CLASS (im_menu_item_parent_class)->dispose (object);
ImMenuItem * self = IM_MENU_ITEM(object);
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
if (priv->time_update_min != 0) {
g_source_remove(priv->time_update_min);
}
g_signal_handler_disconnect(priv->listener, priv->indicator_changed);
priv->indicator_changed = 0;
return;
}
static void
im_menu_item_finalize (GObject *object)
{
G_OBJECT_CLASS (im_menu_item_parent_class)->finalize (object);
}
/* Call back for getting icon data. It just passes it along
to the indicator so that it can visualize it. Not our problem. */
static void
icon_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, const gchar * propertydata, gpointer data)
{
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(data), INDICATOR_MENUITEM_PROP_ICON, propertydata);
return;
}
/* This function takes the time and turns it into the appropriate
string to put on the right side of the menu item. Of course it
doesn't do that if there is a count set. If there's a count then
it gets that space. */
static void
update_time (ImMenuItem * self)
{
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
/* Count has been set, so it takes priority. */
if (priv->count != NULL) {
return;
}
/* Seconds hasn't been set, so we just want to keep the time
area blank. */
if (priv->seconds == 0) {
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(self), INDICATOR_MENUITEM_PROP_RIGHT, "");
return;
}
gchar * timestring = NULL;
GTimeVal current_time;
g_get_current_time(¤t_time);
guint elapsed_seconds = current_time.tv_sec - priv->seconds;
guint elapsed_minutes = elapsed_seconds / 60;
if (elapsed_seconds % 60 > 55) {
/* We're using fuzzy timers, so we need fuzzy comparisons */
elapsed_minutes += 1;
}
if (elapsed_minutes < 60) {
/* TRANSLATORS: This string is used to represent the number of minutes
since an IM has occured. It is in the right column
of a menu so being brief is desirable, but one character
is not a requirement. */
timestring = g_strdup_printf(ngettext("%d m", "%d m", elapsed_minutes), elapsed_minutes);
} else {
guint elapsed_hours = elapsed_minutes / 60;
if (elapsed_minutes % 60 > 55) {
/* We're using fuzzy timers, so we need fuzzy comparisons */
elapsed_hours += 1;
}
/* TRANSLATORS: This string is used to represent the number of hours
since an IM has occured. It is in the right column
of a menu so being brief is desirable, but one character
is not a requirement. */
timestring = g_strdup_printf(ngettext("%d h", "%d h", elapsed_hours), elapsed_hours);
}
if (timestring != NULL) {
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(self), INDICATOR_MENUITEM_PROP_RIGHT, timestring);
g_free(timestring);
}
return;
}
/* This is a wrapper around update_time that matches the prototype
needed to make this a timer callback. Silly. */
static gboolean
time_update_cb (gpointer data)
{
ImMenuItem * self = IM_MENU_ITEM(data);
update_time(self);
return TRUE;
}
/* Yet another time function. This one takes the time as formated as
we get it from libindicate and turns it into the seconds that we're
looking for. It should only be called once at the init with a new
indicator and again when the value changes. */
static void
time_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, const GTimeVal * propertydata, gpointer data)
{
g_debug("Got Time info");
ImMenuItem * self = IM_MENU_ITEM(data);
if (self == NULL) {
g_error("Menu Item callback called without a menu item");
return;
}
if (property == NULL || g_strcmp0(property, "time")) {
g_warning("Time callback called without being sent the time.");
return;
}
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
priv->seconds = propertydata->tv_sec;
update_time(self);
if (priv->time_update_min == 0) {
priv->time_update_min = g_timeout_add_seconds(60, time_update_cb, self);
}
g_signal_emit(G_OBJECT(self), signals[TIME_CHANGED], 0, priv->seconds, TRUE);
return;
}
/* Callback from libindicate that is for getting the sender information
on a particular indicator. */
static void
sender_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, const gchar * propertydata, gpointer data)
{
g_debug("Got Sender Information: %s", propertydata);
ImMenuItem * self = IM_MENU_ITEM(data);
/* Our data should be right */
g_return_if_fail(self != NULL);
/* We should have a property name */
g_return_if_fail(property != NULL);
/* The Property should be sender or name */
g_return_if_fail(!g_strcmp0(property, "sender") || !g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_NAME));
/* We might get the sender variable returning a
null string as it doesn't exist on newer clients
but we don't want to listen to that. */
if (!g_strcmp0(property, "sender") && propertydata[0] == '\0') {
return;
}
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(self), INDICATOR_MENUITEM_PROP_LABEL, propertydata);
return;
}
/* Callback saying that the count is updated, we need to either put
that on the menu item or just remove it if the count is gone. If
that's the case we can update time. */
static void
count_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, const gchar * propertydata, gpointer data)
{
g_debug("Got Count Information");
ImMenuItem * self = IM_MENU_ITEM(data);
/* Our data should be right */
g_return_if_fail(self != NULL);
/* We should have a property name */
g_return_if_fail(property != NULL);
/* The Property should be count */
g_return_if_fail(!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_COUNT));
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
if (propertydata == NULL || propertydata[0] == '\0') {
/* The count is either being unset or it was never
set in the first place. */
if (priv->count != NULL) {
g_free(priv->count);
priv->count = NULL;
update_time(self);
}
return;
}
if (priv->count != NULL) {
g_free(priv->count);
}
priv->count = g_strdup_printf("(%s)", propertydata);
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(self), INDICATOR_MENUITEM_PROP_RIGHT, priv->count);
return;
}
/* This is getting the attention variable that's looking at whether
this indicator should be calling for attention or not. If we are,
we need to signal that. */
static void
attention_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, const GValue * propertydata, gpointer data)
{
g_debug("Got Attention Information");
ImMenuItem * self = IM_MENU_ITEM(data);
/* Our data should be right */
g_return_if_fail(self != NULL);
/* We should have a property name */
g_return_if_fail(property != NULL);
/* The Property should be count */
g_return_if_fail(!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_ATTENTION));
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
gboolean wantit;
if (G_VALUE_HOLDS_BOOLEAN(propertydata)) {
wantit = g_value_get_boolean(propertydata);
} else if (G_VALUE_HOLDS_STRING(propertydata)) {
const gchar * propstring = g_value_get_string(propertydata);
if (propstring == NULL || propstring[0] == '\0' || !g_strcmp0(propstring, "false")) {
wantit = FALSE;
} else {
wantit = TRUE;
}
} else {
g_warning("Got property '%s' of an unknown type.", property);
return;
}
if (priv->attention != wantit) {
priv->attention = wantit;
g_signal_emit(G_OBJECT(self), signals[ATTENTION_CHANGED], 0, wantit, TRUE);
}
return;
}
/* Callback when the item gets clicked on from the Messaging Menu */
static void
activate_cb (ImMenuItem * self, guint timestamp, gpointer data)
{
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
indicate_listener_display(priv->listener, priv->server, priv->indicator, timestamp);
}
/* Callback when a property gets modified. It figures out which one
got modified and notifies the appropriate person. */
void
indicator_modified_cb (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator, gchar * property, ImMenuItem * self)
{
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
/* Not meant for us */
if (INDICATE_LISTENER_INDICATOR_ID(indicator) != INDICATE_LISTENER_INDICATOR_ID(priv->indicator)) return;
if (server != priv->server) return;
/* Determine which property has been changed and request the
value go to the appropriate callback. */
if (!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_NAME)) {
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_NAME, sender_cb, self);
} else if (!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_TIME)) {
indicate_listener_get_property_time(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_TIME, time_cb, self);
} else if (!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_ICON)) {
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_ICON, icon_cb, self);
} else if (!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_COUNT)) {
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_COUNT, count_cb, self);
} else if (!g_strcmp0(property, INDICATE_INDICATOR_MESSAGES_PROP_ATTENTION)) {
indicate_listener_get_property_value(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_ATTENTION, attention_cb, self);
} else if (!g_strcmp0(property, "sender")) {
/* This is a compatibility string with v1 and should be removed */
g_debug("Indicator is using 'sender' property which is a v1 string.");
indicate_listener_get_property(listener, server, indicator, "sender", sender_cb, self);
}
return;
}
ImMenuItem *
im_menu_item_new (IndicateListener * listener, IndicateListenerServer * server, IndicateListenerIndicator * indicator)
{
ImMenuItem * self = g_object_new(IM_MENU_ITEM_TYPE, NULL);
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(self);
priv->listener = listener;
priv->server = server;
priv->indicator = indicator;
priv->count = NULL;
priv->time_update_min = 0;
priv->attention = FALSE;
priv->show = TRUE;
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(self), DBUSMENU_MENUITEM_PROP_TYPE, INDICATOR_MENUITEM_TYPE);
indicate_listener_displayed(listener, server, indicator, TRUE);
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_NAME, sender_cb, self);
indicate_listener_get_property_time(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_TIME, time_cb, self);
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_ICON, icon_cb, self);
indicate_listener_get_property(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_COUNT, count_cb, self);
indicate_listener_get_property_value(listener, server, indicator, INDICATE_INDICATOR_MESSAGES_PROP_ATTENTION, attention_cb, self);
indicate_listener_get_property(listener, server, indicator, "sender", sender_cb, self);
g_signal_connect(G_OBJECT(self), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED, G_CALLBACK(activate_cb), NULL);
priv->indicator_changed = g_signal_connect(G_OBJECT(listener), INDICATE_LISTENER_SIGNAL_INDICATOR_MODIFIED, G_CALLBACK(indicator_modified_cb), self);
return self;
}
/* Gets the number of seconds for the creator
of this item. */
glong
im_menu_item_get_seconds (ImMenuItem * menuitem)
{
g_return_val_if_fail(IS_IM_MENU_ITEM(menuitem), 0);
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(menuitem);
if (priv->seconds == 0) {
return priv->creation_seconds;
} else {
return priv->seconds;
}
}
/* Gets whether or not this indicator item is
asking for attention or not. */
gboolean
im_menu_item_get_attention (ImMenuItem * menuitem)
{
g_return_val_if_fail(IS_IM_MENU_ITEM(menuitem), FALSE);
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(menuitem);
return priv->attention;
}
/* This takes care of items that need to be hidden, this is
usually because they go over the count of allowed indicators.
Which is more than a little bit silly. We shouldn't do that.
But we need to enforce it to save users against bad apps. */
void
im_menu_item_show (ImMenuItem * menuitem, gboolean show)
{
g_return_if_fail(IS_IM_MENU_ITEM(menuitem));
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(menuitem);
if (priv->show == show) {
return;
}
priv->show = show;
/* Tell the app what we're doing to it. If it's being
punished it needs to know about it. */
indicate_listener_displayed(priv->listener, priv->server, priv->indicator, priv->show);
if (priv->attention) {
/* If we were asking for attention we can ask for it
again if we're being shown, otherwise no. */
g_signal_emit(G_OBJECT(menuitem), signals[ATTENTION_CHANGED], 0, priv->show, TRUE);
}
dbusmenu_menuitem_property_set(DBUSMENU_MENUITEM(menuitem), DBUSMENU_MENUITEM_PROP_VISIBLE, priv->show ? "true" : "false");
return;
}
/* Check to see if this item is shown. Accessor for the
internal variable. */
gboolean
im_menu_item_shown (ImMenuItem * menuitem)
{
g_return_val_if_fail(IS_IM_MENU_ITEM(menuitem), FALSE);
ImMenuItemPrivate * priv = IM_MENU_ITEM_GET_PRIVATE(menuitem);
return priv->show;
}
|