1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Server for smart-server protocol."""
25
from bzrlib.hooks import HookPoint, Hooks
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
33
from bzrlib.smart import medium
34
from bzrlib.transport import (
45
class SmartTCPServer(object):
46
"""Listens on a TCP socket and accepts connections from smart clients.
48
Each connection will be served by a SmartServerSocketStreamMedium running in
51
hooks: An instance of SmartServerHooks.
54
def __init__(self, backing_transport, host='127.0.0.1', port=0,
55
root_client_path='/'):
56
"""Construct a new server.
58
To actually start it running, call either start_background_thread or
61
:param backing_transport: The transport to serve.
62
:param host: Name of the interface to listen on.
63
:param port: TCP port to listen on, or 0 to allocate a transient port.
64
:param root_client_path: The client path that will correspond to root
67
# let connections timeout so that we get a chance to terminate
68
# Keep a reference to the exceptions we want to catch because the socket
69
# module's globals get set to None during interpreter shutdown.
70
from socket import timeout as socket_timeout
71
from socket import error as socket_error
72
self._socket_error = socket_error
73
self._socket_timeout = socket_timeout
74
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
75
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
77
(family, socktype, proto, canonname, sockaddr) = addrs
79
self._server_socket = socket.socket(family, socktype, proto)
80
# SO_REUSERADDR has a different meaning on Windows
81
if sys.platform != 'win32':
82
self._server_socket.setsockopt(socket.SOL_SOCKET,
83
socket.SO_REUSEADDR, 1)
85
self._server_socket.bind(sockaddr)
86
except self._socket_error, message:
87
raise errors.CannotBindAddress(host, port, message)
88
self._sockname = self._server_socket.getsockname()
89
self.port = self._sockname[1]
90
self._server_socket.listen(1)
91
self._server_socket.settimeout(1)
92
self.backing_transport = backing_transport
93
self._started = threading.Event()
94
self._stopped = threading.Event()
95
self.root_client_path = root_client_path
97
def serve(self, thread_name_suffix=''):
98
self._should_terminate = False
99
# for hooks we are letting code know that a server has started (and
101
# There are three interesting urls:
102
# The URL the server can be contacted on. (e.g. bzr://host/)
103
# The URL that a commit done on the same machine as the server will
104
# have within the servers space. (e.g. file:///home/user/source)
105
# The URL that will be given to other hooks in the same process -
106
# the URL of the backing transport itself. (e.g. chroot+:///)
107
# We need all three because:
108
# * other machines see the first
109
# * local commits on this machine should be able to be mapped to
111
# * commits the server does itself need to be mapped across to this
113
# The latter two urls are different aliases to the servers url,
114
# so we group those in a list - as there might be more aliases
116
backing_urls = [self.backing_transport.base]
118
backing_urls.append(self.backing_transport.external_url())
119
except errors.InProcessTransport:
121
for hook in SmartTCPServer.hooks['server_started']:
122
hook(backing_urls, self.get_url())
123
for hook in SmartTCPServer.hooks['server_started_ex']:
124
hook(backing_urls, self)
128
while not self._should_terminate:
130
conn, client_addr = self._server_socket.accept()
131
except self._socket_timeout:
132
# just check if we're asked to stop
134
except self._socket_error, e:
135
# if the socket is closed by stop_background_thread
136
# we might get a EBADF here, any other socket errors
138
if e.args[0] != errno.EBADF:
139
trace.warning("listening socket error: %s", e)
141
self.serve_conn(conn, thread_name_suffix)
142
except KeyboardInterrupt:
143
# dont log when CTRL-C'd.
146
trace.report_exception(sys.exc_info(), sys.stderr)
151
# ensure the server socket is closed.
152
self._server_socket.close()
153
except self._socket_error:
154
# ignore errors on close
156
for hook in SmartTCPServer.hooks['server_stopped']:
157
hook(backing_urls, self.get_url())
160
"""Return the url of the server"""
161
return "bzr://%s:%d/" % self._sockname
163
def serve_conn(self, conn, thread_name_suffix):
164
# For WIN32, where the timeout value from the listening socket
165
# propagates to the newly accepted socket.
166
conn.setblocking(True)
167
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
168
handler = medium.SmartServerSocketStreamMedium(
169
conn, self.backing_transport, self.root_client_path)
170
thread_name = 'smart-server-child' + thread_name_suffix
171
connection_thread = threading.Thread(
172
None, handler.serve, name=thread_name)
173
connection_thread.setDaemon(True)
174
connection_thread.start()
176
def start_background_thread(self, thread_name_suffix=''):
177
self._started.clear()
178
self._server_thread = threading.Thread(None,
179
self.serve, args=(thread_name_suffix,),
180
name='server-' + self.get_url())
181
self._server_thread.setDaemon(True)
182
self._server_thread.start()
185
def stop_background_thread(self):
186
self._stopped.clear()
187
# tell the main loop to quit on the next iteration.
188
self._should_terminate = True
189
# close the socket - gives error to connections from here on in,
190
# rather than a connection reset error to connections made during
191
# the period between setting _should_terminate = True and
192
# the current request completing/aborting. It may also break out the
193
# main loop if it was currently in accept() (on some platforms).
195
self._server_socket.close()
196
except self._socket_error:
197
# ignore errors on close
199
if not self._stopped.isSet():
200
# server has not stopped (though it may be stopping)
201
# its likely in accept(), so give it a connection
202
temp_socket = socket.socket()
203
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
204
if not temp_socket.connect_ex(self._sockname):
205
# and close it immediately: we dont choose to send any requests.
208
self._server_thread.join()
211
class SmartServerHooks(Hooks):
212
"""Hooks for the smart server."""
215
"""Create the default hooks.
217
These are all empty initially, because by default nothing should get
221
self.create_hook(HookPoint('server_started',
222
"Called by the bzr server when it starts serving a directory. "
223
"server_started is called with (backing urls, public url), "
224
"where backing_url is a list of URLs giving the "
225
"server-specific directory locations, and public_url is the "
226
"public URL for the directory being served.", (0, 16), None))
227
self.create_hook(HookPoint('server_started_ex',
228
"Called by the bzr server when it starts serving a directory. "
229
"server_started is called with (backing_urls, server_obj).",
231
self.create_hook(HookPoint('server_stopped',
232
"Called by the bzr server when it stops serving a directory. "
233
"server_stopped is called with the same parameters as the "
234
"server_started hook: (backing_urls, public_url).", (0, 16), None))
236
SmartTCPServer.hooks = SmartServerHooks()
239
class SmartTCPServer_for_testing(SmartTCPServer):
240
"""Server suitable for use by transport tests.
242
This server is backed by the process's cwd.
245
def __init__(self, thread_name_suffix=''):
246
SmartTCPServer.__init__(self, None)
247
self.client_path_extra = None
248
self.thread_name_suffix = thread_name_suffix
250
def get_backing_transport(self, backing_transport_server):
251
"""Get a backing transport from a server we are decorating."""
252
return transport.get_transport(backing_transport_server.get_url())
254
def start_server(self, backing_transport_server=None,
255
client_path_extra='/extra/'):
256
"""Set up server for testing.
258
:param backing_transport_server: backing server to use. If not
259
specified, a LocalURLServer at the current working directory will
261
:param client_path_extra: a path segment starting with '/' to append to
262
the root URL for this server. For instance, a value of '/foo/bar/'
263
will mean the root of the backing transport will be published at a
264
URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
265
`bzr://127.0.0.1:nnnn/`. Default value is `extra`, so that tests
266
by default will fail unless they do the necessary path translation.
268
if not client_path_extra.startswith('/'):
269
raise ValueError(client_path_extra)
270
from bzrlib.transport.chroot import ChrootServer
271
if backing_transport_server is None:
272
from bzrlib.transport.local import LocalURLServer
273
backing_transport_server = LocalURLServer()
274
self.chroot_server = ChrootServer(
275
self.get_backing_transport(backing_transport_server))
276
self.chroot_server.start_server()
277
self.backing_transport = transport.get_transport(
278
self.chroot_server.get_url())
279
self.root_client_path = self.client_path_extra = client_path_extra
280
self.start_background_thread(self.thread_name_suffix)
282
def stop_server(self):
283
self.stop_background_thread()
284
self.chroot_server.stop_server()
287
url = super(SmartTCPServer_for_testing, self).get_url()
288
return url[:-1] + self.client_path_extra
290
def get_bogus_url(self):
291
"""Return a URL which will fail to connect"""
292
return 'bzr://127.0.0.1:1/'
295
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
296
"""Get a readonly server for testing."""
298
def get_backing_transport(self, backing_transport_server):
299
"""Get a backing transport from a server we are decorating."""
300
url = 'readonly+' + backing_transport_server.get_url()
301
return transport.get_transport(url)
304
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
305
"""A variation of SmartTCPServer_for_testing that limits the client to
306
using RPCs in protocol v2 (i.e. bzr <= 1.5).
310
url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
311
url = 'bzr-v2://' + url[len('bzr://'):]
315
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
316
"""Get a readonly server for testing."""
318
def get_backing_transport(self, backing_transport_server):
319
"""Get a backing transport from a server we are decorating."""
320
url = 'readonly+' + backing_transport_server.get_url()
321
return transport.get_transport(url)
324
def _local_path_for_transport(transport):
325
"""Return a local path for transport, if reasonably possible.
327
This function works even if transport's url has a "readonly+" prefix,
328
unlike local_path_from_url.
330
This essentially recovers the --directory argument the user passed to "bzr
331
serve" from the transport passed to serve_bzr.
334
base_url = transport.external_url()
335
except (errors.InProcessTransport, NotImplementedError):
338
# Strip readonly prefix
339
if base_url.startswith('readonly+'):
340
base_url = base_url[len('readonly+'):]
342
return urlutils.local_path_from_url(base_url)
343
except errors.InvalidURL:
347
class BzrServerFactory(object):
348
"""Helper class for serve_bzr."""
350
def __init__(self, userdir_expander=None, get_base_path=None):
352
self.base_path = None
353
self.backing_transport = None
354
if userdir_expander is None:
355
userdir_expander = os.path.expanduser
356
self.userdir_expander = userdir_expander
357
if get_base_path is None:
358
get_base_path = _local_path_for_transport
359
self.get_base_path = get_base_path
361
def _expand_userdirs(self, path):
362
"""Translate /~/ or /~user/ to e.g. /home/foo, using
363
self.userdir_expander (os.path.expanduser by default).
365
If the translated path would fall outside base_path, or the path does
366
not start with ~, then no translation is applied.
368
If the path is inside, it is adjusted to be relative to the base path.
370
e.g. if base_path is /home, and the expanded path is /home/joe, then
371
the translated path is joe.
374
if path.startswith('~'):
375
expanded = self.userdir_expander(path)
376
if not expanded.endswith('/'):
378
if expanded.startswith(self.base_path):
379
result = expanded[len(self.base_path):]
382
def _make_expand_userdirs_filter(self, transport):
383
return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
385
def _make_backing_transport(self, transport):
386
"""Chroot transport, and decorate with userdir expander."""
387
self.base_path = self.get_base_path(transport)
388
chroot_server = chroot.ChrootServer(transport)
389
chroot_server.start_server()
390
self.cleanups.append(chroot_server.stop_server)
391
transport = get_transport(chroot_server.get_url())
392
if self.base_path is not None:
393
# Decorate the server's backing transport with a filter that can
395
expand_userdirs = self._make_expand_userdirs_filter(transport)
396
expand_userdirs.start_server()
397
self.cleanups.append(expand_userdirs.stop_server)
398
transport = get_transport(expand_userdirs.get_url())
399
self.transport = transport
401
def _make_smart_server(self, host, port, inet):
403
smart_server = medium.SmartServerPipeStreamMedium(
404
sys.stdin, sys.stdout, self.transport)
407
host = medium.BZR_DEFAULT_INTERFACE
409
port = medium.BZR_DEFAULT_PORT
410
smart_server = SmartTCPServer(self.transport, host=host, port=port)
411
trace.note('listening on port: %s' % smart_server.port)
412
self.smart_server = smart_server
414
def _change_globals(self):
415
from bzrlib import lockdir, ui
416
# For the duration of this server, no UI output is permitted. note
417
# that this may cause problems with blackbox tests. This should be
418
# changed with care though, as we dont want to use bandwidth sending
419
# progress over stderr to smart server clients!
420
old_factory = ui.ui_factory
421
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
422
def restore_default_ui_factory_and_lockdir_timeout():
423
ui.ui_factory = old_factory
424
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
425
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
426
ui.ui_factory = ui.SilentUIFactory()
427
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
429
def set_up(self, transport, host, port, inet):
430
self._make_backing_transport(transport)
431
self._make_smart_server(host, port, inet)
432
self._change_globals()
435
for cleanup in reversed(self.cleanups):
439
def serve_bzr(transport, host=None, port=None, inet=False):
440
"""This is the default implementation of 'bzr serve'.
442
It creates a TCP or pipe smart server on 'transport, and runs it. The
443
transport will be decorated with a chroot and pathfilter (using
446
bzr_server = BzrServerFactory()
448
bzr_server.set_up(transport, host, port, inet)
449
bzr_server.smart_server.serve()
451
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
