src/Configuration/ConfigArea.pm

#
# ConfigArea.pm
#
# Written by Christopher Williams
#
# Description
# -----------
# creates and manages a configuration area
#
# Options
# -------
# ConfigArea_location
# ConfigArea_name
#
# Interface
# ---------
# new()                         : A new ConfigArea object
# location([dir])               : set/return the location of the work area
# bootstrapfromlocation([location]) : bootstrap the object based on location.
#                                     no location specified - cwd used
#                                     return 0 if succesful 1 otherwise
# searchlocation([startdir])    : returns the location directory. search starts
#                                 from cwd if not specified
# defaultdirname()              : return the default directory name string
# scramversion()                : return the scram version associated with
#                                 area
# configurationdir()            : return the location of the project 
#                                 configuration directory
# copy(location)                : copy a configuration
# copysetup(location)           : copy the architecture specific tool setup
#                                 returns 0 if successful, 1 otherwise
# copyenv($ref)                 : copy the areas environment into the hashref

package Configuration::ConfigArea;
require 5.004;
use Utilities::AddDir;
use Utilities::Verbose;
use Cwd;
@ISA=qw(Utilities::Verbose);

sub new {
        my $class=shift;
        my $self={};
        bless $self, $class;

        # data init
        $self->{admindir}=".SCRAM";

        return $self;
}

sub configurationdir {
        my $self=shift;
        if ( @_ ) {
          $self->{configurationdir}=shift;
        }
        if ( ! defined $self->{configurationdir} ) {
          $self->_LoadEnvFile();
          $self->{configurationdir}=$self->{ENV}{projconfigdir};
        }
        return $self->{configurationdir};
}

sub scramversion {
        my $self=shift;
        if ( ! defined $self->{scramversion} ) {
          my $filename=$self->location()."/".$self->configurationdir()."/".
                                                        "scram_version";
          if ( -f $filename ) {
            use FileHandle;
            $fh=FileHandle->new();
            open ($fh, "<".$filename);
            my $version=<$fh>;
            chomp $version;
            $self->{scramversion}=$version;
            undef $fh;
          }
        }
        return $self->{scramversion};
}

sub bootstrapfromlocation {
        my $self=shift;

        my $rv=0;
        
        my $location;
        if ( ! defined ($location=$self->searchlocation(@_)) ) {
         $rv=1;
         $self->verbose("Unable to locate the top of local configuration area");
        }
        else {
         $self->location($location);
         $self->verbose("Found top ".$self->location());
         my $infofile=$self->location()."/".$self->{admindir}."/ConfigArea.dat";
         $self->_LoadEnvFile();
        }
        return $rv;
}

sub location {
        my $self=shift;

        if ( @_ ) {
          $self->{location}=shift;
        }
        elsif ( ! defined $self->{location} ) {
          # try and find the release location
          $self->{location}=$self->searchlocation();
        }
        return  $self->{location};
}

sub searchlocation {
        my $self=shift;

        #start search in current directory if not specified
        my $thispath;
        if ( @_ ) {
          $thispath=shift
        }
        else {
          $thispath=cwd();
        }
 
        my $rv=0;

        # chop off any files - we only want dirs
        if ( -f $thispath ) {
          $thispath=~s/(.*)\/.*/$1/;
        }
        Sloop:{
        do {
          $self->verbose("Searching $thispath");
          if ( -e "$thispath/".$self->{admindir} ) {
            $self->verbose("Found\n");
            $rv=1;
            last Sloop;
          }
        } while ( ($thispath=~s/(.*)\/.*/$1/)=~/./ ) };

        return $rv?$thispath:undef;
}

sub copy {
        my $self=shift;
        my $destination=shift;

        # copy across the admin dir
        my $temp=$self->location()."/".$self->{admindir};
        AddDir::copydir($temp,"$destination/".$self->{admindir});
}

sub copysetup {
        my $self=shift;
        my $dest=shift;

        my $rv=1;
        # copy across the admin dir
        my $temp=$self->location()."/".$self->{admindir}."/".$self->arch();
        my $temp2=$dest."/".$self->{admindir}."/".$self->arch();
        if ( $temp ne $temp2 ) {
         if ( -d $temp ) {
          AddDir::copydir($temp,$temp2);
          $rv=0;
         }
        }
        return $rv;
}

sub copyenv {
        my $self=shift;
        my $hashref=shift;
        
        foreach $elem ( keys %{$self->{ENV}} ) {
           $$hashref{$elem}=$self->{ENV}{$elem};
        }
}

sub arch {
        my $self=shift;
        return $ENV{SCRAM_ARCH};
}

# ---- support routines
sub _LoadEnvFile {
        my $self=shift;

        use FileHandle;
        my $fh=FileHandle->new();
        open ( $fh, "<".$self->location()."/".$self->{admindir}."/".
                "Environment" ) or 
                $self->error("Cannot find Environment file. Area Corrupted? ("
                                .$self->location().")\n $!"); 
        while ( <$fh> ) {
           chomp;
           next if /^#/;
           next if /^\s*$/ ;
           ($name, $value)=split /=/;
           eval "\$self->{ENV}{${name}}=\"$value\"";
        }
        undef $fh;
}

sub _savevar {
        my $self=shift;
        my $fh=shift;
        my $name=shift;
        my $val=shift;
        print $fh "#".$name."\n";
        print $fh $val."\n";
}

sub _restorevars {
        my $self=shift;
        my $fh=shift;
        my $varhash=shift;

        while ( <$fh>=~/^#(.*)/ ) {
         $name=$1;
         chomp $name;
         $value=<$fh>;
         chomp $value;
         $$varhash{$name}=$value;
        #print "Restoring ".$name."=".$value."\n";
        }
}
Revision:	1.13.2.4
Committed:	Fri Apr 28 12:49:15 2000 UTC (25 years ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
CVS Tags:	V0_12_2
Changes since 1.13.2.3:	+0 -2 lines
Log Message:	remove debug line
#	User	Rev	Content
1	williamc	1.1	#
2			# ConfigArea.pm
3			#
4	williamc	1.13.2.1	# Written by Christopher Williams
5	williamc	1.1	#
6			# Description
7	williamc	1.9	# -----------
8			# creates and manages a configuration area
9			#
10			# Options
11			# -------
12			# ConfigArea_location
13			# ConfigArea_name
14	williamc	1.1	#
15			# Interface
16			# ---------
17	williamc	1.13.2.1	# new() : A new ConfigArea object
18			# location([dir]) : set/return the location of the work area
19	williamc	1.13.2.3	# bootstrapfromlocation([location]) : bootstrap the object based on location.
20			# no location specified - cwd used
21			# return 0 if succesful 1 otherwise
22	williamc	1.5	# searchlocation([startdir]) : returns the location directory. search starts
23			# from cwd if not specified
24	williamc	1.6	# defaultdirname() : return the default directory name string
25	williamc	1.13.2.1	# scramversion() : return the scram version associated with
26			# area
27			# configurationdir() : return the location of the project
28			# configuration directory
29	williamc	1.13.2.2	# copy(location) : copy a configuration
30			# copysetup(location) : copy the architecture specific tool setup
31			# returns 0 if successful, 1 otherwise
32			# copyenv($ref) : copy the areas environment into the hashref
33	williamc	1.1
34			package Configuration::ConfigArea;
35			require 5.004;
36			use Utilities::AddDir;
37	williamc	1.13.2.1	use Utilities::Verbose;
38	williamc	1.6	use Cwd;
39	williamc	1.13.2.1	@ISA=qw(Utilities::Verbose);
40	williamc	1.1
41	williamc	1.13.2.1	sub new {
42			my $class=shift;
43			my $self={};
44			bless $self, $class;
45	williamc	1.9
46	williamc	1.13.2.2	# data init
47			$self->{admindir}=".SCRAM";
48	williamc	1.7
49	williamc	1.13.2.2	return $self;
50	williamc	1.9	}
51	williamc	1.8
52	williamc	1.13.2.1	sub configurationdir {
53	williamc	1.1	my $self=shift;
54	williamc	1.13.2.1	if ( @_ ) {
55			$self->{configurationdir}=shift;
56	williamc	1.6	}
57	williamc	1.13.2.1	if ( ! defined $self->{configurationdir} ) {
58			$self->_LoadEnvFile();
59			$self->{configurationdir}=$self->{ENV}{projconfigdir};
60			}
61			return $self->{configurationdir};
62			}
63
64			sub scramversion {
65			my $self=shift;
66			if ( ! defined $self->{scramversion} ) {
67	williamc	1.13.2.2	my $filename=$self->location()."/".$self->configurationdir()."/".
68	williamc	1.13.2.1	"scram_version";
69			if ( -f $filename ) {
70			use FileHandle;
71			$fh=FileHandle->new();
72			open ($fh, "<".$filename);
73			my $version=<$fh>;
74			chomp $version;
75			$self->{scramversion}=$version;
76			undef $fh;
77			}
78	williamc	1.1	}
79	williamc	1.13.2.1	return $self->{scramversion};
80	williamc	1.4	}
81
82	williamc	1.5	sub bootstrapfromlocation {
83			my $self=shift;
84	williamc	1.13.2.2
85			my $rv=0;
86	williamc	1.5
87	williamc	1.13.2.3	my $location;
88			if ( ! defined ($location=$self->searchlocation(@_)) ) {
89	williamc	1.13.2.2	$rv=1;
90			$self->verbose("Unable to locate the top of local configuration area");
91			}
92			else {
93	williamc	1.13.2.3	$self->location($location);
94	williamc	1.13.2.2	$self->verbose("Found top ".$self->location());
95			my $infofile=$self->location()."/".$self->{admindir}."/ConfigArea.dat";
96			$self->_LoadEnvFile();
97	williamc	1.5	}
98	williamc	1.13.2.2	return $rv;
99	williamc	1.1	}
100
101			sub location {
102			my $self=shift;
103
104	williamc	1.5	if ( @_ ) {
105	williamc	1.6	$self->{location}=shift;
106	williamc	1.5	}
107			elsif ( ! defined $self->{location} ) {
108			# try and find the release location
109	williamc	1.9	$self->{location}=$self->searchlocation();
110	williamc	1.5	}
111			return $self->{location};
112			}
113
114			sub searchlocation {
115			my $self=shift;
116
117			#start search in current directory if not specified
118			my $thispath;
119	williamc	1.13.2.3	if ( @_ ) {
120			$thispath=shift
121			}
122			else {
123			$thispath=cwd();
124			}
125	williamc	1.5
126			my $rv=0;
127
128	williamc	1.13.2.3	# chop off any files - we only want dirs
129			if ( -f $thispath ) {
130			$thispath=~s/(.)\/./$1/;
131			}
132	williamc	1.6	Sloop:{
133			do {
134	williamc	1.13.2.1	$self->verbose("Searching $thispath");
135	williamc	1.8	if ( -e "$thispath/".$self->{admindir} ) {
136	williamc	1.13.2.1	$self->verbose("Found\n");
137	williamc	1.5	$rv=1;
138	williamc	1.6	last Sloop;
139	williamc	1.5	}
140	williamc	1.6	} while ( ($thispath=~s/(.)\/./$1/)=~/./ ) };
141	williamc	1.5
142			return $rv?$thispath:undef;
143	williamc	1.1	}
144
145	williamc	1.13.2.2	sub copy {
146			my $self=shift;
147			my $destination=shift;
148
149			# copy across the admin dir
150			my $temp=$self->location()."/".$self->{admindir};
151			AddDir::copydir($temp,"$destination/".$self->{admindir});
152			}
153
154			sub copysetup {
155			my $self=shift;
156			my $dest=shift;
157
158			my $rv=1;
159			# copy across the admin dir
160			my $temp=$self->location()."/".$self->{admindir}."/".$self->arch();
161			my $temp2=$dest."/".$self->{admindir}."/".$self->arch();
162			if ( $temp ne $temp2 ) {
163			if ( -d $temp ) {
164			AddDir::copydir($temp,$temp2);
165			$rv=0;
166			}
167			}
168			return $rv;
169			}
170
171			sub copyenv {
172			my $self=shift;
173			my $hashref=shift;
174
175			foreach $elem ( keys %{$self->{ENV}} ) {
176			$$hashref{$elem}=$self->{ENV}{$elem};
177			}
178			}
179
180			sub arch {
181			my $self=shift;
182			return $ENV{SCRAM_ARCH};
183			}
184
185	williamc	1.13.2.1	# ---- support routines
186			sub _LoadEnvFile {
187	williamc	1.1	my $self=shift;
188
189	williamc	1.13.2.1	use FileHandle;
190			my $fh=FileHandle->new();
191	williamc	1.13.2.2	open ( $fh, "<".$self->location()."/".$self->{admindir}."/".
192			"Environment" ) or
193	williamc	1.13.2.3	$self->error("Cannot find Environment file. Area Corrupted? ("
194			.$self->location().")\n $!");
195	williamc	1.13.2.1	while ( <$fh> ) {
196			chomp;
197			next if /^#/;
198			next if /^\s*$/ ;
199			($name, $value)=split /=/;
200			eval "\$self->{ENV}{${name}}=\"$value\"";
201	williamc	1.9	}
202	williamc	1.13.2.1	undef $fh;
203	williamc	1.1	}
204
205	williamc	1.13.2.1	sub _savevar {
206			my $self=shift;
207			my $fh=shift;
208	williamc	1.9	my $name=shift;
209	williamc	1.13.2.1	my $val=shift;
210			print $fh "#".$name."\n";
211			print $fh $val."\n";
212			}
213
214			sub _restorevars {
215			my $self=shift;
216			my $fh=shift;
217			my $varhash=shift;
218
219			while ( <$fh>=~/^#(.*)/ ) {
220			$name=$1;
221			chomp $name;
222			$value=<$fh>;
223			chomp $value;
224			$$varhash{$name}=$value;
225			#print "Restoring ".$name."=".$value."\n";
226			}
227	williamc	1.1	}