56
51
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='/',
54
def __init__(self, backing_transport, host='127.0.0.1', port=0,
55
root_client_path='/'):
70
56
"""Construct a new server.
72
58
To actually start it running, call either start_background_thread or
75
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.
76
64
:param root_client_path: The client path that will correspond to root
77
65
of backing_transport.
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
67
# let connections timeout so that we get a chance to terminate
96
68
# Keep a reference to the exceptions we want to catch because the socket
116
88
self._sockname = self._server_socket.getsockname()
117
89
self.port = self._sockname[1]
118
90
self._server_socket.listen(1)
119
self._server_socket.settimeout(self._ACCEPT_TIMEOUT)
120
# Once we start accept()ing connections, we set started.
91
self._server_socket.settimeout(1)
92
self.backing_transport = backing_transport
121
93
self._started = threading.Event()
122
# Once we stop accept()ing connections (and are closing the socket) we
124
94
self._stopped = threading.Event()
125
# Once we have finished waiting for all clients, etc. We set
127
self._fully_stopped = threading.Event()
95
self.root_client_path = root_client_path
129
def _backing_urls(self):
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
130
101
# There are three interesting urls:
131
102
# The URL the server can be contacted on. (e.g. bzr://host/)
132
103
# The URL that a commit done on the same machine as the server will
133
104
# have within the servers space. (e.g. file:///home/user/source)
134
105
# 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:///)
106
# the URL of the backing transport itself. (e.g. chroot+:///)
136
107
# We need all three because:
137
108
# * other machines see the first
138
109
# * local commits on this machine should be able to be mapped to
142
113
# The latter two urls are different aliases to the servers url,
143
114
# so we group those in a list - as there might be more aliases
145
urls = [self.backing_transport.base]
116
backing_urls = [self.backing_transport.base]
147
urls.append(self.backing_transport.external_url())
118
backing_urls.append(self.backing_transport.external_url())
148
119
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
121
for hook in SmartTCPServer.hooks['server_started']:
156
122
hook(backing_urls, self.get_url())
157
123
for hook in SmartTCPServer.hooks['server_started_ex']:
158
124
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
125
self._started.set()
230
146
trace.report_exception(sys.exc_info(), sys.stderr)
234
151
# ensure the server socket is closed.
235
152
self._server_socket.close()
236
153
except self._socket_error:
237
154
# 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()
156
for hook in SmartTCPServer.hooks['server_stopped']:
157
hook(backing_urls, self.get_url())
246
159
def get_url(self):
247
160
"""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
161
return "bzr://%s:%d/" % self._sockname
272
163
def serve_conn(self, conn, thread_name_suffix):
273
164
# For WIN32, where the timeout value from the listening socket
274
165
# propagates to the newly accepted socket.
275
166
conn.setblocking(True)
276
167
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
168
handler = medium.SmartServerSocketStreamMedium(
169
conn, self.backing_transport, self.root_client_path)
277
170
thread_name = 'smart-server-child' + thread_name_suffix
278
handler = self._make_handler(conn)
279
171
connection_thread = threading.Thread(
280
172
None, handler.serve, name=thread_name)
281
self._active_connections.append((handler, connection_thread))
282
173
connection_thread.setDaemon(True)
283
174
connection_thread.start()
284
return connection_thread
286
176
def start_background_thread(self, thread_name_suffix=''):
287
177
self._started.clear()
327
217
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',
221
self.create_hook(HookPoint('server_started',
332
222
"Called by the bzr server when it starts serving a directory. "
333
223
"server_started is called with (backing urls, public url), "
334
224
"where backing_url is a list of URLs giving the "
335
225
"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',
226
"public URL for the directory being served.", (0, 16), None))
227
self.create_hook(HookPoint('server_started_ex',
338
228
"Called by the bzr server when it starts serving a directory. "
339
229
"server_started is called with (backing_urls, server_obj).",
341
self.add_hook('server_stopped',
231
self.create_hook(HookPoint('server_stopped',
342
232
"Called by the bzr server when it stops serving a directory. "
343
233
"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))
234
"server_started hook: (backing_urls, public_url).", (0, 16), None))
351
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)
354
324
def _local_path_for_transport(transport):
355
325
"""Return a local path for transport, if reasonably possible.
418
388
chroot_server = chroot.ChrootServer(transport)
419
389
chroot_server.start_server()
420
390
self.cleanups.append(chroot_server.stop_server)
421
transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
391
transport = get_transport(chroot_server.get_url())
422
392
if self.base_path is not None:
423
393
# Decorate the server's backing transport with a filter that can
424
394
# expand homedirs.
425
395
expand_userdirs = self._make_expand_userdirs_filter(transport)
426
396
expand_userdirs.start_server()
427
397
self.cleanups.append(expand_userdirs.stop_server)
428
transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
398
transport = get_transport(expand_userdirs.get_url())
429
399
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')
401
def _make_smart_server(self, host, port, inet):
439
stdin, stdout = self._get_stdin_stdout()
440
403
smart_server = medium.SmartServerPipeStreamMedium(
441
stdin, stdout, self.transport, timeout=timeout)
404
sys.stdin, sys.stdout, self.transport)
444
407
host = medium.BZR_DEFAULT_INTERFACE
446
409
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)
410
smart_server = SmartTCPServer(self.transport, host=host, port=port)
411
trace.note('listening on port: %s' % smart_server.port)
451
412
self.smart_server = smart_server
453
414
def _change_globals(self):
482
def serve_bzr(transport, host=None, port=None, inet=False, timeout=None):
439
def serve_bzr(transport, host=None, port=None, inet=False):
483
440
"""This is the default implementation of 'bzr serve'.
485
442
It creates a TCP or pipe smart server on 'transport, and runs it. The
486
443
transport will be decorated with a chroot and pathfilter (using
487
444
os.path.expanduser).
489
446
bzr_server = BzrServerFactory()
491
bzr_server.set_up(transport, host, port, inet, timeout)
448
bzr_server.set_up(transport, host, port, inet)
492
449
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
451
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
