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/
/* pidgin
*
* 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 <purple.h>
#include "gtkblist.h"
#include "gtkconn.h"
#include "gtkdialogs.h"
#include "gtkstatusbox.h"
#include "pidgincore.h"
#include "gtkutils.h"
#define INITIAL_RECON_DELAY_MIN 8
#define INITIAL_RECON_DELAY_MAX 60
#define MAX_RECON_DELAY 600
#define MAX_RACCOON_DELAY "shorter in urban areas"
typedef struct {
int delay;
guint timeout;
} PidginAutoRecon;
/*
* Contains accounts that are auto-reconnecting.
* The key is a pointer to the PurpleAccount and the
* value is a pointer to a PidginAutoRecon.
*/
static GHashTable *auto_reconns = NULL;
static void
pidgin_connection_connect_progress(PurpleConnection *gc,
const char *text, size_t step, size_t step_count)
{
PidginBuddyList *gtkblist = pidgin_blist_get_default_gtk_blist();
if (!gtkblist)
return;
pidgin_status_box_set_connecting(PIDGIN_STATUS_BOX(gtkblist->statusbox),
(purple_connections_get_connecting() != NULL));
}
static void
pidgin_connection_connected(PurpleConnection *gc)
{
PurpleAccount *account;
PidginBuddyList *gtkblist;
account = purple_connection_get_account(gc);
gtkblist = pidgin_blist_get_default_gtk_blist();
if (gtkblist != NULL)
pidgin_status_box_set_connecting(PIDGIN_STATUS_BOX(gtkblist->statusbox),
(purple_connections_get_connecting() != NULL));
g_hash_table_remove(auto_reconns, account);
}
static void
pidgin_connection_disconnected(PurpleConnection *gc)
{
PidginBuddyList *gtkblist = pidgin_blist_get_default_gtk_blist();
if (!gtkblist)
return;
pidgin_status_box_set_connecting(PIDGIN_STATUS_BOX(gtkblist->statusbox),
(purple_connections_get_connecting() != NULL));
if (purple_connections_get_all() != NULL)
return;
pidgin_dialogs_destroy_all();
}
static void
free_auto_recon(gpointer data)
{
PidginAutoRecon *info = data;
if (info->timeout != 0)
g_source_remove(info->timeout);
g_free(info);
}
static gboolean
do_signon(gpointer data)
{
PurpleAccount *account = data;
PidginAutoRecon *info;
PurpleStatus *status;
purple_debug_info("autorecon", "do_signon called\n");
g_return_val_if_fail(account != NULL, FALSE);
info = g_hash_table_lookup(auto_reconns, account);
if (info)
info->timeout = 0;
status = purple_account_get_active_status(account);
if (purple_status_is_online(status))
{
purple_debug_info("autorecon", "calling purple_account_connect\n");
purple_account_connect(account);
purple_debug_info("autorecon", "done calling purple_account_connect\n");
}
return FALSE;
}
static void
pidgin_connection_report_disconnect(PurpleConnection *gc,
PurpleConnectionError reason,
const char *text)
{
PurpleAccount *account = NULL;
PidginAutoRecon *info;
account = purple_connection_get_account(gc);
info = g_hash_table_lookup(auto_reconns, account);
if (!purple_connection_error_is_fatal (reason)) {
if (info == NULL) {
info = g_new0(PidginAutoRecon, 1);
g_hash_table_insert(auto_reconns, account, info);
info->delay = g_random_int_range(INITIAL_RECON_DELAY_MIN, INITIAL_RECON_DELAY_MAX);
} else {
info->delay = MIN(2 * info->delay, MAX_RECON_DELAY);
if (info->timeout != 0)
g_source_remove(info->timeout);
}
info->timeout = g_timeout_add_seconds(info->delay, do_signon, account);
} else {
if (info != NULL)
g_hash_table_remove(auto_reconns, account);
purple_account_set_enabled(account, PIDGIN_UI, FALSE);
}
}
static void pidgin_connection_network_connected (void)
{
GList *list, *l;
l = list = purple_accounts_get_all_active();
while (l) {
PurpleAccount *account = (PurpleAccount*)l->data;
g_hash_table_remove(auto_reconns, account);
if (purple_account_is_disconnected(account))
do_signon(account);
l = l->next;
}
g_list_free(list);
}
static void pidgin_connection_network_disconnected (void)
{
GList *list, *l;
l = list = purple_accounts_get_all_active();
while (l) {
PurpleAccount *a = (PurpleAccount*)l->data;
if (!purple_account_is_disconnected(a)) {
purple_account_disconnect(a);
}
l = l->next;
}
g_list_free(list);
}
static void pidgin_connection_notice(PurpleConnection *gc, const char *text)
{ }
static PurpleConnectionUiOps conn_ui_ops =
{
pidgin_connection_connect_progress,
pidgin_connection_connected,
pidgin_connection_disconnected,
pidgin_connection_notice,
pidgin_connection_network_connected,
pidgin_connection_network_disconnected,
pidgin_connection_report_disconnect,
NULL,
NULL,
NULL,
NULL
};
PurpleConnectionUiOps *
pidgin_connections_get_ui_ops(void)
{
return &conn_ui_ops;
}
static void
account_removed_cb(PurpleAccount *account, gpointer user_data)
{
g_hash_table_remove(auto_reconns, account);
}
/**************************************************************************
* GTK connection glue
**************************************************************************/
void *
pidgin_connection_get_handle(void)
{
static int handle;
return &handle;
}
void
pidgin_connection_init(void)
{
auto_reconns = g_hash_table_new_full(
g_direct_hash, g_direct_equal,
NULL, free_auto_recon);
purple_signal_connect(purple_accounts_get_handle(), "account-removed",
pidgin_connection_get_handle(),
PURPLE_CALLBACK(account_removed_cb), NULL);
}
void
pidgin_connection_uninit(void)
{
purple_signals_disconnect_by_handle(pidgin_connection_get_handle());
g_hash_table_destroy(auto_reconns);
}