blib/lib/Net/FTP/Versioning.pm untested

filter: Statementstmt 0.0% 0 / 105 Branchbran 0.0% 0 / 38 Conditioncond 0.0% 0 / 15 MC/DCmcdc 0.0% 0 / 10 Subroutinesub 0.0% 0 / 14 Podpod 0.0% 0 / 8 totaltotal 0.0% 0 / 190 CC 20 SCAR 39.0
CC
20
Cov
0%
_rotate_file
110.0
put
42.0
get
42.0
CRAP 49.3
1 package Net::FTP::Versioning;
2 use strict;
3 require 5.001;
4 use Net::FTP;
5 use vars qw(@ISA $VERSION);
6 use Carp;
7 @ISA = ("Net::FTP");
8 $VERSION = "0.01";
9  
10 sub new {
11 my $classname = shift;
12 my $self = $classname->SUPER::new(@_);
13 $self->_init(@_);
14 return $self;
15 }
16 sub _init {
17 my $self = shift;
18 ${*$self}->{net_ftp_versioning_transfertime} = undef;
19 }
20 sub _setTransferTime { # returns: nothing
21 my $self = shift;
22 ${*$self}->{net_ftp_versioning_transfertime} = shift;
23 }
24 sub transferTime { # returns: Integer: the transfer time in seconds
25 my $self = shift;
26 my $seconds = ${*$self}->{net_ftp_versioning_transfertime};
27 return ($seconds);
28 }
29 # put ( LOCAL_FILE [, REMOTE_FILE][, versions => N ] )
30 sub put { # returns: what Net::FTP->put() returns
31 my $self = shift;
32 # checking if versionning is enabled
33 my $versions = 0;
34 my $end = $#_; # last element's index of @_
35 if (@_ >= 3 && $_[$end - 1] eq 'versions' ) { # versionning is enabled
36 $versions = pop (@_);
37 pop (@_); # to remove the "versions" element
38 # defining the remote filename. the piece of code bellow
39 # was cut-and-pasted from Net::FTP module.
40 my($local,$remote) = @_;
41 my $localfd = ref($local) || ref(\$local) eq "GLOB";
42 unless(defined $remote){
43 croak 'Must specify remote filename with stream input'
44 if $localfd;
45 require File::Basename;
46 $remote = File::Basename::basename($local);
47 }
48 croak("Bad remote filename '$remote'\n")
49 if $remote =~ /[\r\n]/s;
50 # end of cut-and-pasting
51
52 # If $versions != 0, we set $remote to rotation in the remote
53 # server. It only will be rotated if already exists a file with
54 # the same name as $remote.
55 if ( $versions != 0 ) {
56 $self->_rotate_file("remote", $remote, $versions);
57 }
58 }
59 # Let's make the file transfer gathering the transfer time
60 my ($t0, # time before the transfer
61 $t1 # time after the transfer
62 );
63 my $result = undef; # will store what Net::FTP->put() returns
64 $t0 = time;
65 $result = $self->SUPER::put(@_);
66 $t1 = time;
67 $self->_setTransferTime($t1 - $t0);
68 return $result;
69 }
70 # get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]][, versions => N])
71 sub get { # returns: what Net::FTP->get() returns
72 my $self = shift;
73 # checking if versionning is enabled
74 my $versions = 0;
75 my $end = $#_; # last element's index of @_
76 if (@_ >= 3 && $_[$end - 1] eq 'versions' ) { # versionning is enabled
77 $versions = pop (@_);
78 pop (@_); # to remove the "versions" element
79 # defining the local filename as is done in Net::FTP module.
80 my($remote, $local) = @_;
81 my $localfd = ref($local) || ref(\$local) eq "GLOB";
82 croak "Can't enable versioning if the local_file is a filehandle\n."
83 if $localfd;
84 ($local = $remote) =~ s#^.*/## unless(defined $local);
85 croak("Bad remote filename '$remote'\n")
86 if $remote =~ /[\r\n]/s;
87
88 # If $versions != 0, we set $local to rotation in the localhost.
89 # It only will be rotated if already exists a file with
90 # the same name as $remote.
91 if ( $versions != 0 ) {
92 $self->_rotate_file("local", $local, $versions);
93 }
94 }
95 # Let's make the file transfer gathering the transfer time
96 my ($t0, # time before the transfer
97 $t1 # time after the transfer
98 );
99 my $result = undef; # will store what Net::FTP->put() returns
100 $t0 = time;
101 $result = $self->SUPER::get(@_);
102 $t1 = time;
103 $self->_setTransferTime($t1 - $t0);
104 return $result;
105 }
106  
107 # rotates a filename. the file can be 'local' or 'remote'.
108 # _rotate_file (
109 # 'local' | 'remote', $filename,
110 # $number_of_versions [, $counter]
111 # )
112 sub _rotate_file { # returns: nothing
113 my $i; # counter. on the first run it must be = 0
114 $i = ( @_ == 5 ? pop (@_) : 0 );
115 my ($self, $where, $file, $nversions) = @_;
116 # Anonymous Subroutines ########################
117 # All the anonymous subroutines bellow are available only inside
118 # _rotate_file() and they relly on $where and $self
119 # variables set inside _rotate_file()
120 my $exist = sub { # tells if the file exists
121 my $file = shift;
122 if ($where eq 'local') {
123 return ( -f $file );
124 } else { # remote file
125 return $self->size($file);
126 }
127 };
128 my $del = sub { # removes the file
129 my $file = shift;
130 if ($where eq 'local') {
131 unlink ($file);
132 } else { # remote file
133 $self->delete($file);
134 }
135 };
136 my $move = sub { # rename the file
137 my ($oldName, $newName) = @_;
138 if ($where eq 'local') {
139 rename ($oldName, $newName);
140 } else {
141 $self->rename($oldName, $newName);
142 }
143 };
144 # Here goes the rotation code
145 my ($oldName, $newName);
146 if ( $i == 0 && &$exist($file) ) {
147 $oldName = $file;
148 } elsif ( &$exist("$file.$i") ) {
149 $oldName = "$file.$i";
150 }
151 if ($oldName) {
152 $newName = "$file." . ++$i;
153 $self->_rotate_file($where, $file, $nversions, $i) unless ($i == $nversions);
154 &$del($newName) if &$exist ($newName);
155 &$move($oldName, $newName);
156 }
157 }
158 sub DESTROY {
159 my $self = shift;
160 $self->close();
161 }
162 1;
163 __END__