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>
*
* Purple 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_PROTOCOL_FACTORY_H
#define PURPLE_PROTOCOL_FACTORY_H
/**
* SECTION:purpleprotocolfactory
* @section_id: libpurple-purpleprotocolfactory
* @short_description: <filename>purpleprotocolfactory.h</filename>
* @title: ProtocolFactoryInterface
*
* A interface where protocols can expose subclasses of libpurple objects.
*/
#include <glib.h>
#include <glib-object.h>
#include <libpurple/account.h>
#include <libpurple/connection.h>
#include <libpurple/protocol.h>
#include <libpurple/roomlist.h>
G_BEGIN_DECLS
/**
* PURPLE_TYPE_PROTOCOL_FACTORY:
*
* The standard _get_type macro for #PurpleProtocolFactory.
*/
#define PURPLE_TYPE_PROTOCOL_FACTORY (purple_protocol_factory_iface_get_type())
G_DECLARE_INTERFACE(PurpleProtocolFactory, purple_protocol_factory, PURPLE,
PROTOCOL_FACTORY, PurpleProtocol)
/**
* PurpleProtocolFactory:
*
* #PurpleProtocolFactory is an opaque representation of an object that
* implements #PurpleProtocolFactoryInterface.
*/
/**
* PurpleProtocolFactoryInterface:
* @connection_new: Creates a new protocol-specific connection object that
* subclasses #PurpleConnection.
* @roomlist_new: Creates a new protocol-specific room list object that
* subclasses #PurpleRoomlist.
* @whiteboard_new: Creates a new protocol-specific whiteboard object that
* subclasses #PurpleWhiteboard.
*
* The protocol factory interface.
*
* This interface provides callbacks for construction of protocol-specific
* subclasses of some purple objects.
*/
struct _PurpleProtocolFactoryInterface {
/*< private >*/
GTypeInterface parent_iface;
/*< public >*/
PurpleConnection *(*connection_new)(PurpleProtocolFactory *factory,
PurpleAccount *account,
const gchar *password);
PurpleRoomlist *(*roomlist_new)(PurpleProtocolFactory *factory,
PurpleAccount *account);
PurpleWhiteboard *(*whiteboard_new)(PurpleProtocolFactory *factory,
PurpleAccount *account,
const gchar *who,
gint state);
};
/**
* purple_protocol_factory_get_type:
*
* The standard `_get_type` function for #PurpleProtocolFactory.
*
* Returns: The #GType for the protocol factory interface.
*
* Since: 3.0.0
*/
/**
* purple_protocol_factory_connection_new:
* @factory: The #PurpleProtocolFactory instance.
* @account: The #PurpleAccount to create the connection for.
* @password: The password for @account.
*
* Creates a new protocol-specific #PurpleConnection subclass.
*
* Returns: (transfer full): The new #PurpleConnection subclass.
*
* Since: 3.0.0
*/
PurpleConnection *purple_protocol_factory_connection_new(PurpleProtocolFactory *factory,
PurpleAccount *account, const gchar *password);
/**
* purple_protocol_factory_roomlist_new:
* @factory: The #PurpleProtocolFactory instance.
* @account: The #PurpleAccount to create a roomlist for.
*
* Creates a new protocol-specific #PurpleRoomlist subclass.
*
* Returns: (transfer full): The new #PurpleRoomlist subclass for @account.
*
* Since: 3.0.0
*/
PurpleRoomlist *purple_protocol_factory_roomlist_new(PurpleProtocolFactory *factory,
PurpleAccount *account);
/**
* purple_protocol_factory_whiteboard_new:
* @factory: The #PurpleProtocolFactory instance.
* @account: The #PurpleAccount instance to create a whiteboard for.
* @who: The name of the contact to create a whiteboard with.
* @state: NFI.
*
* Creates a new protocol-specific #PurpleWhiteboard subclass.
*
* Returns: (transfer full): The new #PurpleWhiteboard subclass for @account
* and @who.
*
* Since: 3.0.0
*/
PurpleWhiteboard *purple_protocol_factory_whiteboard_new(PurpleProtocolFactory *factory,
PurpleAccount *account, const gchar *who, gint state);
G_END_DECLS
#endif /* PURPLE_PROTOCOL_FACTORY_H */