src/BuildSystem/ToolBox.pm

#
# ToolBox.pm
#
# Originally Written by Christopher Williams
#
# Description
# -----------
# tools and interface to access them 
#
# Interface
# ---------
# new()         : A new toolbox object
# tools()       : return a list of tools (name,version) pairs
# defaultversion(tool) : return the default version of the specified tool
# gettool(name[,version]) : get the tool object with the given name
#                           returns the default version if version not spec.
#                           returns undef if no setup tool is available
# toolsetup(name,version[,doc]) : setup the named tool from the specified doc
#                                 if doc not specified try and use previous
#                                 document; returns 0=OK 1=no version 
# interactive(0|1)      : set the setup mode
# searcher(SearchObject) : Set the search object for matching tools during setup

package BuildSystem::ToolBox;
use FileHandle;
use BuildSystem::Tool;
use Utilities::Verbose;

@ISA=qw(Utilities::Verbose);
require 5.004;

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

sub init {
        my $self=shift;
        my $area=shift;
        my $top=$area->location();
        my $config=$top."/".$area->configurationdir();
        $self->{urlcache}="$top/.SCRAM/ToolFiles";
        $self->{datastore}=$top."/.SCRAM/".$ENV{SCRAM_ARCH};
        $self->{reqdoc}=$area->requirementsdoc();
        AddDir::adddir($self->{datastore});
        AddDir::adddir($self->{urlcache});
        $self->_readdefaultsfile($config."/External_Dependencies");
}

sub interactive {
        my $self=shift;

        @_?$self->{interactive}=shift
          :((defined $self->{interactive})?$self->{interactive}:0);
}

sub tools {
        my $self=shift;
        return @{$self->{toollist}};
}

sub toolsetup {
        my $self=shift;
        my $name=shift;

        $name=~tr[A-z][a-z];
        my $rv=0;
        # -- get version
        my $version;
        if ( @_ ) {
          $version=shift;
        }
        else {
          $version=$self->defaultversion($name);
          if ( ! defined $version ) { $rv=1; return $rv; }
        }

        my $url;

        # -- get a tool object
        my ($tool)=$self->_toolobject($name,$version);

        # -- get the url
        if ( @_ ) {
          $url=shift;
        }
        else {
          # no url specified - try to get it from the tool
          $url=$tool->url();
          if ( ! defined $url ) {
            $self->error("Unable to determine document for tool ".
                                $name." ".$version);
          }
        }
        $url=$self->_download($url);

        # -- the tool setup 
        print "\n ----------- Setting Up $name $version ---------------\n";
        if ( ($self->interactive()) || (! $self->_copymatchingtool($tool)) ) {
          require BuildSystem::ToolDoc;
          my $doc=BuildSystem::ToolDoc->new();
          $doc->tool($tool);
          $doc->interactive($self->interactive());
          $tool->reset();
          if ( ! $doc->setup($self->{urlcache}."/".$url,$name,$version) ) {
            $tool->url($url);
            $tool->store($self->_toolfile($name,$version));
          }
          else {
            $self->error("Unable to find $name $version in $url");
          }
          undef $doc;
        }
        return $rv;
}

sub searcher {
        my $self=shift;

        if ( @_ ) {
            $self->{toolboxsearcher}=shift;
        }
        return $self->{toolboxsearcher};
}

sub gettool {
        my $self=shift;
        my $product=shift;
        my $version;

        $product=~tr[A-Z][a-z];
        if ( @_ ) { $version=shift; }
        else {
          # lookup the default version
          $version=$self->defaultversion($product);
          return undef, if ( ! defined $version );
        }
        my ($tool,$rv)=$self->_toolobject($product,$version); 
        return ( $rv==0?$tool:undef ); # only return if already set up
}

sub defaultversion {
        my $self=shift;
        my $product=shift;

        return $self->{defaults}{$product};
}

sub _copymatchingtool {
        my $self=shift;
        my $tool=shift;

        my $rv=0;
        my @validtools=$self->_gettools($tool);
        
        # -- for now we just take the first one
        if ( ! $self->interactive() ) {
          if ( $#validtools >= 0 ) {
           $self->verbose("Found Settings in another tool");
           my $file=$self->_toolfile($validtool[0]->name(),
                                        $validtool[0]->version());
           $validtools[0]->store($file);
           $tool->restore($file);
           $rv=1;
          }
        }
        return $rv;
}

#
# return list of matching tools
sub _gettools {
        my $self=shift;
        my $tool=shift;

        my @tools=();
        my $area;
        my $rtool;
        if ( defined $self->{toolboxsearcher} ) {
           my $it=$self->{toolboxsearcher}->newiterator();
           while ( ! $it->last()  ) {
             $area=$it->next();
             $self->verbose("Searching for ".$tool->name()." ".
                 $tool->version()." in ".$area->location());
             $rtool=$area->toolbox()->gettool($tool->name(),$tool->version());
             if ( (defined $rtool) && $rtool->equals($tool) ) {
                push @tools,$rtool;
             }
           }
        }
        return @tools;
}

sub _toolfile {
        my $self=shift;
        my $name=shift;
        my $version=shift;

        $name=~tr[A-Z][a-z];
        return $self->{datastore}."/".$name."_$version.dat";
}

sub _download {
        my $self=shift;
        my $url=shift;

        # -- make sure we have a copy of the file
        if ( ! -e $self->{urlcache}."/".$url ) {
                $self->verbose("Attemting Download of $url");
                &urlhandler::urlhandler("file:$ENV{SCRAM_HOME}/toolbox/"
                        .$url, $self->{urlcache}."/$url") ;
        }
        return $url;
}

sub _readdefaultsfile {
        my $self=shift;
        my $file=shift;

        # -- Get defaults from the RequirementsDoc
        my $req=$self->_requirements();
        my $tool;
        my $toollower;
        foreach $tool ( $req->tools()) {
           ($toollower=$tool)=~tr[A-Z][a-z];
           push @{$self->{toollist}}, [ ($toollower, $req->version($tool)) ];
           if ( ! defined $self->{defaults}{$toollower} ) {
             $self->{defaults}{$toollower}=$req->version($tool);
           }
        }

        # -- Read the default override file
        my $fh=FileHandle->new();
        $fh->open("<".$file); 
        while ( <$fh> ) {
          chomp;
          next if /^#/;
          next if /^\s*$/;
          ($product, $version)=split /:/;
          $product=~tr[A-Z][a-z];
          $self->{defaults}{$product}=$version;
        }
        undef $fh;
}

sub _requirements {
        my $self=shift;
        if ( ! defined $self->{reqsobj} ) {
          require BuildSystem::Requirements;
          $self->{reqsobj}=
                BuildSystem::Requirements->new($self->{reqdoc});
        }
        return $self->{reqsobj};
}

sub _toolobject {
        my $self=shift;
        my $product=shift;
        my $version=shift;

        my $rv=0;

        if ( ! exists $self->{tools}{$product}{$version} ) {
           $self->verbose("$product $version being Intitialised");
           $self->{tools}{$product}{$version}=BuildSystem::Tool->new();
           my $file=$self->_toolfile($product,$version);
           if ( -f $file ) { # restore it from disk
             $self->verbose("Recovering $product $version from $file");
             $self->{tools}{$product}{$version}->restore($file);
           }
           else {
                $rv=1;
                $self->verbose("Tool $product $version needs set up");
           }
        #   push @{$self->{toollist}}, [$product, $version];
        }
        return ($self->{tools}{$product}{$version}, $rv);
}
Revision:	1.1.2.17
Committed:	Thu May 4 16:44:58 2000 UTC (25 years ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
Changes since 1.1.2.16:	+8 -4 lines
Log Message:	make sure we lower case tool names from req doc so we can find them again
#	User	Rev	Content
1	williamc	1.1.2.1	#
2			# ToolBox.pm
3			#
4			# Originally Written by Christopher Williams
5			#
6			# Description
7			# -----------
8	williamc	1.1.2.9	# tools and interface to access them
9	williamc	1.1.2.1	#
10			# Interface
11			# ---------
12			# new() : A new toolbox object
13			# tools() : return a list of tools (name,version) pairs
14			# defaultversion(tool) : return the default version of the specified tool
15			# gettool(name[,version]) : get the tool object with the given name
16			# returns the default version if version not spec.
17	williamc	1.1.2.3	# returns undef if no setup tool is available
18			# toolsetup(name,version[,doc]) : setup the named tool from the specified doc
19			# if doc not specified try and use previous
20	williamc	1.1.2.7	# document; returns 0=OK 1=no version
21	williamc	1.1.2.8	# interactive(0\|1) : set the setup mode
22	williamc	1.1.2.14	# searcher(SearchObject) : Set the search object for matching tools during setup
23	williamc	1.1.2.1
24			package BuildSystem::ToolBox;
25			use FileHandle;
26			use BuildSystem::Tool;
27	williamc	1.1.2.3	use Utilities::Verbose;
28
29			@ISA=qw(Utilities::Verbose);
30	williamc	1.1.2.1	require 5.004;
31
32			sub new {
33			my $class=shift;
34	williamc	1.1.2.15	my $area=shift;
35	williamc	1.1.2.1	$self={};
36			bless $self, $class;
37	williamc	1.1.2.15	$self->init($area);
38	williamc	1.1.2.17	$self->verbosity(1);
39	williamc	1.1.2.1	return $self;
40			}
41
42			sub init {
43			my $self=shift;
44	williamc	1.1.2.15	my $area=shift;
45			my $top=$area->location();
46			my $config=$top."/".$area->configurationdir();
47			$self->{urlcache}="$top/.SCRAM/ToolFiles";
48			$self->{datastore}=$top."/.SCRAM/".$ENV{SCRAM_ARCH};
49			$self->{reqdoc}=$area->requirementsdoc();
50	williamc	1.1.2.3	AddDir::adddir($self->{datastore});
51			AddDir::adddir($self->{urlcache});
52	williamc	1.1.2.15	$self->_readdefaultsfile($config."/External_Dependencies");
53	williamc	1.1.2.1	}
54
55	williamc	1.1.2.8	sub interactive {
56			my $self=shift;
57
58			@_?$self->{interactive}=shift
59			:((defined $self->{interactive})?$self->{interactive}:0);
60			}
61
62	williamc	1.1.2.1	sub tools {
63			my $self=shift;
64			return @{$self->{toollist}};
65			}
66
67	williamc	1.1.2.3	sub toolsetup {
68			my $self=shift;
69			my $name=shift;
70
71	williamc	1.1.2.17	$name=~tr[A-z][a-z];
72	williamc	1.1.2.3	my $rv=0;
73			# -- get version
74			my $version;
75			if ( @_ ) {
76			$version=shift;
77			}
78			else {
79			$version=$self->defaultversion($name);
80			if ( ! defined $version ) { $rv=1; return $rv; }
81			}
82
83			my $url;
84
85			# -- get a tool object
86			my ($tool)=$self->_toolobject($name,$version);
87
88			# -- get the url
89			if ( @_ ) {
90			$url=shift;
91			}
92			else {
93			# no url specified - try to get it from the tool
94			$url=$tool->url();
95			if ( ! defined $url ) {
96			$self->error("Unable to determine document for tool ".
97			$name." ".$version);
98			}
99			}
100			$url=$self->_download($url);
101
102	williamc	1.1.2.14	# -- the tool setup
103	williamc	1.1.2.10	print "\n ----------- Setting Up $name $version ---------------\n";
104	williamc	1.1.2.15	if ( ($self->interactive()) \|\| (! $self->_copymatchingtool($tool)) ) {
105	williamc	1.1.2.14	require BuildSystem::ToolDoc;
106			my $doc=BuildSystem::ToolDoc->new();
107			$doc->tool($tool);
108			$doc->interactive($self->interactive());
109			$tool->reset();
110	williamc	1.1.2.15	if ( ! $doc->setup($self->{urlcache}."/".$url,$name,$version) ) {
111			$tool->url($url);
112	williamc	1.1.2.14	$tool->store($self->_toolfile($name,$version));
113			}
114			else {
115			$self->error("Unable to find $name $version in $url");
116			}
117			undef $doc;
118	williamc	1.1.2.3	}
119			return $rv;
120			}
121
122	williamc	1.1.2.14	sub searcher {
123			my $self=shift;
124
125			if ( @_ ) {
126			$self->{toolboxsearcher}=shift;
127			}
128			return $self->{toolboxsearcher};
129			}
130	williamc	1.1.2.3
131	williamc	1.1.2.1	sub gettool {
132			my $self=shift;
133			my $product=shift;
134			my $version;
135
136	williamc	1.1.2.17	$product=~tr[A-Z][a-z];
137	williamc	1.1.2.1	if ( @_ ) { $version=shift; }
138			else {
139			# lookup the default version
140			$version=$self->defaultversion($product);
141			return undef, if ( ! defined $version );
142			}
143	williamc	1.1.2.3	my ($tool,$rv)=$self->_toolobject($product,$version);
144			return ( $rv==0?$tool:undef ); # only return if already set up
145	williamc	1.1.2.1	}
146
147			sub defaultversion {
148			my $self=shift;
149			my $product=shift;
150
151			return $self->{defaults}{$product};
152	williamc	1.1.2.14	}
153
154			sub _copymatchingtool {
155			my $self=shift;
156			my $tool=shift;
157
158			my $rv=0;
159			my @validtools=$self->_gettools($tool);
160
161			# -- for now we just take the first one
162			if ( ! $self->interactive() ) {
163			if ( $#validtools >= 0 ) {
164	williamc	1.1.2.15	$self->verbose("Found Settings in another tool");
165	williamc	1.1.2.14	my $file=$self->_toolfile($validtool[0]->name(),
166			$validtool[0]->version());
167			$validtools[0]->store($file);
168			$tool->restore($file);
169			$rv=1;
170			}
171			}
172			return $rv;
173	williamc	1.1.2.1	}
174
175	williamc	1.1.2.13	#
176			# return list of matching tools
177			sub _gettools {
178			my $self=shift;
179			my $tool=shift;
180
181			my @tools=();
182	williamc	1.1.2.15	my $area;
183			my $rtool;
184	williamc	1.1.2.13	if ( defined $self->{toolboxsearcher} ) {
185			my $it=$self->{toolboxsearcher}->newiterator();
186			while ( ! $it->last() ) {
187	williamc	1.1.2.15	$area=$it->next();
188			$self->verbose("Searching for ".$tool->name()." ".
189			$tool->version()." in ".$area->location());
190			$rtool=$area->toolbox()->gettool($tool->name(),$tool->version());
191			if ( (defined $rtool) && $rtool->equals($tool) ) {
192	williamc	1.1.2.13	push @tools,$rtool;
193			}
194			}
195			}
196			return @tools;
197			}
198
199	williamc	1.1.2.3	sub _toolfile {
200			my $self=shift;
201			my $name=shift;
202			my $version=shift;
203
204	williamc	1.1.2.12	$name=~tr[A-Z][a-z];
205	williamc	1.1.2.11	return $self->{datastore}."/".$name."_$version.dat";
206	williamc	1.1.2.3	}
207
208			sub _download {
209			my $self=shift;
210			my $url=shift;
211
212			# -- make sure we have a copy of the file
213			if ( ! -e $self->{urlcache}."/".$url ) {
214	williamc	1.1.2.15	$self->verbose("Attemting Download of $url");
215	williamc	1.1.2.3	&urlhandler::urlhandler("file:$ENV{SCRAM_HOME}/toolbox/"
216			.$url, $self->{urlcache}."/$url") ;
217			}
218	williamc	1.1.2.15	return $url;
219	williamc	1.1.2.3	}
220
221	williamc	1.1.2.1	sub _readdefaultsfile {
222			my $self=shift;
223			my $file=shift;
224
225	williamc	1.1.2.9	# -- Get defaults from the RequirementsDoc
226			my $req=$self->_requirements();
227			my $tool;
228	williamc	1.1.2.17	my $toollower;
229	williamc	1.1.2.9	foreach $tool ( $req->tools()) {
230	williamc	1.1.2.17	($toollower=$tool)=~tr[A-Z][a-z];
231			push @{$self->{toollist}}, [ ($toollower, $req->version($tool)) ];
232			if ( ! defined $self->{defaults}{$toollower} ) {
233			$self->{defaults}{$toollower}=$req->version($tool);
234	williamc	1.1.2.9	}
235			}
236
237			# -- Read the default override file
238	williamc	1.1.2.1	my $fh=FileHandle->new();
239	williamc	1.1.2.9	$fh->open("<".$file);
240	williamc	1.1.2.1	while ( <$fh> ) {
241			chomp;
242			next if /^#/;
243			next if /^\s*$/;
244			($product, $version)=split /:/;
245			$product=~tr[A-Z][a-z];
246			$self->{defaults}{$product}=$version;
247			}
248			undef $fh;
249			}
250
251	williamc	1.1.2.9	sub _requirements {
252	williamc	1.1.2.15	my $self=shift;
253			if ( ! defined $self->{reqsobj} ) {
254	williamc	1.1.2.9	require BuildSystem::Requirements;
255	williamc	1.1.2.15	$self->{reqsobj}=
256	williamc	1.1.2.16	BuildSystem::Requirements->new($self->{reqdoc});
257	williamc	1.1.2.9	}
258	williamc	1.1.2.15	return $self->{reqsobj};
259	williamc	1.1.2.9	}
260	williamc	1.1.2.3
261	williamc	1.1.2.1	sub _toolobject {
262			my $self=shift;
263			my $product=shift;
264			my $version=shift;
265
266	williamc	1.1.2.5	my $rv=0;
267	williamc	1.1.2.3
268	williamc	1.1.2.1	if ( ! exists $self->{tools}{$product}{$version} ) {
269	williamc	1.1.2.3	$self->verbose("$product $version being Intitialised");
270	williamc	1.1.2.1	$self->{tools}{$product}{$version}=BuildSystem::Tool->new();
271	williamc	1.1.2.3	my $file=$self->_toolfile($product,$version);
272			if ( -f $file ) { # restore it from disk
273			$self->verbose("Recovering $product $version from $file");
274			$self->{tools}{$product}{$version}->restore($file);
275			}
276			else {
277	williamc	1.1.2.5	$rv=1;
278	williamc	1.1.2.3	$self->verbose("Tool $product $version needs set up");
279			}
280	williamc	1.1.2.15	# push @{$self->{toollist}}, [$product, $version];
281	williamc	1.1.2.1	}
282	williamc	1.1.2.3	return ($self->{tools}{$product}{$version}, $rv);
283	williamc	1.1.2.1	}