pidgin/pidgin

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 - Internet Messenger
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* 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, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PIDGIN_AVATAR_H
#define PIDGIN_AVATAR_H
/**
* SECTION:pidginavatar
* @section_id: pidgin-pidginavatar
* @short_description: Avatars
* @title: Avatar Widget
*
* #PidginAvatar is a widget that displays avatars for contacts or
* conversations.
*/
#include <glib.h>
#include <gtk/gtk.h>
#include <purple.h>
G_BEGIN_DECLS
/**
* PIDGIN_TYPE_AVATAR:
*
* The standard _get_type macro for #PidginAvatar.
*/
#define PIDGIN_TYPE_AVATAR (pidgin_avatar_get_type())
G_DECLARE_FINAL_TYPE(PidginAvatar, pidgin_avatar,
PIDGIN, AVATAR, GtkEventBox)
/**
* PidginAvatar:
*
* #PidginAvatar is an opaque data structure and should only be accessed via
* its API.
*/
/**
* pidgin_avatar_new:
*
* Creates a new #PidginAvatar instance.
*
* Returns: (transfer full): The new #PidginAvatar instance.
*
* Since: 3.0.0
*/
GtkWidget *pidgin_avatar_new(void);
/**
* pidgin_avatar_set_animate:
* @avatar: The #PidginAvatar instance.
* @animate: Whether or not to animate the avatar.
*
* Starts or stops animation of @avatar. If avatar is displaying a
* non-animated image, changing this will do nothing unless a new animated
* image is set.
*
* Since: 3.0.0
*/
void pidgin_avatar_set_animate(PidginAvatar *avatar, gboolean animate);
/**
* pidgin_avatar_get_animate:
* @avatar: The #PidginAvatar instance.
*
* Gets whether or not @avatar should be animated.
*
* Returns: Whether or not @avatar should be animated.
*
* Since: 3.0.0
*/
gboolean pidgin_avatar_get_animate(PidginAvatar *avatar);
/**
* pidgin_avatar_set_buddy:
* @avatar: The #PidginAvatar instance.
* @buddy: (nullable): The #PurpleBuddy to set or %NULL to unset.
*
* Sets or unsets the #PurpleBuddy that @avatar should use for display.
*
* Since: 3.0.0
*/
void pidgin_avatar_set_buddy(PidginAvatar *avatar, PurpleBuddy *buddy);
/**
* pidgin_avatar_get_buddy:
* @avatar: The #PidginAvatar instance.
*
* Gets the #PurpleBuddy that @avatar is using for display.
*
* Returns: (transfer none): The #PurpleBuddy that @avatar is using for display.
*
* Since: 3.0.0
*/
PurpleBuddy *pidgin_avatar_get_buddy(PidginAvatar *avatar);
/**
* pidgin_avatar_set_conversation:
* @avatar: The #PidginAvatar instance.
* @conversation: (nullable): The #PurpleConversation to set or %NULL to unset.
*
* Sets or unsets the #PurpleConversation that @avatar uses to find the
* #PurpleBuddy whose icon to display.
*
* Since: 3.0.0
*/
void pidgin_avatar_set_conversation(PidginAvatar *avatar, PurpleConversation *conversation);
/**
* pidgin_avatar_get_conversation:
* @avatar: The #PidginAvatar instance.
*
* Gets the #PurpleConversation that @avatar is using for display.
*
* Returns: (transfer none): The #PurpleConversation that @avatar is using to
* find the #PurpleBuddy whose icon to display.
*
* Since: 3.0.0
*/
PurpleConversation *pidgin_avatar_get_conversation(PidginAvatar *avatar);
G_END_DECLS
#endif /* PIDGIN_AVATAR_H */