← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/stub_sftp.py

  • Committer: Martin Pool
  • Date: 2010-02-03 00:08:23 UTC
  • mto: This revision was merged to the branch mainline in revision 5002.
  • Revision ID: mbp@sourcefrog.net-20100203000823-fcyf2791xrl3fbfo
expand tabs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/stub_sftp.py
1
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
2
 
 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""
18
18
A stub SFTP server for loopback SFTP testing.
22
22
import os
23
23
from paramiko import ServerInterface, SFTPServerInterface, SFTPServer, SFTPAttributes, \
24
24
    SFTPHandle, SFTP_OK, AUTH_SUCCESSFUL, OPEN_SUCCEEDED
 
25
import sys
25
26
 
26
27
from bzrlib.osutils import pathjoin
27
28
from bzrlib.trace import mutter
64
65
 
65
66
    def __init__(self, server, root, home=None):
66
67
        SFTPServerInterface.__init__(self, server)
 
68
        # All paths are actually relative to 'root'.
 
69
        # this is like implementing chroot().
67
70
        self.root = root
68
71
        if home is None:
69
 
            self.home = self.root
 
72
            self.home = ''
70
73
        else:
 
74
            if not home.startswith(self.root):
 
75
                raise AssertionError(
 
76
                    "home must be a subdirectory of root (%s vs %s)"
 
77
                    % (home, root))
71
78
            self.home = home[len(self.root):]
72
 
        if (len(self.home) > 0) and (self.home[0] == '/'):
 
79
        if self.home.startswith('/'):
73
80
            self.home = self.home[1:]
74
81
        server._test_case.log('sftpserver - new connection')
75
82
 
76
83
    def _realpath(self, path):
 
84
        # paths returned from self.canonicalize() always start with
 
85
        # a path separator. So if 'root' is just '/', this would cause
 
86
        # a double slash at the beginning '//home/dir'.
 
87
        if self.root == '/':
 
88
            return self.canonicalize(path)
77
89
        return self.root + self.canonicalize(path)
78
90
 
79
 
    def canonicalize(self, path):
80
 
        if os.path.isabs(path):
81
 
            return os.path.normpath(path)
82
 
        else:
83
 
            return os.path.normpath('/' + os.path.join(self.home, path))
 
91
    if sys.platform == 'win32':
 
92
        def canonicalize(self, path):
 
93
            # Win32 sftp paths end up looking like
 
94
            #     sftp://host@foo/h:/foo/bar
 
95
            # which means absolute paths look like:
 
96
            #     /h:/foo/bar
 
97
            # and relative paths stay the same:
 
98
            #     foo/bar
 
99
            # win32 needs to use the Unicode APIs. so we require the
 
100
            # paths to be utf8 (Linux just uses bytestreams)
 
101
            thispath = path.decode('utf8')
 
102
            if path.startswith('/'):
 
103
                # Abspath H:/foo/bar
 
104
                return os.path.normpath(thispath[1:])
 
105
            else:
 
106
                return os.path.normpath(os.path.join(self.home, thispath))
 
107
    else:
 
108
        def canonicalize(self, path):
 
109
            if os.path.isabs(path):
 
110
                return os.path.normpath(path)
 
111
            else:
 
112
                return os.path.normpath('/' + os.path.join(self.home, path))
84
113
 
85
114
    def chattr(self, path, attr):
86
115
        try:
93
122
        path = self._realpath(path)
94
123
        try:
95
124
            out = [ ]
96
 
            flist = os.listdir(path)
 
125
            # TODO: win32 incorrectly lists paths with non-ascii if path is not
 
126
            # unicode. However on Linux the server should only deal with
 
127
            # bytestreams and posix.listdir does the right thing
 
128
            if sys.platform == 'win32':
 
129
                flist = [f.encode('utf8') for f in os.listdir(path)]
 
130
            else:
 
131
                flist = os.listdir(path)
97
132
            for fname in flist:
98
133
                attr = SFTPAttributes.from_stat(os.stat(pathjoin(path, fname)))
99
134
                attr.filename = fname
119
154
    def open(self, path, flags, attr):
120
155
        path = self._realpath(path)
121
156
        try:
122
 
            if hasattr(os, 'O_BINARY'):
123
 
                flags |= os.O_BINARY
 
157
            flags |= getattr(os, 'O_BINARY', 0)
124
158
            if getattr(attr, 'st_mode', None):
125
159
                fd = os.open(path, flags, attr.st_mode)
126
160
            else:
127
 
                fd = os.open(path, flags)
 
161
                # os.open() defaults to 0777 which is
 
162
                # an odd default mode for files
 
163
                fd = os.open(path, flags, 0666)
128
164
        except OSError, e:
129
165
            return SFTPServer.convert_errno(e.errno)
 
166
 
130
167
        if (flags & os.O_CREAT) and (attr is not None):
131
168
            attr._flags &= ~attr.FLAG_PERMISSIONS
132
169
            SFTPServer.set_file_attr(path, attr)
139
176
            fstr = 'rb'
140
177
        try:
141
178
            f = os.fdopen(fd, fstr)
142
 
        except OSError, e:
 
179
        except (IOError, OSError), e:
143
180
            return SFTPServer.convert_errno(e.errno)
144
181
        fobj = StubSFTPHandle()
145
182
        fobj.filename = path