http::proxy::bodyfilter::simple(3pm) [debian man page]

HTTP::Proxy::BodyFilter::simple(3pm)			User Contributed Perl Documentation		      HTTP::Proxy::BodyFilter::simple(3pm)

NAME

       HTTP::Proxy::BodyFilter::simple - A class for creating simple filters

SYNOPSIS

	   use HTTP::Proxy::BodyFilter::simple;

	   # a simple s/// filter
	   my $filter = HTTP::Proxy::BodyFilter::simple->new(
	       sub { ${ $_[1] } =~ s/foo/bar/g; }
	   );
	   $proxy->push_filter( response => $filter );

DESCRIPTION

       HTTP::Proxy::BodyFilter::simple can create BodyFilter without going through the hassle of creating a full-fledged class. Simply pass a code
       reference to the "filter()" method of your filter to the constructor, and you'll get the adequate filter.

   Constructor calling convention
       The constructor can be called in several ways, which are shown in the synopsis:

       single code reference
	   The code reference must conform to the standard filter() signature:

	       sub filter {
		   my ( $self, $dataref, $message, $protocol, $buffer ) = @_;
		   ...
	       }

	   It is assumed to be the code for the "filter()" method.  See HTTP::Proxy::BodyFilter.pm for more details about the "filter()" method.

       name/coderef pairs
	   The name is the name of the method ("filter", "begin", "end") and the coderef is the method itself.

	   See HTTP::Proxy::BodyFilter for the methods signatures.

METHODS

       This filter "factory" defines the standard HTTP::Proxy::BodyFilter methods, but those are only, erm, "proxies" to the actual CODE
       references passed to the constructor. These "proxy" methods are:

       filter()
       begin()
       end()

       Two other methods are actually HTTP::Proxy::BodyFilter::simple methods, and are called automatically:

       init()
	   Initalise the filter instance with the code references passed to the constructor.

       can()
	   Return the actual code reference that will be run, and not the "proxy" methods. If called with any other name than "begin", "end" and
	   "filter", calls UNIVERSAL::can() instead.

       There is also a method that returns a boolean value:

       will_modify()
	   The "will_modify()" method returns a scalar value (boolean) indicating if the filter may modify the body data. The default method
	   returns a true value, so you only need to set this value when you are absolutely certain that the filter will not modify data (or at
	   least not modify its final length).

	   Here's a simple example:

	       $filter = HTTP::Proxy::BodyFilter::simple->new(
		   filter => sub { ${ $_[1] } =~ s/foo/bar/g; },
		   will_modify => 0,	# "foo" is the same length as "bar"
	       );

SEE ALSO

       HTTP::Proxy, HTTP::Proxy::BodyFilter.

AUTHOR

       Philippe "BooK" Bruhat, <book@cpan.org>.

COPYRIGHT

       Copyright 2003-2006, Philippe Bruhat.

LICENSE

       This module is free software; you can redistribute it or modify it under the same terms as Perl itself.

perl v5.12.4							    2011-07-03				      HTTP::Proxy::BodyFilter::simple(3pm)

HTTP::Proxy::BodyFilter::htmlparser(3pm)		User Contributed Perl Documentation		  HTTP::Proxy::BodyFilter::htmlparser(3pm)

NAME

       HTTP::Proxy::BodyFilter::htmlparser - Filter using HTML::Parser

SYNOPSIS

	   use HTTP::Proxy::BodyFilter::htmlparser;

	   # $parser is a HTML::Parser object
	   $proxy->push_filter(
	       mime	=> 'text/html',
	       response => HTTP::Proxy::BodyFilter::htmlparser->new( $parser );
	   );

DESCRIPTION

       The HTTP::Proxy::BodyFilter::htmlparser lets you create a filter based on the HTML::Parser object of your choice.

       This filter takes a HTML::Parser object as an argument to its constructor.  The filter is either read-only or read-write. A read-only
       filter will not allow you to change the data on the fly. If you request a read-write filter, you'll have to rewrite the response-body
       completely.

       With a read-write filter, you must recreate the whole body data. This is mainly due to the fact that the HTML::Parser has its own buffering
       system, and that there is no easy way to correlate the data that triggered the HTML::Parser event and its original position in the chunk
       sent by the origin server. See below for details.

       Note that a simple filter that modify the HTML text (not the tags) can be created more easily with HTTP::Proxy::BodyFilter::htmltext.

   Creating a HTML::Parser that rewrites pages
       A read-write filter is declared by passing "rw => 1" to the constructor:

	    HTTP::Proxy::BodyFilter::htmlparser->new( $parser, rw => 1 );

       To be able to modify the body of a message, a filter created with HTTP::Proxy::BodyFilter::htmlparser must rewrite it completely. The
       HTML::Parser object can update a special attribute named "output".  To do so, the HTML::Parser handler will have to request the "self"
       attribute (that is to say, require access to the parser itself) and update its "output" key.

       The following attributes are added to the HTML::Parser object by this filter:

       output
	   A string that will hold the data sent back by the proxy.

	   This string will be used as a replacement for the body data only if the filter is read-write, that is to say, if it was initialised
	   with "rw => 1".

	   Data should always be appended to "$parser->{output}".

       message
	   A reference to the HTTP::Message that triggered the filter.

       protocol
	   A reference to the HTTP::Protocol object.

METHODS

       This filter defines three methods, called automatically:

       filter()
	   The "filter()" method handles all the interactions with the HTML::Parser object.

       init()
	   Initialise the filter with the HTML::Parser object passed to the constructor.

       will_modify()
	   This method returns a boolean value that indicates to the system if it will modify the data passing through. The value is actually the
	   value of the "rw" parameter passed to the constructor.

SEE ALSO

       HTTP::Proxy, HTTP::Proxy::Bodyfilter, HTTP::Proxy::BodyFilter::htmltext.

AUTHOR

       Philippe "BooK" Bruhat, <book@cpan.org>.

COPYRIGHT

       Copyright 2003-2006, Philippe Bruhat.

LICENSE

       This module is free software; you can redistribute it or modify it under the same terms as Perl itself.

perl v5.12.4							    2011-07-03				  HTTP::Proxy::BodyFilter::htmlparser(3pm)