.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Util 3"
.TH Util 3 "2007-03-30" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Apache::Util \- Interface to Apache C util functions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Apache::Util qw(:all);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a Perl interface to some of the C utility functions
available in Perl.  The same functionality is avaliable in libwww\-perl, but
the C versions are faster:
.PP
.Vb 5
\&    use Benchmark;
\&    timethese(1000, {
\&        C => sub { my $esc = Apache::Util::escape_html($html) },
\&        Perl => sub { my $esc = HTML::Entities::encode($html) },
\&    });
.Ve
.PP
.Vb 3
\&    Benchmark: timing 1000 iterations of C, Perl...
\&            C:  0 secs ( 0.17 usr  0.00 sys =  0.17 cpu)
\&         Perl: 15 secs (15.06 usr  0.04 sys = 15.10 cpu)
.Ve
.PP
.Vb 5
\&    use Benchmark;
\&    timethese(10000, {
\&        C => sub { my $esc = Apache::Util::escape_uri($uri) },
\&        Perl => sub { my $esc = URI::Escape::uri_escape($uri) },
\&    });
.Ve
.PP
.Vb 3
\&    Benchmark: timing 10000 iterations of C, Perl...
\&            C:  0 secs ( 0.55 usr  0.01 sys =  0.56 cpu)
\&         Perl:  2 secs ( 1.78 usr  0.01 sys =  1.79 cpu)
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "escape_html" 4
.IX Item "escape_html"
This routine replaces unsafe characters in \f(CW$string\fR with their entity
representation.
.Sp
.Vb 1
\& my $esc = Apache::Util::escape_html($html);
.Ve
.Sp
This function will correctly escape US-ASCII output. If you are using
a different character set such as \s-1UTF8\s0, or need more control on
the escaping process, use HTML::Entities.
.IP "escape_uri" 4
.IX Item "escape_uri"
This function replaces all unsafe characters in the \f(CW$string\fR with their
escape sequence and returns the result.
.Sp
.Vb 1
\& my $esc = Apache::Util::escape_uri($uri);
.Ve
.IP "unescape_uri" 4
.IX Item "unescape_uri"
This function decodes all \f(CW%XX\fR hex escape sequences in the given \s-1URI\s0.
.Sp
.Vb 1
\& my $unescaped = Apache::Util::unescape_uri($safe_uri);
.Ve
.IP "unescape_uri_info" 4
.IX Item "unescape_uri_info"
This function is similar to \fIunescape_uri()\fR but is specialized to remove
escape sequences from the query string portion of the \s-1URI\s0. The main
difference is that it translates the ``+'' character into spaces  as well
as recognizing and translating the hex escapes.
.Sp
Example:
.Sp
.Vb 3
\& $string = $r->uri->query;
\& my %data = map { Apache::Util::unescape_uri_info($_) }
\&              split /[=&]/, $string, -1;
.Ve
.Sp
.Vb 2
\& This would correctly translate the query string
\& ``name=Fred+Flintstone&town=Bedrock'' into the hash:
.Ve
.Sp
.Vb 2
\& name => 'Fred Flintstone',
\& town => 'Bedrock'
.Ve
.IP "parsedate" 4
.IX Item "parsedate"
Parses an \s-1HTTP\s0 date in one of three standard forms:
.Sp
.Vb 1
\& Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
.Ve
.Sp
.Vb 1
\& Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
.Ve
.Sp
.Vb 1
\& Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
.Ve
.Sp
Example:
.Sp
.Vb 1
\& my $secs = Apache::Util::parsedate($date_str);
.Ve
.IP "ht_time" 4
.IX Item "ht_time"
Format a time string.
.Sp
Examples:
.Sp
.Vb 1
\& my $str = Apache::Util::ht_time(time);
.Ve
.Sp
.Vb 1
\& my $str = Apache::Util::ht_time(time, "%d %b %Y %T %Z");
.Ve
.Sp
.Vb 1
\& my $str = Apache::Util::ht_time(time, "%d %b %Y %T %Z", 0);
.Ve
.IP "size_string" 4
.IX Item "size_string"
Converts the given file size into a formatted string. The size
given in the string will be in units of bytes, kilobytes, or
megabytes, depending on the size.
.Sp
.Vb 1
\& my $size = Apache::Util::size_string -s $r->finfo;
.Ve
.IP "validate_password" 4
.IX Item "validate_password"
Validate a plaintext password against a smashed one.  Use either
\&\fIcrypt()\fR (if available), \fIap_MD5Encode()\fR or ap_SHA1Encode depending 
upon the format of the smashed input password.
.Sp
Returns true if they match, false otherwise.
.Sp
.Vb 6
\& if (Apache::Util::validate_password("slipknot", "aXYx4GnaCrDQc")) {
\&     print "password match\en";
\& }
\& else {
\&     print "password mismatch\en";
\& }
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Doug MacEachern
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1).