| Current File : //opt/RZperl518/man/man3/CPANPLUS::Internals::Fetch.3 |
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CPANPLUS::Internals::Fetch 3"
.TH CPANPLUS::Internals::Fetch 3 "2014-10-01" "perl v5.18.4" "Perl Programmers Reference Guide"
.\" 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"
CPANPLUS::Internals::Fetch \- internals for fetching files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& my $output = $cb\->_fetch(
\& module => $modobj,
\& fetchdir => \*(Aq/path/to/save/to\*(Aq,
\& verbose => BOOL,
\& force => BOOL,
\& );
\&
\& $cb\->_add_fail_host( host => \*(Aqfoo.com\*(Aq );
\& $cb\->_host_ok( host => \*(Aqfoo.com\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
CPANPLUS::Internals::Fetch fetches files from either ftp, http, file
or rsync mirrors.
.PP
This is the rough flow:
.PP
.Vb 2
\& $cb\->_fetch
\& Delegate to File::Fetch;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SH "$path = _fetch( module => $modobj, [fetchdir => '/path/to/save/to', fetch_from => 'scheme://path/to/fetch/from', verbose => BOOL, force => BOOL, prefer_bin => BOOL, ttl => $seconds] )"
.el .SH "\f(CW$path\fP = _fetch( module => \f(CW$modobj\fP, [fetchdir => '/path/to/save/to', fetch_from => 'scheme://path/to/fetch/from', verbose => BOOL, force => BOOL, prefer_bin => BOOL, ttl => \f(CW$seconds\fP] )"
.IX Header "$path = _fetch( module => $modobj, [fetchdir => '/path/to/save/to', fetch_from => 'scheme://path/to/fetch/from', verbose => BOOL, force => BOOL, prefer_bin => BOOL, ttl => $seconds] )"
\&\f(CW\*(C`_fetch\*(C'\fR will fetch files based on the information in a module
object. You always need a module object. If you want a fake module
object for a one-off fetch, look at \f(CW\*(C`CPANPLUS::Module::Fake\*(C'\fR.
.PP
\&\f(CW\*(C`fetchdir\*(C'\fR is the place to save the file to. Usually this
information comes from your configuration, but you can override it
expressly if needed.
.PP
\&\f(CW\*(C`fetch_from\*(C'\fR lets you specify an \s-1URI\s0 to get this file from. If you
do not specify one, your list of configured hosts will be probed to
download the file from.
.PP
\&\f(CW\*(C`force\*(C'\fR forces a new download, even if the file already exists.
.PP
\&\f(CW\*(C`verbose\*(C'\fR simply indicates whether or not to print extra messages.
.PP
\&\f(CW\*(C`prefer_bin\*(C'\fR indicates whether you prefer the use of commandline
programs over perl modules. Defaults to your corresponding config
setting.
.PP
\&\f(CW\*(C`ttl\*(C'\fR (in seconds) indicates how long a cached copy is valid for. If
the fetch time of the local copy is within the ttl, the cached copy is
returned. Otherwise, the file is refetched.
.PP
\&\f(CW\*(C`_fetch\*(C'\fR figures out, based on the host list, what scheme to use and
from there, delegates to \f(CW\*(C`File::Fetch\*(C'\fR do the actual fetching.
.PP
Returns the path of the output file on success, false on failure.
.PP
Note that you can set a \f(CW\*(C`blacklist\*(C'\fR on certain methods in the config.
Simply add the identifying name of the method (ie, \f(CW\*(C`lwp\*(C'\fR) to:
\f(CW$conf\fR\->_set_fetch( blacklist => ['lwp'] );
.PP
And the \f(CW\*(C`LWP\*(C'\fR function will be skipped by \f(CW\*(C`File::Fetch\*(C'\fR.
.ie n .SS "_add_fail_host( host => $host_hashref )"
.el .SS "_add_fail_host( host => \f(CW$host_hashref\fP )"
.IX Subsection "_add_fail_host( host => $host_hashref )"
Mark a particular host as bad. This makes \f(CW\*(C`CPANPLUS::Internals::Fetch\*(C'\fR
skip it in fetches until this cache is flushed.
.ie n .SS "_host_ok( host => $host_hashref )"
.el .SS "_host_ok( host => \f(CW$host_hashref\fP )"
.IX Subsection "_host_ok( host => $host_hashref )"
Query the cache to see if this host is ok, or if it has been flagged
as bad.
.PP
Returns true if the host is ok, false otherwise.