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>
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* 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 "purpleprotocol.h"
#include "purpleaccountmanager.h"
#include "purpleenums.h"
enum {
PROP_0,
PROP_ID,
PROP_NAME,
PROP_DESCRIPTION,
PROP_ICON_NAME,
PROP_ICON_SEARCH_PATH,
PROP_ICON_RESOURCE_PATH,
PROP_OPTIONS,
N_PROPERTIES,
};
static GParamSpec *properties[N_PROPERTIES] = { NULL, };
typedef struct {
gchar *id;
gchar *name;
gchar *description;
gchar *icon_name;
gchar *icon_search_path;
gchar *icon_resource_path;
PurpleProtocolOptions options;
} PurpleProtocolPrivate;
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(PurpleProtocol, purple_protocol,
G_TYPE_OBJECT)
/******************************************************************************
* Helpers
*****************************************************************************/
static void
purple_protocol_set_id(PurpleProtocol *protocol, const gchar *id) {
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->id);
priv->id = g_strdup(id);
g_object_notify_by_pspec(G_OBJECT(protocol), properties[PROP_ID]);
}
static void
purple_protocol_set_name(PurpleProtocol *protocol, const gchar *name) {
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->name);
priv->name = g_strdup(name);
g_object_notify_by_pspec(G_OBJECT(protocol), properties[PROP_NAME]);
}
static void
purple_protocol_set_description(PurpleProtocol *protocol, const gchar *description) {
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->description);
priv->description = g_strdup(description);
g_object_notify_by_pspec(G_OBJECT(protocol), properties[PROP_DESCRIPTION]);
}
static void
purple_protocol_set_icon_name(PurpleProtocol *protocol,
const gchar *icon_name)
{
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->icon_name);
priv->icon_name = g_strdup(icon_name);
g_object_notify_by_pspec(G_OBJECT(protocol), properties[PROP_ICON_NAME]);
}
static void
purple_protocol_set_icon_search_path(PurpleProtocol *protocol,
const gchar *path)
{
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->icon_search_path);
priv->icon_search_path = g_strdup(path);
g_object_notify_by_pspec(G_OBJECT(protocol),
properties[PROP_ICON_SEARCH_PATH]);
}
static void
purple_protocol_set_icon_resource_path(PurpleProtocol *protocol,
const gchar *path)
{
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
g_free(priv->icon_resource_path);
priv->icon_resource_path = g_strdup(path);
g_object_notify_by_pspec(G_OBJECT(protocol),
properties[PROP_ICON_RESOURCE_PATH]);
}
static void
purple_protocol_set_options(PurpleProtocol *protocol,
PurpleProtocolOptions options)
{
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
priv->options = options;
g_object_notify_by_pspec(G_OBJECT(protocol), properties[PROP_OPTIONS]);
}
static void
purple_protocol_foreach_account_disconnect(PurpleAccount *account,
gpointer data)
{
const gchar *protocol_id = (const gchar *)data;
/* I'm not sure that we can finalize a protocol plugin if an account is
* still using it.. Right now accounts don't ref protocols, but maybe
* they should?
*/
if(purple_account_is_disconnected(account)) {
return;
}
if(purple_strequal(protocol_id, purple_account_get_protocol_id(account))) {
purple_account_disconnect(account);
}
}
/******************************************************************************
* PurpleProtocol Implementation
*****************************************************************************/
static PurpleConnection *
purple_protocol_default_create_connection(PurpleProtocol *protocol,
PurpleAccount *account,
const char *password,
G_GNUC_UNUSED GError **error)
{
return g_object_new(
PURPLE_TYPE_CONNECTION,
"protocol", protocol,
"account", account,
"password", password,
NULL);
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
static void
purple_protocol_get_property(GObject *obj, guint param_id, GValue *value,
GParamSpec *pspec)
{
PurpleProtocol *protocol = PURPLE_PROTOCOL(obj);
switch(param_id) {
case PROP_ID:
g_value_set_string(value, purple_protocol_get_id(protocol));
break;
case PROP_NAME:
g_value_set_string(value, purple_protocol_get_name(protocol));
break;
case PROP_DESCRIPTION:
g_value_set_string(value,
purple_protocol_get_description(protocol));
break;
case PROP_ICON_NAME:
g_value_set_string(value, purple_protocol_get_icon_name(protocol));
break;
case PROP_ICON_SEARCH_PATH:
g_value_set_string(value,
purple_protocol_get_icon_search_path(protocol));
break;
case PROP_ICON_RESOURCE_PATH:
g_value_set_string(value,
purple_protocol_get_icon_resource_path(protocol));
break;
case PROP_OPTIONS:
g_value_set_flags(value, purple_protocol_get_options(protocol));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
purple_protocol_set_property(GObject *obj, guint param_id, const GValue *value,
GParamSpec *pspec)
{
PurpleProtocol *protocol = PURPLE_PROTOCOL(obj);
switch(param_id) {
case PROP_ID:
purple_protocol_set_id(protocol, g_value_get_string(value));
break;
case PROP_NAME:
purple_protocol_set_name(protocol, g_value_get_string(value));
break;
case PROP_DESCRIPTION:
purple_protocol_set_description(protocol,
g_value_get_string(value));
break;
case PROP_ICON_NAME:
purple_protocol_set_icon_name(protocol, g_value_get_string(value));
break;
case PROP_ICON_SEARCH_PATH:
purple_protocol_set_icon_search_path(protocol,
g_value_get_string(value));
break;
case PROP_ICON_RESOURCE_PATH:
purple_protocol_set_icon_resource_path(protocol,
g_value_get_string(value));
break;
case PROP_OPTIONS:
purple_protocol_set_options(protocol, g_value_get_flags(value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
purple_protocol_init(G_GNUC_UNUSED PurpleProtocol *protocol) {
}
static void
purple_protocol_finalize(GObject *object) {
PurpleAccountManager *manager = purple_account_manager_get_default();
PurpleProtocol *protocol = PURPLE_PROTOCOL(object);
PurpleProtocolPrivate *priv = NULL;
priv = purple_protocol_get_instance_private(protocol);
purple_account_manager_foreach(manager,
purple_protocol_foreach_account_disconnect,
priv->id);
g_clear_pointer(&priv->id, g_free);
g_clear_pointer(&priv->name, g_free);
g_clear_pointer(&priv->description, g_free);
g_clear_pointer(&priv->icon_name, g_free);
g_clear_pointer(&priv->icon_search_path, g_free);
g_clear_pointer(&priv->icon_resource_path, g_free);
/* these seem to be fallbacks if the subclass protocol doesn't do it's own
* clean up? I kind of want to delete them... - gk 2021-03-03
*/
purple_request_close_with_handle(protocol);
purple_notify_close_with_handle(protocol);
purple_signals_disconnect_by_handle(protocol);
purple_signals_unregister_by_instance(protocol);
purple_prefs_disconnect_by_handle(protocol);
G_OBJECT_CLASS(purple_protocol_parent_class)->finalize(object);
}
static void
purple_protocol_class_init(PurpleProtocolClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->get_property = purple_protocol_get_property;
obj_class->set_property = purple_protocol_set_property;
obj_class->finalize = purple_protocol_finalize;
klass->create_connection = purple_protocol_default_create_connection;
/**
* PurpleProtocol::id:
*
* The identifier for the protocol.
*
* Since: 3.0.0
*/
properties[PROP_ID] = g_param_spec_string(
"id", "id",
"The identifier for the protocol",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::name:
*
* The name to show in user interface for the protocol.
*
* Since: 3.0.0
*/
properties[PROP_NAME] = g_param_spec_string(
"name", "name",
"The name of the protocol to show in the user interface",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::description:
*
* The description to show in user interface for the protocol.
*
* Since: 3.0.0
*/
properties[PROP_DESCRIPTION] = g_param_spec_string(
"description", "description",
"The description of the protocol to show in the user interface",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::icon-name:
*
* The name of an icon that has been installed to either the path specified
* via PurpleProtocol::icon-search-path or
* PurpleProtocol::icon-resource-path.
*
* Since: 3.0.0
*/
properties[PROP_ICON_NAME] = g_param_spec_string(
"icon-name", "icon-name",
"The name of the XDG icon.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::icon-search-path:
*
* The path to an XDG Icon Theme directory which contains the icons for the
* protocol. See purple_protocol_get_icon_search_path() for more
* information.
*
* Since: 3.0.0
*/
properties[PROP_ICON_SEARCH_PATH] = g_param_spec_string(
"icon-search-path", "icon-search-path",
"The path to an XDG Icon Theme directory.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::icon-resource-path:
*
* A #GResource path which contains the icons for the protocol. See
* purple_protocol_get_icon_resource_path() for more information.
*
* Since: 3.0.0
*/
properties[PROP_ICON_RESOURCE_PATH] = g_param_spec_string(
"icon-resource-path", "icon-resource-path",
"The GResource path to the icons.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleProtocol::options:
*
* The #PurpleProtocolOptions for the protocol.
*
* Since: 3.0.0
*/
properties[PROP_OPTIONS] = g_param_spec_flags(
"options", "options",
"The options for the protocol",
PURPLE_TYPE_PROTOCOL_OPTIONS,
0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
g_object_class_install_properties(obj_class, N_PROPERTIES, properties);
}
/******************************************************************************
* Public API
*****************************************************************************/
const gchar *
purple_protocol_get_id(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->id;
}
const gchar *
purple_protocol_get_name(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->name;
}
const gchar *
purple_protocol_get_description(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->description;
}
const gchar *
purple_protocol_get_icon_name(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->icon_name;
}
const gchar *
purple_protocol_get_icon_search_path(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->icon_search_path;
}
const gchar *
purple_protocol_get_icon_resource_path(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
priv = purple_protocol_get_instance_private(protocol);
return priv->icon_resource_path;
}
PurpleProtocolOptions
purple_protocol_get_options(PurpleProtocol *protocol) {
PurpleProtocolPrivate *priv = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), 0);
priv = purple_protocol_get_instance_private(protocol);
return priv->options;
}
GList *
purple_protocol_get_user_splits(PurpleProtocol *protocol) {
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->get_user_splits != NULL) {
return klass->get_user_splits(protocol);
}
return NULL;
}
GList *
purple_protocol_get_account_options(PurpleProtocol *protocol) {
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->get_account_options != NULL) {
return klass->get_account_options(protocol);
}
return NULL;
}
PurpleBuddyIconSpec *
purple_protocol_get_icon_spec(PurpleProtocol *protocol) {
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->get_buddy_icon_spec != NULL) {
return klass->get_buddy_icon_spec(protocol);
}
return NULL;
}
PurpleWhiteboardOps *
purple_protocol_get_whiteboard_ops(PurpleProtocol *protocol) {
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->get_whiteboard_ops != NULL) {
return klass->get_whiteboard_ops(protocol);
}
return NULL;
}
void
purple_protocol_login(PurpleProtocol *protocol, PurpleAccount *account) {
PurpleProtocolClass *klass = NULL;
g_return_if_fail(PURPLE_IS_PROTOCOL(protocol));
g_return_if_fail(PURPLE_IS_ACCOUNT(account));
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->login != NULL) {
klass->login(protocol, account);
}
}
void
purple_protocol_close(PurpleProtocol *protocol, PurpleConnection *gc) {
PurpleProtocolClass *klass = NULL;
g_return_if_fail(PURPLE_IS_PROTOCOL(protocol));
g_return_if_fail(PURPLE_IS_CONNECTION(gc));
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->close != NULL) {
klass->close(protocol, gc);
}
}
void
purple_protocol_can_connect_async(PurpleProtocol *protocol,
PurpleAccount *account,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer data)
{
PurpleProtocolClass *klass = NULL;
g_return_if_fail(PURPLE_IS_PROTOCOL(protocol));
g_return_if_fail(PURPLE_IS_ACCOUNT(account));
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->can_connect_async != NULL) {
klass->can_connect_async(protocol, account, cancellable, callback,
data);
}
}
gboolean
purple_protocol_can_connect_finish(PurpleProtocol *protocol,
GAsyncResult *result,
GError **error)
{
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), FALSE);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->can_connect_finish != NULL) {
return klass->can_connect_finish(protocol, result, error);
}
return FALSE;
}
PurpleConnection *
purple_protocol_create_connection(PurpleProtocol *protocol,
PurpleAccount *account,
const char *password,
GError **error)
{
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->create_connection != NULL) {
return klass->create_connection(protocol, account, password, error);
}
g_set_error(error, PURPLE_CONNECTION_ERROR, 0,
"Protocol %s did not implement create_connection",
purple_protocol_get_name(protocol));
return NULL;
}
GList *
purple_protocol_get_status_types(PurpleProtocol *protocol,
PurpleAccount *account)
{
PurpleProtocolClass *klass = NULL;
g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL);
g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL);
klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
if(klass != NULL && klass->status_types != NULL) {
return klass->status_types(protocol, account);
}
return NULL;
}