'Valid-responses' => \&req_Validresponses,
'valid-requests' => \&req_validrequests,
'Directory' => \&req_Directory,
+ 'Sticky' => \&req_Sticky,
'Entry' => \&req_Entry,
'Modified' => \&req_Modified,
'Unchanged' => \&req_Unchanged,
{
$log->info("Setting prepend to '$state->{path}'");
$state->{prependdir} = $state->{path};
+ my %entries;
foreach my $entry ( keys %{$state->{entries}} )
{
- $state->{entries}{$state->{prependdir} . $entry} = $state->{entries}{$entry};
- delete $state->{entries}{$entry};
+ $entries{$state->{prependdir} . $entry} = $state->{entries}{$entry};
}
+ $state->{entries}=\%entries;
+
+ my %dirMap;
+ foreach my $dir ( keys %{$state->{dirMap}} )
+ {
+ $dirMap{$state->{prependdir} . $dir} = $state->{dirMap}{$dir};
+ }
+ $state->{dirMap}=\%dirMap;
}
if ( defined ( $state->{prependdir} ) )
$log->debug("Prepending '$state->{prependdir}' to state|directory");
$state->{directory} = $state->{prependdir} . $state->{directory}
}
+
+ if ( ! defined($state->{dirMap}{$state->{directory}}) )
+ {
+ $state->{dirMap}{$state->{directory}} =
+ {
+ 'names' => {}
+ #'tagspec' => undef
+ };
+ }
+
$log->debug("req_Directory : localdir=$data repository=$repository path=$state->{path} directory=$state->{directory} module=$state->{module}");
}
+# Sticky tagspec \n
+# Response expected: no. Tell the server that the directory most
+# recently specified with Directory has a sticky tag or date
+# tagspec. The first character of tagspec is T for a tag, D for
+# a date, or some other character supplied by a Set-sticky
+# response from a previous request to the server. The remainder
+# of tagspec contains the actual tag or date, again as supplied
+# by Set-sticky.
+# The server should remember Static-directory and Sticky requests
+# for a particular directory; the client need not resend them each
+# time it sends a Directory request for a given directory. However,
+# the server is not obliged to remember them beyond the context
+# of a single command.
+sub req_Sticky
+{
+ my ( $cmd, $tagspec ) = @_;
+
+ my ( $stickyInfo );
+ if($tagspec eq "")
+ {
+ # nothing
+ }
+ elsif($tagspec=~/^T([^ ]+)\s*$/)
+ {
+ $stickyInfo = { 'tag' => $1 };
+ }
+ elsif($tagspec=~/^D([0-9.]+)\s*$/)
+ {
+ $stickyInfo= { 'date' => $1 };
+ }
+ else
+ {
+ die "Unknown tag_or_date format\n";
+ }
+ $state->{dirMap}{$state->{directory}}{stickyInfo}=$stickyInfo;
+
+ $log->debug("req_Sticky : tagspec=$tagspec repository=$state->{repository}"
+ . " path=$state->{path} directory=$state->{directory}"
+ . " module=$state->{module}");
+}
+
# Entry entry-line \n
# Response expected: no. Tell the server what version of a file is on the
# local machine. The name in entry-line is a name relative to the directory
#$log->debug("req_Entry : $data");
- my @data = split(/\//, $data);
+ my @data = split(/\//, $data, -1);
$state->{entries}{$state->{directory}.$data[1]} = {
revision => $data[2],
tag_or_date => $data[5],
};
+ $state->{dirMap}{$state->{directory}}{names}{$data[1]} = 'F';
+
$log->info("Received entry line '$data' => '" . $state->{directory} . $data[1] . "'");
}
print "M Repository revision:\t" .
$meta->{revision} .
"\t$state->{CVSROOT}/$state->{module}/$filename,v\n";
- print "M Sticky Tag:\t\t(none)\n";
- print "M Sticky Date:\t\t(none)\n";
- print "M Sticky Options:\t\t(none)\n";
+ my($tagOrDate)=$state->{entries}{$filename}{tag_or_date};
+ my($tag)=($tagOrDate=~m/^T(.+)$/);
+ if( !defined($tag) )
+ {
+ $tag="(none)";
+ }
+ print "M Sticky Tag:\t\t$tag\n";
+ my($date)=($tagOrDate=~m/^D(.+)$/);
+ if( !defined($date) )
+ {
+ $date="(none)";
+ }
+ print "M Sticky Date:\t\t$date\n";
+ my($options)=$state->{entries}{$filename}{options};
+ if( $options eq "" )
+ {
+ $options="(none)";
+ }
+ print "M Sticky Options:\t\t$options\n";
} else {
print "M Repository revision:\tNo revision control file\n";
}
}
}
-# This method uses $state->{directory} to populate $state->{args} with a list of filenames
-sub argsfromdir
+# Used by argsfromdir
+sub expandArg
{
- my $updater = shift;
+ my ($updater,$outNameMap,$outDirMap,$path,$isDir) = @_;
- $state->{args} = [] if ( scalar(@{$state->{args}}) == 1 and $state->{args}[0] eq "." );
+ my $fullPath = filecleanup($path);
- return if ( scalar ( @{$state->{args}} ) > 1 );
+ # Is it a directory?
+ if( defined($state->{dirMap}{$fullPath}) ||
+ defined($state->{dirMap}{"$fullPath/"}) )
+ {
+ # It is a directory in the user's sandbox.
+ $isDir=1;
- my @gethead = @{$updater->gethead};
+ if(defined($state->{entries}{$fullPath}))
+ {
+ $log->fatal("Inconsistent file/dir type");
+ die "Inconsistent file/dir type";
+ }
+ }
+ elsif(defined($state->{entries}{$fullPath}))
+ {
+ # It is a file in the user's sandbox.
+ $isDir=0;
+ }
+ my($revDirMap,$otherRevDirMap);
+ if(!defined($isDir) || $isDir)
+ {
+ # Resolve version tree for sticky tag:
+ # (for now we only want list of files for the version, not
+ # particular versions of those files: assume it is a directory
+ # for the moment; ignore Entry's stick tag)
+
+ # Order of precedence of sticky tags:
+ # -A [head]
+ # -r /tag/
+ # [file entry sticky tag, but that is only relevant to files]
+ # [the tag specified in dir req_Sticky]
+ # [the tag specified in a parent dir req_Sticky]
+ # [head]
+ # Also, -r may appear twice (for diff).
+ #
+ # FUTURE: When/if -j (merges) are supported, we also
+ # need to add relevant files from one or two
+ # versions specified with -j.
+
+ if(exists($state->{opt}{A}))
+ {
+ $revDirMap=$updater->getRevisionDirMap();
+ }
+ elsif( defined($state->{opt}{r}) and
+ ref $state->{opt}{r} eq "ARRAY" )
+ {
+ $revDirMap=$updater->getRevisionDirMap($state->{opt}{r}[0]);
+ $otherRevDirMap=$updater->getRevisionDirMap($state->{opt}{r}[1]);
+ }
+ elsif(defined($state->{opt}{r}))
+ {
+ $revDirMap=$updater->getRevisionDirMap($state->{opt}{r});
+ }
+ else
+ {
+ my($sticky)=getDirStickyInfo($fullPath);
+ $revDirMap=$updater->getRevisionDirMap($sticky->{tag});
+ }
- # push added files
- foreach my $file (keys %{$state->{entries}}) {
- if ( exists $state->{entries}{$file}{revision} &&
- $state->{entries}{$file}{revision} eq '0' )
- {
- push @gethead, { name => $file, filehash => 'added' };
- }
+ # Is it a directory?
+ if( defined($revDirMap->{$fullPath}) ||
+ defined($otherRevDirMap->{$fullPath}) )
+ {
+ $isDir=1;
+ }
}
- if ( scalar(@{$state->{args}}) == 1 )
+ # What to do with it?
+ if(!$isDir)
{
- my $arg = $state->{args}[0];
- $arg .= $state->{prependdir} if ( defined ( $state->{prependdir} ) );
+ $outNameMap->{$fullPath}=1;
+ }
+ else
+ {
+ $outDirMap->{$fullPath}=1;
- $log->info("Only one arg specified, checking for directory expansion on '$arg'");
+ if(defined($revDirMap->{$fullPath}))
+ {
+ addDirMapFiles($updater,$outNameMap,$outDirMap,
+ $revDirMap->{$fullPath});
+ }
+ if( defined($otherRevDirMap) &&
+ defined($otherRevDirMap->{$fullPath}) )
+ {
+ addDirMapFiles($updater,$outNameMap,$outDirMap,
+ $otherRevDirMap->{$fullPath});
+ }
+ }
+}
- foreach my $file ( @gethead )
+# Used by argsfromdir
+# Add entries from dirMap to outNameMap. Also recurse into entries
+# that are subdirectories.
+sub addDirMapFiles
+{
+ my($updater,$outNameMap,$outDirMap,$dirMap)=@_;
+
+ my($fullName);
+ foreach $fullName (keys(%$dirMap))
+ {
+ my $cleanName=$fullName;
+ if(defined($state->{prependdir}))
{
- next if ( $file->{filehash} eq "deleted" and not defined ( $state->{entries}{$file->{name}} ) );
- next unless ( $file->{name} =~ /^$arg\// or $file->{name} eq $arg );
- push @{$state->{args}}, $file->{name};
+ if(!($cleanName=~s/^\Q$state->{prependdir}\E//))
+ {
+ $log->fatal("internal error stripping prependdir");
+ die "internal error stripping prependdir";
+ }
}
- shift @{$state->{args}} if ( scalar(@{$state->{args}}) > 1 );
- } else {
- $log->info("Only one arg specified, populating file list automatically");
+ if($dirMap->{$fullName} eq "F")
+ {
+ $outNameMap->{$cleanName}=1;
+ }
+ elsif($dirMap->{$fullName} eq "D")
+ {
+ if(!$state->{opt}{l})
+ {
+ expandArg($updater,$outNameMap,$outDirMap,$cleanName,1);
+ }
+ }
+ else
+ {
+ $log->fatal("internal error in addDirMapFiles");
+ die "internal error in addDirMapFiles";
+ }
+ }
+}
+
+# This method replaces $state->{args} with a directory-expanded
+# list of all relevant filenames (recursively unless -d), based
+# on $state->{entries}, and the "current" list of files in
+# each directory. "Current" files as determined by
+# either the requested (-r/-A) or "req_Sticky" version of
+# that directory.
+# Both the input args and the new output args are relative
+# to the cvs-client's CWD, although some of the internal
+# computations are relative to the top of the project.
+sub argsfromdir
+{
+ my $updater = shift;
+
+ # Notes about requirements for specific callers:
+ # update # "standard" case (entries; a single -r/-A/default; -l)
+ # # Special case: -d for create missing directories.
+ # diff # 0 or 1 -r's: "standard" case.
+ # # 2 -r's: We could ignore entries (just use the two -r's),
+ # # but it doesn't really matter.
+ # annotate # "standard" case
+ # log # Punting: log -r has a more complex non-"standard"
+ # # meaning, and we don't currently try to support log'ing
+ # # branches at all (need a lot of work to
+ # # support CVS-consistent branch relative version
+ # # numbering).
+#HERE: But we still want to expand directories. Maybe we should
+# essentially force "-A".
+ # status # "standard", except that -r/-A/default are not possible.
+ # # Mostly only used to expand entries only)
+ #
+ # Don't use argsfromdir at all:
+ # add # Explicit arguments required. Directory args imply add
+ # # the directory itself, not the files in it.
+ # co # Obtain list directly.
+ # remove # HERE: TEST: MAYBE client does the recursion for us,
+ # # since it only makes sense to remove stuff already in
+ # # the sandobx?
+ # ci # HERE: Similar to remove...
+ # # Don't try to implement the confusing/weird
+ # # ci -r bug er.."feature".
+
+ if(scalar(@{$state->{args}})==0)
+ {
+ $state->{args} = [ "." ];
+ }
+ my %allArgs;
+ my %allDirs;
+ for my $file (@{$state->{args}})
+ {
+ expandArg($updater,\%allArgs,\%allDirs,$file);
+ }
+
+ # Include any entries from sandbox. Generally client won't
+ # send entries that shouldn't be used.
+ foreach my $file (keys %{$state->{entries}})
+ {
+ $allArgs{remove_prependdir($file)} = 1;
+ }
+
+ $state->{dirArgs} = \%allDirs;
+ $state->{args} = [
+ sort {
+ # Sort priority: by directory depth, then actual file name:
+ my @piecesA=split('/',$a);
+ my @piecesB=split('/',$b);
+
+ my $count=scalar(@piecesA);
+ my $tmp=scalar(@piecesB);
+ return $count<=>$tmp if($count!=$tmp);
+
+ for($tmp=0;$tmp<$count;$tmp++)
+ {
+ if($piecesA[$tmp] ne $piecesB[$tmp])
+ {
+ return $piecesA[$tmp] cmp $piecesB[$tmp]
+ }
+ }
+ return 0;
+ } keys(%allArgs) ];
+}
- $state->{args} = [];
+## look up directory sticky tag, of either fullPath or a parent:
+sub getDirStickyInfo
+{
+ my($fullPath)=@_;
+
+ $fullPath=~s%/+$%%;
+ while($fullPath ne "" && !defined($state->{dirMap}{"$fullPath/"}))
+ {
+ $fullPath=~s%/?[^/]*$%%;
+ }
+
+ if( !defined($state->{dirMap}{"$fullPath/"}) &&
+ ( $fullPath eq "" ||
+ $fullPath eq "." ) )
+ {
+ return $state->{dirMap}{""}{stickyInfo};
+ }
+ else
+ {
+ return $state->{dirMap}{"$fullPath/"}{stickyInfo};
+ }
+}
+
+# Resolve precedence of various ways of specifying which version of
+# a file you want. Returns undef (for default head), or a ref to a hash
+# that contains "tag" and/or "date" keys.
+sub resolveStickyInfo
+{
+ my($filename,$stickyTag,$stickyDate,$reset) = @_;
+
+ # Order of precedence of sticky tags:
+ # -A [head]
+ # -r /tag/
+ # [file entry sticky tag]
+ # [the tag specified in dir req_Sticky]
+ # [the tag specified in a parent dir req_Sticky]
+ # [head]
+
+ my $result;
+ if($reset)
+ {
+ # $result=undef;
+ }
+ elsif( defined($stickyTag) && $stickyTag ne "" )
+ # || ( defined($stickyDate) && $stickyDate ne "" ) # TODO
+ {
+ $result={ 'tag' => (defined($stickyTag)?$stickyTag:undef) };
- foreach my $file ( @gethead )
+ # TODO: Convert -D value into the form 2011.04.10.04.46.57,
+ # similar to an entry line's sticky date, without the D prefix.
+ # It sometimes (always?) arrives as something more like
+ # '10 Apr 2011 04:46:57 -0000'...
+ # $result={ 'date' => (defined($stickyDate)?$stickyDate:undef) };
+ }
+ elsif( defined($state->{entries}{$filename}) &&
+ defined($state->{entries}{$filename}{tag_or_date}) &&
+ $state->{entries}{$filename}{tag_or_date} ne "" )
+ {
+ my($tagOrDate)=$state->{entries}{$filename}{tag_or_date};
+ if($tagOrDate=~/^T([^ ]+)\s*$/)
{
- next if ( $file->{filehash} eq "deleted" and not defined ( $state->{entries}{$file->{name}} ) );
- next unless ( $file->{name} =~ s/^$state->{prependdir}// );
- push @{$state->{args}}, $file->{name};
+ $result = { 'tag' => $1 };
}
+ elsif($tagOrDate=~/^D([0-9.]+)\s*$/)
+ {
+ $result= { 'date' => $1 };
+ }
+ else
+ {
+ die "Unknown tag_or_date format\n";
+ }
+ }
+ else
+ {
+ $result=getDirStickyInfo($filename);
}
+
+ return $result;
+}
+
+# Convert a stickyInfo (ref to a hash) as returned by resolveStickyInfo into
+# a form appropriate for the sticky tag field of an Entries
+# line (field index 5, 0-based).
+sub getStickyTagOrDate
+{
+ my($stickyInfo)=@_;
+
+ my $result;
+ if(defined($stickyInfo) && defined($stickyInfo->{tag}))
+ {
+ $result="T$stickyInfo->{tag}";
+ }
+ # TODO: When/if we actually pick versions by {date} properly,
+ # also handle it here:
+ # "D$stickyInfo->{date}" (example: "D2011.04.13.20.37.07").
+ else
+ {
+ $result="";
+ }
+
+ return $result;
}
# This method cleans up the $state variable after a command that uses arguments has run
sub statecleanup
{
$state->{files} = [];
+ $state->{dirArgs} = {};
$state->{args} = [];
$state->{arguments} = [];
$state->{entries} = {};
+ $state->{dirMap} = {};
}
# Return working directory CVS revision "1.X" out
return ( $filepart, $dirpart );
}
+# Cleanup various junk in filename (try to canonicalize it), and
+# add prependdir to accomodate running CVS client from a
+# subdirectory (so the output is relative to top directory of the project).
sub filecleanup
{
my $filename = shift;
return undef;
}
+ if($filename eq ".")
+ {
+ $filename="";
+ }
$filename =~ s/^\.\///g;
+ $filename =~ s%/+%/%g;
$filename = $state->{prependdir} . $filename;
+ $filename =~ s%/$%%;
return $filename;
}
+# Remove prependdir from the path, so that is is relative to the directory
+# the CVS client was started from, rather than the top of the project.
+# Essentially the inverse of filecleanup().
+sub remove_prependdir
+{
+ my($path) = @_;
+ if(defined($state->{prependdir}) && $state->{prependdir} ne "")
+ {
+ my($pre)=$state->{prependdir};
+ $pre=~s%/$%%;
+ if(!($path=~s%^\Q$pre\E/?%%))
+ {
+ $log->fatal("internal error missing prependdir");
+ die("internal error missing prependdir");
+ }
+ }
+ return $path;
+}
+
sub validateGitDir
{
if( !defined($state->{CVSROOT}) )
die "Git repo '$self->{git_path}' doesn't exist" unless ( -d $self->{git_path} );
+ # Stores full sha1's for various branch/tag names, abbreviations, etc:
+ $self->{commitRefCache} = {};
+
$self->{dbdriver} = $cfg->{gitcvs}{$state->{method}}{dbdriver} ||
$cfg->{gitcvs}{dbdriver} || "SQLite";
$self->{dbname} = $cfg->{gitcvs}{$state->{method}}{dbname} ||
push @git_log_params, $self->{module};
}
# git-rev-list is the backend / plumbing version of git-log
- open(GITLOG, '-|', 'git', 'rev-list', @git_log_params) or die "Cannot call git-rev-list: $!";
-
- my @commits;
-
- my %commit = ();
-
- while ( <GITLOG> )
- {
- chomp;
- if (m/^commit\s+(.*)$/) {
- # on ^commit lines put the just seen commit in the stack
- # and prime things for the next one
- if (keys %commit) {
- my %copy = %commit;
- unshift @commits, \%copy;
- %commit = ();
- }
- my @parents = split(m/\s+/, $1);
- $commit{hash} = shift @parents;
- $commit{parents} = \@parents;
- } elsif (m/^(\w+?):\s+(.*)$/ && !exists($commit{message})) {
- # on rfc822-like lines seen before we see any message,
- # lowercase the entry and put it in the hash as key-value
- $commit{lc($1)} = $2;
- } else {
- # message lines - skip initial empty line
- # and trim whitespace
- if (!exists($commit{message}) && m/^\s*$/) {
- # define it to mark the end of headers
- $commit{message} = '';
- next;
- }
- s/^\s+//; s/\s+$//; # trim ws
- $commit{message} .= $_ . "\n";
- }
- }
- close GITLOG;
-
- unshift @commits, \%commit if ( keys %commit );
+ open(my $gitLogPipe, '-|', 'git', 'rev-list', @git_log_params)
+ or die "Cannot call git-rev-list: $!";
+ my @commits=readCommits($gitLogPipe);
+ close $gitLogPipe;
# Now all the commits are in the @commits bucket
# ordered by time DESC. for each commit that needs processing,
}
# convert the date to CVS-happy format
- $commit->{date} = "$2 $1 $4 $3 $5" if ( $commit->{date} =~ /^\w+\s+(\w+)\s+(\d+)\s+(\d+:\d+:\d+)\s+(\d+)\s+([+-]\d+)$/ );
+ my $cvsDate = convertToCvsDate($commit->{date});
if ( defined ( $lastpicked ) )
{
while ( <FILELIST> )
{
chomp;
- unless ( /^:\d{6}\s+\d{3}(\d)\d{2}\s+[a-zA-Z0-9]{40}\s+([a-zA-Z0-9]{40})\s+(\w)$/o )
+ unless ( /^:\d{6}\s+([0-7]{6})\s+[a-f0-9]{40}\s+([a-f0-9]{40})\s+(\w)$/o )
{
die("Couldn't process git-diff-tree line : $_");
}
# $log->debug("File mode=$mode, hash=$hash, change=$change, name=$name");
- my $git_perms = "";
- $git_perms .= "r" if ( $mode & 4 );
- $git_perms .= "w" if ( $mode & 2 );
- $git_perms .= "x" if ( $mode & 1 );
- $git_perms = "rw" if ( $git_perms eq "" );
+ my $dbMode = convertToDbMode($mode);
if ( $change eq "D" )
{
revision => $head->{$name}{revision} + 1,
filehash => "deleted",
commithash => $commit->{hash},
- modified => $commit->{date},
+ modified => $cvsDate,
author => $commit->{author},
- mode => $git_perms,
+ mode => $dbMode,
};
- $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $commit->{date}, $commit->{author}, $git_perms);
+ $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $cvsDate, $commit->{author}, $dbMode);
}
elsif ( $change eq "M" || $change eq "T" )
{
revision => $head->{$name}{revision} + 1,
filehash => $hash,
commithash => $commit->{hash},
- modified => $commit->{date},
+ modified => $cvsDate,
author => $commit->{author},
- mode => $git_perms,
+ mode => $dbMode,
};
- $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $commit->{date}, $commit->{author}, $git_perms);
+ $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $cvsDate, $commit->{author}, $dbMode);
}
elsif ( $change eq "A" )
{
revision => $head->{$name}{revision} ? $head->{$name}{revision}+1 : 1,
filehash => $hash,
commithash => $commit->{hash},
- modified => $commit->{date},
+ modified => $cvsDate,
author => $commit->{author},
- mode => $git_perms,
+ mode => $dbMode,
};
- $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $commit->{date}, $commit->{author}, $git_perms);
+ $self->insert_rev($name, $head->{$name}{revision}, $hash, $commit->{hash}, $cvsDate, $commit->{author}, $dbMode);
}
else
{
die("Couldn't process git-ls-tree line : $_");
}
- my ( $git_perms, $git_type, $git_hash, $git_filename ) = ( $1, $2, $3, $4 );
+ my ( $mode, $git_type, $git_hash, $git_filename ) = ( $1, $2, $3, $4 );
$seen_files->{$git_filename} = 1;
$head->{$git_filename}{mode}
);
- if ( $git_perms =~ /^\d\d\d(\d)\d\d/o )
- {
- $git_perms = "";
- $git_perms .= "r" if ( $1 & 4 );
- $git_perms .= "w" if ( $1 & 2 );
- $git_perms .= "x" if ( $1 & 1 );
- } else {
- $git_perms = "rw";
- }
+ my $dbMode = convertToDbMode($mode);
# unless the file exists with the same hash, we need to update it ...
- unless ( defined($oldhash) and $oldhash eq $git_hash and defined($oldmode) and $oldmode eq $git_perms )
+ unless ( defined($oldhash) and $oldhash eq $git_hash and defined($oldmode) and $oldmode eq $dbMode )
{
my $newrevision = ( $oldrevision or 0 ) + 1;
revision => $newrevision,
filehash => $git_hash,
commithash => $commit->{hash},
- modified => $commit->{date},
+ modified => $cvsDate,
author => $commit->{author},
- mode => $git_perms,
+ mode => $dbMode,
};
- $self->insert_rev($git_filename, $newrevision, $git_hash, $commit->{hash}, $commit->{date}, $commit->{author}, $git_perms);
+ $self->insert_rev($git_filename, $newrevision, $git_hash, $commit->{hash}, $cvsDate, $commit->{author}, $dbMode);
}
}
close FILELIST;
$head->{$file}{revision}++;
$head->{$file}{filehash} = "deleted";
$head->{$file}{commithash} = $commit->{hash};
- $head->{$file}{modified} = $commit->{date};
+ $head->{$file}{modified} = $cvsDate;
$head->{$file}{author} = $commit->{author};
- $self->insert_rev($file, $head->{$file}{revision}, $head->{$file}{filehash}, $commit->{hash}, $commit->{date}, $commit->{author}, $head->{$file}{mode});
+ $self->insert_rev($file, $head->{$file}{revision}, $head->{$file}{filehash}, $commit->{hash}, $cvsDate, $commit->{author}, $head->{$file}{mode});
}
}
# END : "Detect deleted files"
);
}
# invalidate the gethead cache
- $self->{gethead_cache} = undef;
+ $self->clearCommitRefCaches();
# Ending exclusive lock here
$self->{dbh}->commit() or die "Failed to commit changes to SQLite";
}
+sub readCommits
+{
+ my $pipeHandle = shift;
+ my @commits;
+
+ my %commit = ();
+
+ while ( <$pipeHandle> )
+ {
+ chomp;
+ if (m/^commit\s+(.*)$/) {
+ # on ^commit lines put the just seen commit in the stack
+ # and prime things for the next one
+ if (keys %commit) {
+ my %copy = %commit;
+ unshift @commits, \%copy;
+ %commit = ();
+ }
+ my @parents = split(m/\s+/, $1);
+ $commit{hash} = shift @parents;
+ $commit{parents} = \@parents;
+ } elsif (m/^(\w+?):\s+(.*)$/ && !exists($commit{message})) {
+ # on rfc822-like lines seen before we see any message,
+ # lowercase the entry and put it in the hash as key-value
+ $commit{lc($1)} = $2;
+ } else {
+ # message lines - skip initial empty line
+ # and trim whitespace
+ if (!exists($commit{message}) && m/^\s*$/) {
+ # define it to mark the end of headers
+ $commit{message} = '';
+ next;
+ }
+ s/^\s+//; s/\s+$//; # trim ws
+ $commit{message} .= $_ . "\n";
+ }
+ }
+
+ unshift @commits, \%commit if ( keys %commit );
+
+ return @commits;
+}
+
+sub convertToCvsDate
+{
+ my $date = shift;
+ # Convert from: "git rev-list --pretty" formatted date
+ # Convert to: "the format specified by RFC822 as modified by RFC1123."
+ # Example: 26 May 1997 13:01:40 -0400
+ if( $date =~ /^\w+\s+(\w+)\s+(\d+)\s+(\d+:\d+:\d+)\s+(\d+)\s+([+-]\d+)$/ )
+ {
+ $date = "$2 $1 $4 $3 $5";
+ }
+
+ return $date;
+}
+
+sub convertToDbMode
+{
+ my $mode = shift;
+
+ # NOTE: The CVS protocol uses a string similar "u=rw,g=rw,o=rw",
+ # but the database "mode" column historically (and currently)
+ # only stores the "rw" (for user) part of the string.
+ # FUTURE: It might make more sense to persist the raw
+ # octal mode (or perhaps the final full CVS form) instead of
+ # this half-converted form, but it isn't currently worth the
+ # backwards compatibility headaches.
+
+ $mode=~/^\d\d(\d)\d{3}$/;
+ my $userBits=$1;
+
+ my $dbMode = "";
+ $dbMode .= "r" if ( $userBits & 4 );
+ $dbMode .= "w" if ( $userBits & 2 );
+ $dbMode .= "x" if ( $userBits & 1 );
+ $dbMode = "rw" if ( $dbMode eq "" );
+
+ return $dbMode;
+}
+
sub insert_rev
{
my $self = shift;
return $tree;
}
+=head2 getAnyHead
+
+Returns a reference to an array of getmeta structures, one
+per file in the specified tree hash.
+
+=cut
+
+sub getAnyHead
+{
+ my ($self,$hash) = @_;
+
+ if(!defined($hash))
+ {
+ return $self->gethead();
+ }
+
+ my @files;
+ {
+ open(my $filePipe, '-|', 'git', 'ls-tree', '-z', '-r', $hash)
+ or die("Cannot call git-ls-tree : $!");
+ local $/ = "\0";
+ @files=<$filePipe>;
+ close $filePipe;
+ }
+
+ my $tree=[];
+ my($line);
+ foreach $line (@files)
+ {
+ $line=~s/\0$//;
+ unless ( $line=~/^(\d+)\s+(\w+)\s+([a-zA-Z0-9]+)\t(.*)$/o )
+ {
+ die("Couldn't process git-ls-tree line : $_");
+ }
+
+ my($mode, $git_type, $git_hash, $git_filename) = ($1, $2, $3, $4);
+ push @$tree, $self->getMetaFromCommithash($git_filename,$hash);
+ }
+
+ return $tree;
+}
+
+=head2 getRevisionDirMap
+
+A "revision dir map" contains all the plain-file filenames associated
+with a particular revision (treeish), organized by directory:
+
+ $type = $out->{$dir}{$fullName}
+
+The type of each is "F" (for ordinary file) or "D" (for directory,
+for which the map $out->{$fullName} will also exist).
+
+=cut
+
+sub getRevisionDirMap
+{
+ my ($self,$ver)=@_;
+
+ if(!defined($self->{revisionDirMapCache}))
+ {
+ $self->{revisionDirMapCache}={};
+ }
+
+ # Get file list (previously cached results are dependent on HEAD,
+ # but are early in each case):
+ my $cacheKey;
+ my (@fileList);
+ if( !defined($ver) || $ver eq "" )
+ {
+ $cacheKey="";
+ if( defined($self->{revisionDirMapCache}{$cacheKey}) )
+ {
+ return $self->{revisionDirMapCache}{$cacheKey};
+ }
+
+ my @head = @{$self->gethead()};
+ foreach my $file ( @head )
+ {
+ next if ( $file->{filehash} eq "deleted" );
+
+ push @fileList,$file->{name};
+ }
+ }
+ else
+ {
+ my ($hash)=$self->lookupCommitRef($ver);
+ if( !defined($hash) )
+ {
+ return undef;
+ }
+
+ $cacheKey=$hash;
+ if( defined($self->{revisionDirMapCache}{$cacheKey}) )
+ {
+ return $self->{revisionDirMapCache}{$cacheKey};
+ }
+
+ open(my $filePipe, '-|', 'git', 'ls-tree', '-z', '-r', $hash)
+ or die("Cannot call git-ls-tree : $!");
+ local $/ = "\0";
+ while ( <$filePipe> )
+ {
+ chomp;
+ unless ( /^(\d+)\s+(\w+)\s+([a-zA-Z0-9]+)\t(.*)$/o )
+ {
+ die("Couldn't process git-ls-tree line : $_");
+ }
+
+ my($mode, $git_type, $git_hash, $git_filename) = ($1, $2, $3, $4);
+
+ push @fileList, $git_filename;
+ }
+ close $filePipe;
+ }
+
+ # Convert to normalized form:
+ my %revMap;
+ my $file;
+ foreach $file (@fileList)
+ {
+ my($dir) = ($file=~m%^(?:(.*)/)?([^/]*)$%);
+ $dir='' if(!defined($dir));
+
+ # parent directories:
+ # ... create empty dir maps for parent dirs:
+ my($td)=$dir;
+ while(!defined($revMap{$td}))
+ {
+ $revMap{$td}={};
+
+ my($tp)=($td=~m%^(?:(.*)/)?([^/]*)$%);
+ $tp='' if(!defined($tp));
+ $td=$tp;
+ }
+ # ... add children to parent maps (now that they exist):
+ $td=$dir;
+ while($td ne "")
+ {
+ my($tp)=($td=~m%^(?:(.*)/)?([^/]*)$%);
+ $tp='' if(!defined($tp));
+
+ if(defined($revMap{$tp}{$td}))
+ {
+ if($revMap{$tp}{$td} ne 'D')
+ {
+ die "Weird file/directory inconsistency in $cacheKey";
+ }
+ last; # loop exit
+ }
+ $revMap{$tp}{$td}='D';
+
+ $td=$tp;
+ }
+
+ # file
+ $revMap{$dir}{$file}='F';
+ }
+
+ # Save in cache:
+ $self->{revisionDirMapCache}{$cacheKey}=\%revMap;
+ return $self->{revisionDirMapCache}{$cacheKey};
+}
+
=head2 getlog
See also gethistorydense().
This function takes a filename (with path) argument and returns a hashref of
metadata for that file.
+There are several ways $revision can be specified:
+
+ - A reference to hash that contains a "tag" that is the
+ actual revision (one of the below). TODO: Also allow it to
+ specify a "date" in the hash.
+ - undef, to refer to the latest version on the main branch.
+ - Full CVS client revision number (mapped to integer in DB, without the
+ "1." prefix),
+ - Complex CVS-compatible "special" revision number for
+ non-linear history (see comment below)
+ - git commit sha1 hash
+ - branch or tag name
+
=cut
sub getmeta
my $tablename_rev = $self->tablename("revision");
my $tablename_head = $self->tablename("head");
- my $db_query;
- if ( defined($revision) and $revision =~ /^1\.(\d+)$/ )
+ if ( ref($revision) eq "HASH" )
{
- my ($intRev) = $1;
- $db_query = $self->{dbh}->prepare_cached("SELECT * FROM $tablename_rev WHERE name=? AND revision=?",{},1);
- $db_query->execute($filename, $intRev);
+ $revision = $revision->{tag};
}
- elsif ( defined($revision) and $revision =~ /^[a-zA-Z0-9]{40}$/ )
+
+ # Overview of CVS revision numbers:
+ #
+ # General CVS numbering scheme:
+ # - Basic mainline branch numbers: "1.1", "1.2", "1.3", etc.
+ # - Result of "cvs checkin -r" (possible, but not really
+ # recommended): "2.1", "2.2", etc
+ # - Branch tag: "1.2.0.n", where "1.2" is revision it was branched
+ # from, "0" is a magic placeholder that identifies it as a
+ # branch tag instead of a version tag, and n is 2 times the
+ # branch number off of "1.2", starting with "2".
+ # - Version on a branch: "1.2.n.x", where "1.2" is branch-from, "n"
+ # is branch number off of "1.2" (like n above), and "x" is
+ # the version number on the branch.
+ # - Branches can branch off of branches: "1.3.2.7.4.1" (even number
+ # of components).
+ # - Odd "n"s are used by "vendor branches" that result
+ # from "cvs import". Vendor branches have additional
+ # strangeness in the sense that the main rcs "head" of the main
+ # branch will (temporarily until first normal commit) point
+ # to the version on the vendor branch, rather than the actual
+ # main branch. (FUTURE: This may provide an opportunity
+ # to use "strange" revision numbers for fast-forward-merged
+ # branch tip when CVS client is asking for the main branch.)
+ #
+ # git-cvsserver CVS-compatible special numbering schemes:
+ # - Currently git-cvsserver only tries to be identical to CVS for
+ # simple "1.x" numbers on the "main" branch (as identified
+ # by the module name that was originally cvs checkout'ed).
+ # - The database only stores the "x" part, for historical reasons.
+ # But most of the rest of the cvsserver preserves
+ # and thinks using the full revision number.
+ # - To handle non-linear history, it uses a version of the form
+ # "2.1.1.2000.b.b.b."..., where the 2.1.1.2000 is to help uniquely
+ # identify this as a special revision number, and there are
+ # 20 b's that together encode the sha1 git commit from which
+ # this version of this file originated. Each b is
+ # the numerical value of the corresponding byte plus
+ # 100.
+ # - "plus 100" avoids "0"s, and also reduces the
+ # likelyhood of a collision in the case that someone someday
+ # writes an import tool that tries to preserve original
+ # CVS revision numbers, and the original CVS data had done
+ # lots of branches off of branches and other strangeness to
+ # end up with a real version number that just happens to look
+ # like this special revision number form. Also, if needed
+ # there are several ways to extend/identify alternative encodings
+ # within the "2.1.1.2000" part if necessary.
+ # - Unlike real CVS revisions, you can't really reconstruct what
+ # relation a revision of this form has to other revisions.
+ # - FUTURE: TODO: Rework database somehow to make up and remember
+ # fully-CVS-compatible branches and branch version numbers.
+
+ my $meta;
+ if ( defined($revision) )
{
- $db_query = $self->{dbh}->prepare_cached("SELECT * FROM $tablename_rev WHERE name=? AND commithash=?",{},1);
- $db_query->execute($filename, $revision);
- } else {
- $db_query = $self->{dbh}->prepare_cached("SELECT * FROM $tablename_head WHERE name=?",{},1);
+ if ( $revision =~ /^1\.(\d+)$/ )
+ {
+ my ($intRev) = $1;
+ my $db_query;
+ $db_query = $self->{dbh}->prepare_cached(
+ "SELECT * FROM $tablename_rev WHERE name=? AND revision=?",
+ {},1);
+ $db_query->execute($filename, $intRev);
+ $meta = $db_query->fetchrow_hashref;
+ }
+ elsif ( $revision =~ /^2\.1\.1\.2000(\.[1-3][0-9][0-9]){20}$/ )
+ {
+ my ($commitHash)=($revision=~/^2\.1\.1\.2000(.*)$/);
+ $commitHash=~s/\.([0-9]+)/sprintf("%02x",$1-100)/eg;
+ if($commitHash=~/^[0-9a-f]{40}$/)
+ {
+ return $self->getMetaFromCommithash($filename,$commitHash);
+ }
+
+ # error recovery: fall back on head version below
+ print "E Failed to find $filename version=$revision or commit=$commitHash\n";
+ $log->warning("failed get $revision with commithash=$commitHash");
+ undef $revision;
+ }
+ elsif ( $revision =~ /^[0-9a-f]{40}$/ )
+ {
+ # Try DB first. This is mostly only useful for req_annotate(),
+ # which only calls this for stuff that should already be in
+ # the DB. It is fairly likely to be a waste of time
+ # in most other cases [unless the file happened to be
+ # modified in $revision specifically], but
+ # it is probably in the noise compared to how long
+ # getMetaFromCommithash() will take.
+ my $db_query;
+ $db_query = $self->{dbh}->prepare_cached(
+ "SELECT * FROM $tablename_rev WHERE name=? AND commithash=?",
+ {},1);
+ $db_query->execute($filename, $revision);
+ $meta = $db_query->fetchrow_hashref;
+
+ if(! $meta)
+ {
+ my($revCommit)=$self->lookupCommitRef($revision);
+ if($revCommit=~/^[0-9a-f]{40}$/)
+ {
+ return $self->getMetaFromCommithash($filename,$revCommit);
+ }
+
+ # error recovery: nothing found:
+ print "E Failed to find $filename version=$revision\n";
+ $log->warning("failed get $revision");
+ return $meta;
+ }
+ }
+ else
+ {
+ my($revCommit)=$self->lookupCommitRef($revision);
+ if($revCommit=~/^[0-9a-f]{40}$/)
+ {
+ return $self->getMetaFromCommithash($filename,$revCommit);
+ }
+
+ # error recovery: fall back on head version below
+ print "E Failed to find $filename version=$revision\n";
+ $log->warning("failed get $revision");
+ undef $revision; # Allow fallback
+ }
+ }
+
+ if(!defined($revision))
+ {
+ my $db_query;
+ $db_query = $self->{dbh}->prepare_cached(
+ "SELECT * FROM $tablename_head WHERE name=?",{},1);
$db_query->execute($filename);
+ $meta = $db_query->fetchrow_hashref;
}
- my $meta = $db_query->fetchrow_hashref;
if($meta)
{
$meta->{revision} = "1.$meta->{revision}";
return $meta;
}
+sub getMetaFromCommithash
+{
+ my $self = shift;
+ my $filename = shift;
+ my $revCommit = shift;
+
+ # NOTE: This function doesn't scale well (lots of forks), especially
+ # if you have many files that have not been modified for many commits
+ # (each git-rev-parse redoes a lot of work for each file
+ # that theoretically could be done in parallel by smarter
+ # graph traversal).
+ #
+ # TODO: Possible optimization strategies:
+ # - Solve the issue of assigning and remembering "real" CVS
+ # revision numbers for branches, and ensure the
+ # data structure can do this efficiently. Perhaps something
+ # similar to "git notes", and carefully structured to take
+ # advantage same-sha1-is-same-contents, to roll the same
+ # unmodified subdirectory data onto multiple commits?
+ # - Write and use a C tool that is like git-blame, but
+ # operates on multiple files with file granularity, instead
+ # of one file with line granularity. Cache
+ # most-recently-modified in $self->{commitRefCache}{$revCommit}.
+ # Try to be intelligent about how many files we do with
+ # one fork (perhaps one directory at a time, without recursion,
+ # and/or include directory as one line item, recurse from here
+ # instead of in C tool?).
+ # - Perhaps we could ask the DB for (filename,fileHash),
+ # and just guess that it is correct (that the file hadn't
+ # changed between $revCommit and the found commit, then
+ # changed back, confusing anything trying to interpret
+ # history). Probably need to add another index to revisions
+ # DB table for this.
+ # - NOTE: Trying to store all (commit,file) keys in DB [to
+ # find "lastModfiedCommit] (instead of
+ # just files that changed in each commit as we do now) is
+ # probably not practical from a disk space perspective.
+
+ # Does the file exist in $revCommit?
+ # TODO: Include file hash in dirmap cache.
+ my($dirMap)=$self->getRevisionDirMap($revCommit);
+ my($dir,$file)=($filename=~m%^(?:(.*)/)?([^/]*$)%);
+ if(!defined($dir))
+ {
+ $dir="";
+ }
+ if( !defined($dirMap->{$dir}) ||
+ !defined($dirMap->{$dir}{$filename}) )
+ {
+ my($fileHash)="deleted";
+
+ my($retVal)={};
+ $retVal->{name}=$filename;
+ $retVal->{filehash}=$fileHash;
+
+ # not needed and difficult to compute:
+ $retVal->{revision}="0"; # $revision;
+ $retVal->{commithash}=$revCommit;
+ #$retVal->{author}=$commit->{author};
+ #$retVal->{modified}=convertToCvsDate($commit->{date});
+ #$retVal->{mode}=convertToDbMode($mode);
+
+ return $retVal;
+ }
+
+ my($fileHash)=safe_pipe_capture("git","rev-parse","$revCommit:$filename");
+ chomp $fileHash;
+ if(!($fileHash=~/^[0-9a-f]{40}$/))
+ {
+ die "Invalid fileHash '$fileHash' looking up"
+ ." '$revCommit:$filename'\n";
+ }
+
+ # information about most recent commit to modify $filename:
+ open(my $gitLogPipe, '-|', 'git', 'rev-list',
+ '--max-count=1', '--pretty', '--parents',
+ $revCommit, '--', $filename)
+ or die "Cannot call git-rev-list: $!";
+ my @commits=readCommits($gitLogPipe);
+ close $gitLogPipe;
+ if(scalar(@commits)!=1)
+ {
+ die "Can't find most recent commit changing $filename\n";
+ }
+ my($commit)=$commits[0];
+ if( !defined($commit) || !defined($commit->{hash}) )
+ {
+ return undef;
+ }
+
+ # does this (commit,file) have a real assigned CVS revision number?
+ my $tablename_rev = $self->tablename("revision");
+ my $db_query;
+ $db_query = $self->{dbh}->prepare_cached(
+ "SELECT * FROM $tablename_rev WHERE name=? AND commithash=?",
+ {},1);
+ $db_query->execute($filename, $commit->{hash});
+ my($meta)=$db_query->fetchrow_hashref;
+ if($meta)
+ {
+ $meta->{revision} = "1.$meta->{revision}";
+ return $meta;
+ }
+
+ # fall back on special revision number
+ my($revision)=$commit->{hash};
+ $revision=~s/(..)/'.' . (hex($1)+100)/eg;
+ $revision="2.1.1.2000$revision";
+
+ # meta data about $filename:
+ open(my $filePipe, '-|', 'git', 'ls-tree', '-z',
+ $commit->{hash}, '--', $filename)
+ or die("Cannot call git-ls-tree : $!");
+ local $/ = "\0";
+ my $line;
+ $line=<$filePipe>;
+ if(defined(<$filePipe>))
+ {
+ die "Expected only a single file for git-ls-tree $filename\n";
+ }
+ close $filePipe;
+
+ chomp $line;
+ unless ( $line=~m/^(\d+)\s+(\w+)\s+([a-zA-Z0-9]+)\t(.*)$/o )
+ {
+ die("Couldn't process git-ls-tree line : $line\n");
+ }
+ my ( $mode, $git_type, $git_hash, $git_filename ) = ( $1, $2, $3, $4 );
+
+ # save result:
+ my($retVal)={};
+ $retVal->{name}=$filename;
+ $retVal->{revision}=$revision;
+ $retVal->{filehash}=$fileHash;
+ $retVal->{commithash}=$revCommit;
+ $retVal->{author}=$commit->{author};
+ $retVal->{modified}=convertToCvsDate($commit->{date});
+ $retVal->{mode}=convertToDbMode($mode);
+
+ return $retVal;
+}
+
+=head2 lookupCommitRef
+
+Convert tag/branch/abbreviation/etc into a commit sha1 hash. Caches
+the result so looking it up again is fast.
+
+=cut
+
+sub lookupCommitRef
+{
+ my $self = shift;
+ my $ref = shift;
+
+ my $commitHash = $self->{commitRefCache}{$ref};
+ if(defined($commitHash))
+ {
+ return $commitHash;
+ }
+
+ $commitHash=safe_pipe_capture("git","rev-parse","--verify","--quiet",
+ $self->unescapeRefName($ref));
+ $commitHash=~s/\s*$//;
+ if(!($commitHash=~/^[0-9a-f]{40}$/))
+ {
+ $commitHash=undef;
+ }
+
+ if( defined($commitHash) )
+ {
+ my $type=safe_pipe_capture("git","cat-file","-t",$commitHash);
+ if( ! ($type=~/^commit\s*$/ ) )
+ {
+ $commitHash=undef;
+ }
+ }
+ if(defined($commitHash))
+ {
+ $self->{commitRefCache}{$ref}=$commitHash;
+ }
+ return $commitHash;
+}
+
+=head2 clearCommitRefCaches
+
+Clears cached commit cache (sha1's for various tags/abbeviations/etc),
+and related caches.
+
+=cut
+
+sub clearCommitRefCaches
+{
+ my $self = shift;
+ $self->{commitRefCache} = {};
+ $self->{revisionDirMapCache} = undef;
+ $self->{gethead_cache} = undef;
+}
+
=head2 commitmessage
this function takes a commithash and returns the commit message for that commit
return $result;
}
+=head2 escapeRefName
+
+Apply an escape mechanism to compensate for characters that
+git ref names can have that CVS tags can not.
+
+=cut
+sub escapeRefName
+{
+ my($self,$refName)=@_;
+
+ # CVS officially only allows [-_A-Za-z0-9] in tag names (or in
+ # many contexts it can also be a CVS revision number).
+ #
+ # Git tags commonly use '/' and '.' as well, but also handle
+ # anything else just in case:
+ #
+ # = "_-s-" For '/'.
+ # = "_-p-" For '.'.
+ # = "_-u-" For underscore, in case someone wants a literal "_-" in
+ # a tag name.
+ # = "_-xx-" Where "xx" is the hexadecimal representation of the
+ # desired ASCII character byte. (for anything else)
+
+ if(! $refName=~/^[1-9][0-9]*(\.[1-9][0-9]*)*$/)
+ {
+ $refName=~s/_-/_-u--/g;
+ $refName=~s/\./_-p-/g;
+ $refName=~s%/%_-s-%g;
+ $refName=~s/[^-_a-zA-Z0-9]/sprintf("_-%02x-",$1)/eg;
+ }
+}
+
+=head2 unescapeRefName
+
+Undo an escape mechanism to compensate for characters that
+git ref names can have that CVS tags can not.
+
+=cut
+sub unescapeRefName
+{
+ my($self,$refName)=@_;
+
+ # see escapeRefName() for description of escape mechanism.
+
+ $refName=~s/_-([spu]|[0-9a-f][0-9a-f])-/unescapeRefNameChar($1)/eg;
+
+ # allowed tag names
+ # TODO: Perhaps use git check-ref-format, with an in-process cache of
+ # validated names?
+ if( !( $refName=~m%^[^-][-a-zA-Z0-9_/.]*$% ) ||
+ ( $refName=~m%[/.]$% ) ||
+ ( $refName=~/\.lock$/ ) ||
+ ( $refName=~m%\.\.|/\.|[[\\:?*~]|\@\{% ) ) # matching }
+ {
+ # Error:
+ $log->warn("illegal refName: $refName");
+ $refName=undef;
+ }
+ return $refName;
+}
+
+sub unescapeRefNameChar
+{
+ my($char)=@_;
+
+ if($char eq "s")
+ {
+ $char="/";
+ }
+ elsif($char eq "p")
+ {
+ $char=".";
+ }
+ elsif($char eq "u")
+ {
+ $char="_";
+ }
+ elsif($char=~/^[0-9a-f][0-9a-f]$/)
+ {
+ $char=chr(hex($char));
+ }
+ else
+ {
+ # Error case: Maybe it has come straight from user, and
+ # wasn't supposed to be escaped? Restore it the way we got it:
+ $char="_-$char-";
+ }
+
+ return $char;
+}
+
=head2 in_array()
from Array::PAT - mimics the in_array() function