package VCP::Rev ; =head1 NAME VCP::Rev - VCP's concept of a revision =head1 SYNOPSIS =head1 DESCRIPTION =head1 METHODS =over =cut $VERSION = 1 ; use strict ; use Carp ; use VCP::Debug ':debug' ; use vars qw( %FIELDS ) ; use fields ( ## RevML fields: 'NAME', ## The file name, relative to REV_ROOT 'TYPE', ## Type. Binary/text. Need to stdize the values here 'REV_ID', ## The source repositories unique ID for this revision 'CHANGE_ID', ## The unique ID for the change set, if any 'P4_INFO', ## p4-specific info. 'CVS_INFO', ## cvs-specific info. 'STATE', ## The state (CVS specific at the moment). 'TIME', ## The commit/submit time, if available, as a simple number 'MOD_TIME', ## The last modification time, if available 'USER_ID', ## The submitter/commiter of the revision 'LABELS', ## A HASH, keys are tags/labels assoc. with this rev. 'COMMENT', ## The comment/message for this rev. 'ACTION', ## What was done ('edit', 'move', 'delete', etc.) 'BASE_REV_ID', ## Internal fields: used by VCP::* modules, but not present in RevML files. 'WORK_PATH', ## Where to find the revision on the local filesys 'DEST_WORK_PATH', ## Where to find the rev on local fs if it was backfilled 'SOURCE_NAME', ## The non-normalized name of the file, meaningful only to ## a specific VCP::Source 'SORT_KEY', ## An ARRAY of ARRAYs of the fields and segments to sort by ) ; BEGIN { ## Define accessors. for ( keys %FIELDS ) { next if $_ eq 'WORK_PATH' ; next if $_ eq 'DEST_WORK_PATH' ; my $f = lc( $_ ) ; if ( $f eq 'labels' ) { eval qq{ sub $f { my VCP::Rev \$self = shift ; if ( \@_ ) { \$self->{$_} = {} ; \@{\$self->{$_}}{\@_} = (undef) x \@_ ; } return \$self->{$_} ? sort keys \%{\$self->{$_}} : () ; } } ; } else { eval qq{ sub $f { my VCP::Rev \$self = shift ; confess "too many parameters passed" if \@_ > 1 ; \$self->{$_} = shift if \@_ == 1 ; return \$self->{$_} ; } } ; } die $@ if $@ ; } } ## We never, ever want to delete a file that has revs referring to it. ## So, we put a cleanup object in %files_to_delete and manually manage a ## reference count on it. The hash is keyed on filename and contains ## a count value. When the count reaches 0, it is cleaned. We add a warning ## about undeleted files, which is a great PITA. The reason there's a ## warning is that we could be using gobs of disk space for temporary files ## if there's some bug preventing VCP::Rev objects from being DESTROYed ## soon enough. It's a PITA because it means that the source and ## destination object really must be dereferenced ASAP, so their SEEN ## arrays get cleaned up, and every once in awhile I screw it up somehow. my %files_to_delete ; END { if ( debugging ) { for ( sort keys %files_to_delete ) { if ( -e $_ ) { warn "$_ not deleted" ; } } } } =item new Creates an instance, see subclasses for options. my VCP::Rev $rev = VCP::Rev->new( name => 'foo', time => $commit_time, ... ) ; =cut sub new { my $class = shift ; $class = ref $class || $class ; my VCP::Rev $self ; { no strict 'refs' ; $self = bless [ \%{"$class\::FIELDS"} ], $class ; } while ( @_ ) { my $key = shift ; $self->{uc($key)} = shift ; } if ( $self->{LABELS} ) { $self->labels( @{$self->{LABELS}} ) if ref $self->{LABELS} eq "ARRAY" ; } else { $self->{LABELS} = {} unless $self->{LABELS} ; } return $self ; } =item is_base_rev Returns TRUE if this is a base revision. This is the case if no action is defined. A base revision is a revision that is being transferred merely to check it's contents against the destination repository's contents. It's usually a digest and the actual bosy of the revision is 'backfilled' from the destination repository and checked against the digest. This cuts down on transfer size, since the full body of the file never need be sent with incremental updates. See L<VCP::Dest/backfill> as well. =cut sub is_base_rev { my VCP::Rev $self = shift ; return ! defined $self->{ACTION} ; } =item work_path, dest_work_path These set/get the name of the working file for sources and destinations, respectively. These files are automatically cleaned up when all VCP::Rev instances that refer to them are DESTROYED or have their work_path or dest_work_path set to other files or undef. =cut sub _set_work_path { my VCP::Rev $self = shift ; my ( $field, $fn ) = @_ ; my $doomed = $self->{$field} ; if ( defined $doomed && $files_to_delete{$doomed} && --$files_to_delete{$doomed} < 1 && -e $doomed ) { if ( debugging $self ) { my @details ; my $i = 2 ; do { @details = caller(2) } until $details[0] ne __PACKAGE__ ; debug "vcp: $self unlinking '$doomed' in " . join( '|', @details[0,1,2,3]) ; } unlink $doomed or warn "$! unlinking $doomed\n" unless $ENV{VCPNODELETE}; } $self->{$field} = $fn ; ++$files_to_delete{$self->{$field}} if defined $self->{$field} ; } sub work_path { my VCP::Rev $self = shift ; confess "too many parameters passed" if @_ > 1 ; $self->_set_work_path( 'WORK_PATH', @_ ) if @_ ; return $self->{WORK_PATH} ; } sub dest_work_path { my VCP::Rev $self = shift ; confess "too many parameters passed" if @_ > 1 ; $self->_set_work_path( 'DEST_WORK_PATH', @_ ) if @_ ; return $self->{DEST_WORK_PATH} ; } =item labels $r->labels( @labels ) ; @labels = $r->labels ; Sets/gets labels associated with a revision. If a label is applied multiple times, it will only be returned once. This feature means that the automatic label generation code for r_... revision and ch_... change labels won't add additional copies of labels that were already applied to this revision in the source repository. Returns labels in an unpredictible order, which happens to be sorted for now. This sorting is purely for logging purposes and may disappear at any moment. =item add_label $r->add_label( $label ) ; $r->add_label( @labels ) ; Marks one or more labels as being associated with this revision of a file. =cut sub add_label { my VCP::Rev $self = shift ; @{$self->{LABELS}}{@_} = (undef) x @_ ; return ; } sub as_string { my VCP::Rev $self = shift ; my @v = map( defined $_ ? $_ : "<undef>", $self->is_base_rev ? map $self->$_(), qw( name rev_id change_id type ) : map( $_ eq 'time' ? scalar localtime $self->$_() : $self->$_(), qw(name rev_id change_id type action time user_id ) ) ) ; return $self->is_base_rev ? sprintf( "%s#%s @%s (%s) -- base rev --", @v ) : sprintf( "%s#%s @%s (%s) %s %s %s", @v ) ; } sub DESTROY { my VCP::Rev $self = shift ; $self->work_path( undef ) ; $self->dest_work_path( undef ) ; my $doomed = $self->work_path ; if ( defined $doomed && -e $doomed ) { debug "vcp: $self unlinking '$doomed'" if debugging $self ; unlink $doomed or warn "$! unlinking $doomed\n" unless $ENV{VCPNODELETE}; } } =back =head1 SUBCLASSING This class uses the fields pragma, so you'll need to use base and possibly fields in any subclasses. =head1 COPYRIGHT Copyright 2000, Perforce Software, Inc. All Rights Reserved. This module and the VCP package are licensed according to the terms given in the file LICENSE accompanying this distribution, a copy of which is included in L<vcp>. =head1 AUTHOR Barrie Slaymaker <barries@slaysys.com> =cut 1
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 1375 | Sean McCune | Creating my own branch for work on vcp. | ||
//guest/perforce_software/revml/lib/VCP/Rev.pm | |||||
#9 | 1358 | Barrie Slaymaker | Win32 changes | ||
#8 | 1055 | Barrie Slaymaker |
add sorting, revamp test suite, misc cleanup. Dest/revml is not portable off my system yet (need to release ...::Diff) |
||
#7 | 628 | Barrie Slaymaker | Cleaned up POD in bin/vcp, added BSD-style license. | ||
#6 | 620 | Barrie Slaymaker |
Underscorify CVS tags, only warn about undeleted files if debugging. |
||
#5 | 608 | Barrie Slaymaker |
Lots of changes to get vcp to install better, now up to 0.066. Many thanks to Matthew Attaway for testing & suggestions. |
||
#4 | 480 | Barrie Slaymaker |
0.06 Wed Dec 20 23:19:15 EST 2000 - bin/vcp: Added --versions, which loads all modules and checks them for a $VERSION and print the results out. This should help with diagnosing out-of-sync modules. - Added $VERSION vars to a few modules :-). Forgot to increment any $VERSION strings. - VCP::Dest::cvs: The directory "deeply" was not being `cvs add`ed on paths like "a/deeply/nested/file", assuming "deeply" had no files in it. - VCP::Dest::revml: fixed a bug that was causing files with a lot of linefeeds to be emitted in base64 instead of deltaed. This means most text files. - Various minor cleanups of diagnostics and error messages, including exposing "Can't locate Foo.pm" when a VCP::Source or VCP::Dest module depends on a module that's not installed, as reported by Jeff Anton. |
||
#3 | 478 | Barrie Slaymaker |
0.05 Mon Dec 18 07:27:53 EST 2000 - Use `p4 labels //...@label` command as per Rober Cowham's suggestion, with the '-s' flag recommended by Christopher Siewald and Amaury.FORGEOTDARC@atsm.fr. Though it's actually something like vcp: running /usr/bin/p4 -u safari -c safari -p localhost:5666 -s files //.../NtLkly //...@compiler_a3 //.../NtLkly //...@compiler_may3 and so //on //for 50 parameters to get the speed up. I use the //.../NtLkly "file" as //a separator between the lists of files in various //revisions. Hope nobody has any files named that :-). What I should do is choose a random label that doesn't occur in the labels list, I guess. - VCP::Source::revml and VCP::Dest::revml are now binary, control code, and "hibit ASCII" (I know, that's an oxymoron) clean. The <comment>, <delta>, and <content> elements now escape anything other than tab, line feed, space, or printable chars (32 <= c <= ASCII 126) using a tag like '<char code="0x09">'. The test suite tests all this. Filenames should also be escaped this way, but I didn't get to that. - The decision whether to do deltas or encode the content in base64 is now based on how many characters would need to be escaped. - We now depend on the users' diff program to have a "-a" option to force it to diff even if the files look binary to it. I need to use Diff.pm and adapt it for use on binary data. - VCP::Dest::cvs now makes sure that no two consecutive revisions of the same file have the same mod_time. VCP::Source::p4 got so fast at pulling revisions from the repositories the test suite sets up that CVS was not noticing that files had changed. - VCP::Plugin now allows you to set a list of acceptable result codes, since we now use p4 in ways that make it return non-zero result codes. - VCP::Revs now croaks if you try to add two entries of the same VCP::Rev (ie matching filename and rev_id). - The <type> tag is now limited to "text" or "binary", and is meant to pass that level of info between foreign repositories. - The <p4_info> on each file now carries the one line p4 description of the file so that p4->p4 transferes can pick out the more detailed info. VCP::Source::p4, VCP::Dest::p4 do this. - VCP::{Source,Dest}::{p4,cvs} now set binaryness on added files properly, I think. For p4->p4, the native p4 type is preserved. For CVS sources, seeing the keyword substitution flag 'o' or 'b' implies binaryness, for p4, seeing a filetype like qr/u?x?binary/ or qr/x?tempobj/ or "resource" implies binaryness (to non-p4 destinations). NOTE: Seeing a 'o' or 'b' in a CVS source only ends up setting the 'b' option on the destination. That should be ok for most uses, but we can make it smarter for cvs->cvs transfers if need be. |
||
#2 | 468 | Barrie Slaymaker |
- VCP::Dest::p4 now does change number aggregation based on the comment field changing or whenever a new revision of a file with unsubmitted changes shows up on the input stream. Since revisions of files are normally sorted in time order, this should work in a number of cases. I'm sure we'll need to generalize it, perhaps with a time thresholding function. - t/90cvs.t now tests cvs->p4 replication. - VCP::Dest::p4 now doesn't try to `p4 submit` when no changes are pending. - VCP::Rev now prevents the same label from being applied twice to a revision. This was occuring because the "r_1"-style label that gets added to a target revision by VCP::Dest::p4 could duplicate a label "r_1" that happened to already be on a revision. - Added t/00rev.t, the beginnings of a test suite for VCP::Rev. - Tweaked bin/gentrevml to comment revisions with their change number instead of using a unique comment for every revision for non-p4 t/test-*-in-0.revml files. This was necessary to test cvs->p4 functionality. |
||
#1 | 467 | Barrie Slaymaker | Version 0.01, initial checkin in perforce public depot. |