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 program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 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 <https://www.gnu.org/licenses/>.
*/
#include <glib/gi18n-lib.h>
#include "purplecontactmanager.h"
#include "purplegdkpixbuf.h"
#include "purpleprivate.h"
#include "util.h"
enum {
SIG_ADDED,
SIG_REMOVED,
SIG_PERSON_ADDED,
SIG_PERSON_REMOVED,
N_SIGNALS,
};
static guint signals[N_SIGNALS] = {0, };
struct _PurpleContactManager {
GObject parent;
GHashTable *accounts;
GPtrArray *people;
};
static PurpleContactManager *default_manager = NULL;
/* Necessary prototype. */
static void purple_contact_manager_contact_person_changed_cb(GObject *obj,
GParamSpec *pspec,
gpointer data);
/******************************************************************************
* Helpers
*****************************************************************************/
static gboolean
purple_contact_manager_find_with_username_helper(gconstpointer a,
gconstpointer b)
{
PurpleContactInfo *info_a = PURPLE_CONTACT_INFO((gpointer)a);
PurpleContactInfo *info_b = PURPLE_CONTACT_INFO((gpointer)b);
const gchar *username_a = NULL;
const gchar *username_b = NULL;
username_a = purple_contact_info_get_username(info_a);
username_b = purple_contact_info_get_username(info_b);
return purple_strequal(username_a, username_b);
}
static gboolean
purple_contact_manager_find_with_id_helper(gconstpointer a, gconstpointer b) {
PurpleContactInfo *info_a = PURPLE_CONTACT_INFO((gpointer)a);
PurpleContactInfo *info_b = PURPLE_CONTACT_INFO((gpointer)b);
const gchar *id_a = NULL;
const gchar *id_b = NULL;
id_a = purple_contact_info_get_id(info_a);
id_b = purple_contact_info_get_id(info_b);
return purple_strequal(id_a, id_b);
}
static gboolean
purple_contact_manager_convert_icon_to_avatar(G_GNUC_UNUSED GBinding *binding,
const GValue *from_value,
GValue *to_value,
G_GNUC_UNUSED gpointer user_data)
{
PurpleBuddyIcon *icon = g_value_get_pointer(from_value);
GdkPixbuf *avatar = NULL;
gconstpointer data = NULL;
size_t len;
if(icon == NULL) {
g_value_set_object(to_value, NULL);
return TRUE;
}
data = purple_buddy_icon_get_data(icon, &len);
avatar = purple_gdk_pixbuf_from_data(data, len);
g_value_take_object(to_value, avatar);
return TRUE;
}
static gboolean
purple_contact_manager_convert_avatar_to_icon(G_GNUC_UNUSED GBinding *binding,
const GValue *from_value,
GValue *to_value,
G_GNUC_UNUSED gpointer user_data)
{
PurpleBuddyIcon *icon = NULL;
GdkPixbuf *avatar = g_value_get_object(from_value);
gchar *buffer = NULL;
gsize len;
gboolean result = FALSE;
if(!GDK_IS_PIXBUF(avatar)) {
g_value_set_pointer(to_value, NULL);
return TRUE;
}
result = gdk_pixbuf_save_to_buffer(avatar, &buffer, &len, "png", NULL,
"compression", "9", NULL);
if(!result) {
return FALSE;
}
purple_buddy_icon_set_data(icon, (guchar *)buffer, len, NULL);
g_free(buffer);
return TRUE;
}
/******************************************************************************
* Callbacks
*****************************************************************************/
static void
purple_contact_manager_contact_person_changed_cb(GObject *obj,
G_GNUC_UNUSED GParamSpec *pspec,
gpointer data)
{
PurpleContact *contact = PURPLE_CONTACT(obj);
PurpleContactManager *manager = data;
PurplePerson *person = NULL;
person = purple_contact_info_get_person(PURPLE_CONTACT_INFO(contact));
/* If the person is now NULL, we leaving the existing person in place as
* we don't want to potentially delete user data.
*/
if(!PURPLE_IS_PERSON(person)) {
return;
}
/* At this point the person changed or is new so we need to add the new
* person.
*/
purple_contact_manager_add_person(manager, person);
}
/******************************************************************************
* GListModel Implementation
*****************************************************************************/
static GType
purple_contact_manager_get_item_type(G_GNUC_UNUSED GListModel *list) {
return PURPLE_TYPE_PERSON;
}
static guint
purple_contact_manager_get_n_items(GListModel *list) {
PurpleContactManager *manager = PURPLE_CONTACT_MANAGER(list);
return manager->people->len;
}
static gpointer
purple_contact_manager_get_item(GListModel *list, guint position) {
PurpleContactManager *manager = PURPLE_CONTACT_MANAGER(list);
PurpleContact *contact = NULL;
if(position < manager->people->len) {
contact = g_object_ref(g_ptr_array_index(manager->people, position));
}
return contact;
}
static void
pidgin_contact_manager_list_model_iface_init(GListModelInterface *iface) {
iface->get_item_type = purple_contact_manager_get_item_type;
iface->get_n_items = purple_contact_manager_get_n_items;
iface->get_item = purple_contact_manager_get_item;
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
G_DEFINE_FINAL_TYPE_WITH_CODE(PurpleContactManager, purple_contact_manager,
G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE(G_TYPE_LIST_MODEL,
pidgin_contact_manager_list_model_iface_init))
static void
purple_contact_manager_dispose(GObject *obj) {
PurpleContactManager *manager = NULL;
manager = PURPLE_CONTACT_MANAGER(obj);
g_hash_table_remove_all(manager->accounts);
if(manager->people != NULL) {
g_ptr_array_free(manager->people, TRUE);
manager->people = NULL;
}
G_OBJECT_CLASS(purple_contact_manager_parent_class)->dispose(obj);
}
static void
purple_contact_manager_finalize(GObject *obj) {
PurpleContactManager *manager = NULL;
manager = PURPLE_CONTACT_MANAGER(obj);
g_clear_pointer(&manager->accounts, g_hash_table_destroy);
G_OBJECT_CLASS(purple_contact_manager_parent_class)->finalize(obj);
}
static void
purple_contact_manager_init(PurpleContactManager *manager) {
manager->accounts = g_hash_table_new_full(g_direct_hash, g_direct_equal,
g_object_unref, g_object_unref);
/* 100 Seems like a reasonable default of the number people on your contact
* list. - gk 20221109
*/
manager->people = g_ptr_array_new_full(100,
(GDestroyNotify)g_object_unref);
}
static void
purple_contact_manager_class_init(PurpleContactManagerClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->dispose = purple_contact_manager_dispose;
obj_class->finalize = purple_contact_manager_finalize;
/**
* PurpleContactManager::added:
* @manager: The instance.
* @contact: The [class@Purple.Contact] that was registered.
*
* Emitted after @contact has been added to @manager.
*
* Since: 3.0.0
*/
signals[SIG_ADDED] = g_signal_new_class_handler(
"added",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CONTACT);
/**
* PurpleContactManager::removed:
* @manager: The instance.
* @contact: The [class@Purple.Contact] that was removed.
*
* Emitted after @contact has been removed from @manager.
*
* Since: 3.0.0
*/
signals[SIG_REMOVED] = g_signal_new_class_handler(
"removed",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CONTACT);
/**
* PurpleContactManager::person-added:
* @manager: The instance.
* @person: The [class@Purple.Person] that was added.
*
* Emitted after @person has been added to @manager. This is typically done
* when a contact is added via [method@Purple.ContactManager.add] but can
* also happen if [method@Purple.ContactManager.add_person] is called.
*
* Since: 3.0.0
*/
signals[SIG_PERSON_ADDED] = g_signal_new_class_handler(
"person-added",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_PERSON);
/**
* PurpleContactManager::person-removed:
* @manager: The instance.
* @person: The [class@Purple.Person] that was removed.
*
* Emitted after @person has been removed from @manager. This typically
* happens when [method@Purple.ContactManager.remove_person] is called.
*
* Since: 3.0.0
*/
signals[SIG_PERSON_REMOVED] = g_signal_new_class_handler(
"person-removed",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_PERSON);
}
/******************************************************************************
* Private API
*****************************************************************************/
void
purple_contact_manager_startup(void) {
if(default_manager == NULL) {
default_manager = g_object_new(PURPLE_TYPE_CONTACT_MANAGER, NULL);
g_object_add_weak_pointer(G_OBJECT(default_manager),
(gpointer)&default_manager);
}
}
void
purple_contact_manager_shutdown(void) {
g_clear_object(&default_manager);
}
/******************************************************************************
* Public API
*****************************************************************************/
PurpleContactManager *
purple_contact_manager_get_default(void) {
if(G_UNLIKELY(!PURPLE_IS_CONTACT_MANAGER(default_manager))) {
g_warning("The default contact manager was unexpectedly NULL");
}
return default_manager;
}
void
purple_contact_manager_add(PurpleContactManager *manager,
PurpleContact *contact)
{
PurpleAccount *account = NULL;
GListStore *contacts = NULL;
gboolean added = FALSE;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_CONTACT(contact));
account = purple_contact_get_account(contact);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
contacts = g_list_store_new(PURPLE_TYPE_CONTACT);
g_hash_table_insert(manager->accounts, g_object_ref(account), contacts);
g_list_store_append(contacts, contact);
added = TRUE;
} else {
if(g_list_store_find(contacts, contact, NULL)) {
PurpleContactInfo *info = PURPLE_CONTACT_INFO(contact);
const gchar *username = purple_contact_info_get_username(info);
const gchar *id = purple_contact_info_get_id(info);
g_warning("double add detected for contact %s:%s", id, username);
return;
}
g_list_store_append(contacts, contact);
added = TRUE;
}
if(added) {
PurpleContactInfo *info = PURPLE_CONTACT_INFO(contact);
PurplePerson *person = purple_contact_info_get_person(info);
/* If the contact already has a person, add the person to our list of
* people.
*/
if(PURPLE_IS_PERSON(person)) {
purple_contact_manager_add_person(manager, person);
}
/* Add a notify on the person property to track changes. */
g_signal_connect_object(contact, "notify::person",
G_CALLBACK(purple_contact_manager_contact_person_changed_cb),
manager, 0);
g_signal_emit(manager, signals[SIG_ADDED], 0, contact);
}
}
gboolean
purple_contact_manager_remove(PurpleContactManager *manager,
PurpleContact *contact)
{
PurpleAccount *account = NULL;
GListStore *contacts = NULL;
guint position = 0;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_CONTACT(contact), FALSE);
account = purple_contact_get_account(contact);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return FALSE;
}
if(g_list_store_find(contacts, contact, &position)) {
gboolean removed = FALSE;
guint len = 0;
/* Ref the contact to make sure that the instance is valid when we emit
* the removed signal.
*/
g_object_ref(contact);
len = g_list_model_get_n_items(G_LIST_MODEL(contacts));
g_list_store_remove(contacts, position);
if(g_list_model_get_n_items(G_LIST_MODEL(contacts)) < len) {
removed = TRUE;
}
if(removed) {
g_signal_emit(manager, signals[SIG_REMOVED], 0, contact);
}
g_object_unref(contact);
return removed;
}
return FALSE;
}
gboolean
purple_contact_manager_remove_all(PurpleContactManager *manager,
PurpleAccount *account)
{
GListStore *contacts = NULL;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
/* If there are any contacts for this account, manually iterate them and
* emit the removed signal. This is more efficient than calling remove on
* each one individually as that would require updating the backing
* GListStore for each individual removal.
*/
contacts = g_hash_table_lookup(manager->accounts, account);
if(G_IS_LIST_STORE(contacts)) {
guint n_items = g_list_model_get_n_items(G_LIST_MODEL(contacts));
for(guint i = 0; i < n_items; i++) {
PurpleContact *contact = NULL;
contact = g_list_model_get_item(G_LIST_MODEL(contacts), i);
g_signal_emit(manager, signals[SIG_REMOVED], 0, contact);
g_clear_object(&contact);
}
}
return g_hash_table_remove(manager->accounts, account);
}
GListModel *
purple_contact_manager_get_all(PurpleContactManager *manager,
PurpleAccount *account)
{
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
return g_hash_table_lookup(manager->accounts, account);
}
PurpleContact *
purple_contact_manager_find_with_username(PurpleContactManager *manager,
PurpleAccount *account,
const gchar *username)
{
PurpleContact *needle = NULL;
GListStore *contacts = NULL;
guint position = 0;
gboolean found = FALSE;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
g_return_val_if_fail(username != NULL, FALSE);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return NULL;
}
needle = purple_contact_new(account, NULL);
purple_contact_info_set_username(PURPLE_CONTACT_INFO(needle), username);
found = g_list_store_find_with_equal_func(contacts, needle,
purple_contact_manager_find_with_username_helper,
&position);
g_clear_object(&needle);
if(found) {
return g_list_model_get_item(G_LIST_MODEL(contacts), position);
}
return NULL;
}
PurpleContact *
purple_contact_manager_find_with_id(PurpleContactManager *manager,
PurpleAccount *account, const gchar *id)
{
PurpleContact *needle = NULL;
GListStore *contacts = NULL;
guint position = 0;
gboolean found = FALSE;
g_return_val_if_fail(PURPLE_IS_CONTACT_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
g_return_val_if_fail(id != NULL, FALSE);
contacts = g_hash_table_lookup(manager->accounts, account);
if(!G_IS_LIST_STORE(contacts)) {
return NULL;
}
needle = purple_contact_new(account, id);
found = g_list_store_find_with_equal_func(contacts, needle,
purple_contact_manager_find_with_id_helper,
&position);
g_clear_object(&needle);
if(found) {
return g_list_model_get_item(G_LIST_MODEL(contacts), position);
}
return NULL;
}
/******************************************************************************
* Migration API
*****************************************************************************/
void
purple_contact_manager_add_buddy(PurpleContactManager *manager,
PurpleBuddy *buddy)
{
PurpleAccount *account = NULL;
PurpleContact *contact = NULL;
PurpleContactInfo *info = NULL;
PurplePerson *person = NULL;
PurplePresence *buddy_presence = NULL;
PurplePresence *contact_presence = NULL;
const gchar *id = NULL;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_BUDDY(buddy));
/* Create the new contact. */
account = purple_buddy_get_account(buddy);
id = purple_buddy_get_id(buddy);
contact = purple_contact_new(account, id);
info = PURPLE_CONTACT_INFO(contact);
person = purple_person_new();
purple_contact_info_set_person(info, person);
purple_person_add_contact_info(person, info);
/* Bind all of the properties. */
g_object_bind_property(buddy, "name", contact, "username",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy, "local-alias", contact, "alias",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy, "server-alias", contact, "display-name",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
buddy_presence = purple_buddy_get_presence(buddy);
contact_presence = purple_contact_info_get_presence(info);
g_object_bind_property(buddy_presence, "idle", contact_presence, "idle",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "idle-time", contact_presence,
"idle-time",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "login-time", contact_presence,
"login-time",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "active-status", contact_presence,
"active-status",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "message", contact_presence,
"message",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "emoji", contact_presence,
"emoji",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "mobile", contact_presence,
"mobile",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property(buddy_presence, "primitive", contact_presence,
"primitive",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
g_object_bind_property_full(buddy, "icon", contact, "avatar",
G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL,
purple_contact_manager_convert_icon_to_avatar,
purple_contact_manager_convert_avatar_to_icon,
NULL, NULL);
/* Finally add it to the manager. */
purple_contact_manager_add(manager, contact);
/* purple_contact_manager_add adds its own reference, so free our copy. */
g_clear_object(&contact);
}
void
purple_contact_manager_add_person(PurpleContactManager *manager,
PurplePerson *person)
{
guint index = 0;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_PERSON(person));
/* If the person is already known, bail. */
if(g_ptr_array_find(manager->people, person, &index)) {
return;
}
/* Add the person and emit our signals. */
g_ptr_array_add(manager->people, g_object_ref(person));
g_list_model_items_changed(G_LIST_MODEL(manager), index, 0, 1);
g_signal_emit(manager, signals[SIG_PERSON_ADDED], 0, person);
}
void
purple_contact_manager_remove_person(PurpleContactManager *manager,
PurplePerson *person,
gboolean remove_contacts)
{
guint index = 0;
g_return_if_fail(PURPLE_IS_CONTACT_MANAGER(manager));
g_return_if_fail(PURPLE_IS_PERSON(person));
if(!g_ptr_array_find(manager->people, person, &index)) {
return;
}
if(remove_contacts) {
guint n = g_list_model_get_n_items(G_LIST_MODEL(person));
for(guint i = 0; i < n; i++) {
PurpleContact *contact = NULL;
contact = g_list_model_get_item(G_LIST_MODEL(person), i);
if(PURPLE_IS_CONTACT(contact)) {
purple_contact_manager_remove(manager, contact);
g_object_unref(contact);
}
}
}
/* Add a ref to the person, so we can emit the removed signal after it
* was actually removed, as our GPtrArray may be holding the last
* reference.
*/
g_object_ref(person);
g_ptr_array_remove_index(manager->people, index);
g_list_model_items_changed(G_LIST_MODEL(manager), index, 1, 0);
/* Emit the removed signal and clear our temporary reference. */
g_signal_emit(manager, signals[SIG_PERSON_REMOVED], 0, person);
g_object_unref(person);
}