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 <config.h>
#include <glib.h>
#include <glib/gi18n-lib.h>
#include <glib/gstdio.h>
#include <purple.h>
#include <gnt.h>
#include "gntdebug.h"
#include <stdio.h>
#include <string.h>
#define PREF_ROOT "/finch/debug"
struct _FinchDebugUi
{
GObject parent;
/* Other members, including private data. */
};
static void finch_debug_ui_finalize(GObject *gobject);
static void finch_debug_ui_interface_init(PurpleDebugUiInterface *iface);
G_DEFINE_TYPE_WITH_CODE(FinchDebugUi, finch_debug_ui, G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE(PURPLE_TYPE_DEBUG_UI,
finch_debug_ui_interface_init));
static gboolean
handle_fprintf_stderr_cb(GIOChannel *source, GIOCondition cond, gpointer null)
{
gssize size;
char message[1024];
size = read(g_io_channel_unix_get_fd(source), message, sizeof(message) - 1);
if (size <= 0) {
/* Something bad probably happened elsewhere ... let's ignore */
} else {
message[size] = '\0';
g_log("stderr", G_LOG_LEVEL_WARNING, "%s", message);
}
return TRUE;
}
static void
handle_fprintf_stderr(gboolean stop)
{
GIOChannel *stderrch;
static int readhandle = -1;
int pipes[2];
if (stop) {
if (readhandle >= 0) {
g_source_remove(readhandle);
readhandle = -1;
}
return;
}
if (purple_input_pipe(pipes)) {
readhandle = -1;
return;
};
dup2(pipes[1], STDERR_FILENO);
stderrch = g_io_channel_unix_new(pipes[0]);
g_io_channel_set_close_on_unref(stderrch, TRUE);
readhandle = g_io_add_watch_full(stderrch, G_PRIORITY_HIGH,
G_IO_IN | G_IO_ERR | G_IO_PRI,
handle_fprintf_stderr_cb, NULL, NULL);
g_io_channel_unref(stderrch);
}
static struct
{
GntWidget *window;
GntWidget *tview;
GntWidget *search;
gboolean paused;
} debug;
static gboolean
match_string(const char *category, const char *args)
{
const char *str = gnt_entry_get_text(GNT_ENTRY(debug.search));
if (!str || !*str)
return TRUE;
if (g_strrstr(category, str) != NULL)
return TRUE;
if (g_strrstr(args, str) != NULL)
return TRUE;
return FALSE;
}
static void
finch_debug_print(PurpleDebugUi *self,
PurpleDebugLevel level, const char *category,
const char *args)
{
if (debug.window && !debug.paused && match_string(category, args))
{
int pos = gnt_text_view_get_lines_below(GNT_TEXT_VIEW(debug.tview));
GntTextFormatFlags flag = GNT_TEXT_FLAG_NORMAL;
const char *mdate;
time_t mtime = time(NULL);
mdate = purple_utf8_strftime("%H:%M:%S ", localtime(&mtime));
gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(debug.tview),
mdate, flag);
gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(debug.tview),
category, GNT_TEXT_FLAG_BOLD);
gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(debug.tview),
": ", GNT_TEXT_FLAG_BOLD);
switch (level)
{
case PURPLE_DEBUG_WARNING:
flag |= GNT_TEXT_FLAG_UNDERLINE;
/* fall through */
case PURPLE_DEBUG_ERROR:
case PURPLE_DEBUG_FATAL:
flag |= GNT_TEXT_FLAG_BOLD;
break;
default:
break;
}
gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(debug.tview), args, flag);
gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(debug.tview), "\n", GNT_TEXT_FLAG_NORMAL);
if (pos <= 1)
gnt_text_view_scroll(GNT_TEXT_VIEW(debug.tview), 0);
}
}
static gboolean
finch_debug_is_enabled(PurpleDebugUi *self, PurpleDebugLevel level, const char *category)
{
return debug.window && !debug.paused;
}
static void
finch_debug_ui_interface_init(PurpleDebugUiInterface *iface)
{
iface->print = finch_debug_print;
iface->is_enabled = finch_debug_is_enabled;
}
static void
reset_debug_win(GntWidget *w, gpointer null)
{
debug.window = debug.tview = debug.search = NULL;
}
static void
clear_debug_win(GntWidget *w, GntTextView *tv)
{
gnt_text_view_clear(tv);
}
static void
print_stderr(const char *string)
{
g_printerr("%s", string);
}
static void
toggle_pause(GntWidget *w, gpointer n)
{
debug.paused = !debug.paused;
}
/* Xerox */
static void
purple_glib_log_handler(const gchar *domain, GLogLevelFlags flags,
const gchar *msg, gpointer user_data)
{
PurpleDebugLevel level;
char *new_msg = NULL;
char *new_domain = NULL;
if ((flags & G_LOG_LEVEL_ERROR) == G_LOG_LEVEL_ERROR)
level = PURPLE_DEBUG_ERROR;
else if ((flags & G_LOG_LEVEL_CRITICAL) == G_LOG_LEVEL_CRITICAL)
level = PURPLE_DEBUG_FATAL;
else if ((flags & G_LOG_LEVEL_WARNING) == G_LOG_LEVEL_WARNING)
level = PURPLE_DEBUG_WARNING;
else if ((flags & G_LOG_LEVEL_MESSAGE) == G_LOG_LEVEL_MESSAGE)
level = PURPLE_DEBUG_INFO;
else if ((flags & G_LOG_LEVEL_INFO) == G_LOG_LEVEL_INFO)
level = PURPLE_DEBUG_INFO;
else if ((flags & G_LOG_LEVEL_DEBUG) == G_LOG_LEVEL_DEBUG)
level = PURPLE_DEBUG_MISC;
else
{
purple_debug_warning("gntdebug",
"Unknown glib logging level in %d\n", flags);
level = PURPLE_DEBUG_MISC; /* This will never happen. */
}
if (msg != NULL)
new_msg = purple_utf8_try_convert(msg);
if (domain != NULL)
new_domain = purple_utf8_try_convert(domain);
if (new_msg != NULL)
{
purple_debug(level, (new_domain != NULL) ? new_domain : "g_log", "%s", new_msg);
g_free(new_msg);
}
g_free(new_domain);
}
static void
size_changed_cb(GntWidget *widget, int oldw, int oldh)
{
int w, h;
gnt_widget_get_size(widget, &w, &h);
purple_prefs_set_int(PREF_ROOT "/size/width", w);
purple_prefs_set_int(PREF_ROOT "/size/height", h);
}
static gboolean
for_real(gpointer entry)
{
purple_prefs_set_string(PREF_ROOT "/filter", gnt_entry_get_text(entry));
return FALSE;
}
static void
update_filter_string(GntEntry *entry, gpointer null)
{
int id = g_timeout_add_seconds(1, for_real, entry);
g_object_set_data_full(G_OBJECT(entry), "update-filter", GINT_TO_POINTER(id),
(GDestroyNotify)g_source_remove);
}
static void
file_save(GntFileSel *fs, const char *path, const char *file, GntTextView *tv)
{
FILE *fp;
if ((fp = g_fopen(path, "w+")) == NULL) {
purple_notify_error(NULL, NULL, _("Unable to open file."), NULL, NULL);
return;
}
fprintf(fp, "Finch Debug Log : %s\n", purple_date_format_full(NULL));
fprintf(fp, "%s", gnt_text_view_get_text(tv));
fclose(fp);
gnt_widget_destroy(GNT_WIDGET(fs));
}
static void
save_debug_win(GntWidget *w, GntTextView *tv)
{
GntWidget *window = gnt_file_sel_new();
GntFileSel *sel = GNT_FILE_SEL(window);
gnt_file_sel_set_current_location(sel, purple_home_dir());
gnt_file_sel_set_suggested_filename(sel, "debug.txt");
g_signal_connect(G_OBJECT(sel), "file_selected", G_CALLBACK(file_save), tv);
g_signal_connect(G_OBJECT(sel), "cancelled", G_CALLBACK(gnt_widget_destroy), NULL);
gnt_widget_show(window);
}
void finch_debug_window_show()
{
GntWidget *wid, *box, *label;
debug.paused = FALSE;
if (debug.window) {
gnt_window_present(debug.window);
return;
}
debug.window = gnt_vbox_new(FALSE);
gnt_box_set_toplevel(GNT_BOX(debug.window), TRUE);
gnt_box_set_title(GNT_BOX(debug.window), _("Debug Window"));
gnt_box_set_pad(GNT_BOX(debug.window), 0);
gnt_box_set_alignment(GNT_BOX(debug.window), GNT_ALIGN_MID);
debug.tview = gnt_text_view_new();
gnt_box_add_widget(GNT_BOX(debug.window), debug.tview);
gnt_widget_set_size(debug.tview,
purple_prefs_get_int(PREF_ROOT "/size/width"),
purple_prefs_get_int(PREF_ROOT "/size/height"));
g_signal_connect(G_OBJECT(debug.tview), "size_changed", G_CALLBACK(size_changed_cb), NULL);
gnt_box_add_widget(GNT_BOX(debug.window), gnt_line_new(FALSE));
box = gnt_hbox_new(FALSE);
gnt_box_set_alignment(GNT_BOX(box), GNT_ALIGN_MID);
gnt_box_set_fill(GNT_BOX(box), FALSE);
/* XXX: Setting the GROW_Y for the following widgets don't make sense. But right now
* it's necessary to make the width of the debug window resizable ... like I said,
* it doesn't make sense. The bug is likely in the packing in gntbox.c.
*/
wid = gnt_button_new(_("Clear"));
g_signal_connect(G_OBJECT(wid), "activate", G_CALLBACK(clear_debug_win), debug.tview);
gnt_widget_set_grow_y(wid, TRUE);
gnt_box_add_widget(GNT_BOX(box), wid);
wid = gnt_button_new(_("Save"));
g_signal_connect(G_OBJECT(wid), "activate", G_CALLBACK(save_debug_win), debug.tview);
gnt_widget_set_grow_y(wid, TRUE);
gnt_box_add_widget(GNT_BOX(box), wid);
debug.search = gnt_entry_new(purple_prefs_get_string(PREF_ROOT "/filter"));
label = gnt_label_new(_("Filter:"));
gnt_widget_set_grow_x(label, FALSE);
gnt_box_add_widget(GNT_BOX(box), label);
gnt_box_add_widget(GNT_BOX(box), debug.search);
g_signal_connect(G_OBJECT(debug.search), "text_changed", G_CALLBACK(update_filter_string), NULL);
wid = gnt_check_box_new(_("Pause"));
g_signal_connect(G_OBJECT(wid), "toggled", G_CALLBACK(toggle_pause), NULL);
gnt_widget_set_grow_y(wid, TRUE);
gnt_box_add_widget(GNT_BOX(box), wid);
gnt_box_add_widget(GNT_BOX(debug.window), box);
gnt_widget_set_grow_y(box, TRUE);
gnt_widget_set_name(debug.window, "debug-window");
g_signal_connect(G_OBJECT(debug.window), "destroy", G_CALLBACK(reset_debug_win), NULL);
gnt_text_view_attach_scroll_widget(GNT_TEXT_VIEW(debug.tview), debug.window);
gnt_text_view_attach_pager_widget(GNT_TEXT_VIEW(debug.tview), debug.window);
gnt_widget_show(debug.window);
}
static gboolean
start_with_debugwin(gpointer null)
{
finch_debug_window_show();
return FALSE;
}
static void
finch_debug_ui_class_init(FinchDebugUiClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS(klass);
object_class->finalize = finch_debug_ui_finalize;
}
static void
finch_debug_ui_init(FinchDebugUi *self)
{
/* Xerox */
#define REGISTER_G_LOG_HANDLER(name) \
g_log_set_handler((name), G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL \
| G_LOG_FLAG_RECURSION, \
purple_glib_log_handler, NULL)
/* Register the glib log handlers. */
REGISTER_G_LOG_HANDLER(NULL);
REGISTER_G_LOG_HANDLER("GLib");
REGISTER_G_LOG_HANDLER("GModule");
REGISTER_G_LOG_HANDLER("GLib-GObject");
REGISTER_G_LOG_HANDLER("GThread");
REGISTER_G_LOG_HANDLER("Gnt");
REGISTER_G_LOG_HANDLER("GStreamer");
REGISTER_G_LOG_HANDLER("stderr");
g_set_print_handler(print_stderr); /* Redirect the debug messages to stderr */
if (!purple_debug_is_enabled())
handle_fprintf_stderr(FALSE);
purple_prefs_add_none(PREF_ROOT);
purple_prefs_add_string(PREF_ROOT "/filter", "");
purple_prefs_add_none(PREF_ROOT "/size");
purple_prefs_add_int(PREF_ROOT "/size/width", 60);
purple_prefs_add_int(PREF_ROOT "/size/height", 15);
if (purple_debug_is_enabled())
g_timeout_add(0, start_with_debugwin, NULL);
}
static void
finch_debug_ui_finalize(GObject *gobject)
{
handle_fprintf_stderr(TRUE);
G_OBJECT_CLASS(finch_debug_ui_parent_class)->finalize(gobject);
}
FinchDebugUi *
finch_debug_ui_new(void)
{
return g_object_new(FINCH_TYPE_DEBUG_UI, NULL);
}