Telodendria/TODO.txt

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

Key:

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

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

[x] Stream API
    [x] Implementation
    [x] Convert all code that deals with I/O
    [!] Multi-output (proof of concept)
    [!] Memory streams (proof of concept)
    [x] TLS
    [!] SOCKS
    [x] Move/convert UtilStreamCopy()
[x] HTTP Client API
    [x] Document HttpParseHeaders()
    [x] Test on other platforms
[x] Option to pretty-print Json
    [x] Document JsonEncode() and JsonEncodeValue()
[x] Document Telodendria and Main

[x] Simple command line tool to make matrix requests
    [x] Built on HTTP client API
    [x] http man page
[x] 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

[x] Global log object
    - So we don't have to pass LogConfig around everywhere
    - Also allows debug and error logging in other APIs
[x] Make 'listen' directive in config an array of objects
    - Each object has port, threads, maxConnections
    - If tls is given, it can be null, false, or an object with cert and key
[x] Pass TLS certs and keys into HttpServer
[x] Debug OpenSSL
[x] Replace all usages of curl with http
[x] Proper HTTP request router
    [x] Support regex matching
    [x] Replace current routing system
    [x] Add route for requestToken endpoints
    [x] Move TelodendriaBuildRouter() to Routes

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

[ ] Documentation
    [ ] Array
    [ ] Io
    [ ] Stream
    [ ] Tls
    [ ] HttpClient
    [ ] Uri
    [ ] td
    [ ] tt
    [ ] http-debug-server
    [ ] tp
    [ ] send-patch
    [ ] Log
    [ ] TelodendriaConfig -> Config
    [ ] HashMap
    [ ] HttpRouter
    [ ] Str
    [x] telodendria-admin
    [x] telodendria-setup
    [x] telodendria-config
    [ ] Refactor dev pages so function description and
        return value are in the same location.

[~] 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.
        [~] User-Interactive fallback
            [~] Password
            [~] Registration token
    [~] 4: Account management
        [~] Deactivate
            [x] Make sure UserLogin() fails if user is deactivated.
        [x] Change password
        [~] Whoami
            [ ] Attach device id to user object
            [ ] Use UserAuthenticate()
    [~] 9: User Data
    [ ] 5: Capabilities negotiation
    [ ] 10: Security (Rate Limiting)

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

[ ] HTTP/1.1 support

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

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

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

Milestone: v0.6.0
-----------------

[~] Client-Server API
    [ ] Modules
        [ ] Instant Messaging
        [ ] Voice over IP
        [ ] Receipts
        [ ] Fully Read Markers
        [ ] Send-To-Device Messaging

Milestone: v0.7.0
-----------------

[ ] Server-Server API

Milestone: v0.8.0
-----------------

[ ] Application Service API

Milestone: v0.9.0
-----------------

[ ] Identity Service API

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

[ ] 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`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[!] Won't Do`
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
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[x] 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)`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[x] TLS`
			`[!] SOCKS`
Update TODO 2023-03-15 17:30:14 +00:00			`[x] Move/convert UtilStreamCopy()`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[x] HTTP Client API`
Misc changes. 2023-03-12 03:37:57 +00:00			`[x] Document HttpParseHeaders()`
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()`
			`[x] Document Telodendria and Main`
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`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[x] 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-02-23 16:46:27 +00:00
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[x] Global log object`
			`- So we don't have to pass LogConfig around everywhere`
			`- Also allows debug and error logging in other APIs`
Add support for spinning up multiple HTTP servers. This is useful for having a TLS and a non-TLS version port, like Synapse. I verified that the multiple-servers does in fact work as intended, although the TLS server part is broken; I must be doing something incorrectly with LibreSSL in setting up the server. 2023-03-23 02:12:45 +00:00			`[x] Make 'listen' directive in config an array of objects`
Remove remnants of non-global LogConfig from TelodendriaConfig 2023-03-22 16:31:24 +00:00			`- Each object has port, threads, maxConnections`
			`- If tls is given, it can be null, false, or an object with cert and key`
Add support for spinning up multiple HTTP servers. This is useful for having a TLS and a non-TLS version port, like Synapse. I verified that the multiple-servers does in fact work as intended, although the TLS server part is broken; I must be doing something incorrectly with LibreSSL in setting up the server. 2023-03-23 02:12:45 +00:00			`[x] Pass TLS certs and keys into HttpServer`
Fix OpenSSL server accept call. Apparently it can EAGAIN on non-blocking connections... I don't think LibreSSL's TLS library does this, but something to keep in mind if it doesn't work for somebody. 2023-03-31 23:10:52 +00:00			`[x] Debug OpenSSL`
Format code. 2023-04-01 02:46:59 +00:00			`[x] Replace all usages of curl with http`
Add route for requestToken endpoints. 2023-04-14 23:59:40 +00:00			`[x] Proper HTTP request router`
Add HttpRouter API; still have to convert the code to use it. 2023-04-06 01:48:32 +00:00			`[x] Support regex matching`
Refactor routing system to use HttpRouter. 2023-04-14 21:20:56 +00:00			`[x] Replace current routing system`
Add route for requestToken endpoints. 2023-04-14 23:59:40 +00:00			`[x] Add route for requestToken endpoints`
Move router building function into a more sensible location. 2023-04-14 21:37:00 +00:00			`[x] Move TelodendriaBuildRouter() to Routes`
Fix OpenSSL server accept call. Apparently it can EAGAIN on non-blocking connections... I don't think LibreSSL's TLS library does this, but something to keep in mind if it doesn't work for somebody. 2023-03-31 23:10:52 +00:00
Registration tokens now determine what privileges a user gets. 2023-04-16 18:32:22 +00:00			`[~] Move configuration to database`
			`[x] Token permissions`
Move configuration to database, add process control API, fix memory leaks. 2023-04-19 00:33:38 +00:00			`[x] Initial configuration`
			`[x] If no config, create one-time use registration token that`
Get some more of my thoughts in the TODO file. 2023-03-03 18:56:36 +00:00			`grants user admin privileges.`
Move configuration to database, add process control API, fix memory leaks. 2023-04-19 00:33:38 +00:00			`[~] /_telodendria/admin/config endpoint`
			`[x] JsonDuplicate()`
TelodendriaConfig -> Config 2023-03-22 17:17:30 +00:00			`[x] Refactor TelodendriaConfig to just Config`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00
			`[ ] Documentation`
Remove remnants of non-global LogConfig from TelodendriaConfig 2023-03-22 16:31:24 +00:00			`[ ] Array`
Add a global log configuration. This is the easiest and cleanest way to get logging into some of the fundamental APIs, such as the database and TLS APIs. We don't want to have to pass logging functions to those, but they can safely use the global logging configuration. 2023-03-22 14:52:04 +00:00			`[ ] Io`
			`[ ] Stream`
			`[ ] Tls`
			`[ ] HttpClient`
			`[ ] Uri`
			`[ ] td`
			`[ ] tt`
			`[ ] http-debug-server`
			`[ ] tp`
			`[ ] send-patch`
			`[ ] Log`
TelodendriaConfig -> Config 2023-03-22 17:17:30 +00:00			`[ ] TelodendriaConfig -> Config`
Add HttpRouter API; still have to convert the code to use it. 2023-04-06 01:48:32 +00:00			`[ ] HashMap`
			`[ ] HttpRouter`
			`[ ] Str`
Begin documenting Admin API. 2023-04-19 21:45:15 +00:00			`[x] telodendria-admin`
Add some more user documentation to clarify how configuration works. 2023-04-20 01:39:09 +00:00			`[x] telodendria-setup`
			`[x] telodendria-config`
Implement /_telodendria/admin/privileges Note that it's not exactly as the proposal defines it; theres a bit more nuance that will be documented soon. 2023-04-19 18:52:05 +00:00			`[ ] Refactor dev pages so function description and`
			`return value are in the same location.`
Implement password-based user interactive authentication. 2023-02-28 15:17:11 +00:00
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.`
Registration tokens now determine what privileges a user gets. 2023-04-16 18:32:22 +00:00			`[~] User-Interactive fallback`
Work on implementing user interactive authentication fallback. 2023-04-21 02:13:06 +00:00			`[~] Password`
			`[~] Registration token`
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.`
Accept #67: Add the password modification endpoint. 2023-03-28 01:17:47 +00:00			`[x] Change password`
Move configuration to database, add process control API, fix memory leaks. 2023-04-19 00:33:38 +00:00			`[~] Whoami`
			`[ ] Attach device id to user object`
			`[ ] Use UserAuthenticate()`
Apply #69 2023-04-14 17:50:14 +00:00			`[~] 9: User Data`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`[ ] 5: Capabilities negotiation`
			`[ ] 10: Security (Rate Limiting)`

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

Registration tokens now determine what privileges a user gets. 2023-04-16 18:32:22 +00:00			`[ ] HTTP/1.1 support`

Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`[ ] 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`

Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00			`Milestone: v0.6.0`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`-----------------`
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`
Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00
			`Milestone: v0.7.0`
			`-----------------`

Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] Server-Server API`
Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00
			`Milestone: v0.8.0`
			`-----------------`

Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] Application Service API`
Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00
			`Milestone: v0.9.0`
			`-----------------`

Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] Identity Service API`
Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00
			`Milestone: v1.0.0`
			`-----------------`

Clean the TODO list up a bit, organizing it and deleting old entries. 2022-11-03 16:42:57 +00:00			`[ ] 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.`