.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "HTTP::Recorder 3pm" .TH HTTP::Recorder 3pm "2021-01-06" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" HTTP::Recorder \- record interaction with websites .SH "SYNOPSIS" .IX Header "SYNOPSIS" .SS "This module is deprecated" .IX Subsection "This module is deprecated" It works by tagging links in a page, and then when a link is clicked looking on the submitted tag to see which link was clicked .PP It can not handle Javascript-created links or \s-1JS\s0 manipulation of the page so it works only for fairly static websites .PP For better options check out Selenium .PP Patchs are welcome, and I'll fix bugs as much as I can, but please don't expect me to implement new features .SS "Using HTTP::Recorder as a Web Proxy" .IX Subsection "Using HTTP::Recorder as a Web Proxy" Set HTTP::Recorder as the user agent for a proxy, and it rewrites \s-1HTTP\s0 responses so that additional requests can be recorded. .PP \fIThe Proxy Script\fR .IX Subsection "The Proxy Script" .PP For quick start, run the httprecorder script .PP .Vb 1 \& httprecorder .Ve .PP This will open a local proxy on port 8080, and will dump the recorded traffic to a file named http_traffic in the current directory. use the \-help parameter for usage info .PP Start the proxy script, then change the settings in your web browser so that it will use this proxy for web requests. For more information about proxy settings and the default port, see HTTP::Proxy. .PP The script will be recorded in the specified file, and can be viewed and modified via the control panel. .PP For better control, use this example: .PP .Vb 1 \& #!/usr/bin/perl \& \& use HTTP::Proxy; \& use HTTP::Recorder; \& \& my $proxy = HTTP::Proxy\->new(); \& \& # create a new HTTP::Recorder object \& my $agent = new HTTP::Recorder; \& \& # set the log file (optional) \& $agent\->file("/tmp/myfile"); \& \& # set HTTP::Recorder as the agent for the proxy \& $proxy\->agent( $agent ); \& \& # start the proxy \& $proxy\->start(); .Ve .PP \fIStart Recording\fR .IX Subsection "Start Recording" .PP Now you can use your browser as your normally would, and your actions will be recorded in the file you specified. Alternatively, you can start recording from the Control Panel. .PP \fIUsing the Control Panel\fR .IX Subsection "Using the Control Panel" .PP If you have Javascript enabled in your browser, go to the HTTP::Recorder control \s-1URL\s0 (http://http\-recorder by default), optionally type a \s-1URL\s0 into the \*(L"Goto page\*(R" field, and click \*(L"Go\*(R". .PP In the new window, interact with web sites as you normally do, including typing a new address into the address field. The Control Panel will be updated after each recorded action. .PP The Control Panel allows you to modify, delete, or save your script. .SS "\s-1SSL\s0 sessions" .IX Subsection "SSL sessions" As of version 0.03, HTTP::Recorder can record \s-1SSL\s0 sessions. .PP To begin recording an \s-1SSL\s0 session, go to the control \s-1URL\s0 (http://http\-recorder/ by default), and enter the initial \s-1URL.\s0 Then, interact with the web site as usual. .SS "Script output" .IX Subsection "Script output" By default, HTTP::Recorder outputs WWW::Mechanize scripts. .PP However, you can override HTTP::Recorder::Logger to output other types of scripts. .SH "Functions" .IX Header "Functions" .SS "new" .IX Subsection "new" Creates and returns a new HTTP::Recorder object, referred to as the 'agent'. .ie n .SS "$agent\->prefix([$value])" .el .SS "\f(CW$agent\fP\->prefix([$value])" .IX Subsection "$agent->prefix([$value])" Get or set the prefix string that HTTP::Recorder uses for rewriting responses. .ie n .SS "$agent\->control([$value])" .el .SS "\f(CW$agent\fP\->control([$value])" .IX Subsection "$agent->control([$value])" Get or set the \s-1URL\s0 of the control panel. By default, the control \s-1URL\s0 is 'http\-recorder'. .PP The control \s-1URL\s0 will display a control panel which will allow you to view and edit the current script. .ie n .SS "$agent\->logger([$value])" .el .SS "\f(CW$agent\fP\->logger([$value])" .IX Subsection "$agent->logger([$value])" Get or set the logger object. The default logger is a HTTP::Recorder::Logger, which generates WWW::Mechanize scripts. .ie n .SS "$agent\->ignore_favicon([0|1])" .el .SS "\f(CW$agent\fP\->ignore_favicon([0|1])" .IX Subsection "$agent->ignore_favicon([0|1])" Get or set ignore_favicon flag that causes HTTP::Recorder to skip logging requests favicon.ico files. The value is 1 by default. .ie n .SS "$agent\->file([$value])" .el .SS "\f(CW$agent\fP\->file([$value])" .IX Subsection "$agent->file([$value])" Get or set the filename for generated scripts. The default is \&'/tmp/scriptfile'. .SH "Bugs, Missing Features, and other Oddities" .IX Header "Bugs, Missing Features, and other Oddities" .SS "Javascript" .IX Subsection "Javascript" WWW::Mechanize can't play back Javascript actions, and HTTP::Recorder doesn't record them. .SS "Why are my images corrupted?" .IX Subsection "Why are my images corrupted?" HTTP::Recorder only tries to rewrite responses that are of type text/*, which it determines by reading the Content-Type header of the HTTP::Response object. However, if the received image gives the wrong Content-Type header, it may be corrupted by the recorder. While this may not be pleasant to look at, it shouldn't have an effect on your recording session. .SH "See Also" .IX Header "See Also" See also LWP::UserAgent, WWW::Mechanize, HTTP::Proxy. .SH "Requests & Bugs" .IX Header "Requests & Bugs" Please submit any feature requests, suggestions, bugs, or patches at http://rt.cpan.org/, or email to bug\-HTTP\-Recorder@rt.cpan.org. .PP If you're submitting a bug of the type \*(L"X doesn't record correctly,\*(R" be sure to include a (preferably short and simple) \s-1HTML\s0 page that demonstrates the problem, and a clear explanation of a) what it does that it shouldn't, and b) what it should do instead. .SH "Author" .IX Header "Author" Copyright 2003\-2005 by Linda Julien .PP Maintained by Shmuel Fomberg .PP Released under the \s-1GNU\s0 Public License.