Як urlencode дані для команди curl?

Я намагаюся написати скрипт bash для тестування, який бере параметр і надсилає його через curl на веб-сайт. Мені потрібно url кодувати значення, щоб переконатися, що спеціальні символи оброблені належним чином. Який найкращий спосіб зробити це?

Ось мій базовий сценарій поки що:

#!/bin/bash
host=${1:?'bad host'}
value=$2
shift
shift
curl -v -d "param=${value}" http://${host}/somepath $@

Використання curl --data-urlencode; від man curl:

Він публікує дані, подібні до інших --dataпараметрів, за винятком того, що це виконує кодування URL-адрес. Щоб відповідати CGI, <data>частина повинна починатись з імені, за яким слід роздільник та специфікація вмісту.

Приклад використання:

curl \
    --data-urlencode "paramName=value" \
    --data-urlencode "secondParam=value" \
    http://example.com

Додаткову інформацію див. На сторінці чоловіка .

Для цього потрібна згортання 7.18.0 або новішої версії (випущена в січні 2008 року) . Використовуйте, curl -Vщоб перевірити, яку версію у вас є.

Ви також можете кодувати рядок запиту :

curl -G \
    --data-urlencode "p1=value 1" \
    --data-urlencode "p2=value 2" \
    http://example.com
    # http://example.com?p1=value%201&p2=value%202

Ось чистий відповідь БАШ.

rawurlencode() {
  local string="${1}"
  local strlen=${#string}
  local encoded=""
  local pos c o

  for (( pos=0 ; pos<strlen ; pos++ )); do
     c=${string:$pos:1}
     case "$c" in
        [-_.~a-zA-Z0-9] ) o="${c}" ;;
        * )               printf -v o '%%%02x' "'$c"
     esac
     encoded+="${o}"
  done
  echo "${encoded}"    # You can either set a return variable (FASTER) 
  REPLY="${encoded}"   #+or echo the result (EASIER)... or both... :p
}

Використовувати його можна двома способами:

easier:  echo http://url/q?=$( rawurlencode "$args" )
faster:  rawurlencode "$args"; echo http://url/q?${REPLY}

[відредаговано]

Ось відповідна rawurldecode () функція, яка - при всій скромності - дивовижна.

# Returns a string in which the sequences with percent (%) signs followed by
# two hex digits have been replaced with literal characters.
rawurldecode() {

  # This is perhaps a risky gambit, but since all escape characters must be
  # encoded, we can replace %NN with \xNN and pass the lot to printf -b, which
  # will decode hex for us

  printf -v REPLY '%b' "${1//%/\\x}" # You can either set a return variable (FASTER)

  echo "${REPLY}"  #+or echo the result (EASIER)... or both... :p
}

За допомогою відповідного набору тепер ми можемо виконати кілька простих тестів:

$ diff rawurlencode.inc.sh \
        <( rawurldecode "$( rawurlencode "$( cat rawurlencode.inc.sh )" )" ) \
        && echo Matched

Output: Matched

І якщо ви дійсно відчуваєте, що вам потрібен зовнішній інструмент (ну, це піде набагато швидше, і він може робити бінарні файли і таке інше). Я знайшов це на своєму маршрутизаторі OpenWRT ...

replace_value=$(echo $replace_value | sed -f /usr/lib/ddns/url_escape.sed)

Де url_escape.sed був файлом, який містив ці правила:

# sed url escaping
s:%:%25:g
s: :%20:g
s:<:%3C:g
s:>:%3E:g
s:#:%23:g
s:{:%7B:g
s:}:%7D:g
s:|:%7C:g
s:\\:%5C:g
s:\^:%5E:g
s:~:%7E:g
s:\[:%5B:g
s:\]:%5D:g
s:`:%60:g
s:;:%3B:g
s:/:%2F:g
s:?:%3F:g
s^:^%3A^g
s:@:%40:g
s:=:%3D:g
s:&:%26:g
s:\$:%24:g
s:\!:%21:g
s:\*:%2A:g

Використовуйте URI::Escapeмодуль та uri_escapeфункції Perl у другому рядку вашого bash-сценарію:

...

value="$(perl -MURI::Escape -e 'print uri_escape($ARGV[0]);' "$2")"
...

Редагувати: виправити проблеми із цитуванням, як запропонував у коментарях Кріс Джонсен. Дякую!

Ще один варіант - використовувати jq(як фільтр):

jq -sRr @uri

-R( --raw-input) розглядає рядки введення як рядки, а не розбирає їх як JSON і -sR( --slurp --raw-input) зчитує введення в один рядок. -r(--raw-output ) виводить вміст рядків замість літеральних рядків JSON.

Якщо вхід не є результатом іншої команди, ви можете зберегти його в jqрядковій змінній:

jq -nr --arg v "my shell string" '$v|@uri'

-n( --null-input) не читає вхідні дані і --arg name valueзберігає valueзмінну nameу вигляді рядка. У фільтрі $name(в одиничних лапках, щоб уникнути розширення оболонкою) посилається на змінну name.

Згорнутий як функція Bash, це стає:

function uriencode { jq -nr --arg v "$1" '$v|@uri'; }

Або цей відсоток кодує всі байти:

xxd -p|tr -d \\n|sed 's/../%&/g'

заради повноти багато рішень, що використовують sedабоawk лише перекладають спеціальний набір символів, а отже, досить великі за розміром коду, а також не перекладають інші спеціальні символи, які слід закодувати.

безпечним способом urlencode було б просто закодувати кожен байт - навіть той, який був би дозволений.

echo -ne 'some random\nbytes' | xxd -plain | tr -d '\n' | sed 's/\(..\)/%\1/g'

Тут xxd дбає про те, щоб вхід оброблявся як байти, а не символи.

редагувати:

xxd постачається з пакетом vim-common в Debian, і я був просто в системі, де він не був встановлений, і я не хотів його встановлювати. Альтернативне використанняhexdump з пакету bsdmainutils в Debian. Згідно з наступним графіком, bsdmainutils і vim-common повинні мати приблизно однакову ймовірність встановлення:

http://qa.debian.org/popcon-png.php?packages=vim-common%2Cbsdmainutils&show_installed=1&want_legend=1&want_ticks=1

але все ж тут версія, яка використовує hexdumpзамість xxdі дозволяє уникнути trвиклику:

echo -ne 'some random\nbytes' | hexdump -v -e '/1 "%02x"' | sed 's/\(..\)/%\1/g'

Один із варіантів, може бути некрасивим, але простим:

urlencode() {
    local data
    if [[ $# != 1 ]]; then
        echo "Usage: $0 string-to-urlencode"
        return 1
    fi
    data="$(curl -s -o /dev/null -w %{url_effective} --get --data-urlencode "$1" "")"
    if [[ $? != 3 ]]; then
        echo "Unexpected error" 1>&2
        return 2
    fi
    echo "${data##/?}"
    return 0
}

Ось, наприклад, однолінійна версія (як запропонував Бруно ):

date | curl -Gso /dev/null -w %{url_effective} --data-urlencode @- "" | cut -c 3-

# If you experience the trailing %0A, use
date | curl -Gso /dev/null -w %{url_effective} --data-urlencode @- "" | sed -E 's/..(.*).../\1/'

Я вважаю, що це читабельніше в python:

encoded_value=$(python -c "import urllib; print urllib.quote('''$value''')")

потрійний 'гарантує, що окремі котирування цінності не зашкодять. urllib знаходиться в стандартній бібліотеці. Це працює для зразка для цього шаленого (реального світу) URL-адреси:

"http://www.rai.it/dl/audio/" "1264165523944Ho servito il re d'Inghilterra - Puntata 7

Я знайшов такий фрагмент корисним, щоб вставити його у ланцюжок програмних дзвінків, де URI :: Escape може бути не встановлено:

perl -p -e 's/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg'

( джерело )

Якщо ви хочете запустити GETзапит і використовувати чисту завивку, просто додайте --getдо рішення @ Jacob.

Ось приклад:

curl -v --get --data-urlencode "access_token=$(cat .fb_access_token)" https://graph.facebook.com/me/feed

Пряме посилання на версію awk: http://www.shelldorado.com/scripts/cmds/urlencode
Я використовував її роками, і це працює як шарм

:
##########################################################################
# Title      :  urlencode - encode URL data
# Author     :  Heiner Steven (heiner.steven@odn.de)
# Date       :  2000-03-15
# Requires   :  awk
# Categories :  File Conversion, WWW, CGI
# SCCS-Id.   :  @(#) urlencode  1.4 06/10/29
##########################################################################
# Description
#   Encode data according to
#       RFC 1738: "Uniform Resource Locators (URL)" and
#       RFC 1866: "Hypertext Markup Language - 2.0" (HTML)
#
#   This encoding is used i.e. for the MIME type
#   "application/x-www-form-urlencoded"
#
# Notes
#    o  The default behaviour is not to encode the line endings. This
#   may not be what was intended, because the result will be
#   multiple lines of output (which cannot be used in an URL or a
#   HTTP "POST" request). If the desired output should be one
#   line, use the "-l" option.
#
#    o  The "-l" option assumes, that the end-of-line is denoted by
#   the character LF (ASCII 10). This is not true for Windows or
#   Mac systems, where the end of a line is denoted by the two
#   characters CR LF (ASCII 13 10).
#   We use this for symmetry; data processed in the following way:
#       cat | urlencode -l | urldecode -l
#   should (and will) result in the original data
#
#    o  Large lines (or binary files) will break many AWK
#       implementations. If you get the message
#       awk: record `...' too long
#        record number xxx
#   consider using GNU AWK (gawk).
#
#    o  urlencode will always terminate it's output with an EOL
#       character
#
# Thanks to Stefan Brozinski for pointing out a bug related to non-standard
# locales.
#
# See also
#   urldecode
##########################################################################

PN=`basename "$0"`          # Program name
VER='1.4'

: ${AWK=awk}

Usage () {
    echo >&2 "$PN - encode URL data, $VER
usage: $PN [-l] [file ...]
    -l:  encode line endings (result will be one line of output)

The default is to encode each input line on its own."
    exit 1
}

Msg () {
    for MsgLine
    do echo "$PN: $MsgLine" >&2
    done
}

Fatal () { Msg "$@"; exit 1; }

set -- `getopt hl "$@" 2>/dev/null` || Usage
[ $# -lt 1 ] && Usage           # "getopt" detected an error

EncodeEOL=no
while [ $# -gt 0 ]
do
    case "$1" in
        -l) EncodeEOL=yes;;
    --) shift; break;;
    -h) Usage;;
    -*) Usage;;
    *)  break;;         # First file name
    esac
    shift
done

LANG=C  export LANG
$AWK '
    BEGIN {
    # We assume an awk implementation that is just plain dumb.
    # We will convert an character to its ASCII value with the
    # table ord[], and produce two-digit hexadecimal output
    # without the printf("%02X") feature.

    EOL = "%0A"     # "end of line" string (encoded)
    split ("1 2 3 4 5 6 7 8 9 A B C D E F", hextab, " ")
    hextab [0] = 0
    for ( i=1; i<=255; ++i ) ord [ sprintf ("%c", i) "" ] = i + 0
    if ("'"$EncodeEOL"'" == "yes") EncodeEOL = 1; else EncodeEOL = 0
    }
    {
    encoded = ""
    for ( i=1; i<=length ($0); ++i ) {
        c = substr ($0, i, 1)
        if ( c ~ /[a-zA-Z0-9.-]/ ) {
        encoded = encoded c     # safe character
        } else if ( c == " " ) {
        encoded = encoded "+"   # special handling
        } else {
        # unsafe character, encode it as a two-digit hex-number
        lo = ord [c] % 16
        hi = int (ord [c] / 16);
        encoded = encoded "%" hextab [hi] hextab [lo]
        }
    }
    if ( EncodeEOL ) {
        printf ("%s", encoded EOL)
    } else {
        print encoded
    }
    }
    END {
        #if ( EncodeEOL ) print ""
    }
' "$@"

Це може бути найкращим:

after=$(echo -e "$before" | od -An -tx1 | tr ' ' % | xargs printf "%s")

Ось рішення Bash, яке не викликає жодних зовнішніх програм:

uriencode() {
  s="${1//'%'/%25}"
  s="${s//' '/%20}"
  s="${s//'"'/%22}"
  s="${s//'#'/%23}"
  s="${s//'$'/%24}"
  s="${s//'&'/%26}"
  s="${s//'+'/%2B}"
  s="${s//','/%2C}"
  s="${s//'/'/%2F}"
  s="${s//':'/%3A}"
  s="${s//';'/%3B}"
  s="${s//'='/%3D}"
  s="${s//'?'/%3F}"
  s="${s//'@'/%40}"
  s="${s//'['/%5B}"
  s="${s//']'/%5D}"
  printf %s "$s"
}

url=$(echo "$1" | sed -e 's/%/%25/g' -e 's/ /%20/g' -e 's/!/%21/g' -e 's/"/%22/g' -e 's/#/%23/g' -e 's/\$/%24/g' -e 's/\&/%26/g' -e 's/'\''/%27/g' -e 's/(/%28/g' -e 's/)/%29/g' -e 's/\*/%2a/g' -e 's/+/%2b/g' -e 's/,/%2c/g' -e 's/-/%2d/g' -e 's/\./%2e/g' -e 's/\//%2f/g' -e 's/:/%3a/g' -e 's/;/%3b/g' -e 's//%3e/g' -e 's/?/%3f/g' -e 's/@/%40/g' -e 's/\[/%5b/g' -e 's/\\/%5c/g' -e 's/\]/%5d/g' -e 's/\^/%5e/g' -e 's/_/%5f/g' -e 's/`/%60/g' -e 's/{/%7b/g' -e 's/|/%7c/g' -e 's/}/%7d/g' -e 's/~/%7e/g')

це кодує рядок всередині $ 1 і виведе його в $ url. хоча вам не потрібно ставити його у вар, якщо хочете. До речі, BTW не включав sed для вкладки, він перетворив його на пробіли

Використання php із сценарію оболонки:

value="http://www.google.com"
encoded=$(php -r "echo rawurlencode('$value');")
# encoded = "http%3A%2F%2Fwww.google.com"
echo $(php -r "echo rawurldecode('$encoded');")
# returns: "http://www.google.com"

1. http://www.php.net/manual/en/function.rawurlencode.php
2. http://www.php.net/manual/en/function.rawurldecode.php

Для тих, хто шукає рішення, яке не потребує perl, ось таке, яке потребує лише hexdump та awk:

url_encode() {
 [ $# -lt 1 ] && { return; }

 encodedurl="$1";

 # make sure hexdump exists, if not, just give back the url
 [ ! -x "/usr/bin/hexdump" ] && { return; }

 encodedurl=`
   echo $encodedurl | hexdump -v -e '1/1 "%02x\t"' -e '1/1 "%_c\n"' |
   LANG=C awk '
     $1 == "20"                    { printf("%s",   "+"); next } # space becomes plus
     $1 ~  /0[adAD]/               {                      next } # strip newlines
     $2 ~  /^[a-zA-Z0-9.*()\/-]$/  { printf("%s",   $2);  next } # pass through what we can
                                   { printf("%%%s", $1)        } # take hex value of everything else
   '`
}

З’єднані з декількох місць через мережу та деякі локальні проби та помилки. Це чудово працює!

uni2ascii дуже зручний:

$ echo -ne '你好世界' | uni2ascii -aJ
%E4%BD%A0%E5%A5%BD%E4%B8%96%E7%95%8C

Якщо ви не хочете залежати від Perl, ви також можете використовувати sed. Це трохи безладно, оскільки кожного персонажа потрібно уникати індивідуально. Створіть файл із наступним вмістом і зателефонуйте до ньогоurlencode.sed

s/%/%25/g
s/ /%20/g
s/ /%09/g
s/!/%21/g
s/"/%22/g
s/#/%23/g
s/\$/%24/g
s/\&/%26/g
s/'\''/%27/g
s/(/%28/g
s/)/%29/g
s/\*/%2a/g
s/+/%2b/g
s/,/%2c/g
s/-/%2d/g
s/\./%2e/g
s/\//%2f/g
s/:/%3a/g
s/;/%3b/g
s//%3e/g
s/?/%3f/g
s/@/%40/g
s/\[/%5b/g
s/\\/%5c/g
s/\]/%5d/g
s/\^/%5e/g
s/_/%5f/g
s/`/%60/g
s/{/%7b/g
s/|/%7c/g
s/}/%7d/g
s/~/%7e/g
s/      /%09/g

Для його використання виконайте наступне.

STR1=$(echo "https://www.example.com/change&$ ^this to?%checkthe@-functionality" | cut -d\? -f1)
STR2=$(echo "https://www.example.com/change&$ ^this to?%checkthe@-functionality" | cut -d\? -f2)
OUT2=$(echo "$STR2" | sed -f urlencode.sed)
echo "$STR1?$OUT2"

Це розділить рядок на частину, яка потребує кодування, а ту частину, яка добре, кодує ту частину, яка їй потрібна, а потім зшиває назад.

Ви можете помістити це в скрипт sh для зручності, можливо, потрібно взяти параметр для кодування, поставити його на свій шлях, і тоді ви можете просто зателефонувати:

urlencode https://www.exxample.com?isThisFun=HellNo

_{джерело}

Ви можете імітувати JavaScript encodeURIComponentв perl. Ось така команда:

perl -pe 's/([^a-zA-Z0-9_.!~*()'\''-])/sprintf("%%%02X", ord($1))/ge'

Ви можете встановити це як псевдонім bash у .bash_profile:

alias encodeURIComponent='perl -pe '\''s/([^a-zA-Z0-9_.!~*()'\''\'\'''\''-])/sprintf("%%%02X",ord($1))/ge'\'

Тепер ви можете передати encodeURIComponent:

$ echo -n 'hèllo wôrld!' | encodeURIComponent
h%C3%A8llo%20w%C3%B4rld!

Ось версія вузла:

uriencode() {
  node -p "encodeURIComponent('${1//\'/\\\'}')"
}

Питання в тому, щоб зробити це в bash, і немає необхідності в python або perl, оскільки насправді є одна команда, яка виконує саме те, що ви хочете - "urlencode".

value=$(urlencode "${2}")

Це також набагато краще, оскільки, наприклад, вищевказана відповідь perl не кодує всіх символів правильно. Спробуйте це з довгим тире, який ви отримаєте від Word, і ви отримаєте неправильне кодування.

Зауважте, для надання цієї команди вам потрібні "клієнти сітки".

Простий варіант PHP:

echo 'part-that-needs-encoding' | php -R 'echo urlencode($argn);'

Рубі, для повноти

value="$(ruby -r cgi -e 'puts CGI.escape(ARGV[0])' "$2")"

Ще один підхід php:

echo "encode me" | php -r "echo urlencode(file_get_contents('php://stdin'));"

Ось моя версія для оболонки золи для вбудованої системи для вбудованої системи, я спочатку прийняв варіант Orwellophile:

urlencode()
{
    local S="${1}"
    local encoded=""
    local ch
    local o
    for i in $(seq 0 $((${#S} - 1)) )
    do
        ch=${S:$i:1}
        case "${ch}" in
            [-_.~a-zA-Z0-9]) 
                o="${ch}"
                ;;
            *) 
                o=$(printf '%%%02x' "'$ch")                
                ;;
        esac
        encoded="${encoded}${o}"
    done
    echo ${encoded}
}

urldecode() 
{
    # urldecode <string>
    local url_encoded="${1//+/ }"
    printf '%b' "${url_encoded//%/\\x}"
}

Ось функція POSIX для цього:

encodeURIComponent() {
  awk 'BEGIN {while (y++ < 125) z[sprintf("%c", y)] = y
  while (y = substr(ARGV[1], ++j, 1))
  q = y ~ /[[:alnum:]_.!~*\47()-]/ ? q y : q sprintf("%%%02X", z[y])
  print q}' "$1"
}

Приклад:

value=$(encodeURIComponent "$2")

Джерело

Ось однолінійне перетворення за допомогою Lua, подібне до відповіді blueyed, за винятком усіх незарезервованих символів RFC 3986, які залишилися незашифрованими (як ця відповідь ):

url=$(echo 'print((arg[1]:gsub("([^%w%-%.%_%~])",function(c)return("%%%02X"):format(c:byte())end)))' | lua - "$1")

Крім того, вам може знадобитися переконатися, що нові рядки у рядку перетворюються з LF в CRLF, і в цьому випадку ви можете вставити gsub("\r?\n", "\r\n") у ланцюг перед кодуванням відсотків.

Ось варіант, який у нестандартному стилі застосування / x-www-form-urlencoded робить цю нормалізацію нового рядка, а також кодує пробіли як "+" замість "% 20" (що, ймовірно, може бути додано до Фрагмент Perl, використовуючи аналогічну техніку).

url=$(echo 'print((arg[1]:gsub("\r?\n", "\r\n"):gsub("([^%w%-%.%_%~ ]))",function(c)return("%%%02X"):format(c:byte())end):gsub(" ","+"))' | lua - "$1")

Встановивши php, я використовую такий спосіб:

URL_ENCODED_DATA=`php -r "echo urlencode('$DATA');"`

Це ksh версія відповіді orwellophile, що містить функції rawurlencode та rawurldecode (посилання: Як вказати дані urlencode для команди curl? ). У мене не вистачає представника, щоб розмістити коментар, звідси новий пост ..

#!/bin/ksh93

function rawurlencode
{
    typeset string="${1}"
    typeset strlen=${#string}
    typeset encoded=""

    for (( pos=0 ; pos<strlen ; pos++ )); do
        c=${string:$pos:1}
        case "$c" in
            [-_.~a-zA-Z0-9] ) o="${c}" ;;
            * )               o=$(printf '%%%02x' "'$c")
        esac
        encoded+="${o}"
    done
    print "${encoded}"
}

function rawurldecode
{
    printf $(printf '%b' "${1//%/\\x}")
}

print $(rawurlencode "C++")     # --> C%2b%2b
print $(rawurldecode "C%2b%2b") # --> C++

Що би розібрало URL-адреси краще, ніж JavaScript?

node -p "encodeURIComponent('$url')"

Далі базується на відповіді Орвелофіла, але вирішує багатобайтовий помилку, згаданий у коментарях, встановивши LC_ALL = C (хитрість від vte.sh). Я написав це у формі функції, підходящої PROMPT_COMMAND, тому що саме так я її використовую.

print_path_url() {
  local LC_ALL=C
  local string="$PWD"
  local strlen=${#string}
  local encoded=""
  local pos c o

  for (( pos=0 ; pos<strlen ; pos++ )); do
     c=${string:$pos:1}
     case "$c" in
        [-_.~a-zA-Z0-9/] ) o="${c}" ;;
        * )               printf -v o '%%%02x' "'$c"
     esac
     encoded+="${o}"
  done
  printf "\033]7;file://%s%s\007" "${HOSTNAME:-}" "${encoded}"
}