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/
/*
* finch
*
* Finch 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 <glib/gi18n-lib.h>
#include <purple.h>
#include <gnt.h>
#include "gntxfer.h"
typedef struct
{
gboolean keep_open;
gboolean auto_clear;
gint num_transfers;
GntWidget *window;
GntWidget *tree;
GntWidget *remove_button;
GntWidget *stop_button;
GntWidget *close_button;
} PurpleGntXferDialog;
static PurpleGntXferDialog *xfer_dialog = NULL;
#define UI_DATA "finch-ui-data"
typedef struct
{
gint64 last_updated_time;
gboolean notified; /* Has the completion of the transfer been notified? */
} PurpleGntXferUiData;
enum
{
COLUMN_PROGRESS = 0,
COLUMN_FILENAME,
COLUMN_SIZE,
COLUMN_SPEED,
COLUMN_REMAINING,
COLUMN_STATUS,
NUM_COLUMNS
};
/**************************************************************************
* Utility Functions
**************************************************************************/
static void
update_title_progress(void)
{
GList *list;
int num_active_xfers = 0;
guint64 total_bytes_xferred = 0;
guint64 total_file_size = 0;
if (xfer_dialog == NULL || xfer_dialog->window == NULL)
return;
/* Find all active transfers */
for (list = gnt_tree_get_rows(GNT_TREE(xfer_dialog->tree)); list; list = list->next) {
PurpleXfer *xfer = (PurpleXfer *)list->data;
if (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_STARTED) {
num_active_xfers++;
total_bytes_xferred += purple_xfer_get_bytes_sent(xfer);
total_file_size += purple_xfer_get_size(xfer);
}
}
/* Update the title */
if (num_active_xfers > 0) {
gchar *title;
int total_pct = 0;
if (total_file_size > 0) {
total_pct = 100 * total_bytes_xferred / total_file_size;
}
title = g_strdup_printf(ngettext("File Transfers - %d%% of %d file",
"File Transfers - %d%% of %d files",
num_active_xfers),
total_pct, num_active_xfers);
gnt_screen_rename_widget((xfer_dialog->window), title);
g_free(title);
} else {
gnt_screen_rename_widget((xfer_dialog->window), _("File Transfers"));
}
}
/**************************************************************************
* Callbacks
**************************************************************************/
static void
toggle_keep_open_cb(GntWidget *w)
{
xfer_dialog->keep_open = !xfer_dialog->keep_open;
purple_prefs_set_bool("/finch/filetransfer/keep_open",
xfer_dialog->keep_open);
}
static void
toggle_clear_finished_cb(GntWidget *w)
{
xfer_dialog->auto_clear = !xfer_dialog->auto_clear;
purple_prefs_set_bool("/finch/filetransfer/clear_finished",
xfer_dialog->auto_clear);
if (xfer_dialog->auto_clear) {
GList *iter = purple_xfers_get_all();
while (iter) {
PurpleXfer *xfer = iter->data;
iter = iter->next;
if (purple_xfer_is_completed(xfer) || purple_xfer_is_cancelled(xfer))
finch_xfer_dialog_remove_xfer(xfer);
}
}
}
static void
remove_button_cb(GntButton *button)
{
PurpleXfer *selected_xfer = gnt_tree_get_selection_data(GNT_TREE(xfer_dialog->tree));
if (selected_xfer && (purple_xfer_is_completed(selected_xfer) ||
purple_xfer_is_cancelled(selected_xfer))) {
finch_xfer_dialog_remove_xfer(selected_xfer);
}
}
static void
stop_button_cb(GntButton *button)
{
PurpleXfer *selected_xfer = gnt_tree_get_selection_data(GNT_TREE(xfer_dialog->tree));
PurpleXferStatus status;
if (!selected_xfer)
return;
status = purple_xfer_get_status(selected_xfer);
if (status != PURPLE_XFER_STATUS_CANCEL_LOCAL &&
status != PURPLE_XFER_STATUS_CANCEL_REMOTE &&
status != PURPLE_XFER_STATUS_DONE)
purple_xfer_cancel_local(selected_xfer);
}
/**************************************************************************
* Dialog Building Functions
**************************************************************************/
void
finch_xfer_dialog_new(void)
{
GList *iter;
GntWidget *window;
GntWidget *bbox;
GntWidget *button;
GntWidget *checkbox;
GntWidget *tree;
int widths[] = {8, 12, 8, 8, 8, 8, -1};
if (!xfer_dialog)
xfer_dialog = g_new0(PurpleGntXferDialog, 1);
xfer_dialog->keep_open =
purple_prefs_get_bool("/finch/filetransfer/keep_open");
xfer_dialog->auto_clear =
purple_prefs_get_bool("/finch/filetransfer/clear_finished");
/* Create the window. */
xfer_dialog->window = window = gnt_vbox_new(FALSE);
g_signal_connect(G_OBJECT(window), "destroy", G_CALLBACK(finch_xfer_dialog_destroy), NULL);
gnt_box_set_toplevel(GNT_BOX(window), TRUE);
gnt_box_set_title(GNT_BOX(window), _("File Transfers"));
gnt_box_set_fill(GNT_BOX(window), TRUE);
gnt_box_set_alignment(GNT_BOX(window), GNT_ALIGN_MID);
xfer_dialog->tree = tree = gnt_tree_new_with_columns(NUM_COLUMNS);
gnt_tree_set_column_titles(GNT_TREE(tree), _("Progress"), _("Filename"), _("Size"), _("Speed"), _("Remaining"), _("Status"));
gnt_tree_set_column_width_ratio(GNT_TREE(tree), widths);
gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_PROGRESS, FALSE);
gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_SIZE, FALSE);
gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_SPEED, FALSE);
gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_REMAINING, FALSE);
gnt_widget_set_size(tree, 70, -1);
gnt_tree_set_show_title(GNT_TREE(tree), TRUE);
gnt_box_add_widget(GNT_BOX(window), tree);
checkbox = gnt_check_box_new( _("Close this window when all transfers finish"));
gnt_check_box_set_checked(GNT_CHECK_BOX(checkbox),
!xfer_dialog->keep_open);
g_signal_connect(G_OBJECT(checkbox), "toggled",
G_CALLBACK(toggle_keep_open_cb), NULL);
gnt_box_add_widget(GNT_BOX(window), checkbox);
checkbox = gnt_check_box_new(_("Clear finished transfers"));
gnt_check_box_set_checked(GNT_CHECK_BOX(checkbox),
xfer_dialog->auto_clear);
g_signal_connect(G_OBJECT(checkbox), "toggled",
G_CALLBACK(toggle_clear_finished_cb), NULL);
gnt_box_add_widget(GNT_BOX(window), checkbox);
bbox = gnt_hbox_new(FALSE);
xfer_dialog->remove_button = button = gnt_button_new(_("Remove"));
g_signal_connect(G_OBJECT(button), "activate",
G_CALLBACK(remove_button_cb), NULL);
gnt_box_add_widget(GNT_BOX(bbox), button);
xfer_dialog->stop_button = button = gnt_button_new(_("Stop"));
g_signal_connect(G_OBJECT(button), "activate",
G_CALLBACK(stop_button_cb), NULL);
gnt_box_add_widget(GNT_BOX(bbox), button);
xfer_dialog->close_button = button = gnt_button_new(_("Close"));
g_signal_connect(G_OBJECT(button), "activate",
G_CALLBACK(finch_xfer_dialog_destroy), NULL);
gnt_box_add_widget(GNT_BOX(bbox), button);
gnt_box_add_widget(GNT_BOX(window), bbox);
for (iter = purple_xfers_get_all(); iter; iter = iter->next) {
PurpleXfer *xfer = (PurpleXfer *)iter->data;
if (purple_xfer_get_visible(xfer)) {
finch_xfer_dialog_add_xfer(xfer);
finch_xfer_dialog_update_xfer(xfer);
gnt_tree_set_selected(GNT_TREE(tree), xfer);
}
}
gnt_widget_show(xfer_dialog->window);
}
void
finch_xfer_dialog_destroy()
{
gnt_widget_destroy(xfer_dialog->window);
g_free(xfer_dialog);
xfer_dialog = NULL;
}
void
finch_xfer_dialog_show()
{
if (xfer_dialog == NULL)
finch_xfer_dialog_new();
else
gnt_window_present(xfer_dialog->window);
}
void
finch_xfer_dialog_add_xfer(PurpleXfer *xfer)
{
PurpleGntXferUiData *data;
PurpleXferType type;
char *size_str, *remaining_str;
char *lfilename, *utf8;
g_return_if_fail(xfer_dialog != NULL);
g_return_if_fail(xfer != NULL);
g_object_ref(xfer);
data = g_object_get_data(G_OBJECT(xfer), UI_DATA);
finch_xfer_dialog_show();
data->last_updated_time = 0;
type = purple_xfer_get_xfer_type(xfer);
size_str = g_format_size(purple_xfer_get_size(xfer));
remaining_str = g_format_size(purple_xfer_get_bytes_remaining(xfer));
lfilename = g_path_get_basename(purple_xfer_get_local_filename(xfer));
utf8 = g_filename_to_utf8(lfilename, -1, NULL, NULL, NULL);
g_free(lfilename);
lfilename = utf8;
gnt_tree_add_row_last(GNT_TREE(xfer_dialog->tree), xfer,
gnt_tree_create_row(GNT_TREE(xfer_dialog->tree),
"0.0", (type == PURPLE_XFER_TYPE_RECEIVE) ? purple_xfer_get_filename(xfer) : lfilename,
size_str, "0.0", "",_("Waiting for transfer to begin")), NULL);
g_free(lfilename);
g_free(size_str);
g_free(remaining_str);
xfer_dialog->num_transfers++;
update_title_progress();
}
void
finch_xfer_dialog_remove_xfer(PurpleXfer *xfer)
{
g_return_if_fail(xfer_dialog != NULL);
g_return_if_fail(xfer != NULL);
if (!purple_xfer_get_visible(xfer)) {
return;
}
purple_xfer_set_visible(xfer, FALSE);
gnt_tree_remove(GNT_TREE(xfer_dialog->tree), xfer);
xfer_dialog->num_transfers--;
if (xfer_dialog->num_transfers == 0 && !xfer_dialog->keep_open)
finch_xfer_dialog_destroy();
else
update_title_progress();
g_object_unref(xfer);
}
void
finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer)
{
PurpleGntXferUiData *data;
const gchar *status;
g_return_if_fail(xfer_dialog != NULL);
g_return_if_fail(xfer != NULL);
data = g_object_get_data(G_OBJECT(xfer), UI_DATA);
if (data == NULL)
return;
if (!purple_xfer_get_visible(xfer)) {
return;
}
if ((purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_CANCEL_LOCAL) && (xfer_dialog->auto_clear)) {
finch_xfer_dialog_remove_xfer(xfer);
return;
}
update_title_progress();
if (purple_xfer_is_cancelled(xfer))
status = _("Cancelled");
else
status = _("Failed");
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS, status);
}
void
finch_xfer_dialog_update_xfer(PurpleXfer *xfer)
{
PurpleGntXferUiData *data;
char *size_str, *remaining_str;
gint64 current_time;
char prog_str[G_ASCII_DTOSTR_BUF_SIZE];
double kb_sent;
double kbps = 0.0;
gint64 now;
gint64 elapsed = 0;
char *kbsec;
gboolean send;
if (purple_xfer_get_start_time(xfer) > 0) {
if ((now = purple_xfer_get_end_time(xfer)) == 0) {
now = g_get_monotonic_time();
}
elapsed = now - purple_xfer_get_start_time(xfer);
}
kb_sent = purple_xfer_get_bytes_sent(xfer) / 1000.0;
kbps = (elapsed > 0 ? (kb_sent * G_USEC_PER_SEC) / elapsed : 0);
g_return_if_fail(xfer_dialog != NULL);
g_return_if_fail(xfer != NULL);
data = g_object_get_data(G_OBJECT(xfer), UI_DATA);
if (data == NULL || !purple_xfer_get_visible(xfer) || data->notified) {
return;
}
current_time = g_get_monotonic_time();
if (((current_time - data->last_updated_time) < G_USEC_PER_SEC) &&
(!purple_xfer_is_completed(xfer))) {
/* Don't update the window more than once per second */
return;
}
data->last_updated_time = current_time;
send = (purple_xfer_get_xfer_type(xfer) == PURPLE_XFER_TYPE_SEND);
size_str = g_format_size(purple_xfer_get_size(xfer));
remaining_str = g_format_size(purple_xfer_get_bytes_remaining(xfer));
kbsec = g_strdup_printf(_("%.2f KB/s"), kbps);
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_PROGRESS,
g_ascii_dtostr(prog_str, G_ASCII_DTOSTR_BUF_SIZE, purple_xfer_get_progress(xfer) * 100.));
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_SIZE, size_str);
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_REMAINING, remaining_str);
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_SPEED, kbsec);
g_free(size_str);
g_free(remaining_str);
g_free(kbsec);
if (purple_xfer_is_completed(xfer)) {
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS, send ? _("Sent") : _("Received"));
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_REMAINING, _("Finished"));
if (!send) {
char *msg = g_strdup_printf(_("The file was saved as %s."), purple_xfer_get_local_filename(xfer));
purple_xfer_conversation_write(xfer, msg, FALSE);
g_free(msg);
}
data->notified = TRUE;
} else {
gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS,
send ? _("Sending") : _("Receiving"));
}
update_title_progress();
if (purple_xfer_is_completed(xfer) && xfer_dialog->auto_clear)
finch_xfer_dialog_remove_xfer(xfer);
}
/**************************************************************************
* File Transfer UI Ops
**************************************************************************/
static void
finch_xfer_progress_notify(PurpleXfer *xfer, G_GNUC_UNUSED GParamSpec *pspec,
G_GNUC_UNUSED gpointer data)
{
if (xfer_dialog) {
finch_xfer_dialog_update_xfer(xfer);
}
}
static void
finch_xfer_status_notify(PurpleXfer *xfer, G_GNUC_UNUSED GParamSpec *pspec,
G_GNUC_UNUSED gpointer data)
{
if (xfer_dialog) {
if (purple_xfer_is_cancelled(xfer)) {
finch_xfer_dialog_cancel_xfer(xfer);
}
}
}
static void
finch_xfer_visible_notify(PurpleXfer *xfer, G_GNUC_UNUSED GParamSpec *pspec,
G_GNUC_UNUSED gpointer data)
{
if (!purple_xfer_get_visible(xfer)) {
return;
}
if (!xfer_dialog)
finch_xfer_dialog_new();
finch_xfer_dialog_add_xfer(xfer);
gnt_tree_set_selected(GNT_TREE(xfer_dialog->tree), xfer);
}
static void
finch_xfer_new_xfer(PurpleXfer *xfer)
{
PurpleGntXferUiData *data;
/* This is where we're setting xfer's "ui_data" for the first time. */
data = g_new0(PurpleGntXferUiData, 1);
g_object_set_data_full(G_OBJECT(xfer), UI_DATA, data, g_free);
g_signal_connect(xfer, "notify::progress",
G_CALLBACK(finch_xfer_progress_notify), NULL);
g_signal_connect(xfer, "notify::status",
G_CALLBACK(finch_xfer_status_notify), NULL);
g_signal_connect(xfer, "notify::visible",
G_CALLBACK(finch_xfer_visible_notify), NULL);
}
static PurpleXferUiOps ops =
{
finch_xfer_new_xfer
};
/**************************************************************************
* GNT File Transfer API
**************************************************************************/
void
finch_xfers_init(void)
{
purple_prefs_add_none("/finch/filetransfer");
purple_prefs_add_bool("/finch/filetransfer/clear_finished", TRUE);
purple_prefs_add_bool("/finch/filetransfer/keep_open", FALSE);
}
void
finch_xfers_uninit(void)
{
if (xfer_dialog != NULL)
finch_xfer_dialog_destroy();
}
PurpleXferUiOps *
finch_xfers_get_ui_ops(void)
{
return &ops;
}