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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
# Copyright (C) 2009, 2010 Canonical Ltd
#
# 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
"""
FTP test server.
Based on pyftpdlib: http://code.google.com/p/pyftpdlib/
"""
import errno
import os
from pyftpdlib import ftpserver
import select
import threading
from bzrlib import (
osutils,
tests,
trace,
)
from bzrlib.tests import test_server
# Convert the pyftplib string version into a tuple to avoid traps in string
# comparison.
pyftplib_version = tuple(map(int, ftpserver.__ver__.split('.')))
class AnonymousWithWriteAccessAuthorizer(ftpserver.DummyAuthorizer):
def _check_permissions(self, username, perm):
# Like base implementation but don't warn about write permissions
# assigned to anonymous, since that's exactly our purpose.
for p in perm:
if p not in self.read_perms + self.write_perms:
raise ftpserver.AuthorizerError('No such permission "%s"' %p)
class BzrConformingFS(ftpserver.AbstractedFS):
def chmod(self, path, mode):
return os.chmod(path, mode)
def listdir(self, path):
"""List the content of a directory."""
return [osutils.safe_utf8(s) for s in os.listdir(path)]
def fs2ftp(self, fspath):
p = ftpserver.AbstractedFS.fs2ftp(self, osutils.safe_unicode(fspath))
return osutils.safe_utf8(p)
def ftp2fs(self, ftppath):
p = osutils.safe_unicode(ftppath)
return ftpserver.AbstractedFS.ftp2fs(self, p)
class BzrConformingFTPHandler(ftpserver.FTPHandler):
abstracted_fs = BzrConformingFS
def __init__(self, conn, server):
ftpserver.FTPHandler.__init__(self, conn, server)
self.authorizer = server.authorizer
def ftp_SIZE(self, path):
# bzr is overly picky here, but we want to make the test suite pass
# first. This may need to be revisited -- vila 20090226
line = self.fs.fs2ftp(path)
if self.fs.isdir(self.fs.realpath(path)):
why = "%s is a directory" % line
self.log('FAIL SIZE "%s". %s.' % (line, why))
self.respond("550 %s." %why)
else:
ftpserver.FTPHandler.ftp_SIZE(self, path)
def ftp_NLST(self, path):
# bzr is overly picky here, but we want to make the test suite pass
# first. This may need to be revisited -- vila 20090226
line = self.fs.fs2ftp(path)
if self.fs.isfile(self.fs.realpath(path)):
why = "Not a directory: %s" % line
self.log('FAIL NLST "%s". %s.' % (line, why))
self.respond("550 %s." %why)
else:
ftpserver.FTPHandler.ftp_NLST(self, path)
def log_cmd(self, cmd, arg, respcode, respstr):
# base class version choke on unicode, the alternative is to just
# provide an empty implementation and relies on the client to do
# the logging for debugging purposes. Not worth the trouble so far
# -- vila 20110607
if cmd in ("DELE", "RMD", "RNFR", "RNTO", "MKD"):
line = '"%s" %s' % (' '.join([cmd, unicode(arg)]).strip(), respcode)
self.log(line)
# An empty password is valid, hence the arg is neither mandatory nor forbidden
ftpserver.proto_cmds['PASS']['arg'] = None
class ftp_server(ftpserver.FTPServer):
def __init__(self, address, handler, authorizer):
ftpserver.FTPServer.__init__(self, address, handler)
self.authorizer = authorizer
# Worth backporting upstream ?
self.addr = self.socket.getsockname()
class FTPTestServer(test_server.TestServer):
"""Common code for FTP server facilities."""
def __init__(self):
self._root = None
self._ftp_server = None
self._port = None
self._async_thread = None
# ftp server logs
self.logs = []
self._ftpd_running = False
def get_url(self):
"""Calculate an ftp url to this server."""
return 'ftp://anonymous@localhost:%d/' % (self._port)
def get_bogus_url(self):
"""Return a URL which cannot be connected to."""
return 'ftp://127.0.0.1:1/'
def log(self, message):
"""This is used by ftp_server to log connections, etc."""
self.logs.append(message)
def start_server(self, vfs_server=None):
if not (vfs_server is None or isinstance(vfs_server,
test_server.LocalURLServer)):
raise AssertionError(
"FTPServer currently assumes local transport, got %s"
% vfs_server)
self._root = os.getcwdu()
address = ('localhost', 0) # bind to a random port
authorizer = AnonymousWithWriteAccessAuthorizer()
authorizer.add_anonymous(self._root, perm='elradfmwM')
self._ftp_server = ftp_server(address, BzrConformingFTPHandler,
authorizer)
# This is hacky as hell, will not work if we need two servers working
# at the same time, but that's the best we can do so far...
# FIXME: At least log and logline could be overriden in the handler ?
# -- vila 20090227
ftpserver.log = self.log
ftpserver.logline = self.log
ftpserver.logerror = self.log
self._port = self._ftp_server.socket.getsockname()[1]
self._ftpd_starting = threading.Lock()
self._ftpd_starting.acquire() # So it can be released by the server
self._ftpd_thread = threading.Thread(target=self._run_server,)
self._ftpd_thread.start()
if 'threads' in tests.selftest_debug_flags:
sys.stderr.write('Thread started: %s\n'
% (self._ftpd_thread.ident,))
# Wait for the server thread to start (i.e release the lock)
self._ftpd_starting.acquire()
self._ftpd_starting.release()
def stop_server(self):
"""See bzrlib.transport.Server.stop_server."""
# Tell the server to stop, but also close the server socket for tests
# that start the server but never initiate a connection. Closing the
# socket should be done first though, to avoid further connections.
self._ftp_server.close()
self._ftpd_running = False
self._ftpd_thread.join()
if 'threads' in tests.selftest_debug_flags:
sys.stderr.write('Thread joined: %s\n'
% (self._ftpd_thread.ident,))
def _run_server(self):
"""Run the server until stop_server is called.
Shut it down properly then.
"""
self._ftpd_running = True
self._ftpd_starting.release()
while self._ftpd_running:
try:
self._ftp_server.serve_forever(timeout=0.1, count=1)
except select.error, e:
if e.args[0] != errno.EBADF:
raise
self._ftp_server.close_all(ignore_all=True)
def add_user(self, user, password):
"""Add a user with write access."""
self._ftp_server.authorizer.add_user(user, password, self._root,
perm='elradfmwM')
|
