[Bio] / FigKernelPackages / Tracer.pm Repository:
ViewVC logotype

Diff of /FigKernelPackages/Tracer.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.45, Mon May 8 20:37:02 2006 UTC revision 1.55, Sun Jun 18 09:55:24 2006 UTC
# Line 24  Line 24 
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
26      use CGI;      use CGI;
27        use Cwd;
28      use FIG_Config;      use FIG_Config;
29      use PageBuilder;      use PageBuilder;
30      use Digest::MD5;      use Digest::MD5;
31      use File::Basename;      use File::Basename;
32      use File::Path;      use File::Path;
33        use File::stat;
34    
35  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
36    
# Line 1346  Line 1348 
1348      return @inputList;      return @inputList;
1349  }  }
1350    
1351    =head3 Percent
1352    
1353    C<< my $percent = Tracer::Percent($number, $base); >>
1354    
1355    Returns the percent of the base represented by the given number. If the base
1356    is zero, returns zero.
1357    
1358    =over 4
1359    
1360    =item number
1361    
1362    Percent numerator.
1363    
1364    =item base
1365    
1366    Percent base.
1367    
1368    =item RETURN
1369    
1370    Returns the percentage of the base represented by the numerator.
1371    
1372    =back
1373    
1374    =cut
1375    
1376    sub Percent {
1377        # Get the parameters.
1378        my ($number, $base) = @_;
1379        # Declare the return variable.
1380        my $retVal = 0;
1381        # Compute the percent.
1382        if ($base != 0) {
1383            $retVal = $number * 100 / $base;
1384        }
1385        # Return the result.
1386        return $retVal;
1387    }
1388    
1389  =head3 GetFile  =head3 GetFile
1390    
1391  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
# Line 1604  Line 1644 
1644    
1645  =head3 AddToListMap  =head3 AddToListMap
1646    
1647  C<< Tracer::AddToListMap(\%hash, $key, $value); >>  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>
1648    
1649  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list
1650  is created for the key. Otherwise, the new value is pushed onto the list.  is created for the key. Otherwise, the new value is pushed onto the list.
# Line 1619  Line 1659 
1659    
1660  Key for which the value is to be added.  Key for which the value is to be added.
1661    
1662  =item value  =item value1, value2, ... valueN
1663    
1664  Value to add to the key's value list.  List of values to add to the key's value list.
1665    
1666  =back  =back
1667    
# Line 1629  Line 1669 
1669    
1670  sub AddToListMap {  sub AddToListMap {
1671      # Get the parameters.      # Get the parameters.
1672      my ($hash, $key, $value) = @_;      my ($hash, $key, @values) = @_;
1673      # Process according to whether or not the key already has a value.      # Process according to whether or not the key already has a value.
1674      if (! exists $hash->{$key}) {      if (! exists $hash->{$key}) {
1675          $hash->{$key} = [$value];          $hash->{$key} = [@values];
1676      } else {      } else {
1677          push @{$hash->{$key}}, $value;          push @{$hash->{$key}}, @values;
1678      }      }
1679  }  }
1680    
# Line 2008  Line 2048 
2048      }      }
2049  }  }
2050    
2051    =head3 CommaFormat
2052    
2053    C<< my $formatted = Tracer::CommaFormat($number); >>
2054    
2055    Insert commas into a number.
2056    
2057    =over 4
2058    
2059    =item number
2060    
2061    A sequence of digits.
2062    
2063    =item RETURN
2064    
2065    Returns the same digits with commas strategically inserted.
2066    
2067    =back
2068    
2069    =cut
2070    
2071    sub CommaFormat {
2072        # Get the parameters.
2073        my ($number) = @_;
2074        # Pad the length up to a multiple of three.
2075        my $padded = "$number";
2076        $padded = " " . $padded while length($padded) % 3 != 0;
2077        # This is a fancy PERL trick. The parentheses in the SPLIT pattern
2078        # cause the delimiters to be included in the output stream. The
2079        # GREP removes the empty strings in between the delimiters.
2080        my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
2081        # Clean out the spaces.
2082        $retVal =~ s/ //g;
2083        # Return the result.
2084        return $retVal;
2085    }
2086    =head3 SetPermissions
2087    
2088    C<< Tracer::SetPermissions($dirName, $group, $mask, %otherMasks); >>
2089    
2090    Set the permissions for a directory and all the files and folders inside it.
2091    In addition, the group ownership will be changed to the specified value.
2092    
2093    This method is more vulnerable than most to permission and compatability
2094    problems, so it does internal error recovery.
2095    
2096    =over 4
2097    
2098    =item dirName
2099    
2100    Name of the directory to process.
2101    
2102    =item group
2103    
2104    Name of the group to be assigned.
2105    
2106    =item mask
2107    
2108    Permission mask. Bits that are C<1> in this mask will be ORed into the
2109    permission bits of any file or directory that does not already have them
2110    set to 1.
2111    
2112    =item otherMasks
2113    
2114    Map of search patterns to permission masks. If a directory name matches
2115    one of the patterns, that directory and all its members and subdirectories
2116    will be assigned the new pattern. For example, the following would
2117    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2118    
2119        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2120    
2121    The list is ordered, so the following would use 0777 for C<tmp1> and
2122    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2123    
2124        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2125                                                       '^tmp' => 0666);
2126    
2127    Note that the pattern matches are all case-insensitive, and only directory
2128    names are matched, not file names.
2129    
2130    =back
2131    
2132    =cut
2133    
2134    sub SetPermissions {
2135        # Get the parameters.
2136        my ($dirName, $group, $mask, @otherMasks) = @_;
2137        # Set up for error recovery.
2138        eval {
2139            # Switch to the specified directory.
2140            ChDir($dirName);
2141            # Get the group ID.
2142            my $gid = getgrnam($group);
2143            # Get the mask for tracing.
2144            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2145            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(2);
2146            my $fixCount = 0;
2147            my $lookCount = 0;
2148            # @dirs will be a stack of directories to be processed.
2149            my @dirs = (getcwd());
2150            while (scalar(@dirs) > 0) {
2151                # Get the current directory.
2152                my $dir = pop @dirs;
2153                # Check for a match to one of the specified directory names. To do
2154                # that, we need to pull the individual part of the name off of the
2155                # whole path.
2156                my $simpleName = $dir;
2157                if ($dir =~ m!/(.+)$!) {
2158                    $simpleName = $1;
2159                }
2160                # Search for a match.
2161                my $match = 0;
2162                my $i;
2163                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2164                    my $pattern = $otherMasks[$i];
2165                    if ($simpleName =~ /$pattern/i) {
2166                        $match = 1;
2167                    }
2168                }
2169                # Check for a match. Note we use $i-1 because the loop added 2
2170                # before terminating due to the match.
2171                if ($match && $otherMasks[$i-1] != $mask) {
2172                    # This directory matches one of the incoming patterns, and it's
2173                    # a different mask, so we process it recursively with that mask.
2174                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2175                } else {
2176                    # Here we can process normally. Get all of the non-hidden members.
2177                    my @submems = OpenDir($dir, 1);
2178                    for my $submem (@submems) {
2179                        # Get the full name.
2180                        my $thisMem = "$dir/$submem";
2181                        Trace("Checking member $thisMem.") if T(4);
2182                        $lookCount++;
2183                        if ($lookCount % 1000 == 0) {
2184                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(3);
2185                        }
2186                        # Fix the group.
2187                        chown -1, $gid, $thisMem;
2188                        # Insure this member is not a symlink.
2189                        if (! -l $thisMem) {
2190                            # Get its info.
2191                            my $fileInfo = stat $thisMem;
2192                            # Only proceed if we got the info. Otherwise, it's a hard link
2193                            # and we want to skip it anyway.
2194                            if ($fileInfo) {
2195                                my $fileMode = $fileInfo->mode;
2196                                if (($fileMode & $mask) == 0) {
2197                                    # Fix this member.
2198                                    $fileMode |= $mask;
2199                                    chmod $fileMode, $thisMem;
2200                                    $fixCount++;
2201                                }
2202                                # If it's a subdirectory, stack it.
2203                                if (-d $thisMem) {
2204                                    push @dirs, $thisMem;
2205                                }
2206                            }
2207                        }
2208                    }
2209                }
2210            }
2211            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);
2212        };
2213        # Check for an error.
2214        if ($@) {
2215            Confess("SetPermissions error: $@");
2216        }
2217    }
2218    
2219  1;  1;

Legend:
Removed from v.1.45  
changed lines
  Added in v.1.55

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3