forked from fabric/fabric
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scp.py
167 lines (147 loc) · 5.6 KB
/
scp.py
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
# scp.py - scp extension for paramiko.
# Copyright (C) 2008 James Bardin <jbardin@bu.edu>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
Utilities for sending files over ssh using the scp1 protocol.
"""
import os
from socket import timeout as SocketTimeout
class SCPClient(object):
"""
An scp1 implementation, compatible with openssh scp. SCPClient opens a
simple scp session with the server, and only copies files.
"""
def __init__(self, transport, base_path='.',
recursive=False, preserve_times=False,
buff_size=16384, socket_timeout=5.0):
"""
Create an scp1 client.
@param transport: an existing L{Transport}
@type transport: L{Transport}
@param base_path: the destination path
@type base_path: str
@param recursive: open a recursive session (scp -r)
@type recursive: bool
@param preserve_times: preserve mtime and atime when copying.
@type preserve_times: bool
@param buff_size: size of the scp send buffer.
@type buff_size: int
"""
self.transport = transport
self.base_path = base_path
self.recursive = recursive
self.preserve_times = preserve_times
self.buff_size = buff_size
self.socket_timeout = socket_timeout
self.showprogress = False
self.prog = self.Progress()
self.channel = self.transport.open_session()
self.channel.settimeout(self.socket_timeout)
# start the session on the server
scp_command = ('scp -t %s\n', 'scp -rt %s\n')[self.recursive]
self.channel.exec_command(scp_command % self.base_path)
self._confirm()
def send_file(self, name, remote_name=''):
"""
Send a file using scp1
@param name: name of the local file to be copied
@type name: str
@param remote_name: name for the remote copy of the file,
if different from name.
@type remote_name: str
"""
remote_name = remote_name or name
(mode, size, mtime, atime) = self._get_stats(name)
if self.preserve_times:
self._send_time(mtime, atime)
file_hdl = file(name, 'rb')
self.channel.sendall('C%s %d %s\n' % (mode, size, remote_name))
self._confirm()
file_pos = 0
buff_size = self.buff_size
while file_pos < size:
self.channel.sendall(file_hdl.read(buff_size))
file_pos = file_hdl.tell()
self.prog.current = (file_pos, size)
self._end()
self.prog.current = (0, 0)
def push_dir(self, dir_name, remote_name=''):
"""
Create remote directory dir_name if it doesn't exist, and move into
said sirectory.
@param dir_name: directory name to be pushed to scp server
@type dir_name: str
"""
if not self.recursive:
raise SCPException('Must be in recursive mode to push directories')
remote_name = remote_name or dir_name
(mode, size, mtime, atime) = self._get_stats(dir_name)
if self.preserve_times:
self._send_time(mtime, atime)
self.channel.sendall('D%s 0 %s\n' % (mode, remote_name))
self._confirm()
def pop_dir(self):
"""
Move up one level in the remote directory stack. You cannot pop more
directories than you have previously pushed.
"""
if not self.recursive:
raise SCPException('Must be in recursive mode to pop directories')
self.channel.sendall('E\n')
self._confirm()
def close(self):
"""
Close the underlying channel.
"""
self.channel.close()
def _get_stats(self, name):
"""return just the file stats needed for scp"""
stats = os.stat(name)
mode = oct(stats.st_mode)[-4:]
size = stats.st_size
atime = int(stats.st_atime)
mtime = int(stats.st_mtime)
return (mode, size, mtime, atime)
def _send_time(self, mtime, atime):
"""send atime and mtime of the file"""
self.channel.sendall('T%d 0 %d 0\n' % (mtime, atime))
self._confirm()
def _confirm(self):
"""read scp response"""
try:
msg = self.channel.recv(512)
except SocketTimeout:
raise SCPException('Timout waiting for scp response')
if not msg == '\x00':
raise SCPException(msg)
def _end(self):
"""confirm EOF"""
self.channel.sendall('\x00')
self._confirm()
def get_progress(self):
"""
Return an object with only one attribute called "current".
"current" is a tuple containing current file position, and file size,
which is updated during file transfers.
"""
self.showprogress = True
return self.prog
class Progress(object):
def __init__(self):
self.current = (0, 0)
class SCPException(Exception):
"""SCP exception class"""
pass