local-lib5/man/man3/HTTP::Headers::Util.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "HTTP::Headers::Util 3"
 132 .TH HTTP::Headers::Util 3 "2009-06-13" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 HTTP::Headers::Util \- Header value parsing utility functions
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  use HTTP::Headers::Util qw(split_header_words);
 139 \&  @values = split_header_words($h\->header("Content\-Type"));
 140 .Ve
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 This module provides a few functions that helps parsing and
 144 construction of valid \s-1HTTP\s0 header values.  None of the functions are
 145 exported by default.
 146 .PP
 147 The following functions are available:
 148 .ie n .IP "split_header_words( @header_values )" 4
 149 .el .IP "split_header_words( \f(CW@header_values\fR )" 4
 150 .IX Item "split_header_words( @header_values )"
 151 This function will parse the header values given as argument into a
 152 list of anonymous arrays containing key/value pairs.  The function
 153 knows how to deal with \*(L",\*(R", \*(L";\*(R" and \*(L"=\*(R" as well as quoted values after
 154 \&\*(L"=\*(R".  A list of space separated tokens are parsed as if they were
 155 separated by \*(L";\*(R".
 156 .Sp
 157 If the \f(CW@header_values\fR passed as argument contains multiple values,
 158 then they are treated as if they were a single value separated by
 159 comma \*(L",\*(R".
 160 .Sp
 161 This means that this function is useful for parsing header fields that
 162 follow this syntax (\s-1BNF\s0 as from the \s-1HTTP/1\s0.1 specification, but we relax
 163 the requirement for tokens).
 164 .Sp
 165 .Vb 2
 166 \&  headers           = #header
 167 \&  header            = (token | parameter) *( [";"] (token | parameter))
 168 .Ve
 169 .Sp
 170 .Vb 5
 171 \&  token             = 1*<any CHAR except CTLs or separators>
 172 \&  separators        = "(" | ")" | "<" | ">" | "@"
 173 \&                    | "," | ";" | ":" | "\e" | <">
 174 \&                    | "/" | "[" | "]" | "?" | "="
 175 \&                    | "{" | "}" | SP | HT
 176 .Ve
 177 .Sp
 178 .Vb 3
 179 \&  quoted\-string     = ( <"> *(qdtext | quoted\-pair ) <"> )
 180 \&  qdtext            = <any TEXT except <">>
 181 \&  quoted\-pair       = "\e" CHAR
 182 .Ve
 183 .Sp
 184 .Vb 3
 185 \&  parameter         = attribute "=" value
 186 \&  attribute         = token
 187 \&  value             = token | quoted\-string
 188 .Ve
 189 .Sp
 190 Each \fIheader\fR is represented by an anonymous array of key/value
 191 pairs.  The keys will be all be forced to lower case.
 192 The value for a simple token (not part of a parameter) is \f(CW\*(C`undef\*(C'\fR.
 193 Syntactically incorrect headers will not necessary be parsed as you
 194 would want.
 195 .Sp
 196 This is easier to describe with some examples:
 197 .Sp
 198 .Vb 3
 199 \&   split_header_words('foo="bar"; port="80,81"; DISCARD, BAR=baz');
 200 \&   split_header_words('text/html; charset="iso\-8859\-1"');
 201 \&   split_header_words('Basic realm="\e\e"foo\e\e\e\ebar\e\e""');
 202 .Ve
 203 .Sp
 204 will return
 205 .Sp
 206 .Vb 3
 207 \&   [foo=>'bar', port=>'80,81', discard=> undef], [bar=>'baz' ]
 208 \&   ['text/html' => undef, charset => 'iso\-8859\-1']
 209 \&   [basic => undef, realm => "\e"foo\e\ebar\e""]
 210 .Ve
 211 .Sp
 212 If you don't want the function to convert tokens and attribute keys to
 213 lower case you can call it as \f(CW\*(C`_split_header_words\*(C'\fR instead (with a
 214 leading underscore).
 215 .ie n .IP "join_header_words( @arrays )" 4
 216 .el .IP "join_header_words( \f(CW@arrays\fR )" 4
 217 .IX Item "join_header_words( @arrays )"
 218 This will do the opposite of the conversion done by \fIsplit_header_words()\fR.
 219 It takes a list of anonymous arrays as arguments (or a list of
 220 key/value pairs) and produces a single header value.  Attribute values
 221 are quoted if needed.
 222 .Sp
 223 Example:
 224 .Sp
 225 .Vb 2
 226 \&   join_header_words(["text/plain" => undef, charset => "iso\-8859/1"]);
 227 \&   join_header_words("text/plain" => undef, charset => "iso\-8859/1");
 228 .Ve
 229 .Sp
 230 will both return the string:
 231 .Sp
 232 .Vb 1
 233 \&   text/plain; charset="iso\-8859/1"
 234 .Ve
 235 .SH "COPYRIGHT"
 236 .IX Header "COPYRIGHT"
 237 Copyright 1997\-1998, Gisle Aas
 238 .PP
 239 This library is free software; you can redistribute it and/or
 240 modify it under the same terms as Perl itself.