142
104
# The latter two urls are different aliases to the servers url,
143
105
# so we group those in a list - as there might be more aliases
145
urls = [self.backing_transport.base]
107
backing_urls = [self.backing_transport.base]
147
urls.append(self.backing_transport.external_url())
109
backing_urls.append(self.backing_transport.external_url())
148
110
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
112
for hook in SmartTCPServer.hooks['server_started']:
156
113
hook(backing_urls, self.get_url())
157
114
for hook in SmartTCPServer.hooks['server_started_ex']:
158
115
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()
202
116
self._started.set()
208
122
except self._socket_timeout:
209
123
# just check if we're asked to stop
211
except self._socket_error as e:
125
except self._socket_error, e:
212
126
# 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")
127
# we might get a EBADF here, any other socket errors
129
if e.args[0] != errno.EBADF:
130
trace.warning("listening socket error: %s", e)
220
if self._should_terminate:
223
132
self.serve_conn(conn, thread_name_suffix)
224
# Cleanout any threads that have finished processing.
225
self._poll_active_connections()
226
133
except KeyboardInterrupt:
227
134
# dont log when CTRL-C'd.
229
except Exception as e:
230
trace.report_exception(sys.exc_info(), sys.stderr)
137
trace.error("Unhandled smart server error.")
138
trace.log_exception_quietly()
234
143
# ensure the server socket is closed.
235
144
self._server_socket.close()
236
145
except self._socket_error:
237
146
# 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()
148
for hook in SmartTCPServer.hooks['server_stopped']:
149
hook(backing_urls, self.get_url())
246
151
def get_url(self):
247
152
"""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:
268
if thread.is_alive():
269
still_active.append((handler, thread))
270
self._active_connections = still_active
153
return "bzr://%s:%d/" % self._sockname
272
155
def serve_conn(self, conn, thread_name_suffix):
273
156
# For WIN32, where the timeout value from the listening socket
274
157
# propagates to the newly accepted socket.
275
158
conn.setblocking(True)
276
159
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
160
handler = medium.SmartServerSocketStreamMedium(
161
conn, self.backing_transport, self.root_client_path)
277
162
thread_name = 'smart-server-child' + thread_name_suffix
278
handler = self._make_handler(conn)
279
163
connection_thread = threading.Thread(
280
164
None, handler.serve, name=thread_name)
281
self._active_connections.append((handler, connection_thread))
282
165
connection_thread.setDaemon(True)
283
166
connection_thread.start()
284
return connection_thread
286
168
def start_background_thread(self, thread_name_suffix=''):
287
169
self._started.clear()
288
170
self._server_thread = threading.Thread(None,
290
thread_name_suffix,),
291
name='server-' + self.get_url())
171
self.serve, args=(thread_name_suffix,),
172
name='server-' + self.get_url())
292
173
self._server_thread.setDaemon(True)
293
174
self._server_thread.start()
294
175
self._started.wait()
328
209
These are all empty initially, because by default nothing should get
331
Hooks.__init__(self, "breezy.bzr.smart.server", "SmartTCPServer.hooks")
332
self.add_hook('server_started',
333
"Called by the bzr server when it starts serving a directory. "
334
"server_started is called with (backing urls, public url), "
335
"where backing_url is a list of URLs giving the "
336
"server-specific directory locations, and public_url is the "
337
"public URL for the directory being served.", (0, 16))
338
self.add_hook('server_started_ex',
339
"Called by the bzr server when it starts serving a directory. "
340
"server_started is called with (backing_urls, server_obj).",
342
self.add_hook('server_stopped',
343
"Called by the bzr server when it stops serving a directory. "
344
"server_stopped is called with the same parameters as the "
345
"server_started hook: (backing_urls, public_url).", (0, 16))
346
self.add_hook('server_exception',
347
"Called by the bzr server when an exception occurs. "
348
"server_exception is called with the sys.exc_info() tuple "
349
"return true for the hook if the exception has been handled, "
350
"in which case the server will exit normally.", (2, 4))
213
self.create_hook(HookPoint('server_started',
214
"Called by the bzr server when it starts serving a directory. "
215
"server_started is called with (backing urls, public url), "
216
"where backing_url is a list of URLs giving the "
217
"server-specific directory locations, and public_url is the "
218
"public URL for the directory being served.", (0, 16), None))
219
self.create_hook(HookPoint('server_started_ex',
220
"Called by the bzr server when it starts serving a directory. "
221
"server_started is called with (backing_urls, server_obj).",
223
self.create_hook(HookPoint('server_stopped',
224
"Called by the bzr server when it stops serving a directory. "
225
"server_stopped is called with the same parameters as the "
226
"server_started hook: (backing_urls, public_url).", (0, 16), None))
353
228
SmartTCPServer.hooks = SmartServerHooks()
356
def _local_path_for_transport(transport):
357
"""Return a local path for transport, if reasonably possible.
359
This function works even if transport's url has a "readonly+" prefix,
360
unlike local_path_from_url.
362
This essentially recovers the --directory argument the user passed to "bzr
363
serve" from the transport passed to serve_bzr.
366
base_url = transport.external_url()
367
except (errors.InProcessTransport, NotImplementedError):
231
class SmartTCPServer_for_testing(SmartTCPServer):
232
"""Server suitable for use by transport tests.
234
This server is backed by the process's cwd.
237
def __init__(self, thread_name_suffix=''):
238
SmartTCPServer.__init__(self, None)
239
self.client_path_extra = None
240
self.thread_name_suffix = thread_name_suffix
242
def get_backing_transport(self, backing_transport_server):
243
"""Get a backing transport from a server we are decorating."""
244
return transport.get_transport(backing_transport_server.get_url())
246
def setUp(self, backing_transport_server=None,
247
client_path_extra='/extra/'):
248
"""Set up server for testing.
250
:param backing_transport_server: backing server to use. If not
251
specified, a LocalURLServer at the current working directory will
253
:param client_path_extra: a path segment starting with '/' to append to
254
the root URL for this server. For instance, a value of '/foo/bar/'
255
will mean the root of the backing transport will be published at a
256
URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
257
`bzr://127.0.0.1:nnnn/`. Default value is `extra`, so that tests
258
by default will fail unless they do the necessary path translation.
260
if not client_path_extra.startswith('/'):
261
raise ValueError(client_path_extra)
262
from bzrlib.transport.chroot import ChrootServer
263
if backing_transport_server is None:
264
from bzrlib.transport.local import LocalURLServer
265
backing_transport_server = LocalURLServer()
266
self.chroot_server = ChrootServer(
267
self.get_backing_transport(backing_transport_server))
268
self.chroot_server.setUp()
269
self.backing_transport = transport.get_transport(
270
self.chroot_server.get_url())
271
self.root_client_path = self.client_path_extra = client_path_extra
272
self.start_background_thread(self.thread_name_suffix)
275
self.stop_background_thread()
276
self.chroot_server.tearDown()
279
url = super(SmartTCPServer_for_testing, self).get_url()
280
return url[:-1] + self.client_path_extra
282
def get_bogus_url(self):
283
"""Return a URL which will fail to connect"""
284
return 'bzr://127.0.0.1:1/'
287
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
288
"""Get a readonly server for testing."""
290
def get_backing_transport(self, backing_transport_server):
291
"""Get a backing transport from a server we are decorating."""
292
url = 'readonly+' + backing_transport_server.get_url()
293
return transport.get_transport(url)
296
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
297
"""A variation of SmartTCPServer_for_testing that limits the client to
298
using RPCs in protocol v2 (i.e. bzr <= 1.5).
302
url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
303
url = 'bzr-v2://' + url[len('bzr://'):]
307
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
308
"""Get a readonly server for testing."""
310
def get_backing_transport(self, backing_transport_server):
311
"""Get a backing transport from a server we are decorating."""
312
url = 'readonly+' + backing_transport_server.get_url()
313
return transport.get_transport(url)
316
def serve_bzr(transport, host=None, port=None, inet=False):
317
from bzrlib import lockdir, ui
318
from bzrlib.transport import get_transport
319
from bzrlib.transport.chroot import ChrootServer
320
chroot_server = ChrootServer(transport)
321
chroot_server.setUp()
322
transport = get_transport(chroot_server.get_url())
324
smart_server = medium.SmartServerPipeStreamMedium(
325
sys.stdin, sys.stdout, transport)
370
# Strip readonly prefix
371
if base_url.startswith('readonly+'):
372
base_url = base_url[len('readonly+'):]
374
return urlutils.local_path_from_url(base_url)
375
except urlutils.InvalidURL:
379
class BzrServerFactory(object):
380
"""Helper class for serve_bzr."""
382
def __init__(self, userdir_expander=None, get_base_path=None):
384
self.base_path = None
385
self.backing_transport = None
386
if userdir_expander is None:
387
userdir_expander = os.path.expanduser
388
self.userdir_expander = userdir_expander
389
if get_base_path is None:
390
get_base_path = _local_path_for_transport
391
self.get_base_path = get_base_path
393
def _expand_userdirs(self, path):
394
"""Translate /~/ or /~user/ to e.g. /home/foo, using
395
self.userdir_expander (os.path.expanduser by default).
397
If the translated path would fall outside base_path, or the path does
398
not start with ~, then no translation is applied.
400
If the path is inside, it is adjusted to be relative to the base path.
402
e.g. if base_path is /home, and the expanded path is /home/joe, then
403
the translated path is joe.
406
if path.startswith('~'):
407
expanded = self.userdir_expander(path)
408
if not expanded.endswith('/'):
410
if expanded.startswith(self.base_path):
411
result = expanded[len(self.base_path):]
414
def _make_expand_userdirs_filter(self, transport):
415
return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
417
def _make_backing_transport(self, transport):
418
"""Chroot transport, and decorate with userdir expander."""
419
self.base_path = self.get_base_path(transport)
420
chroot_server = chroot.ChrootServer(transport)
421
chroot_server.start_server()
422
self.cleanups.append(chroot_server.stop_server)
423
transport = _mod_transport.get_transport_from_url(
424
chroot_server.get_url())
425
if self.base_path is not None:
426
# Decorate the server's backing transport with a filter that can
428
expand_userdirs = self._make_expand_userdirs_filter(transport)
429
expand_userdirs.start_server()
430
self.cleanups.append(expand_userdirs.stop_server)
431
transport = _mod_transport.get_transport_from_url(
432
expand_userdirs.get_url())
433
self.transport = transport
435
def _get_stdin_stdout(self):
436
return sys.stdin.buffer, sys.stdout.buffer
438
def _make_smart_server(self, host, port, inet, timeout):
440
c = config.GlobalStack()
441
timeout = c.get('serve.client_timeout')
443
stdin, stdout = self._get_stdin_stdout()
444
smart_server = medium.SmartServerPipeStreamMedium(
445
stdin, stdout, self.transport, timeout=timeout)
448
host = medium.BZR_DEFAULT_INTERFACE
450
port = medium.BZR_DEFAULT_PORT
451
smart_server = SmartTCPServer(self.transport,
452
client_timeout=timeout)
453
smart_server.start_server(host, port)
454
trace.note(gettext('listening on port: %s'),
455
str(smart_server.port))
456
self.smart_server = smart_server
458
def _change_globals(self):
459
from breezy import lockdir, ui
460
# For the duration of this server, no UI output is permitted. note
461
# that this may cause problems with blackbox tests. This should be
462
# changed with care though, as we dont want to use bandwidth sending
463
# progress over stderr to smart server clients!
464
old_factory = ui.ui_factory
465
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
467
def restore_default_ui_factory_and_lockdir_timeout():
468
ui.ui_factory = old_factory
469
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
470
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
328
host = medium.BZR_DEFAULT_INTERFACE
330
port = medium.BZR_DEFAULT_PORT
331
smart_server = SmartTCPServer(transport, host=host, port=port)
332
trace.note('listening on port: %s' % smart_server.port)
333
# For the duration of this server, no UI output is permitted. note
334
# that this may cause problems with blackbox tests. This should be
335
# changed with care though, as we dont want to use bandwidth sending
336
# progress over stderr to smart server clients!
337
old_factory = ui.ui_factory
338
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
471
340
ui.ui_factory = ui.SilentUIFactory()
472
341
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
473
orig = signals.install_sighup_handler()
475
def restore_signals():
476
signals.restore_sighup_handler(orig)
477
self.cleanups.append(restore_signals)
479
def set_up(self, transport, host, port, inet, timeout):
480
self._make_backing_transport(transport)
481
self._make_smart_server(host, port, inet, timeout)
482
self._change_globals()
485
for cleanup in reversed(self.cleanups):
489
def serve_bzr(transport, host=None, port=None, inet=False, timeout=None):
490
"""This is the default implementation of 'bzr serve'.
492
It creates a TCP or pipe smart server on 'transport, and runs it. The
493
transport will be decorated with a chroot and pathfilter (using
496
bzr_server = BzrServerFactory()
498
bzr_server.set_up(transport, host, port, inet, timeout)
499
bzr_server.smart_server.serve()
501
hook_caught_exception = False
502
for hook in SmartTCPServer.hooks['server_exception']:
503
hook_caught_exception = hook(sys.exc_info())
504
if not hook_caught_exception:
507
bzr_server.tear_down()
344
ui.ui_factory = old_factory
345
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout