1
# Copyright (C) 2006-2011 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."""
26
from bzrlib.hooks import Hooks
30
transport as _mod_transport,
32
from bzrlib.i18n import gettext
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from bzrlib.smart import (
39
from bzrlib.transport import (
50
class SmartTCPServer(object):
51
"""Listens on a TCP socket and accepts connections from smart clients.
53
Each connection will be served by a SmartServerSocketStreamMedium running in
56
hooks: An instance of SmartServerHooks.
59
# This is the timeout on the socket we use .accept() on. It is exposed here
60
# so the test suite can set it faster. (It thread.interrupt_main() will not
61
# fire a KeyboardInterrupt during socket.accept)
63
_SHUTDOWN_POLL_TIMEOUT = 1.0
64
_LOG_WAITING_TIMEOUT = 10.0
68
def __init__(self, backing_transport, root_client_path='/',
70
"""Construct a new server.
72
To actually start it running, call either start_background_thread or
75
:param backing_transport: The transport to serve.
76
:param root_client_path: The client path that will correspond to root
78
:param client_timeout: See SmartServerSocketStreamMedium's timeout
81
self.backing_transport = backing_transport
82
self.root_client_path = root_client_path
83
self._client_timeout = client_timeout
84
self._active_connections = []
85
# This is set to indicate we want to wait for clients to finish before
87
self._gracefully_stopping = False
89
def start_server(self, host, port):
90
"""Create the server listening socket.
92
:param host: Name of the interface to listen on.
93
:param port: TCP port to listen on, or 0 to allocate a transient port.
95
# let connections timeout so that we get a chance to terminate
96
# Keep a reference to the exceptions we want to catch because the socket
97
# module's globals get set to None during interpreter shutdown.
98
from socket import timeout as socket_timeout
99
from socket import error as socket_error
100
self._socket_error = socket_error
101
self._socket_timeout = socket_timeout
102
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
103
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
105
(family, socktype, proto, canonname, sockaddr) = addrs
107
self._server_socket = socket.socket(family, socktype, proto)
108
# SO_REUSERADDR has a different meaning on Windows
109
if sys.platform != 'win32':
110
self._server_socket.setsockopt(socket.SOL_SOCKET,
111
socket.SO_REUSEADDR, 1)
113
self._server_socket.bind(sockaddr)
114
except self._socket_error, message:
115
raise errors.CannotBindAddress(host, port, message)
116
self._sockname = self._server_socket.getsockname()
117
self.port = self._sockname[1]
118
self._server_socket.listen(1)
119
self._server_socket.settimeout(self._ACCEPT_TIMEOUT)
120
# Once we start accept()ing connections, we set started.
121
self._started = threading.Event()
122
# Once we stop accept()ing connections (and are closing the socket) we
124
self._stopped = threading.Event()
125
# Once we have finished waiting for all clients, etc. We set
127
self._fully_stopped = threading.Event()
129
def _backing_urls(self):
130
# There are three interesting urls:
131
# The URL the server can be contacted on. (e.g. bzr://host/)
132
# The URL that a commit done on the same machine as the server will
133
# have within the servers space. (e.g. file:///home/user/source)
134
# The URL that will be given to other hooks in the same process -
135
# the URL of the backing transport itself. (e.g. filtered-36195:///)
136
# We need all three because:
137
# * other machines see the first
138
# * local commits on this machine should be able to be mapped to
140
# * commits the server does itself need to be mapped across to this
142
# The latter two urls are different aliases to the servers url,
143
# so we group those in a list - as there might be more aliases
145
urls = [self.backing_transport.base]
147
urls.append(self.backing_transport.external_url())
148
except errors.InProcessTransport:
152
def run_server_started_hooks(self, backing_urls=None):
153
if backing_urls is None:
154
backing_urls = self._backing_urls()
155
for hook in SmartTCPServer.hooks['server_started']:
156
hook(backing_urls, self.get_url())
157
for hook in SmartTCPServer.hooks['server_started_ex']:
158
hook(backing_urls, self)
160
def run_server_stopped_hooks(self, backing_urls=None):
161
if backing_urls is None:
162
backing_urls = self._backing_urls()
163
for hook in SmartTCPServer.hooks['server_stopped']:
164
hook(backing_urls, self.get_url())
166
def _stop_gracefully(self):
167
trace.note(gettext('Requested to stop gracefully'))
168
self._should_terminate = True
169
self._gracefully_stopping = True
170
for handler, _ in self._active_connections:
171
handler._stop_gracefully()
173
def _wait_for_clients_to_disconnect(self):
174
self._poll_active_connections()
175
if not self._active_connections:
177
trace.note(gettext('Waiting for %d client(s) to finish')
178
% (len(self._active_connections),))
179
t_next_log = self._timer() + self._LOG_WAITING_TIMEOUT
180
while self._active_connections:
182
if now >= t_next_log:
183
trace.note(gettext('Still waiting for %d client(s) to finish')
184
% (len(self._active_connections),))
185
t_next_log = now + self._LOG_WAITING_TIMEOUT
186
self._poll_active_connections(self._SHUTDOWN_POLL_TIMEOUT)
188
def serve(self, thread_name_suffix=''):
189
# Note: There is a temptation to do
190
# signals.register_on_hangup(id(self), self._stop_gracefully)
191
# However, that creates a temporary object which is a bound
192
# method. signals._on_sighup is a WeakKeyDictionary so it
193
# immediately gets garbage collected, because nothing else
194
# references it. Instead, we need to keep a real reference to the
195
# bound method for the lifetime of the serve() function.
196
stop_gracefully = self._stop_gracefully
197
signals.register_on_hangup(id(self), stop_gracefully)
198
self._should_terminate = False
199
# for hooks we are letting code know that a server has started (and
201
self.run_server_started_hooks()
205
while not self._should_terminate:
207
conn, client_addr = self._server_socket.accept()
208
except self._socket_timeout:
209
# just check if we're asked to stop
211
except self._socket_error, e:
212
# if the socket is closed by stop_background_thread
213
# we might get a EBADF here, or if we get a signal we
214
# can get EINTR, any other socket errors should get
216
if e.args[0] not in (errno.EBADF, errno.EINTR):
217
trace.warning(gettext("listening socket error: %s")
220
if self._should_terminate:
223
self.serve_conn(conn, thread_name_suffix)
224
# Cleanout any threads that have finished processing.
225
self._poll_active_connections()
226
except KeyboardInterrupt:
227
# dont log when CTRL-C'd.
230
trace.report_exception(sys.exc_info(), sys.stderr)
234
# ensure the server socket is closed.
235
self._server_socket.close()
236
except self._socket_error:
237
# ignore errors on close
240
signals.unregister_on_hangup(id(self))
241
self.run_server_stopped_hooks()
242
if self._gracefully_stopping:
243
self._wait_for_clients_to_disconnect()
244
self._fully_stopped.set()
247
"""Return the url of the server"""
248
return "bzr://%s:%s/" % (self._sockname[0], self._sockname[1])
250
def _make_handler(self, conn):
251
return medium.SmartServerSocketStreamMedium(
252
conn, self.backing_transport, self.root_client_path,
253
timeout=self._client_timeout)
255
def _poll_active_connections(self, timeout=0.0):
256
"""Check to see if any active connections have finished.
258
This will iterate through self._active_connections, and update any
259
connections that are finished.
261
:param timeout: The timeout to pass to thread.join(). By default, we
262
set it to 0, so that we don't hang if threads are not done yet.
266
for handler, thread in self._active_connections:
269
still_active.append((handler, thread))
270
self._active_connections = still_active
272
def serve_conn(self, conn, thread_name_suffix):
273
# For WIN32, where the timeout value from the listening socket
274
# propagates to the newly accepted socket.
275
conn.setblocking(True)
276
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
277
thread_name = 'smart-server-child' + thread_name_suffix
278
handler = self._make_handler(conn)
279
connection_thread = threading.Thread(
280
None, handler.serve, name=thread_name)
281
self._active_connections.append((handler, connection_thread))
282
connection_thread.setDaemon(True)
283
connection_thread.start()
284
return connection_thread
286
def start_background_thread(self, thread_name_suffix=''):
287
self._started.clear()
288
self._server_thread = threading.Thread(None,
289
self.serve, args=(thread_name_suffix,),
290
name='server-' + self.get_url())
291
self._server_thread.setDaemon(True)
292
self._server_thread.start()
295
def stop_background_thread(self):
296
self._stopped.clear()
297
# tell the main loop to quit on the next iteration.
298
self._should_terminate = True
299
# close the socket - gives error to connections from here on in,
300
# rather than a connection reset error to connections made during
301
# the period between setting _should_terminate = True and
302
# the current request completing/aborting. It may also break out the
303
# main loop if it was currently in accept() (on some platforms).
305
self._server_socket.close()
306
except self._socket_error:
307
# ignore errors on close
309
if not self._stopped.isSet():
310
# server has not stopped (though it may be stopping)
311
# its likely in accept(), so give it a connection
312
temp_socket = socket.socket()
313
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
314
if not temp_socket.connect_ex(self._sockname):
315
# and close it immediately: we dont choose to send any requests.
318
self._server_thread.join()
321
class SmartServerHooks(Hooks):
322
"""Hooks for the smart server."""
325
"""Create the default hooks.
327
These are all empty initially, because by default nothing should get
330
Hooks.__init__(self, "bzrlib.smart.server", "SmartTCPServer.hooks")
331
self.add_hook('server_started',
332
"Called by the bzr server when it starts serving a directory. "
333
"server_started is called with (backing urls, public url), "
334
"where backing_url is a list of URLs giving the "
335
"server-specific directory locations, and public_url is the "
336
"public URL for the directory being served.", (0, 16))
337
self.add_hook('server_started_ex',
338
"Called by the bzr server when it starts serving a directory. "
339
"server_started is called with (backing_urls, server_obj).",
341
self.add_hook('server_stopped',
342
"Called by the bzr server when it stops serving a directory. "
343
"server_stopped is called with the same parameters as the "
344
"server_started hook: (backing_urls, public_url).", (0, 16))
345
self.add_hook('server_exception',
346
"Called by the bzr server when an exception occurs. "
347
"server_exception is called with the sys.exc_info() tuple "
348
"return true for the hook if the exception has been handled, "
349
"in which case the server will exit normally.", (2, 4))
351
SmartTCPServer.hooks = SmartServerHooks()
354
def _local_path_for_transport(transport):
355
"""Return a local path for transport, if reasonably possible.
357
This function works even if transport's url has a "readonly+" prefix,
358
unlike local_path_from_url.
360
This essentially recovers the --directory argument the user passed to "bzr
361
serve" from the transport passed to serve_bzr.
364
base_url = transport.external_url()
365
except (errors.InProcessTransport, NotImplementedError):
368
# Strip readonly prefix
369
if base_url.startswith('readonly+'):
370
base_url = base_url[len('readonly+'):]
372
return urlutils.local_path_from_url(base_url)
373
except errors.InvalidURL:
377
class BzrServerFactory(object):
378
"""Helper class for serve_bzr."""
380
def __init__(self, userdir_expander=None, get_base_path=None):
382
self.base_path = None
383
self.backing_transport = None
384
if userdir_expander is None:
385
userdir_expander = os.path.expanduser
386
self.userdir_expander = userdir_expander
387
if get_base_path is None:
388
get_base_path = _local_path_for_transport
389
self.get_base_path = get_base_path
391
def _expand_userdirs(self, path):
392
"""Translate /~/ or /~user/ to e.g. /home/foo, using
393
self.userdir_expander (os.path.expanduser by default).
395
If the translated path would fall outside base_path, or the path does
396
not start with ~, then no translation is applied.
398
If the path is inside, it is adjusted to be relative to the base path.
400
e.g. if base_path is /home, and the expanded path is /home/joe, then
401
the translated path is joe.
404
if path.startswith('~'):
405
expanded = self.userdir_expander(path)
406
if not expanded.endswith('/'):
408
if expanded.startswith(self.base_path):
409
result = expanded[len(self.base_path):]
412
def _make_expand_userdirs_filter(self, transport):
413
return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
415
def _make_backing_transport(self, transport):
416
"""Chroot transport, and decorate with userdir expander."""
417
self.base_path = self.get_base_path(transport)
418
chroot_server = chroot.ChrootServer(transport)
419
chroot_server.start_server()
420
self.cleanups.append(chroot_server.stop_server)
421
transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
422
if self.base_path is not None:
423
# Decorate the server's backing transport with a filter that can
425
expand_userdirs = self._make_expand_userdirs_filter(transport)
426
expand_userdirs.start_server()
427
self.cleanups.append(expand_userdirs.stop_server)
428
transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
429
self.transport = transport
431
def _get_stdin_stdout(self):
432
return sys.stdin, sys.stdout
434
def _make_smart_server(self, host, port, inet, timeout):
436
c = config.GlobalStack()
437
timeout = c.get('serve.client_timeout')
439
stdin, stdout = self._get_stdin_stdout()
440
smart_server = medium.SmartServerPipeStreamMedium(
441
stdin, stdout, self.transport, timeout=timeout)
444
host = medium.BZR_DEFAULT_INTERFACE
446
port = medium.BZR_DEFAULT_PORT
447
smart_server = SmartTCPServer(self.transport,
448
client_timeout=timeout)
449
smart_server.start_server(host, port)
450
trace.note(gettext('listening on port: %s') % smart_server.port)
451
self.smart_server = smart_server
453
def _change_globals(self):
454
from bzrlib import lockdir, ui
455
# For the duration of this server, no UI output is permitted. note
456
# that this may cause problems with blackbox tests. This should be
457
# changed with care though, as we dont want to use bandwidth sending
458
# progress over stderr to smart server clients!
459
old_factory = ui.ui_factory
460
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
461
def restore_default_ui_factory_and_lockdir_timeout():
462
ui.ui_factory = old_factory
463
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
464
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
465
ui.ui_factory = ui.SilentUIFactory()
466
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
467
orig = signals.install_sighup_handler()
468
def restore_signals():
469
signals.restore_sighup_handler(orig)
470
self.cleanups.append(restore_signals)
472
def set_up(self, transport, host, port, inet, timeout):
473
self._make_backing_transport(transport)
474
self._make_smart_server(host, port, inet, timeout)
475
self._change_globals()
478
for cleanup in reversed(self.cleanups):
482
def serve_bzr(transport, host=None, port=None, inet=False, timeout=None):
483
"""This is the default implementation of 'bzr serve'.
485
It creates a TCP or pipe smart server on 'transport, and runs it. The
486
transport will be decorated with a chroot and pathfilter (using
489
bzr_server = BzrServerFactory()
491
bzr_server.set_up(transport, host, port, inet, timeout)
492
bzr_server.smart_server.serve()
494
hook_caught_exception = False
495
for hook in SmartTCPServer.hooks['server_exception']:
496
hook_caught_exception = hook(sys.exc_info())
497
if not hook_caught_exception:
500
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
