Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new preserve_mode parameter to allow setting file modes. #58

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add new preserve_mode parameter to allow setting file modes. #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd7b12d
Add new preserve_mode parameter to allow setting file modes.
herm May 24, 2015
cbc46b5
Use new _mode_to_string() function everywhere.
herm May 24, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions scp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ def __init__(self, transport, buff_size=16384, socket_timeout=5.0,
self.socket_timeout = socket_timeout
self.channel = None
self.preserve_times = False
self.preserve_mode = None
self._progress = progress
self._recv_dir = b''
self._rename = False
Expand All @@ -120,7 +121,7 @@ def __exit__(self, type, value, traceback):
self.close()

def put(self, files, remote_path=b'.',
recursive=False, preserve_times=False):
recursive=False, preserve_times=False, preserve_mode=False):
"""
Transfer files to remote host.

Expand All @@ -135,12 +136,19 @@ def put(self, files, remote_path=b'.',
@param preserve_times: preserve mtime and atime of transfered files
and directories.
@type preserve_times: bool
@param preserve_mode: preserve file mode of transfered files and
directories. Can be a boolean or any valid octal mode string/int.
example: False, True, 0b644 and '644' are valid. 'a+x' is invalid.
@type preserve_mode bool OR string OR int
"""
self.preserve_times = preserve_times
self.preserve_mode = preserve_mode
self.channel = self._open()
self._pushed = 0
self.channel.settimeout(self.socket_timeout)
scp_command = (b'scp -t ', b'scp -r -t ')[recursive]
if self.preserve_mode is not False:
scp_command += b'-p '
self.channel.exec_command(scp_command +
self.sanitize(asbytes(remote_path)))
self._recv_confirm()
Expand Down Expand Up @@ -211,12 +219,21 @@ def close(self):
self.channel.close()
self.channel = None

def _mode_to_string(self, mode):
if not isinstance(self.preserve_mode, bool):
mode = self.preserve_mode # Override default file mode
if isinstance(mode, int):
mode = '{0:04o}'.format(mode)
else:
mode.zfill(4)
return mode[-4:]

def _read_stats(self, name):
"""return just the file stats needed for scp"""
if os.name == 'nt':
name = asunicode(name)
stats = os.stat(name)
mode = oct(stats.st_mode)[-4:]
mode = stats.st_mode
size = stats.st_size
atime = int(stats.st_atime)
mtime = int(stats.st_mtime)
Expand All @@ -228,6 +245,7 @@ def _send_files(self, files):
(mode, size, mtime, atime) = self._read_stats(name)
if self.preserve_times:
self._send_time(mtime, atime)
mode = self._mode_to_string(mode)
file_hdl = open(name, 'rb')

# The protocol can't handle \n in the filename.
Expand Down Expand Up @@ -291,6 +309,7 @@ def _send_recursive(self, files):
def _send_pushd(self, directory):
(mode, size, mtime, atime) = self._read_stats(directory)
basename = asbytes(os.path.basename(directory))
mode = self._mode_to_string(mode)
if self.preserve_times:
self._send_time(mtime, atime)
self.channel.sendall(('D%s 0 ' % mode).encode('ascii') +
Expand Down