Telodendria/TODO.txt

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

Key:

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

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

[~] /_telodendria/admin/config endpoint
    [ ] Update only certain values

[~] Client-Server API
    [x] 6: Filtering
        [x] Finish validating filters before saving them.
    [~] 7: Events
        [x] Compute size of JSON object in Canonical JSON
        [x] Rename Sha2.h to just Sha; add Sha1() function
        [x] Make Sha256() return raw bytes; add function to
            convert to hex string.
    [~] 8: Rooms
    [~] 9: User Data
        [x] Profiles
        [~] Directory

[ ] Admin API
    [ ] Registration token endpoints

[~] Cytoplasm
    [~] Debug OpenSSL
        [x] Database corruption
        [ ] File descriptor exhaustion
[ ] Random memory corruption after many requests.
[~] j2s
    [x] Properly support arrays of primitives.
    [ ] How to set default value of true on boolean?
        - defaults probably need to be set at parser level, not
          enough to set it after.
        - Or booleans should default to -1 if not specified, let the
          higher level logic set the default from there.
    [ ] Write man page.

[x] Refactor MatrixErrorCreate() to take a custom message or NULL to
    use the default. This will make debugging a lot easier.
    [ ] Use detailed error messages for HTTP 500s at the minimum. Other
        error messages might also be useful.
[x] Make sure admin registration token is printed to log, not stdout.
    Unless they are the same, of course.
[ ] Refactor Config to use j2s.
[ ] Refactor other endpoints to use j2s for validating request bodies.

[ ] Add parser API to parse the identifier grammers
    [ ] Use in alias endpoints
[ ] Finish RouteRoomAliases
    [ ] Get from "id" in aliases
    [ ] Note to check permissions according to spec
[ ] Finish RouteAliasDirectory
    [ ] Add "id" objects when putting aliases
    [ ] Delete from "id" when deleting alias
    [x] Add alias admin privilege to allow admins to manage aliases

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

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

[ ] HTTP/1.1 support
    [ ] Content-Length
    [ ] Keep connections open
    [ ] Chunked encoding
[ ] Refactor Memory API to use mmap().

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

[~] Client-Server API
    [ ] Modules
        [ ] Instant Messaging
        [ ] Voice over IP
        [ ] Receipts
        [ ] Fully Read Markers
        [ ] Send-To-Device Messaging
    [ ] 10: Security (Rate Limiting)

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

[ ] Server-Server API

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

[ ] Application Service API

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

[ ] Identity Service API

Milestone: v1.7.0
-----------------

[ ] Push Gateway API
[ ] Room Versions

Milestone v1.7.1
----------------

[ ] 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.4.0`
			`-----------------`

Adjust milestone requirements. I really want v0.3.0 out soon. 2023-05-26 19:21:25 +00:00			`[~] /_telodendria/admin/config endpoint`
			`[ ] Update only certain values`

Begin working on filtering. 2023-06-17 19:09:06 +00:00			`[~] Client-Server API`
Add RoomCreateRequest schema. 2023-08-05 15:00:52 +00:00			`[x] 6: Filtering`
			`[x] Finish validating filters before saving them.`
Refactor Sha API to return raw bytes, added Sha1() function. 2023-06-17 17:36:11 +00:00			`[~] 7: Events`
Fix CanonicalJson and ArraySort. 2023-06-21 02:37:56 +00:00			`[x] Compute size of JSON object in Canonical JSON`
Refactor Sha API to return raw bytes, added Sha1() function. 2023-06-17 17:36:11 +00:00			`[x] Rename Sha2.h to just Sha; add Sha1() function`
			`[x] Make Sha256() return raw bytes; add function to`
			`convert to hex string.`
Add EventRedact() prototype. 2023-07-09 23:18:18 +00:00			`[~] 8: Rooms`
Adjust milestone requirements. I really want v0.3.0 out soon. 2023-05-26 19:21:25 +00:00			`[~] 9: User Data`
			`[x] Profiles`
Update TODO. 2023-06-12 18:00:26 +00:00			`[~] Directory`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00
Update TODO. 2023-06-18 03:25:03 +00:00			`[ ] Admin API`
			`[ ] Registration token endpoints`

Prepare for v0.3.0 release. Not exactly as complete as I initially imagined, but I want to get something out because I've been spending too much time on the same issues. 2023-06-10 13:29:56 +00:00			`[~] Cytoplasm`
			`[~] Debug OpenSSL`
			`[x] Database corruption`
			`[ ] File descriptor exhaustion`
			`[ ] Random memory corruption after many requests.`
Implement filter validation by using j2s. 2023-08-05 13:46:23 +00:00			`[~] j2s`
			`[x] Properly support arrays of primitives.`
Add leaky Cytoplasm JSON -> Struct code generator. It is basically complete, I just have to finish cleaning up some of the memory leaks and remove the log messages. 2023-08-01 20:23:19 +00:00			`[ ] How to set default value of true on boolean?`
			`- defaults probably need to be set at parser level, not`
			`enough to set it after.`
Print admin registration token to configured log, not default stdout. If Telodendria is started as a daemon and is logging to the syslog, we want the token to show up in the syslog. 2023-08-05 14:12:02 +00:00			`- Or booleans should default to -1 if not specified, let the`
			`higher level logic set the default from there.`
			`[ ] Write man page.`
Prepare for v0.3.0 release. Not exactly as complete as I initially imagined, but I want to get something out because I've been spending too much time on the same issues. 2023-06-10 13:29:56 +00:00
Apply patch to make MatrixErrorCreate() take a custom message. 2023-08-05 19:26:03 +00:00			`[x] Refactor MatrixErrorCreate() to take a custom message or NULL to`
Update change log. 2023-06-18 03:19:12 +00:00			`use the default. This will make debugging a lot easier.`
Apply patch to make MatrixErrorCreate() take a custom message. 2023-08-05 19:26:03 +00:00			`[ ] Use detailed error messages for HTTP 500s at the minimum. Other`
			`error messages might also be useful.`
Print admin registration token to configured log, not default stdout. If Telodendria is started as a daemon and is logging to the syslog, we want the token to show up in the syslog. 2023-08-05 14:12:02 +00:00			`[x] Make sure admin registration token is printed to log, not stdout.`
Add Filter API to validate filters and process events. 2023-06-18 02:53:06 +00:00			`Unless they are the same, of course.`
Properly exclude Schema directories from showing up in CVS. 2023-08-05 14:03:08 +00:00			`[ ] Refactor Config to use j2s.`
Add RoomCreateRequest schema. 2023-08-05 15:00:52 +00:00			`[ ] Refactor other endpoints to use j2s for validating request bodies.`
Begin working on filtering. 2023-06-17 19:09:06 +00:00
Begin working on room aliases. These endpoints will help me build out some functionality that will be needed when actually implementing rooms. 2023-08-09 15:19:45 +00:00			`[ ] Add parser API to parse the identifier grammers`
			`[ ] Use in alias endpoints`
			`[ ] Finish RouteRoomAliases`
			`[ ] Get from "id" in aliases`
			`[ ] Note to check permissions according to spec`
			`[ ] Finish RouteAliasDirectory`
			`[ ] Add "id" objects when putting aliases`
			`[ ] Delete from "id" when deleting alias`
Add admin privilege to manage room aliases. 2023-08-09 15:50:03 +00:00			`[x] Add alias admin privilege to allow admins to manage aliases`
Begin working on room aliases. These endpoints will help me build out some functionality that will be needed when actually implementing rooms. 2023-08-09 15:19:45 +00:00
Fix -v option 2023-01-17 21:38:39 +00:00			`Milestone: v0.5.0`
			`-----------------`

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

Prepare for v0.3.0 release. Not exactly as complete as I initially imagined, but I want to get something out because I've been spending too much time on the same issues. 2023-06-10 13:29:56 +00:00			`[ ] HTTP/1.1 support`
			`[ ] Content-Length`
			`[ ] Keep connections open`
			`[ ] Chunked encoding`
Update TODO. 2023-06-13 14:05:34 +00:00			`[ ] Refactor Memory API to use mmap().`
Prepare for v0.3.0 release. Not exactly as complete as I initially imagined, but I want to get something out because I've been spending too much time on the same issues. 2023-06-10 13:29:56 +00:00
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`
Document hdoc 2023-05-21 00:21:39 +00:00			`[ ] 10: Security (Rate Limiting)`
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
Fix stable release version scheme (more details in an upcoming newsletter) 2023-07-01 20:18:59 +00:00			`Milestone: v1.7.0`
Break up todo items into more milestones. 2023-04-15 13:31:08 +00:00			`-----------------`

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`

Fix stable release version scheme (more details in an upcoming newsletter) 2023-07-01 20:18:59 +00:00			`Milestone v1.7.1`
Define project timeline a little more. 2023-01-17 19:05:26 +00:00			`----------------`

			`[ ] 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.`
Fix stable release version scheme (more details in an upcoming newsletter) 2023-07-01 20:18:59 +00:00