new

parse_form_data

        my $params = $cgi->parse_form_data ('GET');

For multipart/form-data, uploaded files are stored in the user selected directory (see set_directory). If timestamp mode is on (see add_timestamp), the files are named in the following format:

    timestamp__filename

where the filename is specified in the "Content-disposition" header. NOTE:, the browser URL encodes the name of the file. This module makes no effort to decode the information for security reasons. However, this can be achieved by creating a subroutine and then using the filter_filename method.

Returns either a hash or a reference to the hash, which contains all of the key/value pairs. For fields that contain file information, the value contains either the path to the file, or the filehandle (see the set_file_type method).

parse_new_form_data

    my $CGI = CGI::Lite->new ();
    while (FCGI::accept > 0)
    {
        my $query = $CGI->parse_new_form_data ();
        # process query
    }

parse_cookies

is_error

    my $form = $cgi->parse_form_data ();
    my $went_wrong = $cgi->is_error ();

Returns 0 if there is no error, 1 otherwise.

get_error_message

    my $msg = $cgi->get_error_message ();

Returns the error message as a plain text string.

set_platform

    $cgi->set_platform ($platform);

$platform can be any of (case insensitive):

    Unix                                  EOL: \012      = \n
    Windows, Windows95, DOS, NT, PC       EOL: \015\012  = \r\n
    Mac or Macintosh                      EOL: \015      = \r

"Unix" is the default.

Returns undef.

set_size_limit

    my $size_limit = $cgi->set_size_limit (10_000_000);

Returns the new value if provided, otherwise the existing value.

deny_uploads

    my $deny_uploads = $cgi->deny_uploads (1);

Returns the new value if provided, otherwise the existing value.

force_unique_cookies

To override the default behaviour this method may be called with a single integer argument before the call to parse_cookies. An argument of 1 means that the first cookie value will be used and the others discarded. An argument of 2 means that the last cookie value will be used and the others discarded. An argument of 3 means that an arrayref will be returned as usual but an error raised to indicate the situation. An argument of 0 (or any other value) sets it back to the default.

    $cgi->force_unique_cookies (1);
    $cgi->parse_cookies;

Note that if there is already an item of data in the CGI::Lite object which matches the name of a cookie then the subsequent parse_cookies call will treat the new cookie value as another data item and the resulting behaviour will be affected by this method. This is another reason to call parse_cookies before parse_form_data.

Returns the new value if provided, otherwise the existing value.

set_directory

    my $tmpdir = '/some/dir';
    $cgi->set_directory ($tmpdir) or
        die "Directory $tmpdir cannot be used.\n";

This function should be called before parse_form_data, or else the directory defaults to "/tmp". If the application cannot write to the directory for whatever reason, an error status is returned.

Returns 0 on error, 1 otherwise.

close_all_files

    $cgi->close_all_files;

All uploaded files that are opened as a result of calling set_file_type with the "handle" argument can be closed in one shot by calling this method which takes no arguments and returns undef.

add_mime_type

    $cgi->add_mime_type ('application/mac-binhex40');

Returns 1 if this MIME type is newly added, 0 otherwise.

remove_mime_type

    $cgi->remove_mime_type ('text/html');

Returns 1 if this MIME type is newly deleted, 0 otherwise.

get_mime_types

    my @mimelist = $cgi->get_mime_types ();

get_upload_type

    my $this_type = $cgi->get_upload_type ($field);

Returns the MIME type as a scalar string if single valued, an arrayref if multi-valued or undef if the argument does not exist or has no type.

set_file_type

    # $fh has been set to one of 'handle' or 'file'
    $cgi->set_file_type ($fh);

This function should be called before any call to parse_form_data, or else it will have no effect.

add_timestamp

    $cgi->add_timestamp ($tsflag);      
    # where $tsflag takes one of these values
    #       0 = no timestamp
    #       1 = timestamp all files (default)
    #       2 = timestamp only if file exists

filter_filename

    $cgi->filter_filename (\&make_uppercase);
    $cgi->parse_form_data;

    # ...

    sub make_uppercase
    {
        my $file = shift;

        $file =~ tr/a-z/A-Z/;
        return $file;
    }

This method is perhaps best used to sanitise filenames for a specific O/S or filesystem e.g. by removing spaces or leading hyphens, etc.

set_buffer_size

    my $size = $cgi->set_buffer_size (4096);

The buffer size may not be set below 256 bytes nor above the total amount of multipart form data. The default value is 1024 bytes.

Returns the buffer size.

get_ordered_keys

    my $keys = $cgi->get_ordered_keys;
    my @keys = $cgi->get_ordered_keys;

print_data

wrap_textarea

    my $new_string = $cgi->wrap_textarea ($string, $length);

Returns the modified string.

get_multiple_values

    @all_values = $cgi->get_multiple_values ($reference);

It is only provided as a convenience to the user and is not used internally by the module itself.

Returns a list consisting of the multiple values.

browser_escape

    $escaped_string = $cgi->browser_escape ($string);

Returns the escaped string.

url_encode

    $encoded_string = $cgi->url_encode ($string);

Returns the URL-encoded string.

url_decode

    $decoded_string = $cgi->url_decode ($string);

Returns the URL-decoded string.

is_dangerous

    $status = $cgi->is_dangerous ($string);

Returns 1 if such characters are found, 0 otherwise.