HGKeeper

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/

* 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 <gplugin.h>

#include <gplugin-native.h>

#include <purple.h>

#define PLUGIN_ID "core-psychic"

#define PLUGIN_NAME N_("Psychic Mode")

#define PLUGIN_CATEGORY N_("Utility")

#define PLUGIN_SUMMARY N_("Psychic mode for incoming conversation")

#define PLUGIN_DESC N_("Causes conversation windows to appear as other" \

" users begin to message you. This works for" \

" AIM, ICQ, XMPP, and Sametime")

#define PLUGIN_AUTHORS { "Christopher O'Brien <siege@preoccupied.net>", NULL }

#define PREFS_BASE "/plugins/core/psychic"

#define PREF_BUDDIES PREFS_BASE "/buddies_only"

#define PREF_NOTICE PREFS_BASE "/show_notice"

#define PREF_STATUS PREFS_BASE "/activate_online"

#define PREF_RAISE PREFS_BASE "/raise_conv"

static void

buddy_typing_cb(PurpleAccount *acct, const char *name, void *data) {

PurpleConversation *im;

PurpleConversationManager *manager;

if(purple_prefs_get_bool(PREF_STATUS) &&

! purple_status_is_available(purple_account_get_active_status(acct))) {

purple_debug_info("psychic", "not available, doing nothing\n");

return;

}

if(purple_prefs_get_bool(PREF_BUDDIES) &&

! purple_blist_find_buddy(acct, name)) {

purple_debug_info("psychic", "not in blist, doing nothing\n");

return;

}

if(FALSE == purple_account_privacy_check(acct, name)) {

purple_debug_info("psychic", "user %s is blocked\n", name);

return;

}

manager = purple_conversation_manager_get_default();

im = purple_conversation_manager_find_im(manager, acct, name);

if(! im) {

purple_debug_info("psychic", "no previous conversation exists\n");

im = purple_im_conversation_new(acct, name);

if(purple_prefs_get_bool(PREF_RAISE)) {

purple_conversation_present(im);

}

if(purple_prefs_get_bool(PREF_NOTICE)) {

/* This is a quote from Star Wars. You should probably not

translate it literally. If you can't find a fitting cultural

reference in your language, consider translating something

like this instead: "You feel a new message coming." */

purple_conversation_write_system_message(im,

_("You feel a disturbance in the force..."),

PURPLE_MESSAGE_NO_LOG | PURPLE_MESSAGE_ACTIVE_ONLY);

}

/* Necessary because we may be creating a new conversation window. */

purple_im_conversation_set_typing_state(PURPLE_IM_CONVERSATION(im),

PURPLE_IM_TYPING);

}

static PurplePluginPrefFrame *

get_plugin_pref_frame(PurplePlugin *plugin) {

PurplePluginPrefFrame *frame;

PurplePluginPref *pref;

frame = purple_plugin_pref_frame_new();

pref = purple_plugin_pref_new_with_name(PREF_BUDDIES);

purple_plugin_pref_set_label(pref, _("Only enable for users on"

" the buddy list"));

purple_plugin_pref_frame_add(frame, pref);

pref = purple_plugin_pref_new_with_name(PREF_STATUS);

purple_plugin_pref_set_label(pref, _("Disable when away"));

purple_plugin_pref_frame_add(frame, pref);

pref = purple_plugin_pref_new_with_name(PREF_NOTICE);

purple_plugin_pref_set_label(pref, _("Display notification message in"

" conversations"));

purple_plugin_pref_frame_add(frame, pref);

pref = purple_plugin_pref_new_with_name(PREF_RAISE);

purple_plugin_pref_set_label(pref, _("Raise psychic conversations"));

purple_plugin_pref_frame_add(frame, pref);

return frame;

}

static GPluginPluginInfo *

psychic_query(GError **error) {

const gchar * const authors[] = PLUGIN_AUTHORS;

return purple_plugin_info_new(

"id", PLUGIN_ID,

"name", PLUGIN_NAME,

"version", DISPLAY_VERSION,

"category", PLUGIN_CATEGORY,

"summary", PLUGIN_SUMMARY,

"description", PLUGIN_DESC,

"authors", authors,

"website", PURPLE_WEBSITE,

"abi-version", PURPLE_ABI_VERSION,

"pref-frame-cb", get_plugin_pref_frame,

NULL

);

}

static gboolean

psychic_load(GPluginPlugin *plugin, GError **error) {

void *convs_handle;

purple_prefs_add_none(PREFS_BASE);

purple_prefs_add_bool(PREF_BUDDIES, FALSE);

purple_prefs_add_bool(PREF_NOTICE, TRUE);

purple_prefs_add_bool(PREF_STATUS, TRUE);

convs_handle = purple_conversations_get_handle();

purple_signal_connect(convs_handle, "buddy-typing", plugin,

PURPLE_CALLBACK(buddy_typing_cb), NULL);

return TRUE;

}

static gboolean

psychic_unload(GPluginPlugin *plugin, gboolean shutdown, GError **error) {

return TRUE;

}

GPLUGIN_NATIVE_PLUGIN_DECLARE(psychic)

pidgin/pidgin