pidgin/pidgin

GSoC History API including sqlite history adapter

2021-10-12, James Culver
741992355ead
GSoC History API including sqlite history adapter

The History API has been created to drive all message handling in purple3. It will be used to update existing messages for edits, reactions, pinning, read/deliver receipts, etc. The API uses an adapter pattern, to abstract out backends, but provides a SQLite3 backend by default.

It also provides search capabilities using a custom query language that can easily be expanded over time. It will be use by both the end user to search messages and the frontends to implement features like a pinned messages button. A command line utility is also provided for searching outside of the program itself.

## Remaining Items

**These all will most likely be done by the Pidgin core team after GSoC when we figure out exactly how to solve them.**

Need to store database in purple config directory
* Gary has spent some time looking at this and it looks like the purple-history cli will need to become a purple-ui to make this work write as in the future other adapters will be plugins.

Other things to consider:
- For simplicity, the SqliteHistoryAdapter is parsing the query itself, but for consistency having `PurpleHistoryAdapter` parse the query and pass tokens to the subclass might be something we want to do.

Testing Done:
## Unit Tests
History Manager
History Adapter

## Integration Tests
purplehistorycore created for integration tests.
PurpleSqliteHistoryAdapter functionality tested:
- Creates proper db schema
- Writes logs
- Reads logs
- Queries using query language
- Deletes using query language

Bugs closed: PIDGIN-17526, PIDGIN-17532, PIDGIN-17533, PIDGIN-17534

Reviewed at https://reviews.imfreedom.org/r/877/
/* purple
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#include "internal.h"
#include "prefs.h"
#include "purpleaccountoption.h"
#include "purplekeyvaluepair.h"
/*
* An option for an account.
*
* This is set by protocols, and appears in the account settings
* dialogs.
*/
struct _PurpleAccountOption
{
PurplePrefType type; /* The type of value. */
gchar *text; /* The text that will appear to the user. */
gchar *pref_name; /* The name of the associated preference. */
union
{
gboolean boolean; /* The default boolean value. */
gint integer; /* The default integer value. */
gchar *string; /* The default string value. */
GList *list; /* The default list value. */
} default_value;
union
{
struct
{
gboolean masked; /* Whether the value entered should
* be obscured from view (for
* passwords and similar options)
*/
GSList *hints; /* List of hinted values */
} string;
} params;
};
G_DEFINE_BOXED_TYPE(
PurpleAccountOption,
purple_account_option,
purple_account_option_copy,
purple_account_option_destroy
);
PurpleAccountOption *
purple_account_option_new(PurplePrefType type, const char *text,
const char *pref_name)
{
PurpleAccountOption *option;
g_return_val_if_fail(type != PURPLE_PREF_NONE, NULL);
g_return_val_if_fail(text != NULL, NULL);
g_return_val_if_fail(pref_name != NULL, NULL);
option = g_new0(PurpleAccountOption, 1);
option->type = type;
option->text = g_strdup(text);
option->pref_name = g_strdup(pref_name);
return option;
}
PurpleAccountOption *
purple_account_option_copy(PurpleAccountOption *option) {
PurpleAccountOption *opt = NULL;
g_return_val_if_fail(option, NULL);
opt = g_new0(PurpleAccountOption, 1);
*opt = *option;
opt->text = g_strdup(option->text);
opt->pref_name = g_strdup(option->pref_name);
if(opt->type == PURPLE_PREF_STRING) {
opt->default_value.string = g_strdup(option->default_value.string);
opt->params.string.hints = g_slist_copy(option->params.string.hints);
}
return opt;
}
PurpleAccountOption *
purple_account_option_bool_new(const char *text, const char *pref_name,
gboolean default_value)
{
PurpleAccountOption *option;
option = purple_account_option_new(PURPLE_PREF_BOOLEAN, text, pref_name);
if (option == NULL)
return NULL;
option->default_value.boolean = default_value;
return option;
}
PurpleAccountOption *
purple_account_option_int_new(const char *text, const char *pref_name,
int default_value)
{
PurpleAccountOption *option;
option = purple_account_option_new(PURPLE_PREF_INT, text, pref_name);
if (option == NULL)
return NULL;
option->default_value.integer = default_value;
return option;
}
PurpleAccountOption *
purple_account_option_string_new(const char *text, const char *pref_name,
const char *default_value)
{
PurpleAccountOption *option;
option = purple_account_option_new(PURPLE_PREF_STRING, text, pref_name);
if (option == NULL)
return NULL;
option->default_value.string = g_strdup(default_value);
return option;
}
PurpleAccountOption *
purple_account_option_list_new(const char *text, const char *pref_name,
GList *list)
{
PurpleAccountOption *option;
option = purple_account_option_new(PURPLE_PREF_STRING_LIST, text, pref_name);
if (option == NULL)
return NULL;
option->default_value.list = list;
return option;
}
void
purple_account_option_destroy(PurpleAccountOption *option)
{
g_return_if_fail(option != NULL);
g_free(option->text);
g_free(option->pref_name);
if (option->type == PURPLE_PREF_STRING)
{
g_free(option->default_value.string);
g_slist_free_full(option->params.string.hints, &g_free);
}
else if (option->type == PURPLE_PREF_STRING_LIST)
{
g_list_free_full(option->default_value.list,
(GDestroyNotify)purple_key_value_pair_free);
}
g_free(option);
}
void
purple_account_option_set_default_bool(PurpleAccountOption *option,
gboolean value)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_BOOLEAN);
option->default_value.boolean = value;
}
void
purple_account_option_set_default_int(PurpleAccountOption *option, int value)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_INT);
option->default_value.integer = value;
}
void
purple_account_option_set_default_string(PurpleAccountOption *option,
const char *value)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_STRING);
g_free(option->default_value.string);
option->default_value.string = g_strdup(value);
}
void
purple_account_option_string_set_masked(PurpleAccountOption *option, gboolean masked)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_STRING);
option->params.string.masked = masked;
}
void
purple_account_option_string_set_hints(PurpleAccountOption *option, GSList *hints)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_STRING);
g_slist_free_full(option->params.string.hints, &g_free);
option->params.string.hints = hints;
}
void
purple_account_option_set_list(PurpleAccountOption *option, GList *values)
{
g_return_if_fail(option != NULL);
g_return_if_fail(option->type == PURPLE_PREF_STRING_LIST);
g_list_free_full(option->default_value.list,
(GDestroyNotify)purple_key_value_pair_free);
option->default_value.list = values;
}
void
purple_account_option_add_list_item(PurpleAccountOption *option,
const char *key, const char *value)
{
PurpleKeyValuePair *kvp;
g_return_if_fail(option != NULL);
g_return_if_fail(key != NULL);
g_return_if_fail(value != NULL);
g_return_if_fail(option->type == PURPLE_PREF_STRING_LIST);
kvp = purple_key_value_pair_new_full(key, g_strdup(value), g_free);
option->default_value.list = g_list_append(option->default_value.list,
kvp);
}
PurplePrefType
purple_account_option_get_pref_type(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, PURPLE_PREF_NONE);
return option->type;
}
const char *
purple_account_option_get_text(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, NULL);
return option->text;
}
const char *
purple_account_option_get_setting(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, NULL);
return option->pref_name;
}
gboolean
purple_account_option_get_default_bool(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, FALSE);
g_return_val_if_fail(option->type == PURPLE_PREF_BOOLEAN, FALSE);
return option->default_value.boolean;
}
int
purple_account_option_get_default_int(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, -1);
g_return_val_if_fail(option->type == PURPLE_PREF_INT, -1);
return option->default_value.integer;
}
const char *
purple_account_option_get_default_string(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, NULL);
g_return_val_if_fail(option->type == PURPLE_PREF_STRING, NULL);
return option->default_value.string;
}
const char *
purple_account_option_get_default_list_value(const PurpleAccountOption *option)
{
PurpleKeyValuePair *kvp;
g_return_val_if_fail(option != NULL, NULL);
g_return_val_if_fail(option->type == PURPLE_PREF_STRING_LIST, NULL);
if (option->default_value.list == NULL)
return NULL;
kvp = option->default_value.list->data;
return (kvp ? kvp->value : NULL);
}
gboolean
purple_account_option_string_get_masked(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, FALSE);
g_return_val_if_fail(option->type == PURPLE_PREF_STRING, FALSE);
return option->params.string.masked;
}
const GSList *
purple_account_option_string_get_hints(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, NULL);
g_return_val_if_fail(option->type == PURPLE_PREF_STRING, NULL);
return option->params.string.hints;
}
GList *
purple_account_option_get_list(const PurpleAccountOption *option)
{
g_return_val_if_fail(option != NULL, NULL);
g_return_val_if_fail(option->type == PURPLE_PREF_STRING_LIST, NULL);
return option->default_value.list;
}