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
*/
#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef _PIDGINSAVEDSTATUSES_H_
#define _PIDGINSAVEDSTATUSES_H_
/**
* SECTION:gtksavedstatuses
* @section_id: pidgin-gtksavedstatuses
* @short_description: <filename>gtksavedstatuses.h</filename>
* @title: Saved Status Editor UI
*/
#include <purple.h>
G_BEGIN_DECLS
/**
* pidgin_status_window_show:
*
* Shows the status window.
*/
void pidgin_status_window_show(void);
/**
* pidgin_status_window_hide:
*
* Hides the status window.
*/
void pidgin_status_window_hide(void);
/**
* pidgin_status_editor_show:
* @edit: %TRUE if we want to edit an existing saved
* status or %FALSE to create a new one. You
* can not edit transient statuses--they don't
* have titles. If you want to edit a transient
* status, set this to %FALSE and seed the dialog
* with the transient status using the status
* parameter to this function.
* @status: If edit is %TRUE then this should be a
* pointer to the PurpleSavedStatus to edit.
* If edit is %FALSE then this can be NULL,
* or you can pass in a saved status to
* seed the initial values of the new status.
*
* Shows a status editor (used for adding a new saved status or
* editing an already existing saved status).
*/
void pidgin_status_editor_show(gboolean edit, PurpleSavedStatus *status);
/**
* pidgin_status_menu:
* @status: The default saved_status to show as 'selected'
* @callback: (scope call): The callback to call when the selection changes
*
* Creates a dropdown menu of saved statuses and calls a callback
* when one is selected
*
* Returns: (transfer full): The menu widget
*/
GtkWidget *pidgin_status_menu(PurpleSavedStatus *status, GCallback callback);
/**
* pidgin_status_get_handle:
*
* Returns the GTK status handle.
*
* Returns: The handle to the GTK status system.
*/
void *pidgin_status_get_handle(void);
/**
* pidgin_status_init:
*
* Initializes the GTK status system.
*/
void pidgin_status_init(void);
/**
* pidgin_status_uninit:
*
* Uninitializes the GTK status system.
*/
void pidgin_status_uninit(void);
G_END_DECLS
#endif /* _PIDGINSAVEDSTATUSES_H_ */