Skip to content

Latest commit

 

History

History
197 lines (140 loc) · 6.87 KB

README.md

File metadata and controls

197 lines (140 loc) · 6.87 KB
Raw

urlencode: functions module for shellfire

This module provides a simple framework for coping with the myriad ways of 'urlencoding' UTF-8 strings in URLs in a shellfire application:-

  • Per RFC 3986
  • As URI Templates per RFC 6570
  • As POST form data (the MIME Type application/x-www-form-urlencoded)

An example user is the github api module, which uses it to url encode URI templates.

Compatibility

Overview

URI Templating, eg for the github api

urlencode_template_variable_name="my name"
encodedValue="$(urlencode_template "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name}")

Encoding a path piece as per RFC 3986

someUrl="http://host/path/to/$(urlencode_pathPiece 'my folder name')/file.txt"

### POST data

For example let's say you want to encode the key or value of a form to be `POST`ed:-

```bash
encodedValue="$(urlencode_form 'my key')

More usefully, you can do

urlencode_xWwwFormUrlEncoded 'my key' 'my value' 'another key' 'another value' >"$curl_uploadFile"

Importing

To import this module, add a git submodule to your repository. From the root of your git repository in the terminal, type:-

mkdir -p lib/shellfire
cd lib/shellfire
git submodule add "https://github.com/shellfire-dev/urlencode.git"
cd -
git submodule init --update

You may need to change the url https://github.com/shellfire-dev/urlencode.git above if using a fork.

You will also need to add paths - include the module paths.d.

Namespace urlencode

This namespace exposes helper functions to convert a UTF-8 encoded string into a particular urlencoded form.

To use in code

If calling from another shellfire module, add to your shell code the line

core_usesIn urlencode

in the global scope (ie outside of any functions). A good convention is to put it above any function that depends on functions in this module. If using it directly in a program, put this line inside the _program() function:-

_program()
{
	core_usesIn urlencode
	…
}

Functions

urlencode_pathPiece

Parameter Value Optional
string A string to encode as per RFC 3986 such that it is valid No

Writes the encoded form of the UTF-8 encoded string string to standard out.

This implementation uses a conservative function (it encodes where not strictly necessary so it works in paths, query strings and fragments). It is not suitable for encoding host names or schemes (eg http), but if anyone actually defines a scheme that needs percent encoding, they're mad.

urlencode_form

Parameter Value Optional
string A string to encode as if it is a key or value as per POST form encoding (the MIME Type application/x-www-form-urlencoded) such that it is valid No

Writes the encoded form of the UTF-8 encoded string string to standard out. Might be used in as follows:-

{
	printf '?'
	urlencode_form name
	printf '='
	urlencode_form "Albert Einstein"
	printf '&'
	urlencode_form occupation
	printf '='
	printf 'Theoretical Physicist'
} >"$curl_uploadFile"

However, in that case, the function urlencode_xWwwFormUrlEncoded() is more useful.

urlencode_xWwwFormUrlEncoded

Parameter Value Optional
… Zero or more key-value pairs Yes

Encodes the key value pairs and writes the result to standard out, eg:-

urlencode_xWwwFormUrlEncoded 'my key' 'my value' 'another key' 'another value' >"$curl_uploadFile"

produces my+key=my+value&another+key=another+value.

urlencode_literal

Parameter Value Optional
string A string to encode as a literal as in RFC 6570, Section 2.1 and RFC 6570, Section 3.1; this is a confusing standard. No

Writes the encoded form of the UTF-8 encoded string string to standard out.

urlencode_reserved

Parameter Value Optional
string A string to encode as a reserved literal as in RFC 6570. No

Writes the encoded form of the UTF-8 encoded string string to standard out. Not particularly useful outside of the uri templates functions.

Namespace urlencode_template

This namespace exposes a helper function to convert a UTF-8 encoded URI template string into a RFC 6570 URI.

To use in code

If calling from another shellfire module, add to your shell code the line

core_usesIn urlencode template

in the global scope (ie outside of any functions). A good convention is to put it above any function that depends on functions in this module. If using it directly in a program, put this line inside the _program() function:-

_program()
{
	core_usesIn urlencode template
	…
}

Functions

urlencode_template

Parameter Value Optional
templateString A string to encode as per RFC 6570 such that it is valid No

Writes the encoded form of the UTF-8 encoded URI template string templateString to standard out. Supports Levels 1, 2, 3 and 4. Supports substitution of both single values and arrays of values (defined using core_variable_array_initialise and populated using core_variable_array_append); does not support maps (key value pairs) as this isn't available outside of bash 4. One passes variable values to the function by defining in the form urlencode_template_variable_${variableName}:-

urlencode_template_variable_name="my name"
encodedValue="$(urlencode_template "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name}")