/usr/lib/x86_64-linux-gnu/perl5/5.24/Net/SSH2/File.pm is in libnet-ssh2-perl 0.63-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | package Net::SSH2::File;
use strict;
use warnings;
use Carp;
# methods
sub readline {
my ($self, $eol) = @_;
$eol = $/ unless @_ >= 2;
if (wantarray or not defined $eol) {
my $data = '';
my $buffer;
while (1) {
$self->read($buffer, 32768) or last;
$data .= $buffer;
}
defined $eol and return split /(?<=\Q$eol\E)/s, $data;
wantarray and not length $data and return ();
return $data;
}
else {
my $c;
my $data = '';
while (1) {
$c = $self->getc;
last unless defined $c;
$data .= $c;
last if $data =~ /\Q$eol\E\z/;
}
return (length $data ? $data : undef);
}
}
# tie interface
sub PRINT {
my $self = shift;
my $sep = defined($,) ? $, : '';
$self->write(join $sep, @_)
}
sub PRINTF {
my $self = shift;
my $template = shift;
$self->write(sprintf $template, @_)
}
sub WRITE {
my ($self, $buf, $len, $offset) = @_;
$self->write(substr($buf, $offset, $len))
}
sub READLINE { shift->readline($/) }
*GETC = \&getc;
sub READ {
my ($self, undef, $len, $offset) = @_;
my $bytes = $self->read(my($buffer), $len);
substr($_[1], $offset || 0) = $buffer
if defined $bytes;
return $bytes;
}
sub CLOSE {
}
sub BINMODE { 1 }
sub EOF { 0 }
1;
__END__
=head1 NAME
Net::SSH2::File - SSH2 SFTP file object
=head1 DESCRIPTION
An SFTP file object is created by the L<Net::SSH2::SFTP> C<open> method.
=head2 read ( buffer, size )
Read size bytes from the file into a given buffer. Returns number of bytes
read, or undef on failure.
=head2 write ( buffer )
Write buffer to the remote file.
The C<libssh2_sftp_write> function wrapped by this method has a
complex and quite difficult (if not impossible at all) to use API. It
tries to hide the packet pipelining being done under the hood in order
to attain decent throughput.
Net::SSH2 can not hide that complexity without negatively affecting
the transmission speed so it provides just a thin wrapper for that
library function.
An excerpt from C<libssh2_sftp_write> manual page follows:
WRITE AHEAD
Starting in libssh2 version 1.2.8, the default behavior of libssh2
is to create several smaller outgoing packets for all data you pass
to this function and it will return a positive number as soon as the
first packet is acknowledged from the server.
This has the effect that sometimes more data has been sent off but
isn't acked yet when this function returns, and when this function
is subsequently called again to write more data, libssh2 will
immediately figure out that the data is already received remotely.
In most normal situation this should not cause any problems, but it
should be noted that if you've once called libssh2_sftp_write() with
data and it returns short, you MUST still assume that the rest of
the data might've been cached so you need to make sure you don't
alter that data and think that the version you have in your next
function invoke will be detected or used.
The reason for this funny behavior is that SFTP can only send 32K
data in each packet and it gets all packets acked individually. This
means we cannot use a simple serial approach if we want to reach
high performance even on high latency connections. And we want that.
=head2 stat
Returns file attributes; see Net::SSH2::SFTP::stat.
=head2 setstat ( key, value... )
Sets file attributes; see Net::SSH2::SFTP::setstat.
=head2 seek ( offset )
Set the file pointer offset.
=head2 tell
Returns the current file pointer offset.
=head1 SEE ALSO
L<Net::SSH2::SFTP>.
Check L<Net::SFTP::Foreign> for a high level, perlish and easy to use
SFTP client module. It can work on top of Net::SSH2 via the
L<Net::SFTP::Foreign::Backend::Net_SSH2> backend module.
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2005, 2006 by David B. Robins E<lt>dbrobins@cpan.orgE<gt>;
Copyright (C) 2015 by Salvador FandiE<ntilde>o E<lt>sfandino@yahoo.comE<gt>;
All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.0 or,
at your option, any later version of Perl 5 you may have available.
The documentation for this package contains and excerpt from libssh2
manual pages. You can consult the license of the libssh2 project for
the conditions regulating the copyright of that part.
=cut
|