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/
/*
* pidgin
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include "gtkidle.h"
#ifdef HAVE_IOKIT
/* HAVE_UNISTD_H must have a value, see
* https://forums.developer.apple.com/thread/86887
*/
# ifdef HAVE_UNISTD_H
# undef HAVE_UNISTD_H
# define HAVE_UNISTD_H 1
# else
# define HAVE_UNISTD_H 0
# endif
# include <CoreFoundation/CoreFoundation.h>
# include <IOKit/IOKitLib.h>
#elif defined (_WIN32)
# include "win32/gtkwin32dep.h"
#endif
#include <purple.h>
#if !defined(HAVE_IOKIT) && !defined(_WIN32)
typedef struct {
gchar *bus_name;
gchar *object_path;
gchar *iface_name;
} PidginDBusScreenSaverInfo;
static const PidginDBusScreenSaverInfo screensavers[] = {
{
"org.freedesktop.ScreenSaver",
"/org/freedesktop/ScreenSaver",
"org.freedesktop.ScreenSaver"
}, {
"org.gnome.ScreenSaver",
"/org/gnome/ScreenSaver",
"org.gnome.ScreenSaver"
}, {
"org.kde.ScreenSaver",
"/org/kde/ScreenSaver",
"org.kde.ScreenSaver"
},
};
#endif /* !HAVE_IOKIT && !_WIN32 */
/*
* pidgin_get_time_idle:
*
* Get the number of seconds the user has been idle. In Unix-world
* this is based on the DBus ScreenSaver interfaces. In MS Windows this
* is based on keyboard/mouse usage information obtained from the OS.
* In MacOS X, this is based on keyboard/mouse usage information
* obtained from the OS, if configure detected IOKit. Otherwise,
* MacOS X is handled as a case of Unix.
*
* Returns: The number of seconds the user has been idle.
*/
static time_t
pidgin_get_time_idle(void)
{
# ifdef HAVE_IOKIT
/* Query the IOKit API */
double idleSeconds = -1;
io_iterator_t iter = 0;
if (IOServiceGetMatchingServices(kIOMasterPortDefault, IOServiceMatching("IOHIDSystem"), &iter) == KERN_SUCCESS) {
io_registry_entry_t entry = IOIteratorNext(iter);
if (entry) {
CFMutableDictionaryRef dict = NULL;
kern_return_t status;
status = IORegistryEntryCreateCFProperties(entry, &dict, kCFAllocatorDefault, 0);
if (status == KERN_SUCCESS) {
CFNumberRef obj = CFDictionaryGetValue(dict, CFSTR("HIDIdleTime"));
if (obj) {
int64_t nanoseconds = 0;
if (CFNumberGetValue(obj, kCFNumberSInt64Type, &nanoseconds)) {
idleSeconds = (double) nanoseconds / NSEC_PER_SEC;
}
}
CFRelease(dict);
}
IOObjectRelease(entry);
}
IOObjectRelease(iter);
}
return idleSeconds;
# else
# ifdef _WIN32
/* Query Windows */
return (GetTickCount() - winpidgin_get_lastactive()) / 1000;
# else
static guint idx = 0;
GApplication *app;
GDBusConnection *conn;
GVariant *reply = NULL;
guint32 active_time = 0;
GError *error = NULL;
app = g_application_get_default();
if (app == NULL) {
purple_debug_error("gtkidle",
"Unable to retrieve GApplication");
return 0;
}
conn = g_application_get_dbus_connection(app);
if (conn == NULL) {
purple_debug_misc("gtkidle",
"GApplication lacking DBus connection. "
"Skip checking ScreenSaver interface");
return 0;
}
for (; idx < G_N_ELEMENTS(screensavers); ++idx) {
const PidginDBusScreenSaverInfo *info = &screensavers[idx];
reply = g_dbus_connection_call_sync(conn,
info->bus_name, info->object_path,
info->iface_name, "GetActiveTime",
NULL, G_VARIANT_TYPE("(u)"),
G_DBUS_CALL_FLAGS_NO_AUTO_START, 1000,
NULL, &error);
if (reply != NULL) {
break;
}
if (g_error_matches(error, G_DBUS_ERROR,
G_DBUS_ERROR_NOT_SUPPORTED)) {
purple_debug_info("gtkidle",
"Querying idle time on '%s' "
"unsupported. Trying the next one",
info->bus_name);
} else if (g_error_matches(error, G_DBUS_ERROR,
G_DBUS_ERROR_NAME_HAS_NO_OWNER)) {
purple_debug_info("gtkidle",
"Querying idle time on '%s' "
"not found. Trying the next one",
info->bus_name);
} else {
purple_debug_error("gtkidle",
"Querying idle time on '%s' "
"error: %s", info->bus_name,
error->message);
}
g_clear_error(&error);
}
if (reply == NULL) {
purple_debug_warning("gtkidle",
"Failed to query ScreenSaver active time: "
"No working ScreenSaver interfaces");
return 0;
}
g_variant_get(reply, "(u)", &active_time);
g_variant_unref(reply);
return active_time;
# endif /* !_WIN32 */
# endif /* !HAVE_IOKIT */
}
static PurpleIdleUiOps ui_ops =
{
pidgin_get_time_idle,
NULL,
NULL,
NULL,
NULL
};
PurpleIdleUiOps *
pidgin_idle_get_ui_ops()
{
return &ui_ops;
}