pidgin/pidgin

Fix several leaks in tests

14 months ago, Elliott Sales de Andrade
4e1bf25f5575
Fix several leaks in tests

All of these are specific to tests, not the library code.

For the moment, `protocol_xfer` still leaks connections (and anything they hold on to) because it is very difficult to disentangle them from the connection manager in the partially implemented state they are in.

This fixes leaks of options in the account option test (these two leaks occur for every test since they all leak the option):
```
61 (48 direct, 13 indirect) bytes in 1 blocks are definitely lost in loss record 133 of 276
at 0x4848464: calloc (vg_replace_malloc.c:1340)
by 0x49F75F0: g_malloc0 (gmem.c:163)
by 0x48C3B2E: purple_account_option_new (purpleaccountoption.c:78)
by 0x4014AF: test_purple_account_option_copy_int (test_account_option.c:67)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401721: main (test_account_option.c:157)

61 (48 direct, 13 indirect) bytes in 1 blocks are definitely lost in loss record 134 of 276
at 0x4848464: calloc (vg_replace_malloc.c:1340)
by 0x49F75F0: g_malloc0 (gmem.c:163)
by 0x48C3BC7: purple_account_option_copy (purpleaccountoption.c:93)
by 0x4014BF: test_purple_account_option_copy_int (test_account_option.c:68)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401721: main (test_account_option.c:157)
```
leaks in the credential manager test (times 3 for read/write/cancel tests):
```
69 (16 direct, 53 indirect) bytes in 1 blocks are definitely lost in loss record 2,427 of 3,503
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x4A58168: g_malloc (gmem.c:130)
by 0x4A6FAB5: g_slice_alloc (gslice.c:1074)
by 0x4A700EC: g_slice_alloc0 (gslice.c:1100)
by 0x4A3BECB: g_error_allocate (gerror.c:710)
by 0x4A3C93F: UnknownInlinedFun (gerror.c:724)
by 0x4A3C93F: g_error_new_valist (gerror.c:766)
by 0x4BEE558: g_task_return_new_error (gtask.c:1941)
by 0x48D82C0: purple_credential_manager_read_password_async (purplecredentialmanager.c:492)
by 0x403634: test_purple_credential_manager_no_provider_read_password_idle (test_credential_manager.c:329)
by 0x4A4ECB1: g_idle_dispatch (gmain.c:6124)
by 0x4A4FCBE: UnknownInlinedFun (gmain.c:3444)
by 0x4A4FCBE: g_main_context_dispatch (gmain.c:4162)
by 0x4AA5597: g_main_context_iterate.constprop.0 (gmain.c:4238)
by 0x4A4F28E: g_main_loop_run (gmain.c:4438)
by 0x40369F: test_purple_credential_manager_no_provider_read_password_async (test_credential_manager.c:345)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x4048F6: main (test_credential_manager.c:695)
```
a leak in the image test:
```
161 bytes in 1 blocks are definitely lost in loss record 260 of 274
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x4A55363: g_try_malloc (gmem.c:286)
by 0x4A3D630: UnknownInlinedFun (gfileutils.c:819)
by 0x4A3D630: UnknownInlinedFun (gfileutils.c:924)
by 0x4A3D630: g_file_get_contents (gfileutils.c:1027)
by 0x401890: test_image_new_from_file (test_image.c:144)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x40195D: main (test_image.c:172)
```
a leak in queued output stream test:
```
72 (40 direct, 32 indirect) bytes in 1 blocks are definitely lost in loss record 219 of 396
at 0x49D51EF: g_type_create_instance (gtype.c:1909)
by 0x49BAC1F: g_object_new_internal (gobject.c:2228)
by 0x49BC247: g_object_new_with_properties (gobject.c:2391)
by 0x49BCFF0: g_object_new (gobject.c:2037)
by 0x402003: test_queued_output_stream_push_bytes_async_error (test_queued_output_stream.c:219)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x402429: main (test_queued_output_stream.c:280)
```
and protocol xfer tests (times 3 for each test that creates a test protocol object):
```
112 (48 direct, 64 indirect) bytes in 1 blocks are definitely lost in loss record 3,430 of 3,698
at 0x49D51EF: g_type_create_instance (gtype.c:1909)
by 0x49BAC1F: g_object_new_internal (gobject.c:2228)
by 0x49BC247: g_object_new_with_properties (gobject.c:2391)
by 0x49BCFF0: g_object_new (gobject.c:2037)
by 0x40291C: test_purple_protocol_xfer_send_file_func (test_protocol_xfer.c:146)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x402B64: main (test_protocol_xfer.c:195)
```
and util tests (times 3 for each call to `purple_text_strip_mnemonic` in the test):
```
5 bytes in 1 blocks are definitely lost in loss record 5 of 247
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x49F7168: g_malloc (gmem.c:130)
by 0x491975B: purple_text_strip_mnemonic (util.c:895)
by 0x4015B0: test_util_text_strip_mnemonic (test_util.c:49)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401901: main (test_util.c:224)
```
and these leaks in any test that initializes the test UI:
```
4,104 bytes in 1 blocks are possibly lost in loss record 3,451 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5249A8B: UnknownInlinedFun (sqlite3.c:53675)
by 0x5249A8B: allocateTempSpace (sqlite3.c:70848)
by 0x52625A6: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:93857)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x529B324: sqlite3_exec (sqlite3.c:131002)
by 0x48FD558: purple_sqlite3_run_migration (purplesqlite3.c:37)
by 0x48FDBB4: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:195)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)

4,368 bytes in 1 blocks are possibly lost in loss record 3,453 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5240077: UnknownInlinedFun (sqlite3.c:53634)
by 0x5240077: pcache1FetchStage2 (sqlite3.c:54104)
by 0x5243E9C: UnknownInlinedFun (sqlite3.c:52671)
by 0x5243E9C: getPageNormal.lto_priv.0 (sqlite3.c:60628)
by 0x524A510: UnknownInlinedFun (sqlite3.c:60805)
by 0x524A510: btreeGetPage.lto_priv.0 (sqlite3.c:70289)
by 0x524C2F6: UnknownInlinedFun (sqlite3.c:71257)
by 0x524C2F6: sqlite3BtreeBeginTrans.lto_priv.0 (sqlite3.c:71647)
by 0x5266B3A: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:93532)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x48FD715: purple_sqlite3_get_schema_version (purplesqlite3.c:79)
by 0x48FD9DD: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:146)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)

4,368 bytes in 1 blocks are possibly lost in loss record 3,454 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5240077: UnknownInlinedFun (sqlite3.c:53634)
by 0x5240077: pcache1FetchStage2 (sqlite3.c:54104)
by 0x5243E9C: UnknownInlinedFun (sqlite3.c:52671)
by 0x5243E9C: getPageNormal.lto_priv.0 (sqlite3.c:60628)
by 0x52499BC: UnknownInlinedFun (sqlite3.c:60805)
by 0x52499BC: UnknownInlinedFun (sqlite3.c:70289)
by 0x52499BC: btreeGetUnusedPage (sqlite3.c:70432)
by 0x524F504: allocateBtreePage.lto_priv.0 (sqlite3.c:74604)
by 0x5256209: btreeCreateTable.lto_priv.0 (sqlite3.c:77830)
by 0x5265EB2: UnknownInlinedFun (sqlite3.c:77849)
by 0x5265EB2: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:96382)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x529B324: sqlite3_exec (sqlite3.c:131002)
by 0x48FD558: purple_sqlite3_run_migration (purplesqlite3.c:37)
by 0x48FDBB4: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:195)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)
```

Testing Done:
Ran tests in valgrind, and all above leaks were gone except for noted `protocol_xfer` issues, and a bunch of leaks of the `PurpleBuddy`-`PurpleContact` compatibility bindings, which will go away in their entirety eventually.

Reviewed at https://reviews.imfreedom.org/r/2385/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <https://www.gnu.org/licenses/>.
*/
#include <glib/gi18n-lib.h>
#include "purplenotification.h"
#include "purpleenums.h"
struct _PurpleNotification {
GObject parent;
gchar *id;
PurpleNotificationType type;
PurpleAccount *account;
GDateTime *created_timestamp;
gchar *title;
gchar *icon_name;
gboolean read;
gboolean interactive;
gpointer data;
GDestroyNotify data_destroy_func;
gboolean deleted;
};
enum {
SIG_DELETED,
N_SIGNALS
};
static guint signals[N_SIGNALS] = {0, };
enum {
PROP_0,
PROP_ID,
PROP_TYPE,
PROP_ACCOUNT,
PROP_CREATED_TIMESTAMP,
PROP_TITLE,
PROP_ICON_NAME,
PROP_READ,
PROP_INTERACTIVE,
PROP_DATA,
PROP_DATA_DESTROY_FUNC,
N_PROPERTIES,
};
static GParamSpec *properties[N_PROPERTIES] = {NULL, };
G_DEFINE_TYPE(PurpleNotification, purple_notification, G_TYPE_OBJECT)
/******************************************************************************
* Helpers
*****************************************************************************/
static void
purple_notification_set_id(PurpleNotification *notification, const gchar *id) {
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
if(id == NULL) {
notification->id = g_uuid_string_random();
} else {
notification->id = g_strdup(id);
}
g_object_notify_by_pspec(G_OBJECT(notification), properties[PROP_ID]);
}
static void
purple_notification_set_notification_type(PurpleNotification *notification,
PurpleNotificationType type)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
notification->type = type;
g_object_notify_by_pspec(G_OBJECT(notification), properties[PROP_TYPE]);
}
static void
purple_notification_set_account(PurpleNotification *notification,
PurpleAccount *account)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
if(g_set_object(&notification->account, account)) {
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_ACCOUNT]);
}
}
static void
purple_notification_set_data(PurpleNotification *notification, gpointer data) {
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
notification->data = data;
g_object_notify_by_pspec(G_OBJECT(notification), properties[PROP_DATA]);
}
static void
purple_notification_set_data_destroy_func(PurpleNotification *notification,
GDestroyNotify data_destroy_func)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
notification->data_destroy_func = data_destroy_func;
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_DATA_DESTROY_FUNC]);
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
static void
purple_notification_get_property(GObject *obj, guint param_id, GValue *value,
GParamSpec *pspec)
{
PurpleNotification *notification = PURPLE_NOTIFICATION(obj);
switch(param_id) {
case PROP_ID:
g_value_set_string(value,
purple_notification_get_id(notification));
break;
case PROP_TYPE:
g_value_set_enum(value,
purple_notification_get_notification_type(notification));
break;
case PROP_ACCOUNT:
g_value_set_object(value,
purple_notification_get_account(notification));
break;
case PROP_CREATED_TIMESTAMP:
g_value_set_boxed(value,
purple_notification_get_created_timestamp(notification));
break;
case PROP_TITLE:
g_value_set_string(value,
purple_notification_get_title(notification));
break;
case PROP_ICON_NAME:
g_value_set_string(value,
purple_notification_get_icon_name(notification));
break;
case PROP_READ:
g_value_set_boolean(value,
purple_notification_get_read(notification));
break;
case PROP_INTERACTIVE:
g_value_set_boolean(value,
purple_notification_get_interactive(notification));
break;
case PROP_DATA:
g_value_set_pointer(value,
purple_notification_get_data(notification));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
purple_notification_set_property(GObject *obj, guint param_id,
const GValue *value, GParamSpec *pspec)
{
PurpleNotification *notification = PURPLE_NOTIFICATION(obj);
switch(param_id) {
case PROP_ID:
purple_notification_set_id(notification,
g_value_get_string(value));
break;
case PROP_TYPE:
purple_notification_set_notification_type(notification,
g_value_get_enum(value));
break;
case PROP_ACCOUNT:
purple_notification_set_account(notification,
g_value_get_object(value));
break;
case PROP_CREATED_TIMESTAMP:
purple_notification_set_created_timestamp(notification,
g_value_get_boxed(value));
break;
case PROP_TITLE:
purple_notification_set_title(notification,
g_value_get_string(value));
break;
case PROP_ICON_NAME:
purple_notification_set_icon_name(notification,
g_value_get_string(value));
break;
case PROP_READ:
purple_notification_set_read(notification,
g_value_get_boolean(value));
break;
case PROP_INTERACTIVE:
purple_notification_set_interactive(notification,
g_value_get_boolean(value));
break;
case PROP_DATA:
purple_notification_set_data(notification,
g_value_get_pointer(value));
break;
case PROP_DATA_DESTROY_FUNC:
purple_notification_set_data_destroy_func(notification,
g_value_get_pointer(value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
purple_notification_finalize(GObject *obj) {
PurpleNotification *notification = PURPLE_NOTIFICATION(obj);
g_clear_pointer(&notification->id, g_free);
g_clear_object(&notification->account);
g_clear_pointer(&notification->created_timestamp, g_date_time_unref);
g_clear_pointer(&notification->title, g_free);
g_clear_pointer(&notification->icon_name, g_free);
if(notification->data_destroy_func != NULL) {
notification->data_destroy_func(notification->data);
}
G_OBJECT_CLASS(purple_notification_parent_class)->finalize(obj);
}
static void
purple_notification_init(PurpleNotification *notification) {
purple_notification_set_id(notification, NULL);
if(notification->created_timestamp == NULL) {
purple_notification_set_created_timestamp(notification, NULL);
}
}
static void
purple_notification_class_init(PurpleNotificationClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->get_property = purple_notification_get_property;
obj_class->set_property = purple_notification_set_property;
obj_class->finalize = purple_notification_finalize;
/**
* PurpleNotification::deleted:
* @notification: The instance.
*
* Emitted when the notification is deleted. This is typically done by a
* user interface calling [method@PurpleNotification.delete].
*
* Since: 3.0.0
*/
signals[SIG_DELETED] = g_signal_new_class_handler(
"deleted",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
0);
/**
* PurpleNotification:id:
*
* The ID of the notification. Used for things that need to address it.
* This is auto populated at creation time.
*
* Since: 3.0.0
*/
properties[PROP_ID] = g_param_spec_string(
"id", "id",
"The identifier of the notification.",
NULL,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS
);
/**
* PurpleNotification:type:
*
* The [enum@NotificationType] of this notification.
*
* Since: 3.0.0
*/
properties[PROP_TYPE] = g_param_spec_enum(
"type", "type",
"The type of notification.",
PURPLE_TYPE_NOTIFICATION_TYPE,
PURPLE_NOTIFICATION_TYPE_UNKNOWN,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:account:
*
* An optional [class@Account] that this notification is for.
*
* Since: 3.0.0
*/
properties[PROP_ACCOUNT] = g_param_spec_object(
"account", "account",
"The optional account that this notification is for.",
PURPLE_TYPE_ACCOUNT,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:created-timestamp:
*
* The creation time of this notification. This always represented as UTC
* internally, and will be set to UTC now by default.
*
* Since: 3.0.0
*/
properties[PROP_CREATED_TIMESTAMP] = g_param_spec_boxed(
"created-timestamp", "created-timestamp",
"The timestamp when this notification was created.",
G_TYPE_DATE_TIME,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:title:
*
* An optional title for this notification. A user interface may or may not
* choose to use this when displaying the notification. Regardless, this
* should be a translated string.
*
* Since: 3.0.0
*/
properties[PROP_TITLE] = g_param_spec_string(
"title", "title",
"The title for the notification.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:icon-name:
*
* The icon-name in the icon theme to use for the notification. A user
* interface may or may not choose to use this when display the
* notification.
*
* Since: 3.0.0
*/
properties[PROP_ICON_NAME] = g_param_spec_string(
"icon-name", "icon-name",
"The icon name for the notification.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:read:
*
* Whether or not the notification has been read.
*
* Since: 3.0.0
*/
properties[PROP_READ] = g_param_spec_boolean(
"read", "read",
"Whether or not the notification has been read.",
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:interactive:
*
* Whether or not the notification can be interacted with.
*
* Since: 3.0.0
*/
properties[PROP_INTERACTIVE] = g_param_spec_boolean(
"interactive", "interactive",
"Whether or not the notification can be interacted with.",
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:data:
*
* Data specific to the [enum@NotificationType] for the notification.
*
* Since: 3.0.0
*/
properties[PROP_DATA] = g_param_spec_pointer(
"data", "data",
"The type specific data for the notification.",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleNotification:data-destroy-func:
*
* A function to call to free [property@PurpleNotification:data].
*
* Since: 3.0.0
*/
properties[PROP_DATA_DESTROY_FUNC] = g_param_spec_pointer(
"data-destroy-func", "data-destroy-func",
"The destroy function to clean up the data property.",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
g_object_class_install_properties(obj_class, N_PROPERTIES, properties);
}
/******************************************************************************
* Public API
*****************************************************************************/
PurpleNotification *
purple_notification_new(PurpleNotificationType type, PurpleAccount *account,
gpointer data, GDestroyNotify data_destroy_func)
{
return g_object_new(PURPLE_TYPE_NOTIFICATION,
"type", type,
"account", account,
"data", data,
"data-destroy-func", data_destroy_func,
NULL);
}
PurpleNotification *
purple_notification_new_from_add_contact_request(PurpleAddContactRequest *request)
{
PurpleAccount *account = NULL;
PurpleContactInfo *info = NULL;
PurpleNotification *notification = NULL;
gchar *title = NULL;
const gchar *alias = NULL, *username = NULL;
g_return_val_if_fail(PURPLE_IS_ADD_CONTACT_REQUEST(request), NULL);
account = purple_add_contact_request_get_account(request);
info = PURPLE_CONTACT_INFO(account);
notification = purple_notification_new(PURPLE_NOTIFICATION_TYPE_ADD_CONTACT,
account, request, g_object_unref);
username = purple_add_contact_request_get_username(request);
alias = purple_add_contact_request_get_alias(request);
if(alias != NULL && *alias != '\0') {
title = g_strdup_printf(_("%s (%s) added %s to their contact list"),
alias, username,
purple_contact_info_get_username(info));
} else {
title = g_strdup_printf(_("%s added %s to their contact list"),
username,
purple_contact_info_get_username(info));
}
purple_notification_set_title(notification, title);
g_free(title);
return notification;
}
PurpleNotification *
purple_notification_new_from_authorization_request(PurpleAuthorizationRequest *authorization_request)
{
PurpleAccount *account = NULL;
PurpleContactInfo *info = NULL;
PurpleNotification *notification = NULL;
gchar *title = NULL;
const gchar *alias = NULL, *username = NULL;
g_return_val_if_fail(PURPLE_IS_AUTHORIZATION_REQUEST(authorization_request),
NULL);
account = purple_authorization_request_get_account(authorization_request);
info = PURPLE_CONTACT_INFO(account);
notification = purple_notification_new(PURPLE_NOTIFICATION_TYPE_AUTHORIZATION_REQUEST,
account, authorization_request,
g_object_unref);
username = purple_authorization_request_get_username(authorization_request);
alias = purple_authorization_request_get_alias(authorization_request);
if(alias != NULL && *alias != '\0') {
title = g_strdup_printf(_("%s (%s) would like to add %s to their"
" contact list"),
alias, username,
purple_contact_info_get_username(info));
} else {
title = g_strdup_printf(_("%s would like to add %s to their contact"
" list"),
username,
purple_contact_info_get_username(info));
}
purple_notification_set_title(notification, title);
g_free(title);
return notification;
}
PurpleNotification *
purple_notification_new_from_connection_error(PurpleAccount *account,
PurpleConnectionErrorInfo *info)
{
PurpleNotification *notification = NULL;
PurpleProtocol *protocol = NULL;
char *title = NULL;
const char *username = NULL;
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL);
g_return_val_if_fail(info != NULL, NULL);
notification = purple_notification_new(PURPLE_NOTIFICATION_TYPE_CONNECTION_ERROR,
account, info, NULL);
/* Set the title of the notification. */
username = purple_contact_info_get_username(PURPLE_CONTACT_INFO(account));
if(purple_account_get_enabled(account)) {
title = g_strdup_printf(_("%s disconnected"), username);
} else {
title = g_strdup_printf(_("%s disabled"), username);
}
purple_notification_set_title(notification, title);
g_free(title);
/* Add the protocol's icon as the notification's icon. */
protocol = purple_account_get_protocol(account);
if(PURPLE_IS_PROTOCOL(protocol)) {
const char *icon_name = purple_protocol_get_icon_name(protocol);
if(icon_name != NULL) {
purple_notification_set_icon_name(notification, icon_name);
}
}
return notification;
}
const gchar *
purple_notification_get_id(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->id;
}
PurpleNotificationType
purple_notification_get_notification_type(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification),
PURPLE_NOTIFICATION_TYPE_UNKNOWN);
return notification->type;
}
PurpleAccount *
purple_notification_get_account(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->account;
}
GDateTime *
purple_notification_get_created_timestamp(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->created_timestamp;
}
void
purple_notification_set_created_timestamp(PurpleNotification *notification,
GDateTime *timestamp)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
g_clear_pointer(&notification->created_timestamp, g_date_time_unref);
if(timestamp == NULL) {
notification->created_timestamp = g_date_time_new_now_utc();
} else {
notification->created_timestamp = g_date_time_to_utc(timestamp);
}
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_CREATED_TIMESTAMP]);
}
const gchar *
purple_notification_get_title(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->title;
}
void
purple_notification_set_title(PurpleNotification *notification,
const gchar *title)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
g_free(notification->title);
notification->title = g_strdup(title);
g_object_notify_by_pspec(G_OBJECT(notification), properties[PROP_TITLE]);
}
const gchar *
purple_notification_get_icon_name(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->icon_name;
}
void
purple_notification_set_icon_name(PurpleNotification *notification,
const gchar *icon_name)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
g_free(notification->icon_name);
notification->icon_name = g_strdup(icon_name);
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_ICON_NAME]);
}
gboolean
purple_notification_get_read(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), FALSE);
return notification->read;
}
void
purple_notification_set_read(PurpleNotification *notification, gboolean read) {
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
if(notification->read != read) {
notification->read = read;
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_READ]);
}
}
gboolean
purple_notification_get_interactive(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), FALSE);
return notification->interactive;
}
void
purple_notification_set_interactive(PurpleNotification *notification,
gboolean interactive)
{
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
if(notification->interactive != interactive) {
notification->interactive = interactive;
g_object_notify_by_pspec(G_OBJECT(notification),
properties[PROP_INTERACTIVE]);
}
}
gpointer
purple_notification_get_data(PurpleNotification *notification) {
g_return_val_if_fail(PURPLE_IS_NOTIFICATION(notification), NULL);
return notification->data;
}
gint
purple_notification_compare(gconstpointer a, gconstpointer b) {
PurpleNotification *notification_a = NULL, *notification_b = NULL;
if(a == NULL && b == NULL) {
return 0;
}
if(a == NULL) {
return -1;
}
if(b == NULL) {
return 1;
}
notification_a = (PurpleNotification *)a;
notification_b = (PurpleNotification *)b;
return g_date_time_compare(notification_a->created_timestamp,
notification_b->created_timestamp);
}
void
purple_notification_delete(PurpleNotification *notification) {
g_return_if_fail(PURPLE_IS_NOTIFICATION(notification));
/* Calling this multiple times is a programming error. */
g_return_if_fail(notification->deleted == FALSE);
notification->deleted = TRUE;
g_signal_emit(notification, signals[SIG_DELETED], 0);
}