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 library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; 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_CONVERSATION_MANAGER_H
#define PURPLE_CONVERSATION_MANAGER_H
#include <glib.h>
#include <purpleconversation.h>
/**
* SECTION:purpleconversationmanager
* @section_id: libpurple-purpleconversationmanager
* @title: Conversation Management
* @short_description: Management of conversations.
*
* #PurpleConversationManager keeps track of all #PurpleConversation's inside of
* libpurple and allows searching of them.
*/
G_BEGIN_DECLS
/**
* PURPLE_TYPE_CONVERSATION_MANAGER:
*
* The standard _TYPE_ macro for PurpleConversationManager.
*
* Since: 3.0.0
*/
#define PURPLE_TYPE_CONVERSATION_MANAGER (purple_conversation_manager_get_type())
/**
* purple_conversation_manager_get_type:
*
* Gets the #GType of #PurpleConversationManager.
*
* Returns: The #GType of #PurpleConversationManager.
*
* Since: 3.0.0
*/
/**
* PurpleConversationManager:
*
* An opaque structure that represents the conversation manager.
*
* Since: 3.0.0
*/
G_DECLARE_FINAL_TYPE(PurpleConversationManager, purple_conversation_manager,
PURPLE, CONVERSATION_MANAGER, GObject)
/**
* PurpleConversationManagerForeachFunc:
* @conversation: The #PurpleConversation instance.
* @data: User supplied data.
*
* A function to be used as a callback with
* purple_conversation_manager_foreach().
*
* Since: 3.0.0
*/
typedef void (*PurpleConversationManagerForeachFunc)(PurpleConversation *conversation, gpointer data);
/**
* purple_conversation_manager_get_default:
*
* Gets the default instance of #PurpleConversationManager. This instance
* can be used for any of the API including connecting to signals.
*
* Returns: (transfer none): The default #PurpleConversationManager instance.
*
* Since: 3.0.0
*/
PurpleConversationManager *purple_conversation_manager_get_default(void);
/**
* purple_conversation_manager_register:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation to register.
*
* Registers @conversation with @manager.
*
* Returns: %TRUE if @conversation was not yet registered.
*
* Since: 3.0.0
*/
gboolean purple_conversation_manager_register(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_unregister:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation to unregister.
*
* Unregisters @conversation with @manager.
*
* Returns: %TRUE if @conversation was found and unregistered.
*
* Since: 3.0.0
*/
gboolean purple_conversation_manager_unregister(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_is_registered:
* @manager: The #PurpleConversationManager instance.
* @conversation: The #PurpleConversation instance.
*
* Checks if @conversation is registered with @manager.
*
* Returns: %TRUE if @conversation is registered with @manager, %FALSE
* otherwise.
*
* Since: 3.0.0
*/
gboolean purple_conversation_manager_is_registered(PurpleConversationManager *manager, PurpleConversation *conversation);
/**
* purple_conversation_manager_foreach:
* @manager: The #PurpleConversationManager instance.
* @func: (scope call): The #PurpleConversationManagerForeachFunc to call.
* @data: User data to pass to @func.
*
* Calls @func for each #PurpleConversation that @manager knows about.
*
* Since: 3.0.0
*/
void purple_conversation_manager_foreach(PurpleConversationManager *manager, PurpleConversationManagerForeachFunc func, gpointer data);
/**
* purple_conversation_manager_get_all:
* @manager: The #PurpleConversationManager instance.
*
* Gets a list of all conversations that are registered with @manager.
*
* Returns: (transfer container) (element-type PurpleConversation): A list of
* all of the registered conversations.
*
* Since: 3.0.0
*/
GList *purple_conversation_manager_get_all(PurpleConversationManager *manager);
/**
* purple_conversation_manager_find:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered conversation belonging to @account and named @named.
* This function will return the first one matching the given criteria. If you
* specifically need an im or chat see purple_conversation_manager_find_im()
* or purple_conversation_manager_find_chat().
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0.0
*/
PurpleConversation *purple_conversation_manager_find(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_im:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered im conversation belonging to @account and named
* @name.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0.0
*/
PurpleConversation *purple_conversation_manager_find_im(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_chat:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @name: The name of the conversation.
*
* Looks for a registered chat conversation belonging to @account and named
* @name.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0.0
*/
PurpleConversation *purple_conversation_manager_find_chat(PurpleConversationManager *manager, PurpleAccount *account, const gchar *name);
/**
* purple_conversation_manager_find_chat_by_id:
* @manager: The #PurpleConversationManager instance.
* @account: The #PurpleAccount instance whose conversation to find.
* @id: The id of the conversation.
*
* Looks for a registered chat conversation belonging to @account with an id of
* @id.
*
* This is typically only called by protocols.
*
* Returns: (transfer none): The #PurpleConversation if found, otherwise %NULL.
*
* Since: 3.0.0
*/
PurpleConversation *purple_conversation_manager_find_chat_by_id(PurpleConversationManager *manager, PurpleAccount *account, gint id);
G_END_DECLS
#endif /* PURPLE_CONVERSATION_MANAGER_H */