Skip to content

Commit

Permalink
builtins: make ltrimstr and rtrimstr error for non-string inputs
Browse files Browse the repository at this point in the history
Previously, ltrimstr/rtrimstr would just let the input pass through for
non-string inputs or arguments.

That was happening because, they were leaking the errors returned by
startswith/endswith treating them as if they were jv_false().
The leak was resolved by jqlang#2977 for 1.7.1

This patch rewrites ltrimstr and rtrimstr in jq, and makes them not
ignore startswith and endswith errors anymore.
  • Loading branch information
emanuele6 authored and nicowilliams committed Jan 16, 2024
1 parent 71e7bcd commit 1f1e619
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 33 deletions.
33 changes: 0 additions & 33 deletions src/builtin.c
Original file line number Diff line number Diff line change
Expand Up @@ -294,37 +294,6 @@ static jv f_endswith(jq_state *jq, jv a, jv b) {
return ret;
}

static jv f_ltrimstr(jq_state *jq, jv input, jv left) {
jv startswith = f_startswith(jq, jv_copy(input), jv_copy(left));
if (jv_get_kind(startswith) != JV_KIND_TRUE) {
jv_free(startswith);
jv_free(left);
return input;
}
/*
* FIXME It'd be better to share the suffix with the original input --
* that we could do, we just can't share prefixes.
*/
int prefixlen = jv_string_length_bytes(left);
jv res = jv_string_sized(jv_string_value(input) + prefixlen,
jv_string_length_bytes(jv_copy(input)) - prefixlen);
jv_free(input);
return res;
}

static jv f_rtrimstr(jq_state *jq, jv input, jv right) {
jv endswith = f_endswith(jq, jv_copy(input), jv_copy(right));
if (jv_get_kind(endswith) == JV_KIND_TRUE) {
jv res = jv_string_sized(jv_string_value(input),
jv_string_length_bytes(jv_copy(input)) - jv_string_length_bytes(right));
jv_free(input);
return res;
}
jv_free(endswith);
jv_free(right);
return input;
}

jv binop_minus(jv a, jv b) {
if (jv_get_kind(a) == JV_KIND_NUMBER && jv_get_kind(b) == JV_KIND_NUMBER) {
jv r = jv_number(jv_number_value(a) - jv_number_value(b));
Expand Down Expand Up @@ -1736,8 +1705,6 @@ BINOPS
{f_keys_unsorted, "keys_unsorted", 1},
{f_startswith, "startswith", 2},
{f_endswith, "endswith", 2},
{f_ltrimstr, "ltrimstr", 2},
{f_rtrimstr, "rtrimstr", 2},
{f_string_split, "split", 2},
{f_string_explode, "explode", 1},
{f_string_implode, "implode", 1},
Expand Down
2 changes: 2 additions & 0 deletions src/builtin.jq
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ def fromdateiso8601: strptime("%Y-%m-%dT%H:%M:%SZ")|mktime;
def todateiso8601: strftime("%Y-%m-%dT%H:%M:%SZ");
def fromdate: fromdateiso8601;
def todate: todateiso8601;
def ltrimstr($left): if startswith($left) then .[$left | length:] end;
def rtrimstr($right): if endswith($right) then .[:$right | -length] end;
def match(re; mode): _match_impl(re; mode; false)|.[];
def match($val): ($val|type) as $vt | if $vt == "string" then match($val; null)
elif $vt == "array" and ($val | length) > 1 then match($val[0]; $val[1])
Expand Down
16 changes: 16 additions & 0 deletions tests/jq.test
Original file line number Diff line number Diff line change
Expand Up @@ -2115,3 +2115,19 @@ try ltrimstr("x") catch "x", try rtrimstr("x") catch "x" | "ok"
{"hey":[]}
"ok"
"ok"

# ltrimstr/1 and rtrimstr/1 return an error for non-strings. #2969

.[] as [$x, $y] | try ["ok", ($x | ltrimstr($y))] catch ["ko", .]
[["hi",1],[1,"hi"],["hi","hi"],[1,1]]
["ko","startswith() requires string inputs"]
["ko","startswith() requires string inputs"]
["ok",""]
["ko","startswith() requires string inputs"]

.[] as [$x, $y] | try ["ok", ($x | rtrimstr($y))] catch ["ko", .]
[["hi",1],[1,"hi"],["hi","hi"],[1,1]]
["ko","endswith() requires string inputs"]
["ko","endswith() requires string inputs"]
["ok",""]
["ko","endswith() requires string inputs"]

0 comments on commit 1f1e619

Please sign in to comment.