telodendria/TODO.txt

Telodendria To-Do List
======================

Key:

[ ] Not Started
[x] Done
[~] In Progress
[!] Won't Fix

Milestone: v0.3.0
-----------------

[~] Stream API
    [x] Implementation
    [x] Convert all code that deals with I/O
    [!] Multi-output (proof of concept)
    [!] Memory streams (proof of concept)
    [~] TLS
    [ ] SOCKS
    [x] Move/convert UtilStreamCopy()
    [ ] Io man page
    [ ] Stream man page
    [ ] Tls man page
[~] HTTP Client API
    [x] Document HttpParseHeaders()
    [ ] HttpClient man page
    [ ] Uri man page
    [x] Test on other platforms
[x] Option to pretty-print Json
    [x] Document JsonEncode() and JsonEncodeValue()
[ ] Update man page for td
[x] Document Telodendria and Main
[ ] Document tt and http-debug-server

[x] Simple command line tool to make matrix requests
    [x] Built on HTTP client API
    [x] http man page
[~] Simple command line tool for working with JSON
    [x] Pretty-print Json
    [x] Query fields for use in shell scripts.
    [x] Encode user-provided JSON strings
    [x] json man page
    [ ] Update man pages for tp and send-patch

[ ] Proper HTTP request router
    - Support regex matching

[ ] Move configuration to database
    [ ] Initial configuration
        [ ] If no config, create one-time use registration token that
            grants user admin privileges.
    [ ] /_telodendria/admin/config endpoint
    [ ] Refactor TelodendriaConfig to just Config (ConfigLock() and ConfigUnlock())

[~] Client-Server API
    [x] 4: Token-based user registration
        [x] Implement user-interactive auth flow
        [x] Token validity endpoint
        [x] Add m.login.registration_token to registration endpoint
            flow
            - Ensure that registration tokens can be used even if
              registration is disabled.
    [~] 4: Account management
        [~] Deactivate
            [x] Make sure UserLogin() fails if user is deactivated.
        [ ] Change password
        [x] Whoami
    [ ] 9: User Data
    [ ] 5: Capabilities negotiation
    [ ] 10: Security (Rate Limiting)

Milestone: v0.4.0
-----------------

[ ] Client-Server API
    [ ] 6: Filtering
    [ ] 7: Events
    [ ] 8: Rooms

Milestone: v0.5.0
-----------------

[~] Client-Server API
    [ ] Modules
        [ ] Content Repository

Milestone: v1.0.0
-----------------

[~] Client-Server API
    [ ] Modules
        [ ] Instant Messaging
        [ ] Voice over IP
        [ ] Receipts
        [ ] Fully Read Markers
        [ ] Send-To-Device Messaging
[ ] Server-Server API
[ ] Application Service API
[ ] Identity Service API
[ ] Push Gateway API
[ ] Room Versions

Milestone v1.1.0
----------------

[ ] Database upgrades/migration path
[ ] Create a command line tool to manage Telodendria
	[ ] User management
	[ ] Room management
[ ] Migrate from Synapse or Dendrite, whichever is more mainstream by
    the time we get here.
Add TODO.txt 2022-09-23 21:49:20 +00:00			`Telodendria To-Do List`
Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`======================`
Add TODO.txt 2022-09-23 21:49:20 +00:00
			`Key:`

			`[ ] Not Started`
			`[x] Done`
			`[~] In Progress`
Fix contrast ratio on home page. 2022-09-28 20:25:49 +00:00			`[!] Won't Fix`
Add TODO.txt 2022-09-23 21:49:20 +00:00
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`Milestone: v0.3.0`
Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`-----------------`
Fix a few more memory bugs. Still have some to tackle. 2022-10-31 23:52:37 +00:00
Begin prototyping Stream API. 2023-03-15 02:40:23 +00:00			`[~] Stream API`
Fix broken IoVprintf(). You can't call vsnprintf() on the same va_list more than once! I learned this the hard way with StreamVprintf(). 2023-03-18 14:55:04 +00:00			`[x] Implementation`
			`[x] Convert all code that deals with I/O`
Don't buffer in IoWrite(), indicate that fwrite() returns size_t, not ssize_t. 2023-03-16 14:17:04 +00:00			`[!] Multi-output (proof of concept)`
			`[!] Memory streams (proof of concept)`
Define TLS API, update HttpClient to support optional TLS. Also added a LibreSSL TLS implementation. Client is verified to work; server has not been tested yet. 2023-03-22 00:41:21 +00:00			`[~] TLS`
Update TODO. 2023-02-23 16:46:27 +00:00			`[ ] SOCKS`
Update TODO 2023-03-15 17:30:14 +00:00			`[x] Move/convert UtilStreamCopy()`
Rename HttpStream() to HttpServerStream() to match HttpClientStream() 2023-03-16 02:17:48 +00:00			`[ ] Io man page`
			`[ ] Stream man page`
Define TLS API, update HttpClient to support optional TLS. Also added a LibreSSL TLS implementation. Client is verified to work; server has not been tested yet. 2023-03-22 00:41:21 +00:00			`[ ] Tls man page`
Add HttpClient API 2023-03-07 23:10:06 +00:00			`[~] HTTP Client API`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] Document HttpParseHeaders()`
Add HttpClient API 2023-03-07 23:10:06 +00:00			`[ ] HttpClient man page`
Add simple HTTP CLI tool that uses the HttpClient API. You might be asking why I would just write a simple curl replacement when curl does the job just fine. Well, the most immediate reason is to test the HttpClient API, but since Telodendria's goal is to not be dependent on any third-party code if at all possible, it makes sense to have a simple HTTP client to use not only for testing Telodendria, but also for configuring it. When we move the configuration to the database, we'll ship a script that uses this tool to allow admins to easily submit API requests. Do not be concerned that HttpClient does not support TLS yet. TLS support is necessary for federation to work, so it is coming eventually. 2023-03-08 03:30:36 +00:00			`[ ] Uri man page`
Format code, update TODO items. 2023-03-09 03:35:40 +00:00			`[x] Test on other platforms`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] Option to pretty-print Json`
			`[x] Document JsonEncode() and JsonEncodeValue()`
Implement pretty-printing option in Json. Telodendria itself doesn't use it, but the json CLI tool does. 2023-03-08 17:15:43 +00:00			`[ ] Update man page for td`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] Document Telodendria and Main`
Add tt and http-debug-server tools. 2023-03-10 18:48:52 +00:00			`[ ] Document tt and http-debug-server`
Get some more of my thoughts in the TODO file. 2023-03-03 18:56:36 +00:00
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] Simple command line tool to make matrix requests`
Bump version number to v0.3.0 2023-03-08 03:46:38 +00:00			`[x] Built on HTTP client API`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] http man page`
Begin working on JSON CLI tool. This is a similar situation to the HTTP CLI tool: since we have the Json API anyway, we might as well have a little command line tool to replace jq. 2023-03-08 04:06:43 +00:00			`[~] Simple command line tool for working with JSON`
Implement a mostly-functional query language for JSON. 2023-03-08 19:49:06 +00:00			`[x] Pretty-print Json`
			`[x] Query fields for use in shell scripts.`
Allow encoding user-provided strings. 2023-03-08 20:31:49 +00:00			`[x] Encode user-provided JSON strings`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] json man page`
Update TODO 2023-03-09 00:10:32 +00:00			`[ ] Update man pages for tp and send-patch`
Update TODO. 2023-02-23 16:46:27 +00:00
Define TLS API, update HttpClient to support optional TLS. Also added a LibreSSL TLS implementation. Client is verified to work; server has not been tested yet. 2023-03-22 00:41:21 +00:00			`[ ] Proper HTTP request router`
			`- Support regex matching`

Implement password-based user interactive authentication. 2023-02-28 15:17:11 +00:00			`[ ] Move configuration to database`
Get some more of my thoughts in the TODO file. 2023-03-03 18:56:36 +00:00			`[ ] Initial configuration`
			`[ ] If no config, create one-time use registration token that`
			`grants user admin privileges.`
Implement password-based user interactive authentication. 2023-02-28 15:17:11 +00:00			`[ ] /_telodendria/admin/config endpoint`
			`[ ] Refactor TelodendriaConfig to just Config (ConfigLock() and ConfigUnlock())`

Apply #64: Registration tokens. 2023-03-14 00:37:24 +00:00			`[~] Client-Server API`
			`[x] 4: Token-based user registration`
			`[x] Implement user-interactive auth flow`
			`[x] Token validity endpoint`
			`[x] Add m.login.registration_token to registration endpoint`
Get some more of my thoughts in the TODO file. 2023-03-03 18:56:36 +00:00			`flow`
			`- Ensure that registration tokens can be used even if`
			`registration is disabled.`
Apply #63, make some general bug fixes. 2023-03-10 03:24:04 +00:00			`[~] 4: Account management`
Apply #65, remove printf() in Db, and make tt show login messages. 2023-03-15 13:36:49 +00:00			`[~] Deactivate`
			`[x] Make sure UserLogin() fails if user is deactivated.`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`[ ] Change password`
Apply #63, make some general bug fixes. 2023-03-10 03:24:04 +00:00			`[x] Whoami`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`[ ] 9: User Data`
			`[ ] 5: Capabilities negotiation`
			`[ ] 10: Security (Rate Limiting)`

			`Milestone: v0.4.0`
			`-----------------`

			`[ ] Client-Server API`
			`[ ] 6: Filtering`
			`[ ] 7: Events`
			`[ ] 8: Rooms`

Fix -v option 2023-01-17 21:38:39 +00:00			`Milestone: v0.5.0`
			`-----------------`

			`[~] Client-Server API`
			`[ ] Modules`
			`[ ] Content Repository`

Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`Milestone: v1.0.0`
			`-----------------`
Update TODO items; refactor some milestones. 2022-11-21 21:18:00 +00:00
Add some more detail to TODO.txt 2022-12-06 21:59:06 +00:00			`[~] Client-Server API`
			`[ ] Modules`
			`[ ] Instant Messaging`
			`[ ] Voice over IP`
			`[ ] Receipts`
			`[ ] Fully Read Markers`
			`[ ] Send-To-Device Messaging`
Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] Server-Server API`
			`[ ] Application Service API`
			`[ ] Identity Service API`
			`[ ] Push Gateway API`
			`[ ] Room Versions`

Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`Milestone v1.1.0`
			`----------------`

			`[ ] Database upgrades/migration path`
Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] Create a command line tool to manage Telodendria`
			`[ ] User management`
			`[ ] Room management`
			`[ ] Migrate from Synapse or Dendrite, whichever is more mainstream by`
			`the time we get here.`