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

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

NAME

       HTTP::Proxy::BodyFilter::lines - A filter that outputs only complete lines

SYNOPSIS

	   use HTTP::Proxy::BodyFilter::lines;
	   use MyFilter;    # this filter only works on complete lines

	   my $filter = MyFilter->new();

	   # stack both filters so that they'll handle text/* responses
	   $proxy->push_filter(
	       mime	=> 'text/*',
	       response => HTTP::Proxy::BodyFilter::lines->new,
	       response => $filter
	   );

	   # I want my lines to end with '!'
	   # This is equivalent to $/ = '!' in a normal Perl program
	   my $lines = HTTP::Proxy::BodyFilter::lines->new('!');

DESCRIPTION

       The HTTP::Proxy::BodyFilter::lines filter makes sure that the next filter in the filter chain will only receive complete lines. The
       "chunks" of data received by the following filters with either end with "
" or will be the last piece of data for the current HTTP message
       body.

       You can change the idea the filter has of what is a line by passing to its constructor the string it should understand as line ending. "
"
       is the default value.

	   my $filter = HTTP::Proxy::BodyFilter::lines->new( $sep );

       This is similar to modifying $/ in a Perl program. In fact, this filter has a behaviour so similar to modifying $/ that it also knows about
       "paragraph mode" and "record mode".

       Note that the "slurp" mode is not supported. Please use HTTP::Proxy::BodyFilter::complete to enable the generic store and forward filter
       mechanism.

METHODS

       This filter defines the following methods, which are automatically called:

       init()
	   Initialise the filter with the EOL information.

       filter()
	   Keeps unfinished lines for later.

       will_modify()
	   This method returns a false value, thus indicating to the system that it will not modify data passing through.

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::lines(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)