ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/Configuration/ConfigArea.pm

Comparing COMP/SCRAM/src/Configuration/ConfigArea.pm (file contents):
Revision 1.7 by williamc, Wed Feb 9 08:16:15 2000 UTC vs.
Revision 1.16 by williamc, Thu Sep 21 13:52:07 2000 UTC

#	Line 1 | Line 1
1		#
2		# ConfigArea.pm
3		#
4	<	# Originally Written by Christopher Williams
4	>	# Written by Christopher Williams
5		#
6		# Description
7	+	# -----------
8	+	# creates and manages a configuration area
9	+	#
10	+	# Notes
11	+	# -------
12	+	# Persistency - remember to call the save method to make changes persistent
13		#
14		# Interface
15		# ---------
16	<	# new(ActiveConfig)             : A new ConfigArea object
17	<	# setup()                       : setup the configuration area
18	<	# location([dir])               : set/return the location of the area
19	<	# version([version])            : set/return the version of the area
20	<	# name([name])                  : set/return the name of the area
21	<	# store(location)               : store data in file location
22	<	# restore(location)             : restore data from file location
23	<	# meta()                        : return a description string of the area
24	<	# addconfigitem(url)            : add a new item to the area
25	<	# configitem(@keys)             : return a list of fig items that match
20	<	#                                 the keys - all if left blank
21	<	# parentstore()                 : set/return the parent ObjectStore
22	<	# bootstrapfromlocation([location]): bootstrap the object based on location.
23	<	#                                 no location specified - cwd used
16	>	# new()                         : A new ConfigArea object
17	>	# name()                        : get/set project name
18	>	# setup(dir[,areaname])         : setup a fresh area in dir
19	>	# satellite(dir[,areaname])     : setup a satellite area in dir
20	>	# version()                     : get/set project version
21	>	# location([dir])               : set/return the location of the work area
22	>	# bootstrapfromlocation([location]) : bootstrap the object based on location.
23	>	#                                     no location specified - cwd used
24	>	#                                     return 0 if succesful 1 otherwise
25	>	# requirementsdoc()             : get set the requirements doc
26		# searchlocation([startdir])    : returns the location directory. search starts
27		#                                 from cwd if not specified
28	<	# defaultdirname()              : return the default directory name string
29	<	# copy(location)                : make a copy of the current area at the
30	<	#                                 specified location - return an object
31	<	#                                 representing the area
32	<	# linkarea(oref)                : link area with another
28	>	# scramversion()                : return the scram version associated with
29	>	#                                 area
30	>	# configurationdir()            : return the location of the project
31	>	#                                 configuration directory
32	>	# copy(location)                : copy a configuration
33	>	# copysetup(location)           : copy the architecture specific tool setup
34	>	#                                 returns 0 if successful, 1 otherwise
35	>	# copyenv($ref)                 : copy the areas environment into the hashref
36	>	# toolbox()                     : return the areas toolbox object
37	>	# save()                        : save changes permanently
38	>	# linkto(location)              : link the current area to that at location
39	>	# unlinkarea()                  : destroy link (autosave)
40	>	# linkarea([ConfigArea])        : get/set a link from the current area to the apec Area Object
41	>	# archname()            : get/set a string to indicate architecture
42	>	# archdir()             : return the location of the administration arch dep
43	>	#                         directory
44	>	# objectstore(["<"])            : return the objectStore object of the area
45	>	#                                 if called with temp - will set as undef
46	>	#                                 if it dosnt already exist - otherwise will
47	>	#                                 attempt to create it.
48	>	# - temporary
49	>	# align()                       : adjust hard paths to suit local loaction
50
51		package Configuration::ConfigArea;
33	–	use ActiveDoc::ActiveDoc;
52		require 5.004;
53	+	use URL::URLcache;
54		use Utilities::AddDir;
55	+	use Utilities::Verbose;
56		use ObjectUtilities::ObjectStore;
57		use Cwd;
58	<	@ISA=qw(ActiveDoc::ActiveDoc ObjectUtilities::StorableObject);
39	<
40	<	sub init {
41	<	my $self=shift;
58	>	@ISA=qw(Utilities::Verbose);
59
60	<	$self->newparse("init");
61	<	$self->newparse("download");
62	<	$self->newparse("setup");
63	<	$self->addtag("init","project",\&Project_Start,$self,
47	<	\&Project_text,$self,"", $self );
48	<	$self->addurltags("download");
49	<	$self->addtag("download","use",\&Use_download_Start,$self,
50	<	"", $self, "",$self);
51	<	$self->addurltags("setup");
52	<	$self->addtag("setup","use",\&Use_Start,$self, "", $self, "",$self);
53	<	}
60	>	sub new {
61	>	my $class=shift;
62	>	my $self={};
63	>	bless $self, $class;
64
65	+	# data init
66	+	$self->{admindir}=".SCRAM";
67	+	$self->{cachedir}="cache";
68	+	$self->{dbdir}="ObjectDB";
69	+	undef $self->{linkarea};
70
71	<	sub defaultdirname {
57	<	my $self=shift;
58	<	my $name=$self->name();
59	<	my $vers=$self->version();
60	<	$vers=~s/^$name_//;
61	<	$name=$name."_".$vers;
62	<	return $name;
63	<
71	>	return $self;
72		}
73
74	<	sub setup {
74	>	sub cache {
75		my $self=shift;
76
77	<	# --- find out the location - default is cwd
78	<	my $location=$self->option("area_location");
79	<	if ( ! defined $location ) {
80	<	$location=cwd();
81	<	}
82	<	elsif ( $location!~/^\// ) {
83	<	$location=cwd()."/".$location;
77	>	my $exist=0;
78	>	if ( @_ ) {
79	>	my $cache=shift;
80	>	if ( $cache!~/^</ ) {
81	>	$self->{cache}=$cache;
82	>	}
83	>	$exist=1;
84		}
85	<
86	<	# --- find area directory name , default name projectname_version
87	<	my $name=$self->option("area_name");
88	<	if ( ! defined $name ) {
89	<	$name=$self->defaultdirname();
85	>	elsif ( ! defined $self->{cache} ) {
86	>	my $loc=$self->location()."/".$self->{admindir}."/".$self->{cachedir};
87	>	if ( ! $exist ) {
88	>	$self->{cache}=URL::URLcache->new($loc);
89	>	}
90		}
91	<	$self->location($location."/".$name);
84	<
85	<	# make a new store handler
86	<	$self->_setupstore();
87	<
88	<	# --- download everything first
89	<	# FIX-ME --- cacheing is broken
90	<	$self->parse("download");
91	<
92	<	# --- and parse the setup file
93	<	$self->parse("setup");
94	<
95	<	# --- store bootstrap info
96	<	$self->store($self->location()."/.SCRAM/ConfigArea.dat");
97	<
98	<	# --- store self in original database
99	<	$self->parentconfig()->store($self,"ConfigArea",$self->name(),
100	<	$self->version());
91	>	return $self->{cache};
92		}
93
94	<	sub _setupstore {
94	>	sub objectstore {
95		my $self=shift;
96
97	<	# --- make a new ActiveStore at the location and add it to the db list
98	<	my $ad=ActiveDoc::ActiveConfig->new($self->location()."/\.SCRAM");
99	<
100	<	$self->parentconfig($self->config());
101	<	#        $self->config(Configuration::ConfigureStore->new());
102	<	#        $self->config()->db("local",$ad);
103	<	#        $self->config()->db("parent",$self->parentconfig());
104	<	#        $self->config()->policy("cache","local");
105	<	$self->config($ad);
106	<	$self->config()->basedoc($self->parentconfig()->basedoc());
97	>	my $exist="";
98	>	if ( @_ ) {
99	>	my $db=shift;
100	>	if ( $db!~/^</ ) {
101	>	$self->{dbstore}=cache;
102	>	}
103	>	$exist="<";
104	>	}
105	>	elsif ( ! defined $self->{dbstore} ) {
106	>	my $loc=$self->location()."/".$self->{admindir}."/".$self->{dbdir};
107	>	$self->{dbstore}=ObjectUtilities::ObjectStore->new($exist.$loc);
108	>	}
109	>	return $self->{dbstore}
110		}
111
112	<	sub bootstrapfromlocation {
112	>	sub name {
113		my $self=shift;
114	<
115	<	if ( ! defined $self->location(@_) ) {
122	<	$self->error("Unable to locate the top of local configuration area");
123	<	}
124	<	print "Found top ".$self->location()."\n";
125	<	$self->_setupstore();
126	<	$self->restore($self->location()."/.SCRAM/ConfigArea.dat");
114	>	@_?$self->{name}=shift
115	>	:$self->{name};
116		}
117
118	<	sub parentconfig {
118	>	sub version {
119		my $self=shift;
120	<	@_?$self->{parentconfig}=shift
121	<	:$self->{parentconfig};
120	>	@_?$self->{version}=shift
121	>	:$self->{version};
122		}
123
124	<	sub store {
124	>	sub setup {
125		my $self=shift;
126		my $location=shift;
127	+	my $areaname;
128
129	<	my $fh=$self->openfile(">".$location);
130	<	$self->savevar($fh,"location", $self->location());
131	<	$self->savevar($fh,"url", $self->url());
132	<	$self->savevar($fh,"name", $self->name());
133	<	$self->savevar($fh,"version", $self->version());
134	<	$fh->close();
145	<	}
129	>	# -- check we have a project name and version
130	>	my $name=$self->name();
131	>	my $vers=$self->version();
132	>	if ( ( ! defined $name ) && ( ! defined $version )) {
133	>	$self->error("Set ConfigArea name and version before setup");
134	>	}
135
136	<	sub copy {
137	<	my $self=shift;
138	<	my $destination=shift;
139	<	use File::Basename;
140	<	# create the area
136	>	# -- check arguments and set location
137	>	if ( ! defined $location ) {
138	>	$self->error("ConfigArea: Cannot setup new area without a location");
139	>	}
140	>	if ( @_ ) {
141	>	$areaname=shift;
142	>	}
143	>	if ( (! defined $areaname) || ( $areaname eq "" ) ) {
144	>	# -- make up a name from the project name and version
145	>	$vers=~s/^$name\_//;
146	>	$areaname=$name."_".$vers;
147	>	}
148	>	my $arealoc=$location."/".$areaname;
149	>	my $workloc=$arealoc."/".$self->{admindir};
150	>	$self->verbose("Building at $arealoc");
151	>	$self->location($arealoc);
152	>
153	>	# -- create top level structure and work area
154	>	AddDir::adddir($workloc);
155	>
156	>	# -- add a cache
157	>	$self->cache();
158	>
159	>	# -- Save Environment File
160	>	$self->_SaveEnvFile();
161
153	–	AddDir::adddir(dirname($destination));
154	–
155	–	$temp=$self->location();
156	–	my @cpcmd=(qw(cp -r), "$temp", "$destination");
157	–	print "@cpcmd"."\n";
158	–	#       File::Copy::copy("$self->location()", "$destination") or
159	–	system(@cpcmd) == 0 or
160	–	$self->error("Cannot copy ".$self->location().
161	–	" to $destination ".$!);
162	–
163	–	# create a new object based on the new area
164	–	my $newarea=ref($self)->new($self->parentconfig());
165	–	$newarea->bootstrapfromlocation($destination);
166	–	# save it with the new location info
167	–	$newarea->store($self->location()."/.SCRAM/ConfigArea.dat");
162		}
163
164	<	sub restore {
164	>	sub configurationdir {
165		my $self=shift;
166	<	my $location=shift;
166	>	if ( @_ ) {
167	>	$self->{configurationdir}=shift;
168	>	}
169	>	return (defined $self->{configurationdir})?$self->{configurationdir}:undef;
170	>	}
171
172	<	my $fh=$self->openfile("<".$location);
173	<	my $varhash={};
174	<	$self->restorevars($fh,$varhash);
175	<	if ( ! defined $self->location() ) {
176	<	$self->location($$varhash{"location"});
177	<	}
180	<	$self->_setupstore();
181	<	$self->url($$varhash{"url"});
182	<	$self->name($$varhash{"name"});
183	<	$self->version($$varhash{"version"});
184	<	$fh->close();
172	>	sub toolbox {
173	>	my $self=shift;
174	>	if ( ! defined $self->{toolbox} ) {
175	>	$self->{toolbox}=BuildSystem::ToolBox->new($self);
176	>	}
177	>	return $self->{toolbox};
178		}
179
180	<	sub name {
180	>	sub requirementsdoc {
181		my $self=shift;
182	+	if ( @_ ) {
183	+	$self->{reqdoc}=shift;
184	+	}
185	+	if ( defined $self->{reqdoc} ) {
186	+	return $self->location()."/".$self->{reqdoc};
187	+	}
188	+	else {
189	+	return undef;
190	+	}
191	+	}
192
193	<	@_?$self->{name}=shift
194	<	:$self->{name};
193	>	sub scramversion {
194	>	my $self=shift;
195	>	if ( ! defined $self->{scramversion} ) {
196	>	my $filename=$self->location()."/".$self->configurationdir()."/".
197	>	"scram_version";
198	>	if ( -f $filename ) {
199	>	use FileHandle;
200	>	$fh=FileHandle->new();
201	>	open ($fh, "<".$filename);
202	>	my $version=<$fh>;
203	>	chomp $version;
204	>	$self->{scramversion}=$version;
205	>	undef $fh;
206	>	}
207	>	}
208	>	return $self->{scramversion};
209		}
210
211	<	sub version {
211	>	sub bootstrapfromlocation {
212		my $self=shift;
213
214	<	@_?$self->{version}=shift
215	<	:$self->{version};
214	>	my $rv=0;
215	>
216	>	my $location;
217	>	if ( ! defined ($location=$self->searchlocation(@_)) ) {
218	>	$rv=1;
219	>	$self->verbose("Unable to locate the top of local configuration area");
220	>	}
221	>	else {
222	>	$self->location($location);
223	>	$self->verbose("Found top ".$self->location());
224	>	my $infofile=$self->location()."/".$self->{admindir}."/ConfigArea.dat";
225	>	$self->_LoadEnvFile();
226	>	}
227	>	return $rv;
228		}
229
230		sub location {
#	Line 216 | Line 245 | sub searchlocation {
245
246		#start search in current directory if not specified
247		my $thispath;
248	<	@_?$thispath=shift
249	<	:$thispath=cwd();
248	>	if ( @_ ) {
249	>	$thispath=shift
250	>	}
251	>	else {
252	>	$thispath=cwd();
253	>	}
254
255		my $rv=0;
256
257	+	# chop off any files - we only want dirs
258	+	if ( -f $thispath ) {
259	+	$thispath=~s/(.*)\/.*/$1/;
260	+	}
261		Sloop:{
262		do {
263	<	#         print "Searching $thispath\n";
264	<	if ( -e "$thispath/.SCRAM" ) {
265	<	#           print "Found\n";
263	>	$self->verbose("Searching $thispath");
264	>	if ( -e "$thispath/".$self->{admindir} ) {
265	>	$self->verbose("Found\n");
266		$rv=1;
267		last Sloop;
268		}
#	Line 234 | Line 271 | sub searchlocation {
271		return $rv?$thispath:undef;
272		}
273
274	<	sub meta {
274	>	sub archname {
275		my $self=shift;
276	+	if ( @_ ) {
277	+	$self->{archname}=shift;
278	+	}
279	+	return $self->{archname};
280	+	}
281
282	<	my $string=$self->name()." ".$self->version()." located at :\n  ".
283	<	$self->location;
282	>	sub archdir {
283	>	my $self=shift;
284	>	if ( @_ ) {
285	>	$self->{archdir}=shift;
286	>	}
287	>	if ( ! defined $self->{archdir} ) {
288	>	if ( defined $self->{archname} ) {
289	>	$self->{archdir}=$self->location()."/".$self->{admindir}."/".
290	>	$self->{archname};
291	>	}
292	>	else {
293	>	$self->error("ConfigArea : cannot create arch directory - ".
294	>	"architecture name not set")
295	>	}
296	>	}
297	>	return $self->{archdir};
298		}
299
300	<	sub configitem {
300	>	sub satellite {
301		my $self=shift;
302	+
303	+	# -- create the sat object
304	+	my $sat=Configuration::ConfigArea->new();
305	+	$sat->name($self->name());
306	+	$sat->version($self->version());
307	+	$sat->requirementsdoc($self->{reqdoc});
308	+	$sat->configurationdir($self->configurationdir());
309	+	$sat->setup(@_);
310	+
311	+	# -- copy across the cache and ObjectStore
312	+	# -- make sure we dont try building new caches in release areas
313	+	my $rcache=$self->cache("<");
314	+	if ( defined $rcache ) {
315	+	copy($rcache->location(),$sat->cache()->location());
316	+	}
317	+
318	+	# -- make sure we dont try building new objectstores in release areas
319	+	my $rostore=$self->objectstore("<");
320	+	if ( defined $rostore ) {
321	+	copy($rostore->location(),$sat->objectstore()->location());
322	+	}
323	+
324	+	# and make sure in reinitialises
325	+	undef ($sat->{cache});
326	+
327	+	# -- link it to this area
328	+	$sat->linkarea($self);
329
330	<	return ($self->config()->find("ConfigItem",@_));
330	>	# -- save it
331	>	$sat->save();
332	>
333	>	return $sat;
334	>	}
335	>
336	>	sub copy {
337	>	my $self=shift;
338	>	my $destination=shift;
339	>
340	>	# copy across the admin dir
341	>	my $temp=$self->location()."/".$self->{admindir};
342	>	AddDir::copydir($temp,"$destination/".$self->{admindir});
343	>	}
344	>
345	>	sub align {
346	>	my $self=shift;
347	>	use File::Copy;
348	>
349	>	$self->_LoadEnvFile();
350	>	my $Envfile=$self->location()."/".$self->{admindir}."/Environment";
351	>	my $tmpEnvfile=$Envfile.".bak";
352	>	my $rel=$self->{ENV}{RELEASETOP};
353	>	my $local=$self->location();
354	>
355	>	rename( $Envfile, $tmpEnvfile );
356	>	use FileHandle;
357	>	my $fh=FileHandle->new();
358	>	my $fout=FileHandle->new();
359	>	open ( $fh, "<".$tmpEnvfile ) or
360	>	$self->error("Cannot find Environment file. Area Corrupted? ("
361	>	.$self->location().")\n $!");
362	>	open ( $fout, ">".$Envfile ) or
363	>	$self->error("Cannot find Environment file. Area Corrupted? ("
364	>	.$self->location().")\n $!");
365	>	while ( <$fh> ) {
366	>	$_=~s/\Q$rel\L/$local/g;
367	>	print $fout $_;
368	>	}
369	>	undef $fh;
370	>	undef $fout;
371		}
372
373	<	sub addconfigitem {
373	>	sub copysetup {
374		my $self=shift;
375	<	my $url=shift;
375	>	my $dest=shift;
376
377	<	my $docref=$self->activatedoc($url);
378	<	# Set up the document
379	<	$docref->setup();
380	<	#       $self->config()->storepolicy("local");
377	>	my $rv=1;
378	>	# copy across the admin dir
379	>	my $temp=$self->location()."/".$self->{admindir}."/".$self->arch();
380	>	my $temp2=$dest."/".$self->{admindir}."/".$self->arch();
381	>	if ( $temp ne $temp2 ) {
382	>	if ( -d $temp ) {
383	>	AddDir::copydir($temp,$temp2);
384	>	$rv=0;
385	>	}
386	>	}
387	>	return $rv;
388		}
389
390	<	# -------------- Tags ---------------------------------
261	<	# -- init parse
262	<	sub Project_Start {
390	>	sub copyenv {
391		my $self=shift;
264	–	my $name=shift;
392		my $hashref=shift;
393	+
394	+	foreach $elem ( keys %{$self->{ENV}} ) {
395	+	$$hashref{$elem}=$self->{ENV}{$elem};
396	+	}
397	+	}
398
399	<	$self->checktag($name,$hashref,'name');
400	<	$self->checktag($name,$hashref,'version');
399	>	sub arch {
400	>	my $self=shift;
401	>	return $ENV{SCRAM_ARCH};
402	>	}
403
404	<	$self->name($$hashref{'name'});
405	<	$self->version($$hashref{'version'});
404	>	sub linkto {
405	>	my $self=shift;
406	>	my $location=shift;
407	>	if ( -d $location ) {
408	>	my $area=Configuration::ConfigArea->new();
409	>	$area->bootstrapfromlocation($location);
410	>	$self->linkarea($area);
411	>	}
412	>	else {
413	>	$self->error("ConfigArea : Unable to link to non existing directory ".
414	>	$location);
415	>	}
416		}
417
418	+	sub unlinkarea {
419	+	my $self=shift;
420	+	undef $self->{linkarea};
421	+	$self->{linkarea}=undef;
422	+	$self->save();
423	+	}
424
425	<	sub Project_text {
425	>	sub linkarea {
426		my $self=shift;
427	<	my $name=shift;
428	<	my $string=shift;
427	>	my $area=shift;
428	>	if ( defined $area ) {
429	>	$self->{linkarea}=$area;
430	>	}
431	>	return (defined $self->{linkarea} && $self->{linkarea} ne "")?
432	>	$self->{linkarea}:undef;
433	>	}
434
435	<	print $string;
435	>	sub save {
436	>	my $self=shift;
437	>	$self->_SaveEnvFile();
438		}
439
440	<	# ---- download parse
440	>	# ---- support routines
441
442	<	sub Use_download_Start {
442	>	sub _SaveEnvFile {
443		my $self=shift;
444	<	my $name=shift;
445	<	my $hashref=shift;
446	<
447	<	$self->checktag($name,$hashref,'url');
448	<	print "Downloading .... ".$$hashref{'url'}."\n";
449	<	$self->getfile($$hashref{'url'});
444	>	use FileHandle;
445	>	my $fh=FileHandle->new();
446	>	open ( $fh, ">".$self->location()."/".$self->{admindir}."/".
447	>	"Environment" ) or
448	>	$self->error("Cannot Open Environment file to Save ("
449	>	.$self->location().")\n $!");
450	>
451	>	print $fh "SCRAM_PROJECTNAME=".$self->name()."\n";
452	>	print $fh "SCRAM_PROJECTVERSION=".$self->version()."\n";
453	>	print $fh "projconfigdir=".$self->configurationdir()."\n";
454	>	print $fh "SCRAM_ProjReqsDoc=".$self->{reqdoc}."\n";
455	>	if ( defined $self->linkarea() ) {
456	>	my $area=$self->linkarea()->location();
457	>	if ( $area ne "" ) {
458	>	print $fh "RELEASETOP=".$area."\n";
459	>	}
460	>	}
461	>	undef $fh;
462		}
463
295	–	# --- setup parse
464
465	<	sub Use_Start {
465	>	sub _LoadEnvFile {
466		my $self=shift;
467	<	my $name=shift;
468	<	my $hashref=shift;
467	>
468	>	use FileHandle;
469	>	my $fh=FileHandle->new();
470	>	open ( $fh, "<".$self->location()."/".$self->{admindir}."/".
471	>	"Environment" ) or
472	>	$self->error("Cannot find Environment file. Area Corrupted? ("
473	>	.$self->location().")\n $!");
474	>	while ( <$fh> ) {
475	>	chomp;
476	>	next if /^#/;
477	>	next if /^\s*$/ ;
478	>	($name, $value)=split /=/;
479	>	eval "\$self->{ENV}{${name}}=\"$value\"";
480	>	}
481	>	undef $fh;
482
483	<	$self->checktag($name,$hashref,'url');
484	<	$self->addconfigitem($$hashref{'url'});
483	>	# -- set internal variables appropriately
484	>	if ( defined $self->{ENV}{"SCRAM_PROJECTNAME"} ) {
485	>	$self->name($self->{ENV}{"SCRAM_PROJECTNAME"});
486	>	}
487	>	if ( defined $self->{ENV}{"SCRAM_PROJECTVERSION"} ) {
488	>	$self->version($self->{ENV}{"SCRAM_PROJECTVERSION"});
489	>	}
490	>	if ( defined $self->{ENV}{"projconfigdir"} ) {
491	>	$self->configurationdir($self->{ENV}{projconfigdir});
492	>	}
493	>	if ( defined $self->{ENV}{"SCRAM_ProjReqsDoc"} ) {
494	>	$self->requirementsdoc($self->{ENV}{SCRAM_ProjReqsDoc});
495	>	}
496	>	if ( ( defined $self->{ENV}{"RELEASETOP"} ) &&
497	>	($self->{ENV}{"RELEASETOP"} ne $self->location())) {
498	>	$self->linkto($self->{ENV}{"RELEASETOP"});
499	>	}
500	>	else {
501	>	$self->{ENV}{"RELEASETOP"}=$self->location();
502	>	}
503		}
305	–

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines