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 <glib/gi18n-lib.h>
#include "debug.h"
#include "purpleenums.h"
#include "purplemessage.h"
#include "purpleprivate.h"
struct _PurpleMessage {
GObject parent;
gchar *id;
gchar *author;
gchar *author_name_color;
gchar *author_alias;
gchar *recipient;
gchar *contents;
PurpleMessageContentType content_type;
GDateTime *timestamp;
PurpleMessageFlags flags;
GError *error;
GHashTable *attachments;
};
enum {
PROP_0,
PROP_ID,
PROP_AUTHOR,
PROP_AUTHOR_ALIAS,
PROP_AUTHOR_NAME_COLOR,
PROP_RECIPIENT,
PROP_CONTENTS,
PROP_CONTENT_TYPE,
PROP_TIMESTAMP,
PROP_FLAGS,
PROP_ERROR,
N_PROPERTIES
};
static GParamSpec *properties[N_PROPERTIES];
G_DEFINE_TYPE(PurpleMessage, purple_message, G_TYPE_OBJECT)
/******************************************************************************
* Helpers
*****************************************************************************/
static void
purple_message_set_id(PurpleMessage *message, const gchar *id) {
g_free(message->id);
message->id = g_strdup(id);
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_ID]);
}
static void
purple_message_set_author(PurpleMessage *message, const gchar *author) {
g_free(message->author);
message->author = g_strdup(author);
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_AUTHOR]);
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
static void
purple_message_get_property(GObject *object, guint param_id, GValue *value,
GParamSpec *pspec)
{
PurpleMessage *message = PURPLE_MESSAGE(object);
switch(param_id) {
case PROP_ID:
g_value_set_string(value, purple_message_get_id(message));
break;
case PROP_AUTHOR:
g_value_set_string(value, purple_message_get_author(message));
break;
case PROP_AUTHOR_ALIAS:
g_value_set_string(value, purple_message_get_author_alias(message));
break;
case PROP_AUTHOR_NAME_COLOR:
g_value_set_string(value,
purple_message_get_author_name_color(message));
break;
case PROP_RECIPIENT:
g_value_set_string(value, purple_message_get_recipient(message));
break;
case PROP_CONTENTS:
g_value_set_string(value, purple_message_get_contents(message));
break;
case PROP_CONTENT_TYPE:
g_value_set_enum(value, purple_message_get_content_type(message));
break;
case PROP_TIMESTAMP:
g_value_set_boxed(value, purple_message_get_timestamp(message));
break;
case PROP_FLAGS:
g_value_set_flags(value, purple_message_get_flags(message));
break;
case PROP_ERROR:
g_value_set_boxed(value, purple_message_get_error(message));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, param_id, pspec);
break;
}
}
static void
purple_message_set_property(GObject *object, guint param_id,
const GValue *value, GParamSpec *pspec)
{
PurpleMessage *message = PURPLE_MESSAGE(object);
switch(param_id) {
case PROP_ID:
purple_message_set_id(message, g_value_get_string(value));
break;
case PROP_AUTHOR:
purple_message_set_author(message, g_value_get_string(value));
break;
case PROP_AUTHOR_ALIAS:
purple_message_set_author_alias(message, g_value_get_string(value));
break;
case PROP_AUTHOR_NAME_COLOR:
purple_message_set_author_name_color(message,
g_value_get_string(value));
break;
case PROP_RECIPIENT:
purple_message_set_recipient(message, g_value_get_string(value));
break;
case PROP_CONTENTS:
purple_message_set_contents(message, g_value_get_string(value));
break;
case PROP_CONTENT_TYPE:
purple_message_set_content_type(message, g_value_get_enum(value));
break;
case PROP_TIMESTAMP:
purple_message_set_timestamp(message, g_value_get_boxed(value));
break;
case PROP_FLAGS:
purple_message_set_flags(message, g_value_get_flags(value));
break;
case PROP_ERROR:
purple_message_set_error(message, g_value_get_boxed(value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, param_id, pspec);
break;
}
}
static void
purple_message_finalize(GObject *obj) {
PurpleMessage *message = PURPLE_MESSAGE(obj);
g_free(message->id);
g_free(message->author);
g_free(message->author_name_color);
g_free(message->author_alias);
g_free(message->recipient);
g_free(message->contents);
g_clear_error(&message->error);
if(message->timestamp != NULL) {
g_date_time_unref(message->timestamp);
}
g_hash_table_destroy(message->attachments);
G_OBJECT_CLASS(purple_message_parent_class)->finalize(obj);
}
static void
purple_message_init(PurpleMessage *message) {
message->attachments = g_hash_table_new_full(g_int64_hash, g_int64_equal,
NULL, g_object_unref);
}
static void
purple_message_class_init(PurpleMessageClass *klass) {
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->get_property = purple_message_get_property;
obj_class->set_property = purple_message_set_property;
obj_class->finalize = purple_message_finalize;
/**
* PurpleMessage::id:
*
* The account specific identifier of the message.
*
* Since: 3.0.0
*/
properties[PROP_ID] = g_param_spec_string(
"id", "ID",
"The session-unique message id",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::author:
*
* The author of the message.
*
* Since: 3.0.0
*/
properties[PROP_AUTHOR] = g_param_spec_string(
"author", "Author",
"The username of the person, who sent the message.",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::author-name-color:
*
* The hex color for the author's name.
*
* Since: 3.0.0
*/
properties[PROP_AUTHOR_NAME_COLOR] = g_param_spec_string(
"author-name-color", "author-name-color",
"The hex color to display the author's name with",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::author-alias:
*
* The alias of the author.
*
* Since: 3.0.0
*/
properties[PROP_AUTHOR_ALIAS] = g_param_spec_string(
"author-alias", "Author's alias",
"The alias of the sender",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::recipient:
*
* The recipient of the message.
*
* Since: 3.0.0
*/
properties[PROP_RECIPIENT] = g_param_spec_string(
"recipient", "Recipient",
"The username of the recipient.",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::content:
*
* The contents of the message.
*
* Since: 3.0.0
*/
properties[PROP_CONTENTS] = g_param_spec_string(
"contents", "Contents",
"The message text",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::content-type:
*
* The content-type of the message.
*
* Since: 3.0.0
*/
properties[PROP_CONTENT_TYPE] = g_param_spec_enum(
"content-type", "content-type",
"The content-type of the message.",
PURPLE_TYPE_MESSAGE_CONTENT_TYPE, PURPLE_MESSAGE_CONTENT_TYPE_PLAIN,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::timestamp:
*
* The timestamp of the message.
*
* Since: 3.0.0
*/
properties[PROP_TIMESTAMP] = g_param_spec_boxed(
"timestamp", "timestamp",
"The timestamp of the message",
G_TYPE_DATE_TIME,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage::flags:
*
* The #PurpleMessageFlags for the message.
*
* Since: 3.0.0
*/
properties[PROP_FLAGS] = g_param_spec_flags(
"flags", "Flags",
"Bitwise set of #PurpleMessageFlags flags",
PURPLE_TYPE_MESSAGE_FLAGS, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* PurpleMessage:error:
*
* An error that this message encountered. This could be something like a
* failed delivery, or failed redaction, or rate limited, etc.
*
* Since: 3.0.0
*/
properties[PROP_ERROR] = g_param_spec_boxed(
"error", "error",
"An error that the message encountered",
G_TYPE_ERROR,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_properties(obj_class, N_PROPERTIES, properties);
}
/******************************************************************************
* Public API
*****************************************************************************/
PurpleMessage *
purple_message_new_outgoing(G_GNUC_UNUSED PurpleAccount *account,
const gchar *author, const gchar *recipient,
const gchar *contents, PurpleMessageFlags flags)
{
PurpleMessage *message = NULL;
GDateTime *dt = NULL;
g_warn_if_fail(!(flags & PURPLE_MESSAGE_RECV));
g_warn_if_fail(!(flags & PURPLE_MESSAGE_SYSTEM));
flags |= PURPLE_MESSAGE_SEND;
dt = g_date_time_new_now_local();
/* who may be NULL for outgoing MUC messages */
message = PURPLE_MESSAGE(g_object_new(PURPLE_TYPE_MESSAGE,
"author", author,
"recipient", recipient,
"contents", contents,
"timestamp", dt,
"flags", flags,
NULL));
g_date_time_unref(dt);
return message;
}
PurpleMessage *
purple_message_new_incoming(G_GNUC_UNUSED PurpleAccount *account,
const gchar *who, const gchar *contents,
PurpleMessageFlags flags, guint64 timestamp)
{
PurpleMessage *message = NULL;
GDateTime *dt = NULL;
g_warn_if_fail(!(flags & PURPLE_MESSAGE_SEND));
g_warn_if_fail(!(flags & PURPLE_MESSAGE_SYSTEM));
flags |= PURPLE_MESSAGE_RECV;
if(timestamp == 0) {
dt = g_date_time_new_now_local();
} else {
dt = g_date_time_new_from_unix_local((gint64)timestamp);
}
message = PURPLE_MESSAGE(g_object_new(PURPLE_TYPE_MESSAGE,
"author", who,
"author-alias", who,
"contents", contents,
"timestamp", dt,
"flags", flags,
NULL));
g_date_time_unref(dt);
return message;
}
PurpleMessage *
purple_message_new_system(G_GNUC_UNUSED PurpleAccount *account,
const gchar *contents, PurpleMessageFlags flags)
{
PurpleMessage *message = NULL;
GDateTime *dt = NULL;
g_warn_if_fail(!(flags & PURPLE_MESSAGE_SEND));
g_warn_if_fail(!(flags & PURPLE_MESSAGE_RECV));
flags |= PURPLE_MESSAGE_SYSTEM;
dt = g_date_time_new_now_local();
message = PURPLE_MESSAGE(g_object_new(PURPLE_TYPE_MESSAGE,
"contents", contents,
"timestamp", dt,
"flags", flags,
NULL));
g_date_time_unref(dt);
return message;
}
const gchar *
purple_message_get_id(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), 0);
return message->id;
}
const gchar *
purple_message_get_author(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
return message->author;
}
void
purple_message_set_author_name_color(PurpleMessage *message,
const gchar *color)
{
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_free(message->author_name_color);
message->author_name_color = g_strdup(color);
g_object_notify_by_pspec(G_OBJECT(message),
properties[PROP_AUTHOR_NAME_COLOR]);
}
const gchar *
purple_message_get_author_name_color(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
return message->author_name_color;
}
void
purple_message_set_recipient(PurpleMessage *message, const gchar *recipient) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_free(message->recipient);
message->recipient = g_strdup(recipient);
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_RECIPIENT]);
}
const gchar *
purple_message_get_recipient(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
return message->recipient;
}
void
purple_message_set_author_alias(PurpleMessage *message,
const gchar *author_alias)
{
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_free(message->author_alias);
message->author_alias = g_strdup(author_alias);
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_AUTHOR_ALIAS]);
}
const gchar *
purple_message_get_author_alias(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
if (message->author_alias == NULL)
return purple_message_get_author(message);
return message->author_alias;
}
void
purple_message_set_contents(PurpleMessage *message, const gchar *contents) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_free(message->contents);
message->contents = g_strdup(contents);
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_CONTENTS]);
}
const gchar *
purple_message_get_contents(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
return message->contents;
}
void
purple_message_set_content_type(PurpleMessage *message,
PurpleMessageContentType content_type)
{
g_return_if_fail(PURPLE_IS_MESSAGE(message));
message->content_type = content_type;
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_CONTENT_TYPE]);
}
PurpleMessageContentType
purple_message_get_content_type(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message),
PURPLE_MESSAGE_CONTENT_TYPE_PLAIN);
return message->content_type;
}
gboolean
purple_message_is_empty(PurpleMessage *message) {
return (message->contents == NULL || message->contents[0] == '\0');
}
void
purple_message_set_timestamp(PurpleMessage *message, GDateTime *timestamp) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_clear_pointer(&message->timestamp, g_date_time_unref);
if(timestamp != NULL) {
message->timestamp = g_date_time_ref(timestamp);
}
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_TIMESTAMP]);
}
GDateTime *
purple_message_get_timestamp(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), 0);
if(message->timestamp == NULL) {
GDateTime *dt = g_date_time_new_now_local();
purple_message_set_timestamp(message, dt);
g_date_time_unref(dt);
}
return message->timestamp;
}
gchar *
purple_message_format_timestamp(PurpleMessage *message, const gchar *format) {
GDateTime *dt = NULL;
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
g_return_val_if_fail(format != NULL, NULL);
dt = purple_message_get_timestamp(message);
return g_date_time_format(dt, format);
}
void
purple_message_set_flags(PurpleMessage *message, PurpleMessageFlags flags) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
message->flags = flags;
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_FLAGS]);
}
PurpleMessageFlags
purple_message_get_flags(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), 0);
return message->flags;
}
void
purple_message_set_error(PurpleMessage *message, GError *error) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_clear_error(&message->error);
if(error != NULL) {
g_propagate_error(&message->error, error);
}
g_object_notify_by_pspec(G_OBJECT(message), properties[PROP_ERROR]);
}
GError *
purple_message_get_error(PurpleMessage *message) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
return message->error;
}
gboolean
purple_message_add_attachment(PurpleMessage *message,
PurpleAttachment *attachment)
{
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), FALSE);
g_return_val_if_fail(PURPLE_IS_ATTACHMENT(attachment), FALSE);
return g_hash_table_insert(message->attachments,
purple_attachment_get_hash_key(attachment),
g_object_ref(G_OBJECT(attachment)));
}
gboolean
purple_message_remove_attachment(PurpleMessage *message, guint64 id) {
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), FALSE);
return g_hash_table_remove(message->attachments, &id);
}
PurpleAttachment *
purple_message_get_attachment(PurpleMessage *message, guint64 id) {
PurpleAttachment *attachment = NULL;
g_return_val_if_fail(PURPLE_IS_MESSAGE(message), NULL);
attachment = g_hash_table_lookup(message->attachments, &id);
if(PURPLE_IS_ATTACHMENT(attachment)) {
return PURPLE_ATTACHMENT(g_object_ref(G_OBJECT(attachment)));
}
return NULL;
}
void
purple_message_foreach_attachment(PurpleMessage *message,
PurpleAttachmentForeachFunc func,
gpointer data)
{
GHashTableIter iter;
gpointer value;
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_return_if_fail(func != NULL);
g_hash_table_iter_init(&iter, message->attachments);
while(g_hash_table_iter_next(&iter, NULL, &value)) {
func(PURPLE_ATTACHMENT(value), data);
}
}
void
purple_message_clear_attachments(PurpleMessage *message) {
g_return_if_fail(PURPLE_IS_MESSAGE(message));
g_hash_table_remove_all(message->attachments);
}