Compare commits

...

9 Commits

Author SHA1 Message Date
d820bc2f23 Bump version, update NEWS 2020-10-13 16:03:19 +02:00
b458fc1f99 libedit: bind M-Enter to newline-insert as well 2020-10-13 15:55:37 +02:00
0771c142fe json-rpc-test-server: fix reading the request URI 2020-10-13 04:46:08 +02:00
742632a931 Bump http-parser
Apparently it's reached maturity and there won't be any changes
anytime soon, making this the perfect time for an upgrade.
2020-10-13 04:35:42 +02:00
2221828763 OpenRPC: avoid eating HTTP/transport errors 2020-10-13 04:35:32 +02:00
c2a00511c0 Document OpenRPC tab completion support
Now that it's functional in both frontends, we can flaunt it.

I still don't want to make it the default.

Closes #1
2020-10-13 04:23:28 +02:00
2b18ebf314 Implement tab completion under libedit
I haven't tested it with real wide characters but it will have to do.
I wasn't even sure if this piece of crap could be coerced into doing
this at first, so it's a win for me.

It uses a variation of the code in degesch where we /don't/ want to
print the list of candidates on partial failure.

Updates #1
2020-10-13 03:58:26 +02:00
5d2cd01db0 json-rpc-test-server: fix a potential memory leak 2020-10-13 02:08:53 +02:00
ee79249d23 json-rpc-shell.adoc: update WebSocket notes
https://github.com/open-rpc/client-js also uses WebSockets,
although they don't seem to support notifications (in general).
2020-10-10 05:20:31 +02:00
7 changed files with 190 additions and 46 deletions

View File

@@ -14,7 +14,7 @@ endif ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUCC)
# Version
set (project_VERSION_MAJOR "1")
set (project_VERSION_MINOR "0")
set (project_VERSION_MINOR "1")
set (project_VERSION_PATCH "0")
set (project_VERSION "${project_VERSION_MAJOR}")

11
NEWS
View File

@@ -1,3 +1,14 @@
1.1.0 (2020-10-13)
* Add method name tab completion using OpenRPC information
* Bind M-Enter to insert a newline into the command line
* json-rpc-test-server: fix a memory leak and request URI parsing
* Miscellaneous bug fixes
1.0.0 (2020-09-05)
* Initial release

View File

@@ -18,6 +18,7 @@ you get the following niceties:
results in your favourite editor or redirect them to a file
- ability to edit the input line in your favourite editor as well with Alt+E
- WebSockets (RFC 6455) can also be used as a transport rather than HTTP
- support for method name tab completion using OpenRPC discovery
Documentation
-------------

View File

@@ -76,6 +76,10 @@ Protocol
*-o* _ORIGIN_, *--origin*=_ORIGIN_::
Set the HTTP Origin header to _ORIGIN_. Some servers may need this.
*-O*, *--openrpc*::
Call "rpc.discover" upon start-up in order to pull in OpenRPC data for
tab completion of method names.
Program information
~~~~~~~~~~~~~~~~~~~
*-h*, *--help*::
@@ -113,8 +117,7 @@ newlines.
WebSockets
~~~~~~~~~~
The JSON-RPC 2.0 specification doesn't say almost anything about underlying
transports. As far as the author is aware, he is the only person combining it
with WebSockets. The way it's implemented here is that every request is sent as
transports. The way it's implemented here is that every request is sent as
a single text message. If it has an "id" field, i.e., it's not just
a notification, the client waits for a message from the server in response.
Should any message arrive unexpectedly, you will receive a warning.

View File

@@ -141,6 +141,8 @@ struct input
void (*on_input) (char *line, void *user_data);
/// User requested external line editing
void (*on_run_editor) (const char *line, void *user_data);
/// Tab completion generator, returns locale encoding strings or NULL
char *(*complete_start_word) (const char *text, int state);
};
struct input_vtable
@@ -268,7 +270,19 @@ input_rl_on_startup (void)
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
static char **app_readline_completion (const char *text, int start, int end);
static char **
app_readline_completion (const char *text, int start, int end)
{
(void) end;
// Only customize matches for the first token, which is the method name
if (start)
return NULL;
// Don't iterate over filenames and stuff in this case
rl_attempted_completion_over = true;
return rl_completion_matches (text, g_input_rl->super.complete_start_word);
}
static void
input_rl_start (struct input *input, const char *program_name)
@@ -629,6 +643,15 @@ input_el_on_run_editor (EditLine *editline, int key)
return CC_NORM;
}
static unsigned char
input_el_on_newline_insert (EditLine *editline, int key)
{
(void) key;
el_insertstr (editline, "\n");
return CC_REFRESH;
}
static void
input_el_install_prompt (struct input_el *self)
{
@@ -638,6 +661,8 @@ input_el_install_prompt (struct input_el *self)
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
static unsigned char input_el_on_complete (EditLine *editline, int key);
static void
input_el_start (struct input *input, const char *program_name)
{
@@ -655,17 +680,17 @@ input_el_start (struct input *input, const char *program_name)
// Just what are you doing?
el_set (self->editline, EL_BIND, "^u", "vi-kill-line-prev", NULL);
// It's probably better to handle this ourselves
// It's probably better to handle these ourselves
el_set (self->editline, EL_ADDFN,
"send-line", "Send line", input_el_on_return);
el_set (self->editline, EL_BIND, "\n", "send-line", NULL);
// It's probably better to handle this ourselves
el_set (self->editline, EL_ADDFN,
"run-editor", "Run editor to edit line", input_el_on_run_editor);
el_set (self->editline, EL_BIND, "M-e", "run-editor", NULL);
// TODO: implement method name completion for editline (see degesch)
el_set (self->editline, EL_ADDFN,
"newline-insert", "Insert a newline", input_el_on_newline_insert);
el_set (self->editline, EL_BIND, "M-\n", "newline-insert", NULL);
// Source the user's defaults file
el_source (self->editline, NULL);
@@ -795,6 +820,121 @@ input_el_ding (struct input *input)
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
static int
input_el_collate (const void *a, const void *b)
{
return strcoll (*(const char **) a, *(const char **) b);
}
static struct strv
input_el_collect_candidates (struct input_el *self, const char *word)
{
struct strv v = strv_make ();
int i = 0; char *candidate = NULL;
while ((candidate = self->super.complete_start_word (word, i++)))
strv_append_owned (&v, candidate);
qsort (v.vector, v.len, sizeof *v.vector, input_el_collate);
return v;
}
static void
input_el_print_candidates (struct input_el *self, const struct strv *v)
{
EditLine *editline = self->editline;
// This insanity seems to be required to make it reprint the prompt
const LineInfoW *info = el_wline (editline);
int from_cursor_until_end = info->lastchar - info->cursor;
el_cursor (editline, from_cursor_until_end);
el_insertstr (editline, "\n");
input_el_redisplay (self);
el_wdeletestr (editline, 1);
el_set (editline, EL_REFRESH);
input_el_hide (&self->super);
for (size_t i = 0; i < v->len; i++)
printf ("%s\n", v->vector[i]);
input_el_show (&self->super);
el_cursor (editline, -from_cursor_until_end);
}
static void
input_el_insert_common_prefix (EditLine *editline, const struct strv *v)
{
char *p[v->len]; memcpy (p, v->vector, sizeof p);
mbstate_t state[v->len]; memset (state, 0, sizeof state);
wchar_t want[2] = {}; size_t len;
while ((len = mbrtowc (&want[0], p[0], strlen (p[0]), &state[0])) > 0)
{
p[0] += len;
for (size_t i = 1; i < v->len; i++)
{
wchar_t found = 0;
if ((len = mbrtowc (&found, p[i], strlen (p[i]), &state[i])) <= 0
|| found != want[0])
return;
p[i] += len;
}
el_winsertstr (editline, want);
}
}
static unsigned char
input_el_on_complete (EditLine *editline, int key)
{
(void) key;
struct input_el *self;
el_get (editline, EL_CLIENTDATA, &self);
// First prepare what Readline would have normally done for us...
const LineInfo *info_mb = el_line (editline);
int len = info_mb->lastchar - info_mb->buffer;
int point = info_mb->cursor - info_mb->buffer;
char *word = xstrndup (info_mb->buffer, len);
int start = point;
while (start && !isspace_ascii (word[start - 1]))
start--;
// Only complete the first word, when we're at the end of it
if (start != 0
|| (word[point] && !isspace_ascii (word[point]))
|| (point && isspace_ascii (word[point - 1])))
{
free (word);
return CC_REFRESH_BEEP;
}
word[point] = '\0';
int word_len = mbstowcs (NULL, word, 0);
struct strv v = input_el_collect_candidates (self, word);
free (word);
if (!v.len)
{
strv_free (&v);
return CC_REFRESH_BEEP;
}
// Remove the original word and replace it with the best (sub)match
el_wdeletestr (editline, word_len);
if (v.len == 1)
{
el_insertstr (editline, v.vector[0]);
el_insertstr (editline, " ");
strv_free (&v);
return CC_REFRESH;
}
input_el_insert_common_prefix (editline, &v);
input_el_print_candidates (self, &v);
strv_free (&v);
return CC_REFRESH_BEEP;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
static bool
input_el_load_history (struct input *input, const char *filename,
struct error **e)
@@ -3092,24 +3232,16 @@ fail:
// --- OpenRPC information extraction ------------------------------------------
static void
init_openrpc (struct app_context *ctx)
parse_rpc_discover (struct app_context *ctx, struct str *buf, struct error **e)
{
if (!ctx->openrpc)
return;
json_t *id = json_integer (ctx->next_id++);
struct str buf = str_make ();
struct error *e = json_rpc_call_raw (ctx, "rpc.discover", id, NULL, &buf);
json_decref (id);
// Just optimistically punch through, I don't have time for this shit
json_error_t error;
json_t *response = NULL, *result = NULL, *value = NULL;
if (!e && !(response = json_loadb (buf.str, buf.len, 0, &error)))
error_set (&e, "parse failure: %s", error.text);
if (!(response = json_loadb (buf->str, buf->len, 0, &error)))
error_set (e, "parse failure: %s", error.text);
else if (!(result = json_object_get (response, "result"))
|| !(result = json_object_get (result, "methods")))
error_set (&e, "unsupported");
error_set (e, "unsupported");
else
{
const char *name = NULL;
@@ -3119,20 +3251,31 @@ init_openrpc (struct app_context *ctx)
str_map_set (&ctx->methods, name, (void *) 1);
}
json_decref (response);
if (e)
}
static void
init_openrpc (struct app_context *ctx)
{
if (!ctx->openrpc)
return;
json_t *id = json_integer (ctx->next_id++);
struct str buf = str_make ();
struct error *error;
if (!(error = json_rpc_call_raw (ctx, "rpc.discover", id, NULL, &buf)))
parse_rpc_discover (ctx, &buf, &error);
json_decref (id);
if (error)
{
print_error ("OpenRPC: %s", e->message);
error_free (e);
print_error ("OpenRPC: %s", error->message);
error_free (error);
}
str_free (&buf);
}
// --- GNU Readline user actions -----------------------------------------------
#ifdef HAVE_READLINE
static char *
app_readline_complete (const char *text, int state)
complete_method_name (const char *text, int state)
{
static struct str_map_iter iter;
if (!state)
@@ -3156,22 +3299,6 @@ app_readline_complete (const char *text, int state)
return match;
}
static char **
app_readline_completion (const char *text, int start, int end)
{
(void) end;
// Only customize matches for the first token, which is the method name
if (start)
return NULL;
// Don't iterate over filenames and stuff in this case
rl_attempted_completion_over = true;
return rl_completion_matches (text, app_readline_complete);
}
#endif // HAVE_READLINE
// --- Main program ------------------------------------------------------------
// The ability to use an external editor on the input line has been shamelessly
@@ -3499,6 +3626,7 @@ main (int argc, char *argv[])
g_ctx.input->user_data = &g_ctx;
g_ctx.input->on_input = process_input;
g_ctx.input->on_run_editor = run_editor;
g_ctx.input->complete_start_word = complete_method_name;
g_ctx.methods = str_map_make (NULL);
init_colors (&g_ctx);

View File

@@ -329,6 +329,7 @@ fcgi_muxer_on_get_values
nv_parser.output = &values;
fcgi_nv_parser_push (&nv_parser, parser->content.str, parser->content.len);
fcgi_nv_parser_free (&nv_parser);
const char *key = NULL;
// No real-world servers seem to actually use multiplexing
@@ -1013,7 +1014,7 @@ static int
ws_handler_on_url (http_parser *parser, const char *at, size_t len)
{
struct ws_handler *self = parser->data;
str_append_data (&self->value, at, len);
str_append_data (&self->url, at, len);
return 0;
}