- if & is followed by text that looks like an
entity reference (eg Ӓ or ᪲ or ) then it's
left unescaped
=back
Useful for turning text into similar to form without
actually being in tags
=item C
Turns the contents of C<$HashRef> of the form:
{
aaa => 'bbb',
ccc => undef
}
Into a string of the form:
q{aaa="bbb" ccc}
Useful for generating HTML tags. The I of each hash
entry are escaped with escape_html() before being added
to the final string.
If you want to use a raw value unescaped, pass it as a
scalar ref with a single item. Eg.
{
aaa => \'',
bbb => ''
}
Is turned into:
q{aaa="" bbb="<blah>"}
If the value is an array ref, then the individual items
are joined together with a space separator. Eg.
{
class => [ 'class1', 'class2', \'' ],
aaa => 'bbb'
}
Is turned into:
q{aaa="bbb" class="class1 class2 "}
If the value is a hash ref, then the individual keys
are joined together with a space separator. Eg.
{
class => { class1 => 1, class2 => 2 ],
aaa => 'bbb'
}
Is turned into:
q{aaa="bbb" class="class2 class1"}
Keys are always escaped since you can't have a scalar
reference as a key.
=item C
Creates an HTML tag of the basic form:
<$Tag %$AttrHashRef>$Value
If C<$AttrHashRef> is C, then no attributes are created.
Otherwise C is called to stringify
the hash ref.
If C<$Value> is C, then no C<$Value> is included, and
no E/$TagE is added.
C<$Mode> is a bit field with the additional options:
=over 4
=item *
C - call escape_html on $Value
=item *
C - append \n to output of string
=item *
C - close the tag (eg ). This should really
only be used when C<$Value> is undef, otherwise you'll end
up with something like Ctag /EvalueE/tagE>,
which is probably not what you want
=back
=item C
Escape unsafe characters in a uri.
This escapes all characters not in the unreserved character set.
As a regexp that is:
[^A-Za-z0-9\-_.!~*'()]
or
[\x00-\x1F "#$%&+,/:;<=>?@\[\]^`{}|\\\x7f-\xff];
Some other things to note:
=over 4
=item *
The escaping assumes all strings with high-chars are utf-8 strings. That
is it first turns off any utf-8 bit on the string, and then encodes each
byte to it's corresponding octet.
=item *
When encoding a uri with parameters, you'll probably want to encode each
parameter first and then join it to the final string, something like:
my %uri_params = ( ... )
my $uri = "http://hostname.com/somepath/?" .
join ";",
map { $_ . "=" . escape_uri($uri_params{$_}) }
keys %uri_params;
Assuming your keys don't have any unreserved characters in them, a common
practice in many peoples design.
Doing something like:
my $uri = escape_uri("http://hostname.com/somepath/?a=p1");
Will escape the '?', not giving you what you expect at the other end.
=back
C<$Mode> is a bit field with the additional options:
=over 4
=item *
C - modify in-place, otherwise return new copy
=back
=back
=head1 BUGS AND LIMITATIONS
The EH_LEAVEKNOWN option is just heuristic, and accepts anything
that even looks like an entity reference, even if it isn't a
correct one. I'm not sure if this is a securit issue or not.
=head1 SEE ALSO
L, L, L
Latest news/details can also be found at:
L
=head1 AUTHOR
Rob Mueller Ecpan@robm.fastmail.fmE
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2004 by FastMail IP Partners
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut