src/URL/URLhandler.pm

# url handler -> returns the location of the file
# Interface
# ---------
# new(cache)       : A new urlhandler with a defined default cahce directory
# download(url,[location]) : as get but always download
# get(url,[location]) : download from the specified url to cache or location
#                       return the full url path name incl. any base expansion
#                       and the filename downloaded to
# setbase(type,variablehash) : set the url defaults for a specific url type
#                              arguments are dependent on type
# unsetbase(type)  : deactivate a previously set base
# currentbase(type) : return the current base for the given type
#
# ----------------------------------------------------------------------

package URL::URLhandler;
require 5.004;
use Utilities::AddDir;
use URL::URLcache;
use URL::URLclass;
use URL::URLbase;
use Carp;

sub new {
        my $class=shift;
        my $cache=shift;
        $self={};
        bless $self, $class;
        $self->init($cache);
        return $self;
}

sub init {
        use Utilities::AddDir;
        my $self=shift;
        my $cache=shift;
        $self->{cache}=$cache;
        $self->{dummybase}=URL::URLbase->new({});
        $self->{cachestore}=$self->{cache}->filestore();
        use URL::URL_cvs;
        use URL::URL_file;
        use URL::URL_test;
        $self->{urlmodules}={
                        'cvs' => 'URL::URL_cvs',
                        'file' => 'URL::URL_file',
                        'test' => 'URL::URL_test'
                };
}

sub get {
        my $self=shift;
        my $origurl=shift;
        my $file="";

        my $url=URL::URLclass->new($origurl);
        my $type=$url->type();
        $url->expandurl($self->currentbase($type));
        my $fullurl=$url->url();

        $file=$self->{cache}->file($fullurl);
        if ( $file eq "" ) {
          ($fullurl,$file)=$self->download($origurl, @_);
        }
        return ($fullurl, $file);
}

sub download {
        my $self=shift;
        my $origurl=shift;

        # Process the URL string
        my $url=URL::URLclass->new($origurl);
        my $type=$url->type();
        $urltypehandler=$self->_typehandler($type);
        $url->expandurl($self->currentbase($type));

        # Generate a location name if not provided 
        $nocache=1;
        if ( @_ ) {
           $location=shift;
           $nocache=0; # dont cache if downloaded to an external location
        }
        else {
           $location=$self->{cache}->filename($url->url());
        }
        # -- get the file from the appropriate handler
        if ( defined $urltypehandler ) {
             # Call the download module
             $file=eval{$urltypehandler->get($url, $location)}; 
        } 

        # now register it in the cache if successful
        if ( $file && $nocache) {
          $self->{cache}->store($url->url(), $location);
        }
        return ($url->url(), $file);
}

sub setbase {
        my $self=shift;
        my $type=shift;
        my @args=@_;
        my $oref;

        $self->checktype($type);
        # make a new base object
        my $base=URL::URLbase->new(@_);
        push @{$self->{"basestack"}{$type}}, $base;
}

sub unsetbase {
        my $self=shift;
        my $type=shift;
        my $oref;

        $self->checktype($type);
        # pop off the stack and call the unset base method
        if ( $#{$self->{basestack}{$type}} >=0 ) {
           my $base=pop @{$self->{basestack}{$type}};
           undef $base;
        }
        else {
           die "URLhandler error: Unable to unset type $type\n";
        }
        # remove the stack if its empty
        if ( $#{$self->{basestack}{$type}} == -1 ) {
          delete $self->{basestack}{$type};
        }
}

sub currentbase {
        my $self=shift;
        my $type=shift;
        my $rv;

        if ( exists $self->{basestack}{$type} ) {
          $rv=${$self->{basestack}{$type}}[$#{$self->{basestack}{$type}}];
        }
        else {
          $rv=$self->{dummybase};
        }
        return $rv;
}

sub checktype($type) {
        my $self=shift;
        my $type=shift;

        # Check type is supported
        if ( ! exists $self->{urlmodules}{$type} ) {
          die "URLhandler error: Unsupported type $type\n";
        }
}

sub _typehandler {
        my $self=shift;
        my $type=shift;

        $self->checktype($type);

        # instantiate only if it dosnt already exist;
        if ( exists $self->{'urlobjs'}{$type} ) {
                $self->{'urlobjs'}{$type};
        }       
        else {
                $self->{'urlobjs'}{$type}=$self->{urlmodules}{$type}->new();
        }
}
Revision:	1.14
Committed:	Thu May 18 14:57:30 2000 UTC (24 years, 11 months ago) by williamc
Content type:	text/plain
Branch:	MAIN
Changes since 1.13:	+0 -4 lines
Log Message:	Update to minimum reqs
#	User	Rev	Content
1	williamc	1.7	# url handler -> returns the location of the file
2			# Interface
3	williamc	1.1	# ---------
4	williamc	1.7	# new(cache) : A new urlhandler with a defined default cahce directory
5	williamc	1.11	# download(url,[location]) : as get but always download
6	williamc	1.9	# get(url,[location]) : download from the specified url to cache or location
7			# return the full url path name incl. any base expansion
8			# and the filename downloaded to
9	williamc	1.4	# setbase(type,variablehash) : set the url defaults for a specific url type
10	williamc	1.7	# arguments are dependent on type
11	williamc	1.1	# unsetbase(type) : deactivate a previously set base
12	williamc	1.9	# currentbase(type) : return the current base for the given type
13	williamc	1.1	#
14			# ----------------------------------------------------------------------
15
16	williamc	1.5	package URL::URLhandler;
17	williamc	1.1	require 5.004;
18			use Utilities::AddDir;
19	williamc	1.9	use URL::URLcache;
20			use URL::URLclass;
21			use URL::URLbase;
22	williamc	1.1	use Carp;
23
24			sub new {
25			my $class=shift;
26			my $cache=shift;
27			$self={};
28			bless $self, $class;
29			$self->init($cache);
30			return $self;
31			}
32
33			sub init {
34			use Utilities::AddDir;
35			my $self=shift;
36			my $cache=shift;
37			$self->{cache}=$cache;
38	williamc	1.9	$self->{dummybase}=URL::URLbase->new({});
39	williamc	1.7	$self->{cachestore}=$self->{cache}->filestore();
40	williamc	1.2	use URL::URL_cvs;
41			use URL::URL_file;
42	williamc	1.13	use URL::URL_test;
43	williamc	1.2	$self->{urlmodules}={
44	williamc	1.5	'cvs' => 'URL::URL_cvs',
45	williamc	1.7	'file' => 'URL::URL_file',
46	williamc	1.13	'test' => 'URL::URL_test'
47	williamc	1.2	};
48	williamc	1.1	}
49
50	williamc	1.7	sub get {
51	williamc	1.4	my $self=shift;
52	williamc	1.9	my $origurl=shift;
53	williamc	1.11	my $file="";
54	williamc	1.9
55	williamc	1.11	my $url=URL::URLclass->new($origurl);
56			my $type=$url->type();
57			$url->expandurl($self->currentbase($type));
58			my $fullurl=$url->url();
59
60	williamc	1.12	$file=$self->{cache}->file($fullurl);
61			if ( $file eq "" ) {
62	williamc	1.11	($fullurl,$file)=$self->download($origurl, @_);
63			}
64			return ($fullurl, $file);
65			}
66
67			sub download {
68			my $self=shift;
69			my $origurl=shift;
70
71			# Process the URL string
72			my $url=URL::URLclass->new($origurl);
73	williamc	1.9	my $type=$url->type();
74			$urltypehandler=$self->_typehandler($type);
75			$url->expandurl($self->currentbase($type));
76
77			# Generate a location name if not provided
78	williamc	1.12	$nocache=1;
79	williamc	1.9	if ( @_ ) {
80			$location=shift;
81	williamc	1.12	$nocache=0; # dont cache if downloaded to an external location
82	williamc	1.9	}
83			else {
84			$location=$self->{cache}->filename($url->url());
85			}
86	williamc	1.11	# -- get the file from the appropriate handler
87	williamc	1.9	if ( defined $urltypehandler ) {
88			# Call the download module
89			$file=eval{$urltypehandler->get($url, $location)};
90			}
91	williamc	1.4
92	williamc	1.9	# now register it in the cache if successful
93	williamc	1.12	if ( $file && $nocache) {
94	williamc	1.11	$self->{cache}->store($url->url(), $location);
95	williamc	1.9	}
96	williamc	1.10	return ($url->url(), $file);
97	williamc	1.4	}
98
99	williamc	1.9	sub setbase {
100	williamc	1.1	my $self=shift;
101	williamc	1.9	my $type=shift;
102			my @args=@_;
103			my $oref;
104	williamc	1.7
105	williamc	1.9	$self->checktype($type);
106			# make a new base object
107			my $base=URL::URLbase->new(@_);
108	williamc	1.10	push @{$self->{"basestack"}{$type}}, $base;
109	williamc	1.9	}
110	williamc	1.1
111	williamc	1.9	sub unsetbase {
112			my $self=shift;
113			my $type=shift;
114			my $oref;
115	williamc	1.7
116	williamc	1.9	$self->checktype($type);
117			# pop off the stack and call the unset base method
118			if ( $#{$self->{basestack}{$type}} >=0 ) {
119			my $base=pop @{$self->{basestack}{$type}};
120			undef $base;
121			}
122			else {
123			die "URLhandler error: Unable to unset type $type\n";
124	williamc	1.4	}
125	williamc	1.10	# remove the stack if its empty
126			if ( $#{$self->{basestack}{$type}} == -1 ) {
127			delete $self->{basestack}{$type};
128			}
129	williamc	1.1	}
130
131	williamc	1.9	sub currentbase {
132	williamc	1.1	my $self=shift;
133			my $type=shift;
134	williamc	1.9	my $rv;
135	williamc	1.1
136	williamc	1.9	if ( exists $self->{basestack}{$type} ) {
137	williamc	1.10	$rv=${$self->{basestack}{$type}}[$#{$self->{basestack}{$type}}];
138	williamc	1.1	}
139			else {
140	williamc	1.9	$rv=$self->{dummybase};
141	williamc	1.1	}
142	williamc	1.9	return $rv;
143	williamc	1.1	}
144
145	williamc	1.9	sub checktype($type) {
146	williamc	1.1	my $self=shift;
147	williamc	1.9	my $type=shift;
148	williamc	1.1
149	williamc	1.9	# Check type is supported
150	williamc	1.2	if ( ! exists $self->{urlmodules}{$type} ) {
151	williamc	1.9	die "URLhandler error: Unsupported type $type\n";
152	williamc	1.1	}
153			}
154
155	williamc	1.9	sub _typehandler {
156	williamc	1.7	my $self=shift;
157	williamc	1.8	my $type=shift;
158	williamc	1.7
159	williamc	1.9	$self->checktype($type);
160	williamc	1.7
161	williamc	1.9	# instantiate only if it dosnt already exist;
162	williamc	1.10	if ( exists $self->{'urlobjs'}{$type} ) {
163			$self->{'urlobjs'}{$type};
164			}
165			else {
166			$self->{'urlobjs'}{$type}=$self->{urlmodules}{$type}->new();
167			}
168	williamc	1.1	}