Add JSON-RPC capability #1373
Open
Add JSON-RPC capability #1373
+26,312
−231
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Inline nlohmann/json for the JSON parsing itself, and handle requests with the same SCGI interface as XML-RPC. Based off the work in https://github.com/jesec/rtorrent
rakshasa
reviewed
Jan 12, 2025
| [](const char* hash) { return control->core()->download_list()->find_hex_ptr(hash); }, | ||
| [](core::Download* d, uint32_t index) { return rpc_find_file(d, index); }, | ||
| [](core::Download* d, uint32_t index) { return rpc_find_tracker(d, index); }, | ||
| [](core::Download* d, const torrent::HashString& hash) { return rpc_find_peer(d, hash); }); |
There was a problem hiding this comment.
Not a fan of this style without assignment being done to named slots.
rakshasa
reviewed
Jan 12, 2025
| const unsigned long start = uri.find("base64,", 5) + 7; | ||
| if (start >= uri.size()) | ||
| throw torrent::input_error("Empty base64."); | ||
| auto output = utils::decode_base64(uri.substr(start)); |
There was a problem hiding this comment.
Create a function decode_data_uri that does both the check and decoding.
rakshasa
reviewed
Jan 12, 2025
|
|
||
| #include "parse_commands.h" | ||
|
|
||
| #include "rpc/rpc_manager.h" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based off the work in https://github.com/jesec/rtorrent, this implements the 2.0 specification: https://www.jsonrpc.org/specification. It adds a new RpcManager class and a little SCGI logic to handle switching between XML and JSON seamlessly. If the
CONTENT_TYPEheader is present and set toapplication/json(ortext/xmlfor XML-RPC), it'll use that, otherwise it will peek at the body to auto-detect it.The main benefit is reduced message size, as seen on this synthetic set of 10k torrents:
One limitation of JSON-RPC is that it doesn't have a dedicated binary data type. Due to that, base64 data URI support has been added to all the
load.*commands. Those are currently the only commands which normally need to take binary data, but any future commands would have to follow the same pattern or implement their own scheme.Note for Flood users
When Flood detects the presence of JSON-RPC, it assumes that the full jesec/rtorrent capabilities are available, which breaks a couple things. Thankfully, it's pretty easy to provide some stubs/redirects to get it working: