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

Diff Legend

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