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();
        $self->verbose("Using Requirements Doc : ".$self->{reqdoc});
        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;

        AddDir::adddir($self->{datastore});
        $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 
        $tool->url($url);
        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->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;
        $self->verbose("Check Other Projects for tool");
        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($validtools[0]->name(),
                                        $validtools[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();
             if ( defined $area ) {
              $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;

        my $name;
        # -- make sure we have a copy of the file
        if ( ! -f $self->{urlcache}."/".$url ) {
                if ( $url!~/:/ ) {
                   $name=$url;
                   $url="file:$ENV{SCRAM_HOME}/toolbox/".$url;
                }
                else {
                   ($name=$url)=~s/.*\/(.*)/$1/;
                }
                $self->verbose("Attempting Download of $url");
                &urlhandler::urlhandler($url,
                        , $self->{urlcache}."/$name") ;
                $url=$name;
        }
        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->{tools}{$product}{$version}->name($product);
                $self->{tools}{$product}{$version}->version($version);
                $self->verbose("Tool $product $version needs set up");
           }
        #   push @{$self->{toollist}}, [$product, $version];
        }
        return ($self->{tools}{$product}{$version}, $rv);
}
Revision:	1.1.2.24
Committed:	Wed Jun 14 18:20:08 2000 UTC (24 years, 11 months ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
Changes since 1.1.2.23:	+1 -0 lines
Log Message:	Get binaries working
#	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.18	#$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.24	$self->verbose("Using Requirements Doc : ".$self->{reqdoc});
51	williamc	1.1.2.3	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.20	AddDir::adddir($self->{datastore});
72	williamc	1.1.2.18	$name=~tr[A-Z][a-z];
73	williamc	1.1.2.3	my $rv=0;
74			# -- get version
75			my $version;
76			if ( @_ ) {
77			$version=shift;
78			}
79			else {
80			$version=$self->defaultversion($name);
81			if ( ! defined $version ) { $rv=1; return $rv; }
82			}
83
84			my $url;
85
86			# -- get a tool object
87			my ($tool)=$self->_toolobject($name,$version);
88
89			# -- get the url
90			if ( @_ ) {
91			$url=shift;
92			}
93			else {
94			# no url specified - try to get it from the tool
95			$url=$tool->url();
96			if ( ! defined $url ) {
97			$self->error("Unable to determine document for tool ".
98			$name." ".$version);
99			}
100			}
101			$url=$self->_download($url);
102
103	williamc	1.1.2.14	# -- the tool setup
104	williamc	1.1.2.19	$tool->url($url);
105	williamc	1.1.2.10	print "\n ----------- Setting Up $name $version ---------------\n";
106	williamc	1.1.2.15	if ( ($self->interactive()) \|\| (! $self->_copymatchingtool($tool)) ) {
107	williamc	1.1.2.14	require BuildSystem::ToolDoc;
108			my $doc=BuildSystem::ToolDoc->new();
109			$doc->tool($tool);
110			$doc->interactive($self->interactive());
111			$tool->reset();
112	williamc	1.1.2.15	if ( ! $doc->setup($self->{urlcache}."/".$url,$name,$version) ) {
113	williamc	1.1.2.14	$tool->store($self->_toolfile($name,$version));
114			}
115			else {
116			$self->error("Unable to find $name $version in $url");
117			}
118			undef $doc;
119	williamc	1.1.2.3	}
120			return $rv;
121			}
122
123	williamc	1.1.2.14	sub searcher {
124			my $self=shift;
125
126			if ( @_ ) {
127			$self->{toolboxsearcher}=shift;
128			}
129			return $self->{toolboxsearcher};
130			}
131	williamc	1.1.2.3
132	williamc	1.1.2.1	sub gettool {
133			my $self=shift;
134			my $product=shift;
135			my $version;
136
137	williamc	1.1.2.17	$product=~tr[A-Z][a-z];
138	williamc	1.1.2.1	if ( @_ ) { $version=shift; }
139			else {
140			# lookup the default version
141			$version=$self->defaultversion($product);
142			return undef, if ( ! defined $version );
143			}
144	williamc	1.1.2.3	my ($tool,$rv)=$self->_toolobject($product,$version);
145			return ( $rv==0?$tool:undef ); # only return if already set up
146	williamc	1.1.2.1	}
147
148			sub defaultversion {
149			my $self=shift;
150			my $product=shift;
151
152			return $self->{defaults}{$product};
153	williamc	1.1.2.14	}
154
155			sub _copymatchingtool {
156			my $self=shift;
157			my $tool=shift;
158
159			my $rv=0;
160	williamc	1.1.2.19	$self->verbose("Check Other Projects for tool");
161	williamc	1.1.2.14	my @validtools=$self->_gettools($tool);
162
163			# -- for now we just take the first one
164			if ( ! $self->interactive() ) {
165			if ( $#validtools >= 0 ) {
166	williamc	1.1.2.15	$self->verbose("Found Settings in another tool");
167	williamc	1.1.2.19	my $file=$self->_toolfile($validtools[0]->name(),
168			$validtools[0]->version());
169	williamc	1.1.2.14	$validtools[0]->store($file);
170			$tool->restore($file);
171			$rv=1;
172			}
173			}
174			return $rv;
175	williamc	1.1.2.1	}
176
177	williamc	1.1.2.13	#
178			# return list of matching tools
179			sub _gettools {
180			my $self=shift;
181			my $tool=shift;
182
183			my @tools=();
184	williamc	1.1.2.15	my $area;
185			my $rtool;
186	williamc	1.1.2.13	if ( defined $self->{toolboxsearcher} ) {
187			my $it=$self->{toolboxsearcher}->newiterator();
188			while ( ! $it->last() ) {
189	williamc	1.1.2.15	$area=$it->next();
190	williamc	1.1.2.21	if ( defined $area ) {
191			$self->verbose("Searching for ".$tool->name()." ".
192	williamc	1.1.2.15	$tool->version()." in ".$area->location());
193	williamc	1.1.2.21	$rtool=$area->toolbox()->gettool($tool->name(),$tool->version());
194			if ( (defined $rtool) && $rtool->equals($tool) ) {
195	williamc	1.1.2.13	push @tools,$rtool;
196	williamc	1.1.2.21	}
197	williamc	1.1.2.13	}
198			}
199			}
200			return @tools;
201			}
202
203	williamc	1.1.2.3	sub _toolfile {
204			my $self=shift;
205			my $name=shift;
206			my $version=shift;
207
208	williamc	1.1.2.12	$name=~tr[A-Z][a-z];
209	williamc	1.1.2.11	return $self->{datastore}."/".$name."_$version.dat";
210	williamc	1.1.2.3	}
211
212			sub _download {
213			my $self=shift;
214			my $url=shift;
215
216	williamc	1.1.2.22	my $name;
217	williamc	1.1.2.3	# -- make sure we have a copy of the file
218	williamc	1.1.2.22	if ( ! -f $self->{urlcache}."/".$url ) {
219			if ( $url!~/:/ ) {
220			$name=$url;
221			$url="file:$ENV{SCRAM_HOME}/toolbox/".$url;
222			}
223			else {
224			($name=$url)=~s/.\/(.)/$1/;
225			}
226			$self->verbose("Attempting Download of $url");
227			&urlhandler::urlhandler($url,
228			, $self->{urlcache}."/$name") ;
229	williamc	1.1.2.23	$url=$name;
230	williamc	1.1.2.3	}
231	williamc	1.1.2.15	return $url;
232	williamc	1.1.2.3	}
233
234	williamc	1.1.2.1	sub _readdefaultsfile {
235			my $self=shift;
236			my $file=shift;
237
238	williamc	1.1.2.9	# -- Get defaults from the RequirementsDoc
239			my $req=$self->_requirements();
240			my $tool;
241	williamc	1.1.2.17	my $toollower;
242	williamc	1.1.2.9	foreach $tool ( $req->tools()) {
243	williamc	1.1.2.17	($toollower=$tool)=~tr[A-Z][a-z];
244			push @{$self->{toollist}}, [ ($toollower, $req->version($tool)) ];
245			if ( ! defined $self->{defaults}{$toollower} ) {
246			$self->{defaults}{$toollower}=$req->version($tool);
247	williamc	1.1.2.9	}
248			}
249
250			# -- Read the default override file
251	williamc	1.1.2.1	my $fh=FileHandle->new();
252	williamc	1.1.2.9	$fh->open("<".$file);
253	williamc	1.1.2.1	while ( <$fh> ) {
254			chomp;
255			next if /^#/;
256			next if /^\s*$/;
257			($product, $version)=split /:/;
258			$product=~tr[A-Z][a-z];
259			$self->{defaults}{$product}=$version;
260			}
261			undef $fh;
262			}
263
264	williamc	1.1.2.9	sub _requirements {
265	williamc	1.1.2.15	my $self=shift;
266			if ( ! defined $self->{reqsobj} ) {
267	williamc	1.1.2.9	require BuildSystem::Requirements;
268	williamc	1.1.2.15	$self->{reqsobj}=
269	williamc	1.1.2.16	BuildSystem::Requirements->new($self->{reqdoc});
270	williamc	1.1.2.9	}
271	williamc	1.1.2.15	return $self->{reqsobj};
272	williamc	1.1.2.9	}
273	williamc	1.1.2.3
274	williamc	1.1.2.1	sub _toolobject {
275			my $self=shift;
276			my $product=shift;
277			my $version=shift;
278
279	williamc	1.1.2.5	my $rv=0;
280	williamc	1.1.2.3
281	williamc	1.1.2.1	if ( ! exists $self->{tools}{$product}{$version} ) {
282	williamc	1.1.2.3	$self->verbose("$product $version being Intitialised");
283	williamc	1.1.2.1	$self->{tools}{$product}{$version}=BuildSystem::Tool->new();
284	williamc	1.1.2.3	my $file=$self->_toolfile($product,$version);
285			if ( -f $file ) { # restore it from disk
286			$self->verbose("Recovering $product $version from $file");
287			$self->{tools}{$product}{$version}->restore($file);
288			}
289			else {
290	williamc	1.1.2.5	$rv=1;
291	williamc	1.1.2.19	$self->{tools}{$product}{$version}->name($product);
292			$self->{tools}{$product}{$version}->version($version);
293	williamc	1.1.2.3	$self->verbose("Tool $product $version needs set up");
294			}
295	williamc	1.1.2.15	# push @{$self->{toollist}}, [$product, $version];
296	williamc	1.1.2.1	}
297	williamc	1.1.2.3	return ($self->{tools}{$product}{$version}, $rv);
298	williamc	1.1.2.1	}