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.3 by williamc, Fri Jan 21 08:59:34 2000 UTC vs.
Revision 1.21 by sashby, Mon Dec 3 19:02:05 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
26	<	#                                 the keys - all if left blank
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;
23	–	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;
59	<	$self->newparse("init");
60	<	$self->newparse("download");
61	<	$self->newparse("setup");
62	<	$self->addtag("init","project",\&Project_Start,$self,
63	<	\&Project_text,$self,"", $self );
64	<	$self->addurltags("download");
65	<	$self->addtag("download","use",\&Use_download_Start,$self,
66	<	"", $self, "",$self);
67	<	$self->addurltags("setup");
68	<	$self->addtag("setup","use",\&Use_Start,$self, "", $self, "",$self);
57	>	sub new {
58	>	my $class=shift;
59	>	my $self={};
60	>	bless $self, $class;
61	>
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",
48	<	"Please Enter the location of the directory");
49	<
50	<	# --- find area directory name , default name projectname_version
51	<	my $name=$self->option("area_name");
52	<	my $vers=$self->version;
53	<	if ( ! defined $name ) {
54	<	$name=$self->name();
55	<	$vers=~s/^$name_//;
56	<	$name=$name."_".$vers;
74	>	if ( @_ ) {
75	>	$self->{cache}=shift;
76		}
77	<	$self->location($location."/".$name);
78	<
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	<	# make a new store handler
90	<	my $parentconfig=$self->_setupstore();
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	<	# --- download everything first
97	<	# FIX-ME --- cacheing is broken
98	<	$self->parse("download");
99	<
100	<	# --- and parse the setup file
69	<	$self->parse("setup");
70	<
71	<	# --- store self in original database
72	<	$parentconfig->store($self,"ConfigArea",$self->name(),
73	<	$self->version());
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	<	sub _setupstore {
103	>	sub objectstore {
104		my $self=shift;
105
106	<	# --- make a new ActiveStore at the location and add it to the db list
107	<	my $ad=ActiveDoc::ActiveConfig->new($self->location()."/\.SCRAM");
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 name {
122	>	my $self=shift;
123	>	@_?$self->{name}=shift
124	>	:$self->{name};
125	>	}
126
127	<	my $parentconfig=$self->config();
128	<	$self->config(Configuration::ConfigureStore->new());
129	<	$self->config()->db("local",$ad);
130	<	$self->config()->db("parent",$parentconfig);
86	<	$self->config()->policy("cache","local");
87	<	$self->config()->basedoc($parentconfig->basedoc());
88	<	return $parentconfig;
127	>	sub version {
128	>	my $self=shift;
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
95	–	my $fh=$self->openfile(">".$location);
96	–	print $fh $self->location()."\n";
97	–	$fh->close();
174		}
175
176	<	sub restore {
176	>	sub configurationdir {
177		my $self=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	<	$self->{location}=<$fh>;
186	<	chomp $self->{location};
187	<	$fh->close();
188	<
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 sitename
224	>	{
225	>	###############################################################
226	>	# sitename()                                                  #
227	>	###############################################################
228	>	# modified : Mon Dec  3 15:45:35 2001 / SFA                   #
229	>	# params   :                                                  #
230	>	#          :                                                  #
231	>	#          :                                                  #
232	>	#          :                                                  #
233	>	# function : Read the site name from config/site/sitename and #
234	>	#          : export it.                                       #
235	>	#          :                                                  #
236	>	#          :                                                  #
237	>	###############################################################
238	>	my $self = shift;
239	>	my $sitefile = $self->location()."/".$self->configurationdir()."/site/sitename";
240	>
241	>	$self->{sitename} = 'CERN'; # Use CERN as the default site name
242	>
243	>	use FileHandle;
244	>	my $sitefh = FileHandle->new();
245	>
246	>	# See if we can read from the file. If not, just
247	>	# use default site name:
248	>	open($sitefh,"<".$sitefile) ||
249	>	do
250	>	{
251	>	$self->verbose("Unable to read a site name definition file. Using \'CERN\' as the site name.");
252	>	return $self->{sitename};
253	>	};
254	>
255	>	$sitename = <$sitefh>;
256	>	chomp($sitename);
257	>	$self->{sitename} = $sitename;
258	>
259	>	# Close the file (be tidy!);
260	>	close($sitefile);
261	>	# Return:
262	>	return $self->{sitename};
263	>	}
264	>
265	>
266	>	sub bootstrapfromlocation {
267		my $self=shift;
268
269	<	@_?$self->{version}=shift
270	<	:$self->{version};
269	>	my $rv=0;
270	>
271	>	my $location;
272	>	if ( ! defined ($location=$self->searchlocation(@_)) ) {
273	>	$rv=1;
274	>	$self->verbose("Unable to locate the top of local configuration area");
275	>	}
276	>	else {
277	>	$self->location($location);
278	>	$self->verbose("Found top ".$self->location());
279	>	my $infofile=$self->location()."/".$self->{admindir}."/ConfigArea.dat";
280	>	$self->_LoadEnvFile();
281	>	}
282	>	return $rv;
283		}
284
285		sub location {
286		my $self=shift;
287
288	<	@_?$self->{location}=shift
289	<	:$self->{location};
288	>	if ( @_ ) {
289	>	$self->{location}=shift;
290	>	}
291	>	elsif ( ! defined $self->{location} ) {
292	>	# try and find the release location
293	>	$self->{location}=$self->searchlocation();
294	>	}
295	>	return  $self->{location};
296		}
297
298	<	sub meta {
298	>	sub searchlocation {
299		my $self=shift;
300	+
301	+	#start search in current directory if not specified
302	+	my $thispath;
303	+	if ( @_ ) {
304	+	$thispath=shift
305	+	}
306	+	else {
307	+	$thispath=cwd();
308	+	}
309	+
310	+	my $rv=0;
311
312	<	my $string=$self->name()." ".$self->version()." located at :\n  ".
313	<	$self->location;
312	>	# chop off any files - we only want dirs
313	>	if ( -f $thispath ) {
314	>	$thispath=~s/(.*)\/.*/$1/;
315	>	}
316	>	Sloop:{
317	>	do {
318	>	$self->verbose("Searching $thispath");
319	>	if ( -e "$thispath/".$self->{admindir} ) {
320	>	$self->verbose("Found\n");
321	>	$rv=1;
322	>	last Sloop;
323	>	}
324	>	} while ( ($thispath=~s/(.*)\/.*/$1/)=~/./ ) };
325	>
326	>	return $rv?$thispath:undef;
327		}
328
329	<	sub configitem {
329	>	sub archname {
330		my $self=shift;
331	<	my $location=shift;
331	>	if ( @_ ) {
332	>	$self->{archname}=shift;
333	>	}
334	>	return $self->{archname};
335	>	}
336	>
337	>	sub archdir {
338	>	my $self=shift;
339	>	if ( @_ ) {
340	>	$self->{archdir}=shift;
341	>	}
342	>	if ( ! defined $self->{archdir} ) {
343	>	if ( defined $self->{archname} ) {
344	>	$self->{archdir}=$self->location()."/".$self->{admindir}."/".
345	>	$self->{archname};
346	>	}
347	>	else {
348	>	$self->error("ConfigArea : cannot create arch directory - ".
349	>	"architecture name not set")
350	>	}
351	>	}
352	>	return $self->{archdir};
353	>	}
354	>
355	>	sub satellite {
356	>	my $self=shift;
357	>
358	>	# -- create the sat object
359	>	my $sat=Configuration::ConfigArea->new();
360	>	$sat->name($self->name());
361	>	$sat->version($self->version());
362	>	$sat->requirementsdoc($self->{reqdoc});
363	>	$sat->configurationdir($self->configurationdir());
364	>	$sat->setup(@_);
365	>
366	>	# -- copy across the cache and ObjectStore
367	>	# -- make sure we dont try building new caches in release areas
368	>	my $rcache=$self->cache();
369	>	if ( defined $rcache ) {
370	>	copy($rcache->location(),$sat->cache()->location());
371	>	}
372	>
373	>	# -- make sure we dont try building new objectstores in release areas
374	>	my $rostore=$self->objectstore();
375	>	if ( defined $rostore ) {
376	>	copy($rostore->location(),$sat->objectstore()->location());
377	>	}
378	>
379	>	# and make sure in reinitialises
380	>	undef ($sat->{cache});
381	>
382	>	# -- link it to this area
383	>	$sat->linkarea($self);
384
385	<	$self->config()->find("ConfigItem",@_);
385	>	# -- save it
386	>	$sat->save();
387	>
388	>	return $sat;
389		}
390
391	<	sub addconfigitem {
391	>	sub copy {
392		my $self=shift;
393	<	my $url=shift;
393	>	my $destination=shift;
394
395	<	my $docref=$self->activatedoc($url);
396	<	# Set up the document
397	<	$docref->setup();
152	<	$self->config()->storepolicy("local");
153	<	$docref->save();
395	>	# copy across the admin dir
396	>	my $temp=$self->location()."/".$self->{admindir};
397	>	AddDir::copydir($temp,"$destination/".$self->{admindir});
398		}
399
400	<	# -------------- Tags ---------------------------------
157	<	# -- init parse
158	<	sub Project_Start {
400	>	sub align {
401		my $self=shift;
402	<	my $name=shift;
161	<	my $hashref=shift;
402	>	use File::Copy;
403
404	<	$self->checktag($name,$hashref,'name');
405	<	$self->checktag($name,$hashref,'version');
404	>	$self->_LoadEnvFile();
405	>	my $Envfile=$self->location()."/".$self->{admindir}."/Environment";
406	>	my $tmpEnvfile=$Envfile.".bak";
407	>	my $rel=$self->{ENV}{RELEASETOP};
408	>	my $local=$self->location();
409
410	<	$self->name($$hashref{'name'});
411	<	$self->version($$hashref{'version'});
410	>	rename( $Envfile, $tmpEnvfile );
411	>	use FileHandle;
412	>	my $fh=FileHandle->new();
413	>	my $fout=FileHandle->new();
414	>	open ( $fh, "<".$tmpEnvfile ) or
415	>	$self->error("Cannot find Environment file. Area Corrupted? ("
416	>	.$self->location().")\n $!");
417	>	open ( $fout, ">".$Envfile ) or
418	>	$self->error("Cannot find Environment file. Area Corrupted? ("
419	>	.$self->location().")\n $!");
420	>	while ( <$fh> ) {
421	>	$_=~s/\Q$rel\L/$local/g;
422	>	print $fout $_;
423	>	}
424	>	undef $fh;
425	>	undef $fout;
426		}
427
428	+	sub copysetup {
429	+	my $self=shift;
430	+	my $dest=shift;
431
432	<	sub Project_text {
432	>	my $rv=1;
433	>	# copy across the admin dir
434	>	my $temp=$self->location()."/".$self->{admindir}."/".$self->arch();
435	>	my $temp2=$dest."/".$self->{admindir}."/".$self->arch();
436	>	if ( $temp ne $temp2 ) {
437	>	if ( -d $temp ) {
438	>	AddDir::copydir($temp,$temp2);
439	>	$rv=0;
440	>	}
441	>	}
442	>	return $rv;
443	>	}
444	>
445	>	sub copyenv {
446		my $self=shift;
447	<	my $name=shift;
448	<	my $string=shift;
447	>	my $hashref=shift;
448	>
449	>	foreach $elem ( keys %{$self->{ENV}} ) {
450	>	$$hashref{$elem}=$self->{ENV}{$elem};
451	>	}
452	>	}
453
454	<	print $string;
454	>	sub arch {
455	>	my $self=shift;
456	>	return $ENV{SCRAM_ARCH};
457		}
458
459	<	# ---- download parse
459	>	sub linkto {
460	>	my $self=shift;
461	>	my $location=shift;
462	>	if ( -d $location ) {
463	>	my $area=Configuration::ConfigArea->new();
464	>	$area->bootstrapfromlocation($location);
465	>	$self->linkarea($area);
466	>	}
467	>	else {
468	>	$self->error("ConfigArea : Unable to link to non existing directory ".
469	>	$location);
470	>	}
471	>	}
472
473	<	sub Use_download_Start {
473	>	sub unlinkarea {
474		my $self=shift;
475	<	my $name=shift;
476	<	my $hashref=shift;
475	>	undef $self->{linkarea};
476	>	$self->{linkarea}=undef;
477	>	$self->save();
478	>	}
479
480	<	$self->checktag($name,$hashref,'url');
481	<	print "Downloading .... ".$$hashref{'url'}."\n";
482	<	$self->getfile($$hashref{'url'});
480	>	sub linkarea {
481	>	my $self=shift;
482	>	my $area=shift;
483	>	if ( defined $area ) {
484	>	$self->{linkarea}=$area;
485	>	}
486	>	return (defined $self->{linkarea} && $self->{linkarea} ne "")?
487	>	$self->{linkarea}:undef;
488		}
489
490	<	# --- setup parse
490	>	sub save {
491	>	my $self=shift;
492	>	$self->_SaveEnvFile();
493	>	}
494	>
495	>	# ---- support routines
496
497	<	sub Use_Start {
497	>	sub _SaveEnvFile {
498		my $self=shift;
499	<	my $name=shift;
500	<	my $hashref=shift;
499	>	use FileHandle;
500	>	my $fh=FileHandle->new();
501	>	open ( $fh, ">".$self->location()."/".$self->{admindir}."/".
502	>	"Environment" ) or
503	>	$self->error("Cannot Open Environment file to Save ("
504	>	.$self->location().")\n $!");
505
506	<	$self->checktag($name,$hashref,'url');
507	<	$self->addconfigitem($$hashref{'url'});
506	>	print $fh "SCRAM_PROJECTNAME=".$self->name()."\n";
507	>	print $fh "SCRAM_PROJECTVERSION=".$self->version()."\n";
508	>	print $fh "projconfigdir=".$self->configurationdir()."\n";
509	>	print $fh "SCRAM_ProjReqsDoc=".$self->{reqdoc}."\n";
510	>	if ( defined $self->linkarea() ) {
511	>	my $area=$self->linkarea()->location();
512	>	if ( $area ne "" ) {
513	>	print $fh "RELEASETOP=".$area."\n";
514	>	}
515	>	}
516	>	undef $fh;
517		}
518
519	+
520	+	sub _LoadEnvFile {
521	+	my $self=shift;
522	+
523	+	use FileHandle;
524	+	my $fh=FileHandle->new();
525	+	open ( $fh, "<".$self->location()."/".$self->{admindir}."/".
526	+	"Environment" ) or
527	+	$self->error("Cannot find Environment file. Area Corrupted? ("
528	+	.$self->location().")\n $!");
529	+	while ( <$fh> ) {
530	+	chomp;
531	+	next if /^#/;
532	+	next if /^\s*$/ ;
533	+	($name, $value)=split /=/;
534	+	eval "\$self->{ENV}{${name}}=\"$value\"";
535	+	}
536	+	undef $fh;
537	+
538	+	# -- set internal variables appropriately
539	+	if ( defined $self->{ENV}{"SCRAM_PROJECTNAME"} ) {
540	+	$self->name($self->{ENV}{"SCRAM_PROJECTNAME"});
541	+	}
542	+	if ( defined $self->{ENV}{"SCRAM_PROJECTVERSION"} ) {
543	+	$self->version($self->{ENV}{"SCRAM_PROJECTVERSION"});
544	+	}
545	+	if ( defined $self->{ENV}{"projconfigdir"} ) {
546	+	$self->configurationdir($self->{ENV}{projconfigdir});
547	+	}
548	+	if ( defined $self->{ENV}{"SCRAM_ProjReqsDoc"} ) {
549	+	$self->requirementsdoc($self->{ENV}{SCRAM_ProjReqsDoc});
550	+	}
551	+	if ( ( defined $self->{ENV}{"RELEASETOP"} ) &&
552	+	($self->{ENV}{"RELEASETOP"} ne $self->location())) {
553	+	$self->linkto($self->{ENV}{"RELEASETOP"});
554	+	}
555	+	else {
556	+	$self->{ENV}{"RELEASETOP"}=$self->location();
557	+	}
558	+	}

Diff Legend

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