Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New relay "api": HTTP REST API #2066

Open
flashcode opened this issue Feb 1, 2024 · 0 comments
Open

New relay "api": HTTP REST API #2066

flashcode opened this issue Feb 1, 2024 · 0 comments
Assignees
@flashcode
Labels
feature New feature request in progress Someone is working on this issue
Milestone
4.3.0

Comments

@flashcode
Copy link
Member

flashcode commented Feb 1, 2024 •
edited

Feature description

Add a new relay protocol called "api", with the following goals:

  • easy client implementation: HTTP REST API, JSON input/output
  • data synchronization: real-time sync with websocket or polling with HTTP requests
  • no internal structures exposed: ANSI color codes, no use of pointers & complex structures like hdata
  • WeeChat itself can connect to another WeeChat using this protocol (also known as relay "remote")

Specification: https://specs.weechat.org/specs/2023-005-relay-http-rest-api.html
@flashcode flashcode added the feature New feature request label Feb 1, 2024
@flashcode flashcode added this to the 4.3.0 milestone Feb 1, 2024
@flashcode flashcode self-assigned this Feb 1, 2024
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay: add "api" protocol (HTTP REST API) (issue #2066)
8971fc0
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
core: add support of base64url in encode/decode functions (issue #2066)
f126255
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay: rename option relay.weechat.commands to relay.network.commands…
70907fc 
… (issue #2066)
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay: allow password hash authentication in api relay, add option re…
83567fd 
…lay.network.time_window (issue #2066)
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay: remove request from some function arguments (issue #2066)
89aeb03
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay/api: fix send of responses 400 and 404 in case of error (issue #…
de72fe1 
…2066)
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay: check that request is not NULL before compressing data (issue #…
3f902db 
…2066)
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
relay/api: add handshake resource, without authentication required (i…
6acf1af 
…ssue #2066)
flashcode added a commit that referenced this issue Feb 1, 2024
@flashcode
core: update translations (issue #2066)
86685f4
@flashcode flashcode added the in progress Someone is working on this issue label Feb 2, 2024
flashcode added a commit that referenced this issue Feb 2, 2024
@flashcode
relay: fix build when CJSON is disabled (issue #2066)
bc46467
flashcode added a commit that referenced this issue Feb 2, 2024
@flashcode
core: disable CJSON in Debian/buster, Raspbian/buster and Ubuntu/foca…
5c86972 
…l builds (issue #2066)

This is because in these versions the libcjson-dev package doesn't provide
pkg-config file.
@flashcode flashcode mentioned this issue Feb 2, 2024
Closed
flashcode added a commit that referenced this issue Feb 3, 2024
@flashcode
relay/api: add extra check on JSON types in handshake and input resou…
052db75 
…rces (issue #2066)
@flashcode flashcode mentioned this issue Mar 26, 2024
Closed
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add command /remote, add remote configuration in relay.conf …
786f889 
…(issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay/api: fix style (issue #2066)
3f993f9
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add proxy option in remote (issue #2066)
c4c220f
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add functions to parse HTTP response (issue #2066)
c2343ec
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add option disconnect in command /remote (issue #2066)
fd32192
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add connection to remote (issue #2066)
90b855e 
Connection to remote:

- handshake: offer support for all supported hash algorithms
- network connect with a socket
- upgrade to websocket and authenticate with remote (password/TOTP)
- check websocket response
- get list of buffers (not used yet)

Note: connection to remote with TLS or a proxy is not yet supported.
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: check that parameter ws_deflate is not NULL in function relay_…
a3f3c9d 
…websocket_deflate_free (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
tests: add tests on relay remote functions (issue #2066)
f507be4
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: stop URL address before the first question mark if colon is no…
4460f92 
…t found (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add option send in command /remote (issue #2066)
643adec 
This can be used to send raw JSON data encapsulated in a websocket frame to the
remote.

Example: /remote send test {"request":"GET /api/version"}
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay/api: add "body_type" in response when a body is set and connect…
9d7e887 
…ed via websocket (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay/api: add "request" and "request_body" in response when connecte…
cb785d5 
…d via websocket (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay/api: replace direct access to JSON number value by call to func…
64db1b9 
…tion cJSON_GetNumberValue() (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay/api: add fields "displayed" and "notify_level" in lines returne…
3cce916 
…d (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
buffer: add property input_get_any_user_data in buffer (issue #2066)
4adb642 
This allows buffers to get any user input, including commands, that are sent to
the buffer callback instead of being executed on the buffer.
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: do not share content of any relay buffer in api and weechat pr…
b664700 
…otocols (issue #2066)

This is to prevent infinite loop when connected to a remote which is the
weechat instance itself.
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add synchronization with remote and handler for events receive…
a499b50 
…d (issue #2066)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: set default value of undefined remote options to empty string …
40a6854 
…instead of NULL (issue #2066)

This fixes the websocket connection to remote that is not initiated after the
successful handshake with the remote relay/api.
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: improve messages displayed (issue #2066)
ef12c93
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
core: update French translations (issue #2066)
cb6c2fd
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add missing line for "api" protocol in /help relay (issue #2066
eacd000 
)
flashcode added a commit that referenced this issue Apr 7, 2024
@flashcode
relay: add example with "api" protocol in /help relay (issue #2066)
8cb302e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@flashcode flashcode

Labels
feature New feature request in progress Someone is working on this issue
Projects
None yet
Milestone
4.3.0
Development

No branches or pull requests
1 participant
@flashcode