1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2004-2007 Imendio AB
4 * Copyright (C) 2007-2008 Collabora Ltd.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301 USA
21 * Authors: Mikael Hallendal <micke@imendio.com>
22 * Xavier Claessens <xclaesse@gmail.com>
29 #include <glib/gi18n-lib.h>
31 #include "empathy-client-factory.h"
32 #include "empathy-message.h"
33 #include "empathy-utils.h"
34 #include "empathy-enum-types.h"
36 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyMessage)
38 TpMessage *tp_message;
39 TpChannelTextMessageType type;
40 EmpathyContact *sender;
41 EmpathyContact *receiver;
46 gint64 original_timestamp;
50 TpChannelTextMessageFlags flags;
53 static void empathy_message_finalize (GObject *object);
54 static void message_get_property (GObject *object,
58 static void message_set_property (GObject *object,
63 G_DEFINE_TYPE (EmpathyMessage, empathy_message, G_TYPE_OBJECT);
74 PROP_ORIGINAL_TIMESTAMP,
82 empathy_message_class_init (EmpathyMessageClass *class)
84 GObjectClass *object_class;
86 object_class = G_OBJECT_CLASS (class);
87 object_class->finalize = empathy_message_finalize;
88 object_class->get_property = message_get_property;
89 object_class->set_property = message_set_property;
91 g_object_class_install_property (object_class,
93 g_param_spec_uint ("type",
95 "The type of message",
96 TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL,
97 TP_CHANNEL_TEXT_MESSAGE_TYPE_AUTO_REPLY,
98 TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL,
99 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
100 G_PARAM_CONSTRUCT_ONLY));
101 g_object_class_install_property (object_class,
103 g_param_spec_object ("sender",
105 "The sender of the message",
106 EMPATHY_TYPE_CONTACT,
107 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
108 g_object_class_install_property (object_class,
110 g_param_spec_object ("receiver",
112 "The receiver of the message",
113 EMPATHY_TYPE_CONTACT,
114 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
115 g_object_class_install_property (object_class,
117 g_param_spec_string ("token",
121 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY));
122 g_object_class_install_property (object_class,
124 g_param_spec_string ("supersedes",
126 "The message-token this message supersedes",
128 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY));
129 g_object_class_install_property (object_class,
131 g_param_spec_string ("body",
133 "The content of the message",
135 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
136 G_PARAM_CONSTRUCT_ONLY));
137 g_object_class_install_property (object_class,
139 g_param_spec_int64 ("timestamp",
142 G_MININT64, G_MAXINT64, 0,
143 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
144 G_PARAM_CONSTRUCT_ONLY));
145 g_object_class_install_property (object_class,
146 PROP_ORIGINAL_TIMESTAMP,
147 g_param_spec_int64 ("original-timestamp",
148 "Original Timestamp",
149 "Timestamp of the original message",
150 G_MININT64, G_MAXINT64, 0,
151 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY));
152 g_object_class_install_property (object_class,
154 g_param_spec_boolean ("is-backlog",
156 "If the message belongs to history",
158 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
159 G_PARAM_CONSTRUCT_ONLY));
162 g_object_class_install_property (object_class,
164 g_param_spec_boolean ("incoming",
166 "If this is an incoming (as opposed to sent) message",
168 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
169 G_PARAM_CONSTRUCT_ONLY));
171 g_object_class_install_property (object_class,
173 g_param_spec_uint ("flags",
175 "The TpChannelTextMessageFlags of this message",
177 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
178 G_PARAM_CONSTRUCT_ONLY));
180 g_object_class_install_property (object_class,
182 g_param_spec_object ("tp-message",
184 "The TpMessage of this message",
186 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
187 G_PARAM_CONSTRUCT_ONLY));
189 g_type_class_add_private (object_class, sizeof (EmpathyMessagePriv));
194 empathy_message_init (EmpathyMessage *message)
196 EmpathyMessagePriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
197 EMPATHY_TYPE_MESSAGE, EmpathyMessagePriv);
199 message->priv = priv;
200 priv->timestamp = empathy_time_get_current ();
204 empathy_message_finalize (GObject *object)
206 EmpathyMessagePriv *priv;
208 priv = GET_PRIV (object);
211 g_object_unref (priv->sender);
213 if (priv->receiver) {
214 g_object_unref (priv->receiver);
217 if (priv->tp_message) {
218 g_object_unref (priv->tp_message);
221 g_free (priv->token);
222 g_free (priv->supersedes);
225 G_OBJECT_CLASS (empathy_message_parent_class)->finalize (object);
229 message_get_property (GObject *object,
234 EmpathyMessagePriv *priv;
236 priv = GET_PRIV (object);
240 g_value_set_uint (value, priv->type);
243 g_value_set_object (value, priv->sender);
246 g_value_set_object (value, priv->receiver);
249 g_value_set_string (value, priv->token);
251 case PROP_SUPERSEDES:
252 g_value_set_string (value, priv->supersedes);
255 g_value_set_string (value, priv->body);
258 g_value_set_int64 (value, priv->timestamp);
260 case PROP_ORIGINAL_TIMESTAMP:
261 g_value_set_int64 (value, priv->original_timestamp);
263 case PROP_IS_BACKLOG:
264 g_value_set_boolean (value, priv->is_backlog);
267 g_value_set_boolean (value, priv->incoming);
270 g_value_set_uint (value, priv->flags);
272 case PROP_TP_MESSAGE:
273 g_value_set_object (value, priv->tp_message);
276 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
282 message_set_property (GObject *object,
287 EmpathyMessagePriv *priv;
289 priv = GET_PRIV (object);
293 priv->type = g_value_get_uint (value);
296 empathy_message_set_sender (EMPATHY_MESSAGE (object),
297 EMPATHY_CONTACT (g_value_get_object (value)));
300 empathy_message_set_receiver (EMPATHY_MESSAGE (object),
301 EMPATHY_CONTACT (g_value_get_object (value)));
304 g_assert (priv->token == NULL); /* construct only */
305 priv->token = g_value_dup_string (value);
307 case PROP_SUPERSEDES:
308 g_assert (priv->supersedes == NULL); /* construct only */
309 priv->supersedes = g_value_dup_string (value);
312 g_assert (priv->body == NULL); /* construct only */
313 priv->body = g_value_dup_string (value);
316 priv->timestamp = g_value_get_int64 (value);
317 if (priv->timestamp <= 0)
318 priv->timestamp = empathy_time_get_current ();
320 case PROP_ORIGINAL_TIMESTAMP:
321 priv->original_timestamp = g_value_get_int64 (value);
323 case PROP_IS_BACKLOG:
324 priv->is_backlog = g_value_get_boolean (value);
327 priv->incoming = g_value_get_boolean (value);
330 priv->flags = g_value_get_uint (value);
332 case PROP_TP_MESSAGE:
333 priv->tp_message = g_value_dup_object (value);
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
342 empathy_message_from_tpl_log_event (TplEvent *logevent)
344 EmpathyMessage *retval = NULL;
345 EmpathyClientFactory *factory;
346 TpAccount *account = NULL;
347 TplEntity *receiver = NULL;
348 TplEntity *sender = NULL;
350 const gchar *token = NULL, *supersedes = NULL;
351 EmpathyContact *contact;
352 TpChannelTextMessageType type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
353 gint64 timestamp, original_timestamp = 0;
355 g_return_val_if_fail (TPL_IS_EVENT (logevent), NULL);
357 factory = empathy_client_factory_dup ();
358 /* FIXME Currently Empathy shows in the log viewer only valid accounts, so it
359 * won't be selected any non-existing (ie removed) account.
360 * When #610455 will be fixed, calling tp_account_manager_ensure_account ()
361 * might add a not existing account to the AM. tp_account_new () probably
362 * will be the best way to handle it.
363 * Note: When creating an EmpathyContact from a TplEntity instance, the
364 * TpAccount is passed *only* to let EmpathyContact be able to retrieve the
365 * avatar (contact_get_avatar_filename () need a TpAccount).
366 * If the way EmpathyContact stores the avatar is changes, it might not be
367 * needed anymore any TpAccount passing and the following call will be
369 account = tp_simple_client_factory_ensure_account (
370 TP_SIMPLE_CLIENT_FACTORY (factory),
371 tpl_event_get_account_path (logevent), NULL, NULL);
372 g_object_unref (factory);
374 if (TPL_IS_TEXT_EVENT (logevent)) {
375 TplTextEvent *textevent = TPL_TEXT_EVENT (logevent);
377 supersedes = tpl_text_event_get_supersedes_token (textevent);
379 /* tp-logger is kind of messy in that instead of having
380 * timestamp and original-timestamp like Telepathy it has
381 * timestamp (which is the original) and edited-timestamp,
382 * (which is when the message was edited) */
383 if (tp_str_empty (supersedes)) {
384 /* not an edited message */
385 timestamp = tpl_event_get_timestamp (logevent);
387 /* this is an edited event */
388 original_timestamp = tpl_event_get_timestamp (logevent);
389 timestamp = tpl_text_event_get_edit_timestamp (textevent);
392 body = g_strdup (tpl_text_event_get_message (textevent));
394 type = tpl_text_event_get_message_type (TPL_TEXT_EVENT (logevent));
395 token = tpl_text_event_get_message_token (textevent);
397 else if (TPL_IS_CALL_EVENT (logevent)) {
398 TplCallEvent *call = TPL_CALL_EVENT (logevent);
400 timestamp = tpl_event_get_timestamp (logevent);
402 if (tpl_call_event_get_end_reason (call) == TP_CALL_STATE_CHANGE_REASON_NO_ANSWER)
403 body = g_strdup_printf (_("Missed call from %s"),
404 tpl_entity_get_alias (tpl_event_get_sender (logevent)));
405 else if (tpl_entity_get_entity_type (tpl_event_get_sender (logevent)) == TPL_ENTITY_SELF)
406 /* Translators: this is an outgoing call, e.g. 'Called Alice' */
407 body = g_strdup_printf (_("Called %s"),
408 tpl_entity_get_alias (tpl_event_get_receiver (logevent)));
410 body = g_strdup_printf (_("Call from %s"),
411 tpl_entity_get_alias (tpl_event_get_sender (logevent)));
414 /* Unknown event type */
418 receiver = tpl_event_get_receiver (logevent);
419 sender = tpl_event_get_sender (logevent);
421 retval = g_object_new (EMPATHY_TYPE_MESSAGE,
424 "supersedes", supersedes,
427 "timestamp", timestamp,
428 "original-timestamp", original_timestamp,
431 if (receiver != NULL) {
432 contact = empathy_contact_from_tpl_contact (account, receiver);
433 empathy_message_set_receiver (retval, contact);
434 g_object_unref (contact);
437 if (sender != NULL) {
438 contact = empathy_contact_from_tpl_contact (account, sender);
439 empathy_message_set_sender (retval, contact);
440 g_object_unref (contact);
449 empathy_message_get_tp_message (EmpathyMessage *message)
451 EmpathyMessagePriv *priv;
453 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
455 priv = GET_PRIV (message);
457 return priv->tp_message;
460 TpChannelTextMessageType
461 empathy_message_get_tptype (EmpathyMessage *message)
463 EmpathyMessagePriv *priv;
465 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message),
466 TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL);
468 priv = GET_PRIV (message);
474 empathy_message_get_sender (EmpathyMessage *message)
476 EmpathyMessagePriv *priv;
478 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
480 priv = GET_PRIV (message);
486 empathy_message_set_sender (EmpathyMessage *message, EmpathyContact *contact)
488 EmpathyMessagePriv *priv;
489 EmpathyContact *old_sender;
491 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
492 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
494 priv = GET_PRIV (message);
496 old_sender = priv->sender;
497 priv->sender = g_object_ref (contact);
500 g_object_unref (old_sender);
503 g_object_notify (G_OBJECT (message), "sender");
507 empathy_message_get_receiver (EmpathyMessage *message)
509 EmpathyMessagePriv *priv;
511 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
513 priv = GET_PRIV (message);
515 return priv->receiver;
519 empathy_message_set_receiver (EmpathyMessage *message, EmpathyContact *contact)
521 EmpathyMessagePriv *priv;
522 EmpathyContact *old_receiver;
524 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
525 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
527 priv = GET_PRIV (message);
529 old_receiver = priv->receiver;
530 priv->receiver = g_object_ref (contact);
533 g_object_unref (old_receiver);
536 g_object_notify (G_OBJECT (message), "receiver");
540 empathy_message_get_token (EmpathyMessage *message)
542 EmpathyMessagePriv *priv;
544 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
546 priv = GET_PRIV (message);
552 empathy_message_get_supersedes (EmpathyMessage *message)
554 EmpathyMessagePriv *priv;
556 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
558 priv = GET_PRIV (message);
560 return priv->supersedes;
564 empathy_message_is_edit (EmpathyMessage *message)
566 EmpathyMessagePriv *priv;
568 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
570 priv = GET_PRIV (message);
572 return !tp_str_empty (priv->supersedes);
576 empathy_message_get_body (EmpathyMessage *message)
578 EmpathyMessagePriv *priv;
580 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), NULL);
582 priv = GET_PRIV (message);
588 empathy_message_get_timestamp (EmpathyMessage *message)
590 EmpathyMessagePriv *priv;
592 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), -1);
594 priv = GET_PRIV (message);
596 return priv->timestamp;
600 empathy_message_get_original_timestamp (EmpathyMessage *message)
602 EmpathyMessagePriv *priv;
604 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), -1);
606 priv = GET_PRIV (message);
608 return priv->original_timestamp;
612 empathy_message_is_backlog (EmpathyMessage *message)
614 EmpathyMessagePriv *priv;
616 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
618 priv = GET_PRIV (message);
620 return priv->is_backlog;
623 TpChannelTextMessageType
624 empathy_message_type_from_str (const gchar *type_str)
626 if (strcmp (type_str, "normal") == 0) {
627 return TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
629 if (strcmp (type_str, "action") == 0) {
630 return TP_CHANNEL_TEXT_MESSAGE_TYPE_ACTION;
632 else if (strcmp (type_str, "notice") == 0) {
633 return TP_CHANNEL_TEXT_MESSAGE_TYPE_NOTICE;
635 else if (strcmp (type_str, "auto-reply") == 0) {
636 return TP_CHANNEL_TEXT_MESSAGE_TYPE_AUTO_REPLY;
639 return TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
643 empathy_message_type_to_str (TpChannelTextMessageType type)
646 case TP_CHANNEL_TEXT_MESSAGE_TYPE_ACTION:
648 case TP_CHANNEL_TEXT_MESSAGE_TYPE_NOTICE:
650 case TP_CHANNEL_TEXT_MESSAGE_TYPE_AUTO_REPLY:
652 case TP_CHANNEL_TEXT_MESSAGE_TYPE_DELIVERY_REPORT:
653 return "delivery-report";
654 case TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL:
661 empathy_message_is_incoming (EmpathyMessage *message)
663 EmpathyMessagePriv *priv = GET_PRIV (message);
665 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
667 return priv->incoming;
671 empathy_message_equal (EmpathyMessage *message1, EmpathyMessage *message2)
673 EmpathyMessagePriv *priv1;
674 EmpathyMessagePriv *priv2;
676 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message1), FALSE);
677 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message2), FALSE);
679 priv1 = GET_PRIV (message1);
680 priv2 = GET_PRIV (message2);
682 if (priv1->timestamp == priv2->timestamp &&
683 !tp_strdiff (priv1->body, priv2->body)) {
690 TpChannelTextMessageFlags
691 empathy_message_get_flags (EmpathyMessage *self)
693 EmpathyMessagePriv *priv = GET_PRIV (self);
695 g_return_val_if_fail (EMPATHY_IS_MESSAGE (self), 0);
701 empathy_message_new_from_tp_message (TpMessage *tp_msg,
704 EmpathyMessage *message;
706 TpChannelTextMessageFlags flags;
708 gint64 original_timestamp;
709 const GHashTable *part = tp_message_peek (tp_msg, 0);
712 g_return_val_if_fail (TP_IS_MESSAGE (tp_msg), NULL);
714 body = tp_message_to_text (tp_msg, &flags);
716 timestamp = tp_message_get_sent_timestamp (tp_msg);
718 timestamp = tp_message_get_received_timestamp (tp_msg);
720 original_timestamp = tp_asv_get_int64 (part,
721 "original-message-received", NULL);
723 is_backlog = (flags & TP_CHANNEL_TEXT_MESSAGE_FLAG_SCROLLBACK) ==
724 TP_CHANNEL_TEXT_MESSAGE_FLAG_SCROLLBACK;
726 message = g_object_new (EMPATHY_TYPE_MESSAGE,
728 "token", tp_message_get_token (tp_msg),
729 "supersedes", tp_message_get_supersedes (tp_msg),
730 "type", tp_message_get_message_type (tp_msg),
731 "timestamp", timestamp,
732 "original-timestamp", original_timestamp,
734 "is-backlog", is_backlog,
735 "incoming", incoming,
736 "tp-message", tp_msg,