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/
/*
* finch
*
* Finch 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(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
# error "only <finch.h> may be included directly"
#endif
#ifndef FINCH_CONV_H
#define FINCH_CONV_H
/**
* SECTION:gntconv
* @section_id: finch-gntconv
* @short_description: <filename>gntconv.h</filename>
* @title: Conversation API
*/
#include <gnt.h>
#include <purple.h>
/* Grabs the conv out of a PurpleConverstation */
#define FINCH_CONV(conv) ((FinchConv *)g_object_get_data(G_OBJECT(conv), "finch"))
/***************************************************************************
* GNT Conversations API
***************************************************************************/
typedef struct _FinchConv FinchConv;
typedef struct _FinchConvChat FinchConvChat;
typedef struct _FinchConvIm FinchConvIm;
/**
* FinchConversationFlag:
* @FINCH_CONV_NO_SOUND: A flag to mute a conversation.
*
* Flags that can be set for each conversation.
*/
typedef enum
{
FINCH_CONV_NO_SOUND = 1 << 0,
} FinchConversationFlag;
/**
* FinchConv:
* @list: A list of conversations being displayed in this window.
* @active_conv: The active conversation.
* @window: The #GntWindow for the conversation.
* @entry: The #GntEntry for input.
* @tv: The #GntTextView that displays the history.
* @menu: The menu for the conversation.
* @info: The info widget that shows the information about the conversation.
* @plugins: The #GntMenuItem for plugins.
* @flags: The flags for the conversation.
*
* A Finch conversation.
*/
struct _FinchConv
{
GList *list;
PurpleConversation *active_conv;
GntWidget *window; /* the container */
GntWidget *entry; /* entry */
GntWidget *tv; /* text-view */
GntWidget *menu;
GntWidget *info;
GntMenuItem *plugins;
FinchConversationFlag flags;
union
{
FinchConvChat *chat;
FinchConvIm *im;
} u;
};
/**
* FinchConvChat:
* @userlist: The widget that displays the users in the chat.
*
* The chat specific implementation for a conversation.
*/
struct _FinchConvChat
{
GntWidget *userlist; /* the userlist */
/*< private >*/
void *finch_reserved1;
void *finch_reserved2;
void *finch_reserved3;
void *finch_reserved4;
};
/**
* FinchConvIm:
* @sendto: The sendto widget which allows the user to select who they're
* messaging.
*
* The instant message implementation for a conversation.
*/
struct _FinchConvIm
{
GntMenuItem *sendto;
/*< private >*/
void *finch_reserved1;
void *finch_reserved2;
void *finch_reserved3;
void *finch_reserved4;
};
/**
* finch_conv_get_ui_ops:
*
* Get the ui-functions.
*
* Returns: The PurpleConversationUiOps populated with the appropriate functions.
*/
PurpleConversationUiOps *finch_conv_get_ui_ops(void);
/**
* finch_conversation_init:
*
* Perform the necessary initializations.
*/
void finch_conversation_init(void);
/**
* finch_conversation_uninit:
*
* Perform the necessary uninitializations.
*/
void finch_conversation_uninit(void);
/**
* finch_conversation_set_active:
* @conv: The conversation to make active.
*
* Set a conversation as active in a contactized conversation
*/
void finch_conversation_set_active(PurpleConversation *conv);
/**
* finch_conversation_set_info_widget:
* @conv: The conversation.
* @widget: The widget containing the information. If %NULL,
* the current information widget is removed.
*
* Sets the information widget for the conversation window.
*/
void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget);
#endif /* FINCH_CONV_H */