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/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PURPLE_WHITEBOARD_MANAGER_H
#define PURPLE_WHITEBOARD_MANAGER_H
#include <glib.h>
#include <glib-object.h>
#include <libpurple/purplewhiteboard.h>
G_BEGIN_DECLS
/**
* SECTION:purplewhiteboardmanager
* @section_id: libpurple-purplewhiteboardmanager
* @title: Purple Whiteboard Manager
* @short_description: Management of whiteboards.
*
* #PurpleWhiteboardManager keeps track of all whiteboards and emits signals
* when whiteboards are registered and unregistered.
*/
/**
* PURPLE_WHITEBOARD_MANAGER_DOMAIN:
*
* A #GError domain for errors from #PurpleWhiteboardManager.
*
* Since: 3.0.0
*/
#define PURPLE_WHITEBOARD_MANAGER_DOMAIN (g_quark_from_static_string("purple-whiteboard-manager"))
/**
* PURPLE_TYPE_WHITEBOARD_MANAGER:
*
* The standard _TYPE_ macro for #PurpleWhiteboardManager.
*
* Since: 3.0.0
*/
#define PURPLE_TYPE_WHITEBOARD_MANAGER (purple_whiteboard_manager_get_type())
/**
* purple_whiteboard_manager_get_type:
*
* The standard _get_type macro for #PurpleWhiteboardManager.
*
* Since: 3.0.0
*/
/**
* PurpleWhiteboardManager:
*
* An opaque data structure that manages whiteboards.
*
* Since: 3.0.0
*/
G_DECLARE_DERIVABLE_TYPE(PurpleWhiteboardManager, purple_whiteboard_manager,
PURPLE, WHITEBOARD_MANAGER, GObject)
/**
* PurpleWhiteboardManagerClass:
* @registered: The default signal handler for when a whiteboard is registered.
* @unregistered: The default signal handler for when a whiteboard is
* unregistered.
*
* The class structure for #PurpleWhiteboardManager.
*
* Since: 3.0.0
*/
struct _PurpleWhiteboardManagerClass {
/*< private >*/
GObjectClass parent;
/*< public >*/
void (*registered)(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard);
void (*unregistered)(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard);
/*< private >*/
gpointer reserved[4];
};
/**
* PurpleWhiteboardManagerForeachFunc:
* @whiteboard: The #PurpleWhiteboard instance.
* @data: User supplied data.
*
* A function to be used as a callback with purple_whiteboard_manager_foreach().
*
* Since: 3.0.0
*/
typedef void (*PurpleWhiteboardManagerForeachFunc)(PurpleWhiteboard *whiteboard, gpointer data);
/**
* purple_whiteboard_manager_get_default:
*
* Gets the default #PurpleWhiteboardManager instance.
*
* Returns: (transfer none): The default #PurpleWhiteboardManager instance.
*
* Since: 3.0.0
*/
PurpleWhiteboardManager *purple_whiteboard_manager_get_default(void);
/**
* purple_whiteboard_manager_register:
* @manager: The #PurpleWhiteboardManager instance.
* @whiteboard: The #PurpleWhiteboard to register.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Registers @whiteboard with @manager.
*
* Returns: %TRUE if @whiteboard was successfully registered with @manager,
* %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_whiteboard_manager_register(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard, GError **error);
/**
* purple_whiteboard_manager_unregister:
* @manager: The #PurpleWhiteboardManager instance.
* @whiteboard: The #PurpleWhiteboard to unregister.
* @error: (out) (optional) (nullable): A return address for a #GError.
*
* Unregisters @whiteboard from @manager.
*
* Returns: %TRUE if @whiteboard was successfully unregistered from @manager,
* %FALSE otherwise.
*
* Since: 3.0.0
*/
gboolean purple_whiteboard_manager_unregister(PurpleWhiteboardManager *manager, PurpleWhiteboard *whiteboard, GError **error);
/**
* purple_whiteboard_manager_find:
* @manager: The #PurpleWhiteboardManager instance.
* @id: The id of the #PurpleWhiteboard to find.
*
* Gets the #PurpleWhiteboard identified by @id if found, otherwise %NULL.
*
* Returns: (transfer full): The #PurpleWhiteboard identified by @id or %NULL.
*
* Since: 3.0.0
*/
PurpleWhiteboard *purple_whiteboard_manager_find(PurpleWhiteboardManager *manager, const gchar *id);
/**
* purple_whiteboard_manager_foreach:
* @manager: The #PurpleWhiteboardManager instance.
* @func: (scope call): The #PurpleWhiteboardManagerForeachFunc to call.
* @data: User data to pass to @func.
*
* Calls @func for each #PurpleWhiteboard that @manager knows about.
*
* Since: 3.0.0
*/
void purple_whiteboard_manager_foreach(PurpleWhiteboardManager *manager, PurpleWhiteboardManagerForeachFunc func, gpointer data);
/**
* purple_whiteboard_manager_get_model:
* @manager: The #PurpleWhiteboardManager instance.
*
* Gets the backing model of @manager as a #GListModel.
*
* Returns: (transfer none) (element-type PurpleWhiteboard): The #GListModel
* containing all of the #PurpleWhiteboards registered with @manager.
*
* Since: 3.0.0
*/
GListModel *purple_whiteboard_manager_get_model(PurpleWhiteboardManager *manager);
G_END_DECLS
#endif /* PURPLE_WHITEBOARD_MANAGER_H */