CGI::Ajax Example

From: Moritz Bunkus Date: Thu, 14 Dec 2006 10:26:06 +0000 (+0000) Subject: Das Perl-Modul CGI::Ajax hinzugefuegt, da es von praktisch keiner Distribution mitgeb... X-Git-Tag: release-2.4.0^2~33 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=433eafd522c60d4e9f3a09acb83dbaf22af42aac;p=kivitendo-erp.git Das Perl-Modul CGI::Ajax hinzugefuegt, da es von praktisch keiner Distribution mitgebracht wird. --- diff --git a/CGI/Ajax.pm b/CGI/Ajax.pm new file mode 100644 index 000000000..41e9c3342 --- /dev/null +++ b/CGI/Ajax.pm @@ -0,0 +1,1215 @@ +package CGI::Ajax; +use strict; +use Data::Dumper; +use base qw(Class::Accessor); +use overload '""' => 'show_javascript'; # for building web pages, so + # you can just say: print $pjx +BEGIN { + use vars qw ($VERSION @ISA @METHODS); + @METHODS = qw(url_list coderef_list DEBUG JSDEBUG html + js_encode_function cgi_header_extra); + + CGI::Ajax->mk_accessors( @METHODS ); + + $VERSION = .697; +} + +########################################### main pod documentation begin ## + +=head1 NAME + +CGI::Ajax - a perl-specific system for writing Asynchronous web +applications + +=head1 SYNOPSIS + + use strict; + use CGI; # or any other CGI:: form handler/decoder + use CGI::Ajax; + + my $cgi = new CGI; + my $pjx = new CGI::Ajax( 'exported_func' => \&perl_func ); + + print $pjx->build_html( $cgi, \&Show_HTML); + + sub perl_func { + my $input = shift; + # do something with $input + my $output = $input . " was the input!"; + return( $output ); + } + + sub Show_HTML { + my $html = < + + Enter something: + +
+

+ + + EOHTML + return $html; + } + +I + +=head1 DESCRIPTION + +CGI::Ajax is an object-oriented module that provides a unique +mechanism for using perl code asynchronously from javascript- +enhanced HTML pages. CGI::Ajax unburdens the user from having to +write extensive javascript, except for associating an exported +method with a document-defined event (such as onClick, onKeyUp, +etc). CGI::Ajax also mixes well with HTML containing more complex +javascript. + +CGI::Ajax supports methods that return single results or multiple +results to the web page, and supports returning values to multiple +DIV elements on the HTML page. + +Using CGI::Ajax, the URL for the HTTP GET/POST request is +automatically generated based on HTML layout and events, and the +page is then dynamically updated with the output from the perl +function. Additionally, CGI::Ajax supports mapping URL's to a +CGI::Ajax function name, so you can separate your code processing +over multiple scripts. + +Other than using the Class::Accessor module to generate CGI::Ajax' +accessor methods, CGI::Ajax is completely self-contained - it +does not require you to install a larger package or a full Content +Management System, etc. + +We have added I for other CGI handler/decoder modules, +like L or L, but we can't test these +since we run mod_perl2 only here. CGI::Ajax checks to see if a +header() method is available to the CGI object, and then uses it. +If method() isn't available, it creates it's own minimal header. + +A primary goal of CGI::Ajax is to keep the module streamlined and +maximally flexible. We are trying to keep the generated javascript +code to a minimum, but still provide users with a variety of +methods for deploying CGI::Ajax. And VERY little user javascript. + +=head1 EXAMPLES + +The CGI::Ajax module allows a Perl subroutine to be called +asynchronously, when triggered from a javascript event on the +HTML page. To do this, the subroutine must be I, +usually done during: + + my $pjx = new CGI::Ajax( 'JSFUNC' => \&PERLFUNC ); + +This maps a perl subroutine (PERLFUNC) to an automatically +generated Javascript function (JSFUNC). Next you setup a trigger this +function when an event occurs (e.g. "onClick"): + + onClick="JSFUNC(['source1','source2'], ['dest1','dest2']);" + +where 'source1', 'dest1', 'source2', 'dest2' are the DIV ids of +HTML elements in your page... + + + +

+ +L sends the values from source1 and source2 to your +Perl subroutine and returns the results to dest1 and dest2. + +=head2 4 Usage Methods + +=over 4 + +=item 1 Standard CGI::Ajax example + +Start by defining a perl subroutine that you want available from +javascript. In this case we'll define a subrouting that determines +whether or not an input is odd, even, or not a number (NaN): + + use strict; + use CGI::Ajax; + use CGI; + + + sub evenodd_func { + my $input = shift; + + # see if input is defined + if ( not defined $input ) { + return("input not defined or NaN"); + } + + # see if value is a number (*thanks Randall!*) + if ( $input !~ /\A\d+\z/ ) { + return("input is NaN"); + } + + # got a number, so mod by 2 + $input % 2 == 0 ? return("EVEN") : return("ODD"); + } + +Alternatively, we could have used coderefs to associate an +exported name... + + my $evenodd_func = sub { + # exactly the same as in the above subroutine + }; + +Next we define a function to generate the web page - this can +be done many different ways, and can also be defined as an +anonymous sub. The only requirement is that the sub send back +the html of the page. You can do this via a string containing the +html, or from a coderef that returns the html, or from a function +(as shown here)... + + sub Show_HTML { + my $html = < + CGI::Ajax Example + + + Enter a number: + +
+

+ + +EOT + return $html; + } + +The exported Perl subrouting is triggered using the C +event handler of the input HTML element. The subroutine takes one +value from the form, the input element B<'val1'>, and returns the +the result to an HTML div element with an id of B<'resultdiv'>. +Sending in the input id in an array format is required to support +multiple inputs, and similarly, to output multiple the results, +you can use an array for the output divs, but this isn't mandatory - +as will be explained in the B usage. + +Now create a CGI object and a CGI::Ajax object, associating a reference +to our subroutine with the name we want available to javascript. + + my $cgi = new CGI(); + my $pjx = new CGI::Ajax( 'evenodd' => \&evenodd_func ); + +And if we used a coderef, it would look like this... + + my $pjx = new CGI::Ajax( 'evenodd' => $evenodd_func ); + +Now we're ready to print the output page; we send in the cgi +object and the HTML-generating function. + + print $pjx->build_html($cgi,\&Show_HTML); + +CGI::Ajax has support for passing in extra HTML header information +to the CGI object. This can be accomplished by adding a third +argument to the build_html() call. The argument needs to be a +hashref containing Key=>value pairs that CGI objects understand: + + print $pjx->build_html($cgi,\&Show_HTML, + {-charset=>'UTF-8, -expires=>'-1d'}); + +See L for more header() method options. + +That's it for the CGI::Ajax standard method. Let's look at +something more advanced. + +=item 2 Advanced CGI::Ajax example + +Let's say we wanted to have a perl subroutine process multiple +values from the HTML page, and similarly return multiple values +back to distinct divs on the page. This is easy to do, and +requires no changes to the perl code - you just create it as you +would any perl subroutine that works with multiple input values +and returns multiple values. The significant change happens in +the event handler javascript in the HTML... + + onClick="exported_func(['input1','input2'],['result1','result2']);" + +Here we associate our javascript function ("exported_func") with +two HTML element ids ('input1','input2'), and also send in two +HTML element ids to place the results in ('result1','result2'). + +=item 3 Sending Perl Subroutine Output to a Javascript function + +Occassionally, you might want to have a custom javascript function +process the returned information from your Perl subroutine. +This is possible, and the only requierment is that you change +your event handler code... + + onClick="exported_func(['input1'],[js_process_func]);" + +In this scenario, C is a javascript function you +write to take the returned value from your Perl subroutine and +process the results. I Beware that with this usage, B. If the exported Perl subroutine returns, e.g. 2 +values, then C would need to process the input +by working through an array, or using the javascript Function +C object. + + function js_process_func() { + var input1 = arguments[0] + var input2 = arguments[1]; + // do something and return results, or set HTML divs using + // innerHTML + document.getElementById('outputdiv').innerHTML = input1; + } + +=item 4 URL/Outside Script CGI::Ajax example + +There are times when you may want a different script to +return content to your page. This could be because you have +an existing script already written to perform a particular +task, or you want to distribute a part of your application to another +script. This can be accomplished in L by using a URL in +place of a locally-defined Perl subroutine. In this usage, +you alter you creation of the L object to link an +exported javascript function name to a local URL instead of +a coderef or a subroutine. + + my $url = 'scripts/other_script.pl'; + my $pjx = new CGI::Ajax( 'external' => $url ); + +This will work as before in terms of how it is called from you +event handler: + + onClick="external(['input1','input2'],['resultdiv']);" + +The other_script.pl will get the values via a CGI object and +accessing the 'args' key. The values of the B<'args'> key will +be an array of everything that was sent into the script. + + my @input = $cgi->params('args'); + $input[0]; # contains first argument + $input[1]; # contains second argument, etc... + +This is good, but what if you need to send in arguments to the +other script which are directly from the calling Perl script, +i.e. you want a calling Perl script's variable to be sent, not +the value from an HTML element on the page? This is possible +using the following syntax: + + onClick="exported_func(['args__$input1','args__$input2'], + ['resultdiv']);" + +Similary, if the external script required a constant as input +(e.g. C, you would use this syntax: + + onClick="exported_func(['args__42'],['resultdiv']);" + +In both of the above examples, the result from the external +script would get placed into the I element on our +(the calling script's) page. + +If you are sending more than one argument from an external perl +script back to a javascript function, you will need to split the +string (AJAX applications communicate in strings only) on something. +Internally, we use '__pjx__', and this string is checked for. If +found, L will automatically split it. However, if you +don't want to use '__pjx__', you can do it yourself: + +For example, from your Perl script, you would... + + return("A|B"); # join with "|" + +and then in the javascript function you would have something like... + + process_func() { + var arr = arguments[0].split("|"); + // arr[0] eq 'A' + // arr[1] eq 'B' + } + +In order to rename parameters, in case the outside script needs +specifically-named parameters and not CGI::Ajax' I<'args'> default +parameter name, change your event handler associated with an HTML +event like this + + onClick="exported_func(['myname__$input1','myparam__$input2'], + ['resultdiv']);" + +The URL generated would look like this... + +C + +You would then retrieve the input in the outside script with this... + + my $p1 = $cgi->params('myname'); + my $p1 = $cgi->params('myparam'); + +Finally, what if we need to get a value from our HTML page and we +want to send that value to an outside script but the outside script +requires a named parameter different from I<'args'>? You can +accomplish this with L using the getVal() javascript +method (which returns an array, thus the C notation): + + onClick="exported_func(['myparam__' + getVal('div_id')[0]], + ['resultdiv']);" + +This will get the value of our HTML element with and +I of I, and submit it to the url attached to +I. So if our exported handler referred to a URI +called I'; + return $rv; +} + +## new +sub new { + my ($class) = shift; + my $self = bless ({}, ref ($class) || $class); +# $self->SUPER::new(); + $self->JSDEBUG(0); # turn javascript debugging off (if on, + # extra info will be added to the web page output + # if set to 1, then the core js will get + # compressed, but the user-defined functions will + # not be compressed. If set to 2 (or anything + # greater than 1 or 0), then none of the + # javascript will get compressed. + # + $self->DEBUG(0); # turn debugging off (if on, check web logs) + + #accessorized attributes + $self->coderef_list({}); + $self->url_list({}); + #$self->html(""); + #$self->cgi(); + #$self->cgi_header_extra(""); # set cgi_header_extra to an empty string + + # setup a default endcoding; if you need support for international + # charsets, use 'escape' instead of encodeURIComponent. Due to the + # number of browser problems users report about scripts with a default of + # encodeURIComponent, we are setting the default to 'escape' + $self->js_encode_function('escape'); + + if ( @_ < 2 ) { + die "incorrect usage: must have fn=>code pairs in new\n"; + } + + while ( @_ ) { + my($function_name,$code) = splice( @_, 0, 2 ); + if ( ref( $code ) eq "CODE" ) { + if ( $self->DEBUG() ) { + print STDERR "name = $function_name, code = $code\n"; + } + # add the name/code to hash + $self->coderef_list()->{ $function_name } = $code; + } elsif ( ref($code) ) { + die "Unsuported code block/url\n"; + } else { + if ( $self->DEBUG() ) { + print STDERR "Setting function $function_name to url $code\n"; + } + # if it's a url, it is added here + $self->url_list()->{ $function_name } = $code; + } + } + return ($self); +} + +###################################################### +## METHODS - private ## +###################################################### + +# sub cgiobj(), cgi() +# +# Purpose: accessor method to associate a CGI object with our +# CGI::Ajax object +# Arguments: a CGI object +# Returns: CGI::Ajax objects cgi object +# Called By: originating cgi script, or build_html() +# +sub cgiobj { + my $self = shift; + # see if any values were sent in... + if ( @_ ) { + my $cgi = shift; + # add support for other CGI::* modules This requires that your web server + # be configured properly. I can't test anything but a mod_perl2 + # setup, so this prevents me from testing CGI::Lite,CGI::Simple, etc. + if ( ref($cgi) =~ /CGI.*/ ) { + if ( $self->DEBUG() ) { + print STDERR "cgiobj() received a CGI-like object ($cgi)\n"; + } + $self->{'cgi'} = $cgi; + } else { + die "CGI::Ajax -- Can't set internal CGI object to a non-CGI object ($cgi)\n"; + } + } + # return the object + return( $self->{'cgi'} ); +} + +sub cgi { + my $self = shift; + if ( @_ ) { + return( $self->cgiobj( @_ ) ); + } else { + return( $self->cgiobj() ); + } +} + +## # sub cgi_header_extra +## # +## # Purpose: accessor method to associate CGI header information +## # with the CGI::Ajax object +## # Arguments: a hashref with key=>value pairs that get handed off to +## # the CGI object's header() method +## # Returns: hashref of extra cgi header params +## # Called By: originating cgi script, or build_html() +## +## sub cgi_header_extra { +## my $self = shift; +## if ( @_ ) { +## $self->{'cgi_header_extra'} = shift; +## } +## return( $self->{'cgi_header_extra'} ); +## } + +# sub create_js_setRequestHeader +# +# Purpose: create text of the header for the javascript side, +# xmlhttprequest call +# Arguments: none +# Returns: text of header to pass to xmlhttpreq call so it will +# match whatever was setup for the main web-page +# Called By: originating cgi script, or build_html() +# + +sub create_js_setRequestHeader { + my $self = shift; + my $cgi_header_extra = $self->cgi_header_extra(); + my $js_header_string = q{r.setRequestHeader("}; + #$js_header_string .= $self->cgi()->header( $cgi_header_extra ); + $js_header_string .= $self->cgi()->header(); + $js_header_string .= q{");}; + #if ( ref $cgi_header_extra eq "HASH" ) { + # foreach my $k ( keys(%$cgi_header_extra) ) { + # $js_header_string .= $self->cgi()->header($cgi_headers) + # } + #} else { + #print STDERR $self->cgi()->header($cgi_headers) ; + + if ( $self->DEBUG() ) { + print STDERR "js_header_string is (", $js_header_string, ")\n"; + } + + return($js_header_string); +} + +# sub show_common_js() +# +# Purpose: create text of the javascript needed to interface with +# the perl functions +# Arguments: none +# Returns: text of common javascript subroutine, 'do_http_request' +# Called By: originating cgi script, or build_html() +# + +sub show_common_js { + my $self = shift; + my $encodefn = $self->js_encode_function(); + my $decodefn = $encodefn; + $decodefn =~ s/^(en)/de/; + $decodefn =~ s/^(esc)/unesc/; + #my $request_header_str = $self->create_js_setRequestHeader(); + my $request_header_str = ""; + my $rv = <

";
+    for( var i=0; i < ajax.length; i++ ) {
+      tmp += '' +
+      decodeURI(ajax[i].url) + ' 
';
+    }
+    document.getElementById('pjxdebugrequest').innerHTML = tmp + "

"; +} + +EOT + + if ( $self->JSDEBUG() <= 1 ) { + $rv = $self->compress_js($rv); + } + + return($rv); +} + +# sub compress_js() +# +# Purpose: searches the javascript for newlines and spaces and +# removes them (if a newline) or shrinks them to a single (if +# space). +# Arguments: javascript to compress +# Returns: compressed js string +# Called By: show_common_js(), +# + +sub compress_js { + my($self,$js) = @_; + return if not defined $js; + return if $js eq ""; + $js =~ s/\n//g; # drop newlines + $js =~ s/\s+/ /g; # replace 1+ spaces with just one space + return $js; +} + + +# sub insert_js_in_head() +# +# Purpose: searches the html value in the CGI::Ajax object and inserts +# the ajax javascript code in the section, +# or if no such section exists, then it creates it. If +# JSDEBUG is set, then an extra div will be added and the +# url wil be desplayed as a link +# Arguments: none +# Returns: none +# Called By: build_html() +# + +sub insert_js_in_head{ + my $self = shift; + my $mhtml = $self->html(); + my $newhtml; + my @shtml; + my $js = $self->show_javascript(); + + if ( $self->JSDEBUG() ) { + my $showurl=qq!

!; + # find the terminal so we can insert just before it + my @splith = $mhtml =~ /(.*)(<\s*\/\s*body[^>]*>?)(.*)/is; + $mhtml = $splith[0].$showurl.$splith[1].$splith[2]; + } + + # see if we can match on + @shtml= $mhtml =~ /(.*)(<\s*head[^>]*>?)(.*)/is; + if ( @shtml ) { + # yes, there's already a , so let's insert inside it, + # at the beginning + $newhtml = $shtml[0].$shtml[1].$js.$shtml[2]; + } elsif( @shtml= $mhtml =~ /(.*)(<\s*html[^>]*>?)(.*)/is){ + # there's no , so look for the tag, and insert out + # javascript inside that tag + $newhtml = $shtml[0].$shtml[1].$js.$shtml[2]; + } else { + $newhtml .= ""; + $newhtml .= $js; + $newhtml .= ""; + $newhtml .= "No head/html tags, nowhere to insert. Returning javascript anyway
"; + $newhtml .= ""; + } + $self->html($newhtml); + return; +} + +# sub handle_request() +# +# Purpose: makes sure a fname function name was set in the CGI +# object, and then tries to eval the function with +# parameters sent in on args +# Arguments: none +# Returns: the result of the perl subroutine, as text; if multiple +# arguments are sent back from the defined, exported perl +# method, then join then with a connector (__pjx__). +# Called By: build_html() +# + +sub handle_request { + my ($self) = shift; + + my $result; # $result takes the output of the function, if it's an + # array split on __pjx__ + my @other = (); # array for catching extra parameters + + # we need to access "fname" in the form from the web page, so make + # sure there is a CGI object defined + return undef unless defined $self->cgi(); + + my $rv = ""; + if ( $self->cgi()->can('header') ) { + $rv = $self->cgi()->header( $self->cgi_header_extra() ); + } else { + # don't have an object with a "header()" method, so just create + # a mimimal one + $rv = "Content-Type: text/html;"; + # TODO: + $rv .= $self->cgi_header_extra(); + $rv .= "\n\n"; + } + + # get the name of the function + my $func_name = $self->cgi()->param("fname"); + + # check if the function name was created + if ( defined $self->coderef_list()->{$func_name} ) { + my $code = $self->coderef_list()->{$func_name}; + + # eval the code from the coderef, and append the output to $rv + if ( ref($code) eq "CODE" ) { + eval { ($result, @other) = $code->( $self->cgi()->param("args") ) }; + + if ($@) { + # see if the eval caused and error and report it + # Should we be more severe and die? + if ( $self->DEBUG() ) { + print STDERR "Problem with code: $@\n"; + } + } + + if( @other ) { + $rv .= join( "__pjx__", ($result, @other) ); + if ( $self->DEBUG() ) { + print STDERR "rv = $rv\n"; + } + } else { + if ( defined $result ) { + $rv .= $result; + } + } + + } # end if ref = CODE + } else { + # # problems with the URL, return a CGI rrror + print STDERR "POSSIBLE SECURITY INCIDENT! Browser from ", $self->cgi()->remote_addr(); + print STDERR "\trequested URL: ", $self->cgi()->url(); + print STDERR "\tfname request: ", $self->cgi()->param('fname'); + print STDERR " -- returning Bad Request status 400\n"; + if ( $self->cgi()->can('header') ) { + return($self->cgi()->header( -status=>'400' )); + } else { + # don't have an object with a "header()" method, so just create + # a mimimal one with 400 error + $rv = "Status: 400\nContent-Type: text/html;\n\n"; + } + } + return $rv; +} + + +# sub make_function() +# +# Purpose: creates the javascript wrapper for the underlying perl +# subroutine +# Arguments: CGI object from web form, and the name of the perl +# function to export to javascript, or a url if the +# function name refers to another cgi script +# Returns: text of the javascript-wrapped perl subroutine +# Called By: show_javascript; called once for each registered perl +# subroutine +# + +sub make_function { + my ($self, $func_name ) = @_; + return("") if not defined $func_name; + return("") if $func_name eq ""; + my $rv = ""; + my $script = $0 || $ENV{SCRIPT_FILENAME}; + $script =~ s/.*[\/|\\](.+)$/$1/; + my $outside_url = $self->url_list()->{ $func_name }; + my $url = defined $outside_url ? $outside_url : $script; + if ($url =~ /\?/) { $url.='&'; } else {$url.='?'} + $url = "'$url'"; + my $jsdebug = ""; + if ( $self->JSDEBUG()) { + $jsdebug = "jsdebug()"; + } + + #create the javascript text + $rv .= <JSDEBUG() ) { + $rv = $self->compress_js($rv); + } + return $rv; +} + +=item register() + + Purpose: adds a function name and a code ref to the global coderef + hash, after the original object was created + Arguments: function name, code reference + Returns: none + Called By: originating web script + +=cut + +sub register { + my ( $self, $fn, $coderef ) = @_; + # coderef_list() is a Class::Accessor function + # url_list() is a Class::Accessor function + if ( ref( $coderef ) eq "CODE" ) { + $self->coderef_list()->{$fn} = $coderef; + } elsif ( ref($coderef) ) { + die "Unsupported code/url type - error\n"; + } else { + $self->url_list()->{$fn} = $coderef; + } +} + +=item JSDEBUG() + + Purpose: Show the AJAX URL that is being generated, and stop + compression of the generated javascript, both of which can aid + during debugging. If set to 1, then the core js will get + compressed, but the user-defined functions will not be + compressed. If set to 2 (or anything greater than 1 or 0), + then none of the javascript will get compressed. + + Arguments: JSDEBUG(0); # turn javascript debugging off + JSDEBUG(1); # turn javascript debugging on, some javascript compression + JSDEBUG(2); # turn javascript debugging on, no javascript compresstion + Returns: prints a link to the url that is being generated automatically by + the Ajax object. this is VERY useful for seeing what + CGI::Ajax is doing. Following the link, will show a page + with the output that the page is generating. + + Called By: $pjx->JSDEBUG(1) # where $pjx is a CGI::Ajax object; + +=item DEBUG() + + Purpose: Show debugging information in web server logs + Arguments: DEBUG(0); # turn debugging off (default) + DEBUG(1); # turn debugging on + Returns: prints debugging information to the web server logs using + STDERR + Called By: $pjx->DEBUG(1) # where $pjx is a CGI::Ajax object; + +=back + +=head1 BUGS + +Follow any bugs at our homepage.... + + http://www.perljax.us + +=head1 SUPPORT + +Check out the news/discussion/bugs lists at our homepage: + + http://www.perljax.us + +=head1 AUTHORS + + Brian C. Thomas Brent Pedersen + CPAN ID: BCT + bct.x42@gmail.com bpederse@gmail.com + +=head1 A NOTE ABOUT THE MODULE NAME + +This module was initiated using the name "Perljax", but then +registered with CPAN under the WWW group "CGI::", and so became +"CGI::Perljax". Upon further deliberation, we decided to change it's +name to L. + +=head1 COPYRIGHT + +This program is free software; you can redistribute +it and/or modify it under the same terms as Perl itself. + +The full text of the license can be found in the +LICENSE file included with this module. + +=head1 SEE ALSO + +L +L +L + +=cut + +1; +__END__ diff --git a/CGI/LICENSE b/CGI/LICENSE new file mode 100644 index 000000000..9d0305b3f --- /dev/null +++ b/CGI/LICENSE @@ -0,0 +1,383 @@ +Terms of Perl itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--------------------------------------------------------------------------- + +The General Public License (GPL) +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, +Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute +verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to most of +the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for this service if you wish), that +you receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs; and that you know you can do +these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a +fee, you must give the recipients all the rights that you have. You must make +sure that they, too, receive or can get the source code. And you must show +them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) offer +you this license which gives you legal permission to copy, distribute and/or +modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced by +others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We wish +to avoid the danger that redistributors of a free program will individually obtain +patent licenses, in effect making the program proprietary. To prevent this, we +have made it clear that any patent must be licensed for everyone's free use or +not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +GNU GENERAL PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND +MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is not +restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and appropriately +publish on each copy an appropriate copyright notice and disclaimer of warranty; +keep intact all the notices that refer to this License and to the absence of any +warranty; and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at +your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such +modifications or work under the terms of Section 1 above, provided that you also +meet all of these conditions: + +a) You must cause the modified files to carry prominent notices stating that you +changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or in +part contains or is derived from the Program or any part thereof, to be licensed +as a whole at no charge to all third parties under the terms of this License. + +c) If the modified program normally reads commands interactively when run, you +must cause it, when started running for such interactive use in the most ordinary +way, to print or display an announcement including an appropriate copyright +notice and a notice that there is no warranty (or else, saying that you provide a +warranty) and that users may redistribute the program under these conditions, +and telling the user how to view a copy of this License. (Exception: if the +Program itself is interactive but does not normally print such an announcement, +your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be on +the terms of this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to +work written entirely by you; rather, the intent is to exercise the right to control +the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and 2 +above provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source +code, which must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give any +third party, for a charge no more than your cost of physically performing source +distribution, a complete machine-readable copy of the corresponding source +code, to be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all the +source code for all modules it contains, plus any associated interface definition +files, plus the scripts used to control compilation and installation of the +executable. However, as a special exception, the source code distributed need +not include anything that is normally distributed (in either source or binary form) +with the major components (compiler, kernel, and so on) of the operating system +on which the executable runs, unless that component itself accompanies the +executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so long +as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not accept +this License. Therefore, by modifying or distributing the Program (or any work +based on the Program), you indicate your acceptance of this License to do so, +and all its terms and conditions for copying, distributing or modifying the +Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to copy, +distribute or modify the Program subject to these terms and conditions. You +may not impose any further restrictions on the recipients' exercise of the rights +granted herein. You are not responsible for enforcing compliance by third parties +to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), conditions are imposed on +you (whether by court order, agreement or otherwise) that contradict the +conditions of this License, they do not excuse you from the conditions of this +License. If you cannot distribute so as to satisfy simultaneously your obligations +under this License and any other pertinent obligations, then as a consequence +you may not distribute the Program at all. For example, if a patent license would +not permit royalty-free redistribution of the Program by all those who receive +copies directly or indirectly through you, then the only way you could satisfy +both it and this License would be to refrain entirely from distribution of the +Program. + +If any portion of this section is held invalid or unenforceable under any particular +circumstance, the balance of the section is intended to apply and the section as +a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other +property right claims or to contest validity of any such claims; this section has +the sole purpose of protecting the integrity of the free software distribution +system, which is implemented by public license practices. Many people have +made generous contributions to the wide range of software distributed through +that system in reliance on consistent application of that system; it is up to the +author/donor to decide if he or she is willing to distribute software through any +other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries +either by patents or by copyrighted interfaces, the original copyright holder who +places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is permitted +only in or among countries not thus excluded. In such case, this License +incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems or +concerns. + +Each version is given a distinguishing version number. If the Program specifies a +version number of this License which applies to it and "any later version", you +have the option of following the terms and conditions either of that version or of +any later version published by the Free Software Foundation. If the Program does +not specify a version number of this License, you may choose any version ever +published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of all +derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS +NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE +COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM +"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR +IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE +ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED +TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY +WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM +(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY +OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS +BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + + +--------------------------------------------------------------------------- + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of the +package the right to use and distribute the Package in a more-or-less customary +fashion, plus the right to make reasonable modifications. + +Definitions: + +- "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through textual + modification. +- "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. +- "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. +- "You" is you, if you're thinking about copying or distributing this Package. +- "Reasonable copying fee" is whatever you can justify on the basis of + media cost, duplication charges, time of people involved, and so on. (You + will not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) +- "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you duplicate +all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived from +the Public Domain or from the Copyright Holder. A Package modified in such a +way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided +that you insert a prominent notice in each changed file stating how and when +you changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise + make them Freely Available, such as by posting said modifications + to Usenet or an equivalent medium, or placing the modifications on + a major archive site such as ftp.uu.net, or by allowing the + Copyright Holder to include your modifications in the Standard + Version of the Package. + + b) use the modified Package only within your corporation or + organization. + + c) rename any non-standard executables so the names do not + conflict with standard executables, which must also be provided, + and provide a separate manual page for each non-standard + executable that clearly documents how it differs from the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library + files, together with instructions (in the manual page or equivalent) + on where to get the Standard Version. + + b) accompany the distribution with the machine-readable source of + the Package with your modifications. + + c) accompany any non-standard executables with their + corresponding Standard Version executables, giving the + non-standard executables non-standard names, and clearly + documenting the differences in manual pages (or equivalent), + together with instructions on where to get the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this Package. +You may charge any fee you choose for support of this Package. You may not +charge a fee for this Package itself. However, you may distribute this Package in +aggregate with other (possibly commercial) programs as part of a larger +(possibly commercial) software distribution provided that you do not advertise +this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output from +the programs of this Package do not automatically fall under the copyright of this +Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. Aggregation of this Package with a commercial distribution is always permitted +provided that the use of this Package is embedded; that is, when no overt attempt +is made to make this Package's interfaces visible to the end user of the +commercial distribution. Such use shall not be construed as a distribution of +this Package. + +9. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED +WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR +PURPOSE. + +The End + + diff --git a/CGI/README b/CGI/README new file mode 100644 index 000000000..1af8860c6 --- /dev/null +++ b/CGI/README @@ -0,0 +1,41 @@ +pod2text CGI::Perljax.pm > README + +CGI::Perljax + +Perljax - a perl-specific system for writing AJAX- or +DHTML-based web applications. + + +Perljax provides a unique mechanism for using perl code +asynchronously from javascript using AJAX to access user-written +perl functions/methods. Perljax unburdens the user from having to +write any javascript, except for having to associate an exported +method with a document-defined event (such as onClick, onKeyUp, +etc). Only in the more advanced implementations of a exported perl +method would a user need to write custom javascript. Perljax supports +methods that return single results, or multiple results to the web +page. No other projects that we know of are like Perljax for the +following reasons: 1. Perljax is targeted specifically for perl +development. 2. Perljax shields the user from having to write any +javascript at all (unless they want to). 3. The URL for the HTTP GET +request is automatically generated based on HTML layout and events, +and the page is then dynamically updated. 4. Perljax is not part +of a Content Management System, or some other larger project. + + +INSTALL + +perl Makefile.PL +make +make test +make install + +*If you are on a windows box you should use 'nmake' rather than 'make'. + +Installation will place Perljax into the system perl @INC path, but it +is important that you make sure mod_perl uses this path (which is +mod_perl's default behavior, and also assuming you use mod_perl, and +not just run perl as a CGI). + +Example scripts are provided in the source script directory, and can +also be seen on the project's website, http://www.perljax.us.