XML::CGI - Perl extension for converting CGI.pm variables to/from XML

CGI-XML documentation Contained in the CGI-XML distribution.

Index

Code Index:

NAME

Top

XML::CGI - Perl extension for converting CGI.pm variables to/from XML

SYNOPSIS

Top

  use XML::CGI;
  $q = new XML::CGI;

  # convert CGI.pm variables to XML
  $xml = $q->toXML;
  $xml = $q->toXML($root);

  # convert XML to CGI.pm variables
  $q->toCGI($xml);

DESCRIPTION

Top

The XML::CGI module converts CGI.pm variables to XML and vice versa.

XML::CGI is a subclass of CGI.pm, so it reads the CGI variables just as CGI.pm would.

METHODS

Top

creates a new instance of XML::CGI. You also have access to all of the methods in CGI.pm.

where $root is an optional parameter that specifies the root element. By default, toXML will not return a root element.

where $xml is the XML you would like to convert to CGI.pm parameters. Values in the XML will overwrite any existing values if they exist.

NOTE

Top

XML::CGI does not currently handle multiple selections passed from HTML forms. This will be added in a future release.

AUTHOR

Top

Jonathan Eisenzopf <eisen@pobox.com>

CONTRIBUTORS

Top

David Black <dblack@candle.superlink.net>

SEE ALSO

Top

perl(1), XML::Parser(3).

CGI-XML documentation Contained in the CGI-XML distribution. 
package CGI::XML;

use strict;
use CGI;
use vars qw($VERSION @ISA $self $parser);
use XML::Parser;

@ISA = qw(CGI);
$VERSION = '0.1';

sub toXML {
        my ($self,$root) = @_;
        my $xml = join "\n", (map { "<$_>" . &QuoteXMLChars($self->param($_)) . "</$_>" } $self->param), "";
	return $root 
           ? "<$root>\n$xml</$root>\n"
	   : $xml;
}

sub toCGI {
    my ($self, $xml) = @_;
    my $root;
    my $parser = new XML::Parser(Handlers => {Char => $self->handle_char});
    $parser->parse($xml);
}

sub handle_char {
        my $self = shift;
        return sub {
	    my ($parser,$cdata) = @_;
	    return if $parser->depth == 1;
	    my $element = $parser->current_element;
	    $self->delete($element);
	    unshift @{$self->param_fetch(-name=>$element)},$cdata;
        }
}

sub QuoteXMLChars {
    $_[0] =~ s/&/&amp;/g;
    $_[0] =~ s/</&lt;/g;
    $_[0] =~ s/>/&gt;/g;
    $_[0] =~ s/'/&apos;/g;
    $_[0] =~ s/"/&quot;/g;
    $_[0] =~ s/([\x80-\xFF])/&XmlUtf8Encode(ord($1))/ge;
    return($_[0]);
}

sub XmlUtf8Encode {
# borrowed from XML::DOM
    my $n = shift;
    if ($n < 0x80) {
        return chr ($n);
    } elsif ($n < 0x800) {
        return pack ("CC", (($n >> 6) | 0xc0), (($n & 0x3f) | 0x80));
    } elsif ($n < 0x10000) {
        return pack ("CCC", (($n >> 12) | 0xe0), ((($n >> 6) & 0x3f) | 0x80),
                     (($n & 0x3f) | 0x80));
    } elsif ($n < 0x110000) {
        return pack ("CCCC", (($n >> 18) | 0xf0), ((($n >> 12) & 0x3f) | 0x80),
                     ((($n >> 6) & 0x3f) | 0x80), (($n & 0x3f) | 0x80));
    }
    return $n;
}

1;
__END__