[14657] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
| 3 | # WgetDownload.pm -- Download base module that handles calling Wget
|
---|
| 4 | # A component of the Greenstone digital library software
|
---|
| 5 | # from the New Zealand Digital Library Project at the
|
---|
| 6 | # University of Waikato, New Zealand.
|
---|
| 7 | #
|
---|
| 8 | # Copyright (C) 2006 New Zealand Digital Library Project
|
---|
| 9 | #
|
---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
---|
| 11 | # it under the terms of the GNU General Public License as published by
|
---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
---|
| 13 | # (at your option) any later version.
|
---|
| 14 | #
|
---|
| 15 | # This program is distributed in the hope that it will be useful,
|
---|
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 18 | # GNU General Public License for more details.
|
---|
| 19 | #
|
---|
| 20 | # You should have received a copy of the GNU General Public License
|
---|
| 21 | # along with this program; if not, write to the Free Software
|
---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 23 | #
|
---|
| 24 | ###########################################################################
|
---|
| 25 |
|
---|
| 26 | package WgetDownload;
|
---|
| 27 |
|
---|
| 28 | eval {require bytes};
|
---|
| 29 |
|
---|
| 30 | # suppress the annoying "subroutine redefined" warning that various
|
---|
| 31 | # plugins cause under perl 5.6
|
---|
| 32 | $SIG{__WARN__} = sub {warn($_[0]) unless ($_[0] =~ /Subroutine\s+\S+\sredefined/)};
|
---|
| 33 |
|
---|
| 34 | use BasDownload;
|
---|
| 35 | use strict;
|
---|
| 36 | use IPC::Open2;
|
---|
| 37 | use Cwd;
|
---|
| 38 |
|
---|
| 39 | sub BEGIN {
|
---|
| 40 | @WgetDownload::ISA = ('BasDownload');
|
---|
| 41 | }
|
---|
| 42 |
|
---|
| 43 | my $arguments =
|
---|
| 44 | [ { 'name' => "proxy_on",
|
---|
| 45 | 'desc' => "{WgetDownload.proxy_on}",
|
---|
| 46 | 'type' => "flag",
|
---|
| 47 | 'reqd' => "no",
|
---|
| 48 | 'hiddengli' => "yes"},
|
---|
| 49 | { 'name' => "proxy_host",
|
---|
| 50 | 'desc' => "{WgetDownload.proxy_host}",
|
---|
| 51 | 'type' => "string",
|
---|
| 52 | 'reqd' => "no",
|
---|
| 53 | 'hiddengli' => "yes"},
|
---|
| 54 | { 'name' => "proxy_port",
|
---|
| 55 | 'desc' => "{WgetDownload.proxy_port}",
|
---|
| 56 | 'type' => "string",
|
---|
| 57 | 'reqd' => "no",
|
---|
| 58 | 'hiddengli' => "yes"},
|
---|
| 59 | { 'name' => "user_name",
|
---|
| 60 | 'desc' => "{WgetDownload.user_name}",
|
---|
| 61 | 'type' => "string",
|
---|
| 62 | 'reqd' => "no",
|
---|
| 63 | 'hiddengli' => "yes"},
|
---|
| 64 | { 'name' => "user_password",
|
---|
| 65 | 'desc' => "{WgetDownload.user_password}",
|
---|
| 66 | 'type' => "string",
|
---|
| 67 | 'reqd' => "no",
|
---|
| 68 | 'hiddengli' => "yes"}];
|
---|
| 69 |
|
---|
| 70 | my $options = { 'name' => "WgetDownload",
|
---|
| 71 | 'desc' => "{WgetDownload.desc}",
|
---|
| 72 | 'abstract' => "yes",
|
---|
| 73 | 'inherits' => "yes",
|
---|
| 74 | 'args' => $arguments };
|
---|
| 75 |
|
---|
| 76 |
|
---|
| 77 | sub new {
|
---|
| 78 | my ($class) = shift (@_);
|
---|
| 79 | my ($getlist,$inputargs,$hashArgOptLists) = @_;
|
---|
| 80 | push(@$getlist, $class);
|
---|
| 81 |
|
---|
| 82 | if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
|
---|
| 83 | if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
|
---|
| 84 |
|
---|
| 85 | my $self = (defined $hashArgOptLists)? new BasDownload($getlist,$inputargs,$hashArgOptLists): new BasDownload($getlist,$inputargs);
|
---|
| 86 |
|
---|
| 87 | return bless $self, $class;
|
---|
| 88 | }
|
---|
| 89 |
|
---|
| 90 | sub checkWgetSetup
|
---|
| 91 | {
|
---|
| 92 | my ($self,$blnGliCall) = @_;
|
---|
| 93 | #TODO: proxy detection??
|
---|
| 94 |
|
---|
| 95 | if((!$blnGliCall) && $self->{'proxy_on'})
|
---|
| 96 | {
|
---|
| 97 | &checkProxySetup($self);
|
---|
| 98 | }
|
---|
| 99 | &checkURL($self);
|
---|
| 100 | }
|
---|
| 101 |
|
---|
| 102 | sub getWgetOptions
|
---|
| 103 | {
|
---|
| 104 | my ($self) = @_;
|
---|
| 105 | my $strOptions = "";
|
---|
| 106 |
|
---|
| 107 | if($self->{'proxy_on'} && $self->{'proxy_host'} && $self->{'proxy_port'}
|
---|
| 108 | && $self->{'user_name'} && $self->{'user_password'}
|
---|
| 109 | )
|
---|
| 110 | {
|
---|
| 111 | $strOptions = " -e httpproxy=$self->{'proxy_host'}:$self->{'proxy_port'} --proxy-user=$self->{'user_name'}"." --proxy-passwd=$self->{'user_password'} -Y on ";
|
---|
| 112 | }
|
---|
| 113 |
|
---|
| 114 | return $strOptions;
|
---|
| 115 | }
|
---|
| 116 |
|
---|
| 117 | # Checking for proxy setup: proxy server, proxy port, proxy username and password.
|
---|
| 118 | sub checkProxySetup
|
---|
| 119 | {
|
---|
| 120 | my ($self) = @_;
|
---|
| 121 | ($self->{'proxy_on'}) || &error("checkProxySetup","The proxy is not on? How could that be happening?");
|
---|
| 122 | # Setup .wgetrc by using $self->{'proxy_host'} and $self->{'proxy_port'}
|
---|
| 123 | # Test if the connection is succeful. If the connection wasn't succeful then ask user to supply username and password.
|
---|
| 124 |
|
---|
| 125 | }
|
---|
| 126 |
|
---|
| 127 | sub useWget
|
---|
| 128 | {
|
---|
| 129 | my ($self, $cmdWget,$blnShow, $working_dir) = @_;
|
---|
| 130 |
|
---|
| 131 | my ($strReadIn,$strLine,$command);
|
---|
| 132 | $strReadIn = "" unless defined $strReadIn;
|
---|
| 133 |
|
---|
| 134 | my $current_dir = cwd();
|
---|
| 135 | my $changed_dir = 0;
|
---|
| 136 | if (defined $working_dir && -e $working_dir) {
|
---|
| 137 | chdir "$working_dir";
|
---|
| 138 | $changed_dir = 1;
|
---|
| 139 | }
|
---|
| 140 | my $wget_file_path = &util::filename_cat($ENV{'GSDLHOME'}, "bin", $ENV{'GSDLOS'}, "wget");
|
---|
| 141 | $command = "\"$wget_file_path\" $cmdWget |";
|
---|
| 142 |
|
---|
| 143 | open(*WIN,$command) || die "wget request failed: $!\n";
|
---|
| 144 |
|
---|
| 145 | while (defined($strLine=<WIN>))
|
---|
| 146 | {
|
---|
| 147 | if($blnShow)
|
---|
| 148 | {
|
---|
| 149 | print STDERR "$strReadIn\n";
|
---|
| 150 | }
|
---|
| 151 |
|
---|
| 152 | $strReadIn .= $strLine;
|
---|
| 153 | }
|
---|
| 154 |
|
---|
| 155 | close(WIN);
|
---|
| 156 | if ($changed_dir) {
|
---|
| 157 | chdir $current_dir;
|
---|
| 158 | }
|
---|
| 159 |
|
---|
| 160 | return $strReadIn;
|
---|
| 161 | }
|
---|
| 162 |
|
---|
| 163 | # TODO: Check if the URL is valid?? Not sure what should be in this function yet!!
|
---|
| 164 | sub checkURL
|
---|
| 165 | {
|
---|
| 166 | my ($self) = @_;
|
---|
| 167 | if ($self->{'url'} eq "")
|
---|
| 168 | {
|
---|
| 169 | &error("checkURL","no URL is specified!! Please specifies the URL for downloading.");
|
---|
| 170 | }
|
---|
| 171 | }
|
---|
| 172 |
|
---|
| 173 | sub error
|
---|
| 174 | {
|
---|
| 175 | my ($strFunctionName,$strError) = @_;
|
---|
| 176 | {
|
---|
| 177 | print "Error occoured in WgetDownload.pm\n".
|
---|
| 178 | "In Function:".$strFunctionName."\n".
|
---|
| 179 | "Error Message:".$strError."\n";
|
---|
| 180 | exit(-1);
|
---|
| 181 | }
|
---|
| 182 | }
|
---|
| 183 |
|
---|
| 184 | 1;
|
---|