Comment urlencode les données pour la commande curl?

J'essaie d'écrire un script bash pour les tests qui prend un paramètre et l'envoie via curl au site Web. J'ai besoin d'url encoder la valeur pour m'assurer que les caractères spéciaux sont traités correctement. Quelle est la meilleure façon de procéder?

Voici mon script de base jusqu'à présent:

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

Utilisation curl --data-urlencode; de man curl:

Cela publie des données, similaires aux autres --dataoptions, à l'exception du fait qu'il effectue le codage d'URL. Pour être conforme à CGI, la <data>pièce doit commencer par un nom suivi d'un séparateur et d'une spécification de contenu.

Exemple d'utilisation:

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

Consultez la page de manuel pour plus d'informations.

Cela nécessite curl 7.18.0 ou plus récent (publié en janvier 2008) . Utilisez curl -Vpour vérifier quelle version vous avez.

Vous pouvez également encoder la chaîne de requête :

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

Voici la pure réponse BASH.

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
}

Vous pouvez l'utiliser de deux manières:

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

[édité]

Voici la fonction correspondante rawurldecode (), qui - en toute modestie - est géniale.

# 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
}

Avec l'ensemble correspondant, nous pouvons maintenant effectuer des tests simples:

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

Output: Matched

Et si vous sentez vraiment que vous avez besoin d'un outil externe (eh bien, il ira beaucoup plus vite, et pourrait faire des fichiers binaires et autres ...) J'ai trouvé cela sur mon routeur OpenWRT ...

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

Où url_escape.sed était un fichier contenant ces règles:

# 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

Utilisez le URI::Escapemodule et la uri_escapefonction de Perl dans la deuxième ligne de votre script bash:

...

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

Edit: Correction des problèmes de citation, comme suggéré par Chris Johnsen dans les commentaires. Merci!

Une autre option consiste à utiliser jq(comme filtre):

jq -sRr @uri

-R( --raw-input) traite les lignes d'entrée comme des chaînes au lieu de les analyser en JSON et -sR( --slurp --raw-input) lit l'entrée en une seule chaîne. -r( --raw-output) affiche le contenu des chaînes au lieu des littéraux de chaîne JSON.

Si l'entrée n'est pas la sortie d'une autre commande, vous pouvez la stocker dans une jqvariable de chaîne:

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

-n( --null-input) ne lit pas l'entrée et la --arg name valuestocke valuedans une variable namesous forme de chaîne. Dans le filtre, $name(entre guillemets simples, pour éviter l'expansion par le shell), référence la variable name.

Enveloppé comme une fonction Bash, cela devient:

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

Ou ce pourcentage encode tous les octets:

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

dans un souci d'exhaustivité, de nombreuses solutions utilisant sedou awkne traduisent qu'un ensemble spécial de caractères et sont donc assez grandes par la taille du code et ne traduisent pas non plus d'autres caractères spéciaux qui devraient être encodés.

un moyen sûr de coder en url serait de simplement coder chaque octet - même ceux qui auraient été autorisés.

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

xxd veille ici à ce que l'entrée soit traitée comme des octets et non comme des caractères.

Éditer:

xxd est livré avec le paquet vim-common dans Debian et j'étais sur un système où il n'était pas installé et je ne voulais pas l'installer. L'alternative est d'utiliser à hexdumppartir du paquet bsdmainutils dans Debian. Selon le graphique suivant, bsdmainutils et vim-common devraient avoir une probabilité à peu près égale d'être installés:

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

mais néanmoins voici une version qui utilise à la hexdumpplace de xxdet permet d'éviter l' trappel:

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

L'une des variantes, peut être moche, mais simple:

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
}

Voici la version one-liner par exemple (comme suggéré par Bruno ):

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/'

Je le trouve plus lisible en python:

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

le triple 'garantit que les guillemets simples en valeur ne nuiront pas. urllib est dans la bibliothèque standard. Cela fonctionne pour exampple pour cette url folle (du monde réel):

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

J'ai trouvé l'extrait de code suivant utile pour le coller dans une chaîne d'appels de programme, où URI :: Escape peut ne pas être installé:

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

( source )

Si vous souhaitez exécuter la GETdemande et utiliser la boucle pure, ajoutez simplement--get à la solution de @ Jacob.

Voici un exemple:

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

Lien direct vers la version awk: http://www.shelldorado.com/scripts/cmds/urlencode
Je l'ai utilisé pendant des années et cela fonctionne comme un charme

:
##########################################################################
# Title      :  urlencode - encode URL data
# Author     :  Heiner Steven ([email protected])
# 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 ""
    }
' "$@"

Cela peut être le meilleur:

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

Voici une solution Bash qui n'invoque aucun programme externe:

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')

cela va encoder la chaîne à l'intérieur de $ 1 et l'afficher dans $ url. bien que vous n'ayez pas à le mettre dans un var si vous voulez. BTW n'a pas inclus le sed pour tab pensait que cela le transformerait en espaces

Utiliser php à partir d'un script shell:

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

Pour ceux d'entre vous qui recherchent une solution qui n'a pas besoin de perl, en voici une qui n'a besoin que de hexdump et 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
   '`
}

Assemblé à partir de quelques endroits à travers le net et des essais et erreurs locaux. Ça marche super!

uni2ascii est très pratique:

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

Si vous ne voulez pas dépendre de Perl, vous pouvez également utiliser sed. C'est un peu compliqué, car chaque personnage doit être échappé individuellement. Créez un fichier avec le contenu suivant et appelez-leurlencode.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

Pour l'utiliser, procédez comme suit.

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"

Cela divisera la chaîne en une partie qui a besoin d'encodage, et la partie qui va bien, codera la partie qui en a besoin, puis recoudra ensemble.

Vous pouvez mettre cela dans un script sh pour plus de commodité, peut-être lui faire prendre un paramètre pour encoder, le mettre sur votre chemin et ensuite vous pouvez simplement appeler:

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

_{la source}

Vous pouvez émuler du javascript encodeURIComponenten perl. Voici la commande:

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

Vous pouvez définir ceci comme un alias bash dans .bash_profile:

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

Vous pouvez maintenant accéder à encodeURIComponent:

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

Voici la version du nœud:

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

La question est de faire cela en bash et il n'y a pas besoin de python ou de perl car il y a en fait une seule commande qui fait exactement ce que vous voulez - "urlencode".

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

C'est aussi beaucoup mieux, car la réponse Perl ci-dessus, par exemple, n'encode pas tous les caractères correctement. Essayez-le avec le long tiret que vous obtenez de Word et vous obtenez le mauvais encodage.

Remarque, vous devez installer "gridsite-clients" pour fournir cette commande.

Option PHP simple:

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

Ruby, pour l'exhaustivité

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

Une autre approche php:

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

Voici ma version pour shell ashbox occupé pour un système embarqué, j'ai à l'origine adopté la variante d'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}"
}

Voici une fonction POSIX pour ce faire:

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"
}

Exemple:

value=$(encodeURIComponent "$2")

La source

Voici une conversion d'une ligne utilisant Lua, similaire à la réponse de Blueyed, sauf que tous les caractères RFC 3986 non réservés ne sont pas codés (comme cette réponse ):

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

En outre, vous devrez peut-être vous assurer que les sauts de ligne dans votre chaîne sont convertis de LF en CRLF, auquel cas vous pouvez insérer un gsub("\r?\n", "\r\n") dans la chaîne avant le pourcentage de codage.

Voici une variante qui, dans le style d'application non standard / x-www-form-urlencoded , effectue cette normalisation de nouvelle ligne, ainsi que le codage des espaces en tant que '+' au lieu de '% 20' (qui pourrait probablement être ajouté à la Extrait de Perl utilisant une technique similaire).

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

Après avoir installé php, j'utilise de cette façon:

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

Il s'agit de la version ksh de la réponse d'orwellophile contenant les fonctions rawurlencode et rawurldecode (lien: Comment urlencoder des données pour la commande curl? ). Je n'ai pas assez de représentant pour poster un commentaire, d'où le nouveau message ..

#!/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++

Qu'est-ce qui analyserait mieux les URL que javascript?

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

Ce qui suit est basé sur la réponse d'Orwellophile, mais résout le bogue multi-octets mentionné dans les commentaires en définissant LC_ALL = C (une astuce de vte.sh). Je l'ai écrit sous forme de fonction adaptée PROMPT_COMMAND, car c'est ainsi que je l'utilise.

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}"
}