diff options
| author | James Culver <rewtguy@gmail.com> | 2021-10-12 00:50:59 -0500 |
|---|---|---|
| committer | James Culver <rewtguy@gmail.com> | 2021-10-12 00:50:59 -0500 |
| commit | c144a67f75bf9187999955ac7a60589883777f65 (patch) | |
| tree | 9bda7b6b4fa50463e1f871a131470a6cfb2fb94c /doc | |
| parent | 70f03c3c1fa44b65d94480d07f3ed0d865c3e765 (diff) | |
| download | pidgin-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 'doc')
| -rw-r--r-- | doc/reference/libpurple/libpurple-docs.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml index 54fea6abb2..642c925999 100644 --- a/doc/reference/libpurple/libpurple-docs.xml +++ b/doc/reference/libpurple/libpurple-docs.xml @@ -73,6 +73,8 @@ <xi:include href="xml/purpleconversationmanager.xml" /> <xi:include href="xml/purpleconversationuiops.xml" /> <xi:include href="xml/purpledebugui.xml" /> + <xi:include href="xml/purplehistoryadapter.xml" /> + <xi:include href="xml/purplehistorymanager.xml" /> <xi:include href="xml/purpleimconversation.xml" /> <xi:include href="xml/purplekeyvaluepair.xml" /> <xi:include href="xml/purplemarkup.xml" /> |