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/
/*
* Themes for libpurple
*
* Pidgin 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 "theme-manager.h"
#include "util.h"
struct _PurpleThemeManager {
GObject parent;
};
/******************************************************************************
* Globals
*****************************************************************************/
static GHashTable *theme_table = NULL;
/*****************************************************************************
* GObject Stuff
****************************************************************************/
GType
purple_theme_manager_get_type(void)
{
static GType type = 0;
if (type == 0) {
static const GTypeInfo info = {
sizeof(PurpleThemeManagerClass),
NULL, /* base_init */
NULL, /* base_finalize */
NULL, /* class_init */
NULL, /* class_finalize */
NULL, /* class_data */
sizeof(PurpleThemeManager),
0, /* n_preallocs */
NULL, /* instance_init */
NULL, /* Value Table */
};
type = g_type_register_static(G_TYPE_OBJECT,
"PurpleThemeManager", &info, 0);
}
return type;
}
/******************************************************************************
* Helpers
*****************************************************************************/
/* makes a key of <type> + '/' + <name> */
static gchar *
purple_theme_manager_make_key(const gchar *name, const gchar *type)
{
g_return_val_if_fail(name && *name, NULL);
g_return_val_if_fail(type && *type, NULL);
return g_strconcat(type, "/", name, NULL);
}
/* returns TRUE if theme is of type "user_data" */
static gboolean
purple_theme_manager_is_theme_type(gchar *key,
gpointer value,
gchar *user_data)
{
return g_str_has_prefix(key, g_strconcat(user_data, "/", NULL));
}
static gboolean
check_if_theme_or_loader(gchar *key, gpointer value, GSList **loaders)
{
if (PURPLE_IS_THEME(value))
return TRUE;
else if (PURPLE_IS_THEME_LOADER(value))
*loaders = g_slist_prepend(*loaders, value);
return FALSE;
}
static void
purple_theme_manager_function_wrapper(gchar *key,
gpointer value,
PurpleThemeFunc user_data)
{
if (PURPLE_IS_THEME(value))
(* user_data)(value);
}
static void
purple_theme_manager_build_dir(GSList *loaders, const gchar *root)
{
gchar *theme_dir;
const gchar *name;
GDir *rdir;
GSList *tmp;
PurpleThemeLoader *loader;
rdir = g_dir_open(root, 0, NULL);
if (!rdir)
return;
while ((name = g_dir_read_name(rdir))) {
theme_dir = g_build_filename(root, name, NULL);
for (tmp = loaders; tmp; tmp = g_slist_next(tmp)) {
loader = PURPLE_THEME_LOADER(tmp->data);
if (purple_theme_loader_probe(loader, theme_dir)) {
PurpleTheme *theme = purple_theme_loader_build(loader, theme_dir);
if (PURPLE_IS_THEME(theme))
purple_theme_manager_add_theme(theme);
}
}
g_free(theme_dir);
}
g_dir_close(rdir);
}
/*****************************************************************************
* Public API functions
*****************************************************************************/
void
purple_theme_manager_init(void)
{
theme_table = g_hash_table_new_full(g_str_hash,
g_str_equal, g_free, g_object_unref);
}
void
purple_theme_manager_refresh(void)
{
gchar *path;
const gchar *const *xdg_dirs;
gint i;
GSList *loaders = NULL;
g_hash_table_foreach_remove(theme_table, (GHRFunc)check_if_theme_or_loader,
&loaders);
/* Add themes from ~/.purple */
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
path = g_build_filename(purple_user_dir(), "themes", NULL);
G_GNUC_END_IGNORE_DEPRECATIONS
purple_theme_manager_build_dir(loaders, path);
g_free(path);
/* look for XDG_DATA_HOME */
/* NOTE: will work on Windows, see g_get_user_data_dir() documentation */
path = g_build_filename(g_get_user_data_dir(), "themes", NULL);
purple_theme_manager_build_dir(loaders, path);
g_free(path);
/* now dig through XDG_DATA_DIRS and add those too */
/* NOTE: will work on Windows, see g_get_system_data_dirs() documentation */
xdg_dirs = g_get_system_data_dirs();
for (i = 0; xdg_dirs[i] != NULL; i++) {
path = g_build_filename(xdg_dirs[i], "themes", NULL);
purple_theme_manager_build_dir(loaders, path);
g_free(path);
}
g_slist_free(loaders);
}
void
purple_theme_manager_uninit(void)
{
g_hash_table_destroy(theme_table);
}
void
purple_theme_manager_register_type(PurpleThemeLoader *loader)
{
gchar *type;
g_return_if_fail(PURPLE_IS_THEME_LOADER(loader));
type = g_strdup(purple_theme_loader_get_type_string(loader));
g_return_if_fail(type);
/* if something is already there do nothing */
if (!g_hash_table_lookup(theme_table, type))
g_hash_table_insert(theme_table, type, loader);
}
void
purple_theme_manager_unregister_type(PurpleThemeLoader *loader)
{
const gchar *type;
g_return_if_fail(PURPLE_IS_THEME_LOADER(loader));
type = purple_theme_loader_get_type_string(loader);
g_return_if_fail(type);
if (g_hash_table_lookup(theme_table, type) == loader)
{
g_hash_table_remove(theme_table, type);
g_hash_table_foreach_remove(theme_table,
(GHRFunc)purple_theme_manager_is_theme_type, (gpointer)type);
} /* only free if given registered loader */
}
PurpleTheme *
purple_theme_manager_find_theme(const gchar *name,
const gchar *type)
{
gchar *key;
PurpleTheme *theme;
key = purple_theme_manager_make_key(name, type);
g_return_val_if_fail(key, NULL);
theme = g_hash_table_lookup(theme_table, key);
g_free(key);
return theme;
}
void
purple_theme_manager_add_theme(PurpleTheme *theme)
{
gchar *key;
g_return_if_fail(PURPLE_IS_THEME(theme));
key = purple_theme_manager_make_key(purple_theme_get_name(theme),
purple_theme_get_type_string(theme));
g_return_if_fail(key);
/* if something is already there do nothing */
if (g_hash_table_lookup(theme_table, key) == NULL)
g_hash_table_insert(theme_table, key, theme);
}
void
purple_theme_manager_remove_theme(PurpleTheme *theme)
{
gchar *key;
g_return_if_fail(PURPLE_IS_THEME(theme));
key = purple_theme_manager_make_key(purple_theme_get_name(theme),
purple_theme_get_type_string(theme));
g_return_if_fail(key);
g_hash_table_remove(theme_table, key);
g_free(key);
}
void
purple_theme_manager_for_each_theme(PurpleThemeFunc func)
{
g_return_if_fail(func);
g_hash_table_foreach(theme_table,
(GHFunc) purple_theme_manager_function_wrapper, func);
}
PurpleTheme *
purple_theme_manager_load_theme(const gchar *theme_dir, const gchar *type)
{
PurpleThemeLoader *loader;
g_return_val_if_fail(theme_dir != NULL && type != NULL, NULL);
loader = g_hash_table_lookup(theme_table, type);
g_return_val_if_fail(PURPLE_IS_THEME_LOADER(loader), NULL);
return purple_theme_loader_build(loader, theme_dir);
}