summaryrefslogtreecommitdiff
path: root/libpurple/purpleprivate.h
diff options
context:
space:
mode:
authorJames Culver <rewtguy@gmail.com>2021-10-12 00:50:59 -0500
committerJames Culver <rewtguy@gmail.com>2021-10-12 00:50:59 -0500
commitc144a67f75bf9187999955ac7a60589883777f65 (patch)
tree9bda7b6b4fa50463e1f871a131470a6cfb2fb94c /libpurple/purpleprivate.h
parent70f03c3c1fa44b65d94480d07f3ed0d865c3e765 (diff)
downloadpidgin-c144a67f75bf9187999955ac7a60589883777f65.tar.gz
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/
Diffstat (limited to 'libpurple/purpleprivate.h')
-rw-r--r--libpurple/purpleprivate.h48
1 files changed, 47 insertions, 1 deletions
diff --git a/libpurple/purpleprivate.h b/libpurple/purpleprivate.h
index dcfa88ec93..01309322b8 100644
--- a/libpurple/purpleprivate.h
+++ b/libpurple/purpleprivate.h
@@ -32,6 +32,7 @@
#include "accounts.h"
#include "connection.h"
#include "purplecredentialprovider.h"
+#include "purplehistoryadapter.h"
#define PURPLE_STATIC_ASSERT(condition, message) \
{ typedef char static_assertion_failed_ ## message \
@@ -256,6 +257,52 @@ void purple_credential_provider_activate(PurpleCredentialProvider *provider);
void purple_credential_provider_deactivate(PurpleCredentialProvider *provider);
/**
+ * purple_history_adapter_activate:
+ * @adapter: The #PurpleHistoryAdapter instance.
+ * @error: A return address for a #GError.
+ *
+ * Asks @adapter to become the active adapter. If @adapter can not become active
+ * it should return %FALSE and set @error.
+ *
+ * Returns: %TRUE on success otherwise %FALSE with @error set.
+ *
+ * Since: 3.0.0
+ */
+gboolean purple_history_adapter_activate(PurpleHistoryAdapter *adapter, GError **error);
+
+/**
+ * purple_history_adapter_deactivate:
+ * @adapter: The #PurpleHistoryAdapter instance.
+ * @error: A return address for a #GError.
+ *
+ * Asks @adapter to stop being the active adapter. If @adapter can not
+ * deactivate it should return %FALSE and set @error.
+ *
+ * Returns: %TRUE on success otherwise %FALSE with @error set.
+ *
+ * Since: 3.0.0
+ */
+gboolean purple_history_adapter_deactivate(PurpleHistoryAdapter *adapter, GError **error);
+
+/**
+ * purple_history_manager_startup:
+ *
+ * Starts up the history manager by creating the default instance.
+ *
+ * Since: 3.0.0
+ */
+void purple_history_manager_startup(void);
+
+/**
+ * purple_history_manager_shutdown:
+ *
+ * Shuts down the history manager by destroying the default instance.
+ *
+ * Since: 3.0.0
+ */
+void purple_history_manager_shutdown(void);
+
+/**
* purple_whiteboard_manager_startup:
*
* Starts up the whiteboard manager by creating the default instance.
@@ -273,7 +320,6 @@ void purple_whiteboard_manager_startup(void);
*/
void purple_whiteboard_manager_shutdown(void);
-
G_END_DECLS
#endif /* PURPLE_PRIVATE_H */