Alex Efros > CGI-Easy-1.0.1 > CGI::Easy::Util

Download:
CGI-Easy-1.0.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.0.0   Source  

NAME ^

CGI::Easy::Util - low-level helpers for HTTP/CGI

SYNOPSIS ^

    use CGI::Easy::Util qw( date_http date_cookie make_cookie );

    my $mtime = (stat '/some/file')[9];
    printf "Last-Modified: %s\r\n", date_http($mtime);

    printf "Set-Cookie: a=5; expires=%s\r\n", date_cookie(time+86400);

    printf make_cookie({ name=>'a', value=>5, expires=>time+86400 });


    use CGI::Easy::Util qw( uri_unescape_plus
                            burst_urlencoded burst_multipart );

    my $s = uri_unescape_plus('a+b%20c');   # $s is 'a b c'

    my %param = %{ burst_urlencoded($ENV{QUERY_STRING}) };
    my $a = $param{a}[0];

    ($params, $filenames, $mimetypes) = burst_multipart($STDIN_data, $1)
        if $ENV{CONTENT_TYPE} =~ m/;\s+boundary=(.*)/xms;
    my $avatar_image    = $params->{avatar}[0];
    my $avatar_filename = $filenames->{avatar}[0];
    my $avatar_mimetype = $mimetypes->{avatar}[0];

DESCRIPTION ^

This module contain low-level function which you usually doesn't need - use CGI::Easy::Request and CGI::Easy::Headers instead.

EXPORTS ^

Nothing by default, but all documented functions can be explicitly imported.

INTERFACE ^

date_http( $seconds )

Convert given time into text format suitable for sending in HTTP headers.

Return date string.

date_cookie( $seconds )

Convert given time into text format suitable for sending in HTTP header Set-Cookie's "expires" option.

Return date string.

make_cookie( \%cookie )

Convert HASHREF with cookie properties to "Set-Cookie: ..." HTTP header.

Possible keys in %cookie:

    name        REQUIRED STRING
    value       OPTIONAL STRING (default "")
    domain      OPTIONAL STRING (default "")
    path        OPTIONAL STRING (default "/")
    expires     OPTIONAL STRING or SECONDS
    secure      OPTIONAL BOOL

Format for "expires" should be either correct date 'Thu, 01-Jan-1970 00:00:00 GMT' or time in seconds.

Return HTTP header string.

uri_unescape_plus( $uri_escaped_value )

Same as uri_unescape from URI::Escape but additionally replace '+' with space.

Return unescaped string.

burst_urlencoded( $url_encoded_name_value_pairs )

Unpack name/value pairs from url-encoded string (like $ENV{QUERY_STRING} or STDIN content for non-multipart forms sent using POST method).

Return HASHREF with params, each param's value will be ARRAYREF (because there can be more than one value for any parameter in source string).

burst_multipart( $buffer, $boundary )

Unpack buffer with name/value pairs in multipart/form-data format. This format usually used to upload files from forms, and each name/value pair may additionally contain 'file name' and 'mime type' properties.

Return three HASHREF (with param's values, with param's file names, and with param's mime types), all values in all three HASHREF are ARRAYREF (because there can be more than one value for any parameter in source string). For non-file-upload parameters corresponding values in last two hashes (with file names and mime types) will be undef().

BUGS AND LIMITATIONS ^

No bugs have been reported.

SUPPORT ^

Please report any bugs or feature requests through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Easy. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can also look for information at:

AUTHOR ^

Alex Efros <powerman-asdf@ya.ru>

LICENSE AND COPYRIGHT ^

Copyright 2009-2010 Alex Efros <powerman-asdf@ya.ru>.

This module also include some code derived from

CGI::Minimal (1.29)

by Benjamin Franz <snowhare@nihongo.org>. Copyright (c) Benjamin Franz. All rights reserved.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

syntax highlighting: