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 "purplecredentialmanager.h"
#include "core.h"
#include "debug.h"
#include "prefs.h"
#include "purplenoopcredentialprovider.h"
#include "purpleprivate.h"
#include "util.h"
enum {
SIG_REGISTERED,
SIG_UNREGISTERED,
SIG_ACTIVE_CHANGED,
N_SIGNALS,
};
static guint signals[N_SIGNALS] = {0, };
struct _PurpleCredentialManager {
GObject parent;
GHashTable *providers;
PurpleCredentialProvider *active;
};
G_DEFINE_TYPE(PurpleCredentialManager, purple_credential_manager,
G_TYPE_OBJECT);
static PurpleCredentialManager *default_manager = NULL;
/******************************************************************************
* Async Callbacks
*****************************************************************************/
static void
purple_credential_manager_read_password_callback(GObject *obj,
GAsyncResult *res,
gpointer data)
{
PurpleCredentialProvider *provider = PURPLE_CREDENTIAL_PROVIDER(obj);
GError *error = NULL;
GTask *task = G_TASK(data);
gchar *password = NULL;
password = purple_credential_provider_read_password_finish(provider, res,
&error);
if(error != NULL) {
g_task_return_error(task, error);
} else {
g_task_return_pointer(task, password, g_free);
}
/* Clean up our initial reference to the task. */
g_object_unref(G_OBJECT(task));
}
static void
purple_credential_manager_write_password_callback(GObject *obj,
GAsyncResult *res,
gpointer data)
{
PurpleCredentialProvider *provider = PURPLE_CREDENTIAL_PROVIDER(obj);
GError *error = NULL;
GTask *task = G_TASK(data);
gboolean ret = FALSE;
ret = purple_credential_provider_write_password_finish(provider, res,
&error);
if(error != NULL) {
g_task_return_error(task, error);
} else {
g_task_return_boolean(task, ret);
}
/* Clean up our initial reference to the task. */
g_object_unref(G_OBJECT(task));
}
static void
purple_credential_manager_clear_password_callback(GObject *obj,
GAsyncResult *res,
gpointer data)
{
PurpleCredentialProvider *provider = PURPLE_CREDENTIAL_PROVIDER(obj);
GError *error = NULL;
GTask *task = G_TASK(data);
gboolean ret = FALSE;
ret = purple_credential_provider_clear_password_finish(provider, res,
&error);
if(error != NULL) {
g_task_return_error(task, error);
} else {
g_task_return_boolean(task, ret);
}
/* Clean up our initial reference to the task. */
g_object_unref(G_OBJECT(task));
}
/******************************************************************************
* Purple Callbacks
*****************************************************************************/
static void
purple_credential_manager_core_init_cb(gpointer data) {
PurpleCredentialManager *manager = PURPLE_CREDENTIAL_MANAGER(data);
if(!PURPLE_IS_CREDENTIAL_PROVIDER(manager->active)) {
GSettings *settings = NULL;
GError *error = NULL;
gchar *id = NULL;
settings = g_settings_new_with_backend("im.pidgin.Purple.Credentials",
purple_core_get_settings_backend());
id = g_settings_get_string(settings, "active-provider");
g_object_unref(settings);
if(!purple_credential_manager_set_active(manager, id, &error)) {
g_warning("Failed to make %s the active credential provider : %s",
id, error != NULL ? error->message : "unknown error");
purple_notify_error(NULL, _("Credential Manager"),
_("Failed to load the selected credential "
"provider."),
_("Check your system configuration or select "
"another one in the preferences dialog."),
NULL);
}
g_free(id);
g_clear_error(&error);
}
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
static void
purple_credential_manager_finalize(GObject *obj) {
PurpleCredentialManager *manager = NULL;
manager = PURPLE_CREDENTIAL_MANAGER(obj);
g_clear_pointer(&manager->providers, g_hash_table_destroy);
g_clear_object(&manager->active);
G_OBJECT_CLASS(purple_credential_manager_parent_class)->finalize(obj);
}
static void
purple_credential_manager_init(PurpleCredentialManager *manager) {
manager->providers = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
g_object_unref);
/* Connect to the core-initialized signal so we can alert the user if we
* were unable to find their credential provider.
*/
purple_signal_connect(purple_get_core(), "core-initialized", manager,
G_CALLBACK(purple_credential_manager_core_init_cb),
manager);
}
static void
purple_credential_manager_class_init(PurpleCredentialManagerClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->finalize = purple_credential_manager_finalize;
/**
* PurpleCredentialManager::registered:
* @manager: The #PurpleCredentialManager instance.
* @provider: The #PurpleCredentialProvider that was registered.
*
* Emitted after @provider has been registered in @manager.
*
* Since: 3.0.0
*/
signals[SIG_REGISTERED] = g_signal_new_class_handler(
"registered",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CREDENTIAL_PROVIDER);
/**
* PurpleCredentialManager::unregistered:
* @manager: The #PurpleCredentialManager instance.
* @provider: The #PurpleCredentialProvider that was unregistered.
*
* Emitted after @provider has been unregistered from @manager.
*
* Since: 3.0.0
*/
signals[SIG_UNREGISTERED] = g_signal_new_class_handler(
"unregistered",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
1,
PURPLE_TYPE_CREDENTIAL_PROVIDER);
/**
* PurpleCredentialManager::active-changed:
* @manager: The #PurpleCredentialManager instance.
* @previous: The #PurpleCredentialProvider that was previously active.
* @current: The #PurpleCredentialProvider that is now currently active.
*
* Emitted after @provider has become the active provider for @manager.
*
* Since: 3.0.0
*/
signals[SIG_ACTIVE_CHANGED] = g_signal_new_class_handler(
"active-changed",
G_OBJECT_CLASS_TYPE(klass),
G_SIGNAL_RUN_LAST,
NULL,
NULL,
NULL,
NULL,
G_TYPE_NONE,
2,
PURPLE_TYPE_CREDENTIAL_PROVIDER,
PURPLE_TYPE_CREDENTIAL_PROVIDER);
}
/******************************************************************************
* Private API
*****************************************************************************/
/* Currently we're auto-registering the noop provider on the default manager,
* this may get moved to purple core later, so we just want to keep it all in
* one place for now.
*/
static PurpleCredentialProvider *noop = NULL;
void
purple_credential_manager_startup(void) {
if(default_manager == NULL) {
GError *error = NULL;
default_manager = g_object_new(PURPLE_TYPE_CREDENTIAL_MANAGER, NULL);
noop = purple_noop_credential_provider_new();
if(!purple_credential_manager_register(default_manager, noop, &error)) {
g_warning("failed to register the noop credential manager: %s",
error ? error->message : "unknown");
g_clear_error(&error);
g_clear_object(&noop);
}
}
}
void
purple_credential_manager_shutdown(void) {
if(PURPLE_IS_CREDENTIAL_MANAGER(default_manager)) {
guint size = 0;
/* If we have an instance of the noop provider we need to unregister
* it before continuing.
*/
if(PURPLE_IS_CREDENTIAL_PROVIDER(noop)) {
GError *error = NULL;
if(!purple_credential_manager_unregister(default_manager,
noop, &error))
{
g_warning("failed to unregister the noop provider: %s",
error ? error->message : "unknown");
g_clear_error(&error);
}
g_clear_object(&noop);
}
size = g_hash_table_size(default_manager->providers);
if(size > 0) {
g_warning("purple_credential_manager_shutdown called while %d "
"providers were still registered. Skipping shutdown",
size);
} else {
g_clear_object(&default_manager);
}
}
}
/******************************************************************************
* Public API
*****************************************************************************/
PurpleCredentialManager *
purple_credential_manager_get_default(void) {
return default_manager;
}
gboolean
purple_credential_manager_register(PurpleCredentialManager *manager,
PurpleCredentialProvider *provider,
GError **error)
{
const gchar *id = NULL;
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_PROVIDER(provider), FALSE);
if(!purple_credential_provider_is_valid(provider, error)) {
/* purple_credential_provider_is_valid sets the error on failure. */
return FALSE;
}
id = purple_credential_provider_get_id(provider);
if(g_hash_table_lookup(manager->providers, id) != NULL) {
g_set_error(error, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("provider %s is already registered"), id);
return FALSE;
}
g_hash_table_insert(manager->providers, g_strdup(id),
g_object_ref(provider));
g_signal_emit(G_OBJECT(manager), signals[SIG_REGISTERED], 0, provider);
/* If we don't currently have an active provider, check if the newly
* registered provider has the id of the stored provider in preferences.
* If it is, go ahead and make it the active provider.
*/
if(!PURPLE_IS_CREDENTIAL_PROVIDER(manager->active)) {
GSettings *settings = NULL;
gchar *wanted = NULL;
settings = g_settings_new_with_backend("im.pidgin.Purple.Credentials",
purple_core_get_settings_backend());
wanted = g_settings_get_string(settings, "active-provider");
if(purple_strequal(wanted, id)) {
purple_credential_manager_set_active(manager, id, error);
}
g_free(wanted);
g_object_unref(settings);
}
return TRUE;
}
gboolean
purple_credential_manager_unregister(PurpleCredentialManager *manager,
PurpleCredentialProvider *provider,
GError **error)
{
const gchar *id = NULL;
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), FALSE);
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_PROVIDER(provider), FALSE);
id = purple_credential_provider_get_id(provider);
if(provider == manager->active) {
g_set_error(error, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("provider %s is currently in use"), id);
return FALSE;
}
if(g_hash_table_remove(manager->providers, id)) {
g_signal_emit(G_OBJECT(manager), signals[SIG_UNREGISTERED], 0,
provider);
return TRUE;
}
g_set_error(error, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("provider %s is not registered"), id);
return FALSE;
}
gboolean
purple_credential_manager_set_active(PurpleCredentialManager *manager,
const gchar *id, GError **error)
{
PurpleCredentialProvider *previous = NULL, *provider = NULL;
GSettings *settings = NULL;
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), FALSE);
/* First look up the new provider if we're given one. */
if(id != NULL) {
provider = g_hash_table_lookup(manager->providers, id);
if(!PURPLE_IS_CREDENTIAL_PROVIDER(provider)) {
g_set_error(error, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
"no credential provider found with id %s", id);
return FALSE;
}
}
if(PURPLE_IS_CREDENTIAL_PROVIDER(manager->active)) {
previous = PURPLE_CREDENTIAL_PROVIDER(g_object_ref(manager->active));
}
if(g_set_object(&manager->active, provider)) {
if(PURPLE_IS_CREDENTIAL_PROVIDER(previous)) {
purple_credential_provider_deactivate(previous);
}
if(PURPLE_IS_CREDENTIAL_PROVIDER(provider)) {
purple_credential_provider_activate(provider);
}
g_signal_emit(G_OBJECT(manager), signals[SIG_ACTIVE_CHANGED], 0,
previous, manager->active);
}
g_clear_object(&previous);
/* Finally update the preference if we were given a new id. We assume, that
* a NULL id means we're shutting down and thus shouldn't update the
* setting.
*/
if(id != NULL) {
settings = g_settings_new_with_backend("im.pidgin.Purple.Credentials",
purple_core_get_settings_backend());
g_settings_set_string(settings, "active-provider", id);
g_object_unref(settings);
}
purple_debug_info("credential-manager", "set active provider to '%s'", id);
return TRUE;
}
PurpleCredentialProvider *
purple_credential_manager_get_active(PurpleCredentialManager *manager) {
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), NULL);
return manager->active;
}
void
purple_credential_manager_read_password_async(PurpleCredentialManager *manager,
PurpleAccount *account,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer data)
{
GTask *task = NULL;
g_return_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager));
g_return_if_fail(PURPLE_IS_ACCOUNT(account));
task = g_task_new(manager, cancellable, callback, data);
if(manager->active != NULL) {
purple_credential_provider_read_password_async(manager->active,
account,
cancellable,
purple_credential_manager_read_password_callback,
task);
} else {
g_task_return_new_error(task, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("can not read password, no active "
"credential provider"));
g_object_unref(G_OBJECT(task));
}
}
gchar *
purple_credential_manager_read_password_finish(PurpleCredentialManager *manager,
GAsyncResult *result,
GError **error)
{
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), NULL);
return g_task_propagate_pointer(G_TASK(result), error);
}
void
purple_credential_manager_write_password_async(PurpleCredentialManager *manager,
PurpleAccount *account,
const gchar *password,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer data)
{
GTask *task = NULL;
g_return_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager));
g_return_if_fail(PURPLE_IS_ACCOUNT(account));
task = g_task_new(manager, cancellable, callback, data);
if(!purple_account_get_remember_password(account)) {
const gchar *name = NULL;
name = purple_contact_info_get_username(PURPLE_CONTACT_INFO(account));
g_task_return_new_error(task, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("account \"%s\" is not marked to be stored"),
name);
g_object_unref(G_OBJECT(task));
return;
}
if(manager->active != NULL) {
purple_credential_provider_write_password_async(manager->active,
account,
password, cancellable,
purple_credential_manager_write_password_callback,
task);
} else {
g_task_return_new_error(task, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("can not write password, no active "
"credential provider"));
g_object_unref(G_OBJECT(task));
}
}
gboolean
purple_credential_manager_write_password_finish(PurpleCredentialManager *manager,
GAsyncResult *result,
GError **error)
{
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), FALSE);
return g_task_propagate_boolean(G_TASK(result), error);
}
void
purple_credential_manager_clear_password_async(PurpleCredentialManager *manager,
PurpleAccount *account,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer data)
{
GTask *task = NULL;
g_return_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager));
g_return_if_fail(PURPLE_IS_ACCOUNT(account));
task = g_task_new(manager, cancellable, callback, data);
if(manager->active != NULL) {
purple_credential_provider_clear_password_async(manager->active,
account,
cancellable,
purple_credential_manager_clear_password_callback,
task);
} else {
g_task_return_new_error(task, PURPLE_CREDENTIAL_MANAGER_DOMAIN, 0,
_("can not clear password, no active "
"credential provider"));
g_object_unref(G_OBJECT(task));
}
}
gboolean
purple_credential_manager_clear_password_finish(PurpleCredentialManager *manager,
GAsyncResult *result,
GError **error)
{
g_return_val_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager), FALSE);
return g_task_propagate_boolean(G_TASK(result), error);
}
void
purple_credential_manager_foreach(PurpleCredentialManager *manager,
PurpleCredentialManagerForeachFunc func,
gpointer data)
{
GHashTableIter iter;
gpointer value;
g_return_if_fail(PURPLE_IS_CREDENTIAL_MANAGER(manager));
g_return_if_fail(func != NULL);
g_hash_table_iter_init(&iter, manager->providers);
while(g_hash_table_iter_next(&iter, NULL, &value)) {
func(PURPLE_CREDENTIAL_PROVIDER(value), data);
}
}