Skip to content

Add snake case aliases for escapeURIComponent #27

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

Merged
hsbt merged 2 commits into from
Nov 7, 2023
Merged

Add snake case aliases for escapeURIComponent #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e78890e
Add snake case aliases for escapeURIComponent
byroot Aug 16, 2022
11c11ef
Implement escapeURIComponent for JRuby
byroot Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ext/cgi/escape/escape.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,9 @@ InitVM_escape(void)
rb_define_method(rb_mEscape, "escapeHTML", cgiesc_escape_html, 1);
rb_define_method(rb_mEscape, "unescapeHTML", cgiesc_unescape_html, 1);
rb_define_method(rb_mEscape, "escapeURIComponent", cgiesc_escape_uri_component, 1);
rb_define_alias(rb_mEscape, "escape_uri_component", "escapeURIComponent");
rb_define_method(rb_mEscape, "unescapeURIComponent", cgiesc_unescape_uri_component, -1);
rb_define_alias(rb_mEscape, "unescape_uri_component", "unescapeURIComponent");
rb_define_method(rb_mEscape, "escape", cgiesc_escape, 1);
rb_define_method(rb_mEscape, "unescape", cgiesc_unescape, -1);
rb_prepend_module(rb_mUtil, rb_mEscape);
Expand Down
51 changes: 45 additions & 6 deletions ext/java/org/jruby/ext/cgi/escape/CGIEscape.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ static boolean url_unreserved_char(int c) {

static final byte[] upper_hexdigits = "0123456789ABCDEF".getBytes(RubyEncoding.UTF8);

static IRubyObject optimized_escape(Ruby runtime, RubyString str) {
static IRubyObject optimized_escape(Ruby runtime, RubyString str, boolean escapePlus) {
int i, len, beg = 0;
RubyString dest = null;
byte[] cstrBytes;
Expand All @@ -285,7 +285,7 @@ static IRubyObject optimized_escape(Ruby runtime, RubyString str) {
dest.cat(cstrBytes, cstr + beg, i - beg);
beg = i + 1;

if (c == ' ') {
if (escapePlus && c == ' ') {
dest.cat('+');
} else {
buf[1] = upper_hexdigits[(c >> 4) & 0xf];
Expand All @@ -305,7 +305,7 @@ static IRubyObject optimized_escape(Ruby runtime, RubyString str) {
}

static IRubyObject
optimized_unescape(ThreadContext context, RubyString str, IRubyObject encoding) {
optimized_unescape(ThreadContext context, RubyString str, IRubyObject encoding, boolean unescapePlus) {
int i, len, beg = 0;
RubyString dest = null;
byte[] cstrBytes;
Expand All @@ -331,7 +331,7 @@ static IRubyObject optimized_escape(Ruby runtime, RubyString str) {
buf = ((char_to_number(cstrBytes[cstr + i + 1]) << 4)
| char_to_number(cstrBytes[cstr + i + 2]));
clen = 2;
} else if (c == '+') {
} else if (unescapePlus && c == '+') {
buf = ' ';
} else {
continue;
Expand Down Expand Up @@ -416,7 +416,25 @@ public static IRubyObject cgiesc_escape(ThreadContext context, IRubyObject self,
RubyString str = _str.convertToString();

if (str.getEncoding().isAsciiCompatible()) {
return optimized_escape(context.runtime, str);
return optimized_escape(context.runtime, str, true);
} else {
return Helpers.invokeSuper(context, self, _str, Block.NULL_BLOCK);
}
}

/*
* call-seq:
* CGI.escapeURIComponent(string) -> string
*
* Returns URL-escaped string following RFC 3986.
*
*/
@JRubyMethod(name = "escapeURIComponent", alias = { "escape_uri_component" }, module = true, frame = true)
public static IRubyObject cgiesc_escape_uri_component(ThreadContext context, IRubyObject self, IRubyObject _str) {
RubyString str = _str.convertToString();

if (str.getEncoding().isAsciiCompatible()) {
return optimized_escape(context.runtime, str, false);
} else {
return Helpers.invokeSuper(context, self, _str, Block.NULL_BLOCK);
}
Expand All @@ -443,7 +461,28 @@ public static IRubyObject cgiesc_unescape(ThreadContext context, IRubyObject sel

if (str.getEncoding().isAsciiCompatible()) {
IRubyObject enc = accept_charset(argv, argv.length - 1, 1, self);
return optimized_unescape(context, str, enc);
return optimized_unescape(context, str, enc, true);
} else {
return Helpers.invokeSuper(context, self, argv, Block.NULL_BLOCK);
}
}

/*
* call-seq:
* CGI.unescapeURIComponent(string, encoding=@@accept_charset) -> string
*
* Returns URL-unescaped string following RFC 3986.
*
*/
@JRubyMethod(name = "unescapeURIComponent", alias = { "unescape_uri_component" }, required = 1, optional = 1, module = true, frame = true)
public static IRubyObject cgiesc_unescape_uri_component(ThreadContext context, IRubyObject self, IRubyObject[] argv) {
IRubyObject _str = argv[0];

RubyString str = _str.convertToString();

if (str.getEncoding().isAsciiCompatible()) {
IRubyObject enc = accept_charset(argv, argv.length - 1, 1, self);
return optimized_unescape(context, str, enc, false);
} else {
return Helpers.invokeSuper(context, self, argv, Block.NULL_BLOCK);
}
Expand Down
3 changes: 3 additions & 0 deletions lib/cgi/util.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ def escapeURIComponent(string)
end
buffer.force_encoding(encoding)
end
alias escape_uri_component escapeURIComponent

# URL-decode a string following RFC 3986 with encoding(optional).
# string = CGI.unescapeURIComponent("%27Stop%21%27+said%20Fred")
Expand All @@ -59,6 +60,8 @@ def unescapeURIComponent(string, encoding = @@accept_charset)
str.valid_encoding? ? str : str.force_encoding(string.encoding)
end

alias unescape_uri_component unescapeURIComponent

# The set of special characters and their escaped values
TABLE_FOR_ESCAPE_HTML__ = {
"'" => '&#39;',
Expand Down
9 changes: 9 additions & 0 deletions test/cgi/test_cgi_util.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ def test_cgi_escapeURIComponent
assert_equal('%26%3C%3E%22%20%E3%82%86%E3%82%93%E3%82%86%E3%82%93'.ascii_only?, CGI.escapeURIComponent(@str1).ascii_only?) if defined?(::Encoding)
end

def test_cgi_escape_uri_component
assert_equal('%26%3C%3E%22%20%E3%82%86%E3%82%93%E3%82%86%E3%82%93', CGI.escape_uri_component(@str1))
end

def test_cgi_escapeURIComponent_with_unreserved_characters
assert_equal("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~",
CGI.escapeURIComponent("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~"),
Expand Down Expand Up @@ -101,6 +105,11 @@ def test_cgi_unescapeURIComponent
assert_equal("\u{30E1 30E2 30EA 691C 7D22}", CGI.unescapeURIComponent("\u{30E1 30E2 30EA}%E6%A4%9C%E7%B4%A2"))
end

def test_cgi_unescape_uri_component
str = CGI.unescape_uri_component('%26%3C%3E%22%20%E3%82%86%E3%82%93%E3%82%86%E3%82%93')
assert_equal(@str1, str)
end

def test_cgi_unescapeURIComponent_preserve_encoding
assert_equal(Encoding::US_ASCII, CGI.unescapeURIComponent("%C0%3C%3C".dup.force_encoding("US-ASCII")).encoding)
assert_equal(Encoding::ASCII_8BIT, CGI.unescapeURIComponent("%C0%3C%3C".dup.force_encoding("ASCII-8BIT")).encoding)
Expand Down