File Coverage

blib/lib/ASP4/Server.pm

Criterion	Covered	Total	%
statement	35	46	76.0
branch	1	2	50.0
condition			n/a
subroutine	12	16	75.0
pod	7	9	77.7
total	55	73	75.3

package ASP4::Server;

use strict;
use warnings 'all';
use ASP4::HTTPContext;
use encoding 'utf8';
use Mail::Sendmail;

sub new
{
  return bless { }, shift;
}# end new()


sub context { ASP4::HTTPContext->current }


sub URLEncode
{
  ASP4::HTTPContext->current->cgi->escape( $_[1] );
}# end URLEncode()


sub URLDecode
{
  ASP4::HTTPContext->current->cgi->unescape( $_[1] );
}# end URLDecode()


sub HTMLEncode
{
  my ($s, $str) = @_;
  no warnings 'uninitialized';
  $str =~ s/&/&/g;
  $str =~ s/
  $str =~ s/>/>/g;
  $str =~ s/"/"/g;
  $str =~ s/'/'/g;
  return $str;
}# end HTMLEncode()


sub HTMLDecode
{
  my ($s, $str) = @_;
  no warnings 'uninitialized';
  $str =~ s/</
  $str =~ s/>/>/g;
  $str =~ s/"/"/g;
  $str =~ s/&/&/g;
  $str =~ s/'/'/g;
  return $str;
}# end HTMLDecode()


sub MapPath
{
  my ($s, $path) = @_;

  return unless defined($path);

  ASP4::HTTPContext->current->config->web->www_root . $path;
}# end MapPath()


sub Mail
{
  my $s = shift;

  Mail::Sendmail::sendmail( @_ );
}# end Mail()


sub RegisterCleanup
{
  my ($s, $sub, @args) = @_;

  $s->context->r->pool->cleanup_register( $sub, \@args );
}# end RegisterCleanup()

1;# return true:

=pod

=head1 NAME

ASP4::Server - Utility Methods

=head1 SYNOPSIS

  # Get the full disk path to /contact/form.asp:
  $Server->MapPath("/contact/form.asp");

  # Email someone:
  $Server->Mail(
    To      => '[e-mail]',
    From    => 'Joe Jangles ',
    Subject => 'Test Email',
    Message => "Hello There!",
  );

  # Avoid XSS:


  # Proper URLs:
  Click

=head1 DESCRIPTION

The C<$Server> object provides some utility methods that don't really fit anywhere
else, but are still important.

=head1 PUBLIC METHODS

=head2 HTMLEncode( $str )

Performs a simple string substitution to sanitize C<$str> for inclusion on HTML pages.

Removes the threat of cross-site-scripting (XSS).

Eg:



Becomes:

  <tag/>

=head2 HTMLDecode( $str )

Does exactly the reverse of HTMLEncode.

Eg:

  <tag/>

Becomes:



=head2 URLEncode( $str )

Converts a string for use within a URL.

eg:

  [e-mail]

becomes:

  test%40test.com

=head2 URLDecode( $str )

Converts a url-encoded string to a normal string.

eg:

  test%40test.com

becomes:

  [e-mail]

=head2 MapPath( $file )

Converts a relative path to a full disk path.

eg:

  /contact/form.asp

becomes:

  /var/www/mysite.com/htdocs/contact/form.asp

=head2 Mail( %args )

Sends email - uses L's C function.

=head2 RegisterCleanup( \&code, @args )

The supplied coderef will be executed with its arguments as the request enters
its Cleanup phase.

See L for details.

=cut