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.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
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])        : 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;
23	–	use ActiveDoc::ActiveDoc;
52		require 5.004;
53	+	use URL::URLcache;
54		use Utilities::AddDir;
55	+	use Utilities::Verbose;
56		use ObjectUtilities::ObjectStore;
57	<	@ISA=qw(ActiveDoc::ActiveDoc ObjectUtilities::StorableObject);
57	>	use Cwd;
58	>	@ISA=qw(Utilities::Verbose);
59
60	<	sub init {
61	<	my $self=shift;
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,
69	<	"", $self, "",$self);
70	<	$self->addurltags("setup");
71	<	$self->addtag("setup","use",\&Use_Start,$self, "", $self, "",$self);
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	>	return $self;
72		}
73
74	<	sub setup {
74	>	sub cache {
75		my $self=shift;
76
77	<	# --- find out the location
78	<	my $location=$self->requestoption("area_location",
79	<	"Please Enter the location of the directory");
80	<
81	<	# --- find area directory name , default name projectname_version
82	<	my $name=$self->option("area_name");
83	<	my $vers=$self->version;
84	<	if ( ! defined $name ) {
85	<	$name=$self->name();
86	<	$vers=~s/^$name_//;
87	<	$name=$name."_".$vers;
88	<	}
89	<	$self->location($location."/".$name);
90	<
91	<
61	<	# make a new store handler
62	<	my $parentconfig=$self->_setupstore();
63	<
64	<	# --- download everything first
65	<	# FIX-ME --- cacheing is broken
66	<	$self->parse("download");
67	<
68	<	# --- 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());
77	>	my $exist=0;
78	>	if ( @_ ) {
79	>	my $cache=shift;
80	>	if ( $cache!~/^</ ) {
81	>	$self->{cache}=$cache;
82	>	}
83	>	$exist=1;
84	>	}
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	>	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");
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 name {
113	>	my $self=shift;
114	>	@_?$self->{name}=shift
115	>	:$self->{name};
116	>	}
117
118	<	my $parentconfig=$self->config();
119	<	$self->config(Configuration::ConfigureStore->new());
120	<	$self->config()->db("local",$ad);
121	<	$self->config()->db("parent",$parentconfig);
86	<	$self->config()->policy("cache","local");
87	<	$self->config()->basedoc($parentconfig->basedoc());
88	<	return $parentconfig;
118	>	sub version {
119	>	my $self=shift;
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	+	# -- 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	+	# -- 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
95	–	my $fh=$self->openfile(">".$location);
96	–	print $fh $self->location()."\n";
97	–	$fh->close();
162		}
163
164	<	sub restore {
164	>	sub configurationdir {
165		my $self=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	<	$self->{location}=<$fh>;
174	<	chomp $self->{location};
175	<	$fh->close();
176	<
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 {
231		my $self=shift;
232
233	<	@_?$self->{location}=shift
234	<	:$self->{location};
233	>	if ( @_ ) {
234	>	$self->{location}=shift;
235	>	}
236	>	elsif ( ! defined $self->{location} ) {
237	>	# try and find the release location
238	>	$self->{location}=$self->searchlocation();
239	>	}
240	>	return  $self->{location};
241	>	}
242	>
243	>	sub searchlocation {
244	>	my $self=shift;
245	>
246	>	#start search in current directory if not specified
247	>	my $thispath;
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	>	$self->verbose("Searching $thispath");
264	>	if ( -e "$thispath/".$self->{admindir} ) {
265	>	$self->verbose("Found\n");
266	>	$rv=1;
267	>	last Sloop;
268	>	}
269	>	} while ( ($thispath=~s/(.*)\/.*/$1/)=~/./ ) };
270	>
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	<	my $location=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	<	$self->config()->find("ConfigItem",@_);
330	>	# -- save it
331	>	$sat->save();
332	>
333	>	return $sat;
334		}
335
336	<	sub addconfigitem {
336	>	sub copy {
337		my $self=shift;
338	<	my $url=shift;
338	>	my $destination=shift;
339
340	<	my $docref=$self->activatedoc($url);
341	<	# Set up the document
342	<	$docref->setup();
152	<	$self->config()->storepolicy("local");
153	<	$docref->save();
340	>	# copy across the admin dir
341	>	my $temp=$self->location()."/".$self->{admindir};
342	>	AddDir::copydir($temp,"$destination/".$self->{admindir});
343		}
344
345	<	# -------------- Tags ---------------------------------
157	<	# -- init parse
158	<	sub Project_Start {
345	>	sub align {
346		my $self=shift;
347	<	my $name=shift;
161	<	my $hashref=shift;
347	>	use File::Copy;
348
349	<	$self->checktag($name,$hashref,'name');
350	<	$self->checktag($name,$hashref,'version');
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	<	$self->name($$hashref{'name'});
356	<	$self->version($$hashref{'version'});
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 copysetup {
374	+	my $self=shift;
375	+	my $dest=shift;
376
377	<	sub Project_text {
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	>	sub copyenv {
391		my $self=shift;
392	<	my $name=shift;
393	<	my $string=shift;
392	>	my $hashref=shift;
393	>
394	>	foreach $elem ( keys %{$self->{ENV}} ) {
395	>	$$hashref{$elem}=$self->{ENV}{$elem};
396	>	}
397	>	}
398
399	<	print $string;
399	>	sub arch {
400	>	my $self=shift;
401	>	return $ENV{SCRAM_ARCH};
402		}
403
404	<	# ---- download parse
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 Use_download_Start {
418	>	sub unlinkarea {
419		my $self=shift;
420	<	my $name=shift;
421	<	my $hashref=shift;
420	>	undef $self->{linkarea};
421	>	$self->{linkarea}=undef;
422	>	$self->save();
423	>	}
424
425	<	$self->checktag($name,$hashref,'url');
426	<	print "Downloading .... ".$$hashref{'url'}."\n";
427	<	$self->getfile($$hashref{'url'});
425	>	sub linkarea {
426	>	my $self=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	<	# --- setup parse
435	>	sub save {
436	>	my $self=shift;
437	>	$self->_SaveEnvFile();
438	>	}
439
440	<	sub Use_Start {
440	>	# ---- support routines
441	>
442	>	sub _SaveEnvFile {
443		my $self=shift;
444	<	my $name=shift;
445	<	my $hashref=shift;
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	<	$self->checktag($name,$hashref,'url');
452	<	$self->addconfigitem($$hashref{'url'});
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
464	+
465	+	sub _LoadEnvFile {
466	+	my $self=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	+	# -- 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	+	}

Diff Legend

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