25
from bzrlib.hooks import HookPoint, Hooks
25
from bzrlib.hooks import Hooks
26
26
from bzrlib import (
29
transport as _mod_transport,
31
31
from bzrlib.lazy_import import lazy_import
32
32
lazy_import(globals(), """
33
33
from bzrlib.smart import medium
34
34
from bzrlib.transport import (
39
38
from bzrlib import (
51
50
hooks: An instance of SmartServerHooks.
54
def __init__(self, backing_transport, host='127.0.0.1', port=0,
55
root_client_path='/'):
53
def __init__(self, backing_transport, root_client_path='/'):
56
54
"""Construct a new server.
58
56
To actually start it running, call either start_background_thread or
61
59
:param backing_transport: The transport to serve.
60
:param root_client_path: The client path that will correspond to root
63
self.backing_transport = backing_transport
64
self.root_client_path = root_client_path
66
def start_server(self, host, port):
67
"""Create the server listening socket.
62
69
:param host: Name of the interface to listen on.
63
70
: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
72
# let connections timeout so that we get a chance to terminate
68
73
# Keep a reference to the exceptions we want to catch because the socket
89
94
self.port = self._sockname[1]
90
95
self._server_socket.listen(1)
91
96
self._server_socket.settimeout(1)
92
self.backing_transport = backing_transport
93
97
self._started = threading.Event()
94
98
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
100
def _backing_urls(self):
101
101
# There are three interesting urls:
102
102
# The URL the server can be contacted on. (e.g. bzr://host/)
103
103
# The URL that a commit done on the same machine as the server will
104
104
# have within the servers space. (e.g. file:///home/user/source)
105
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+:///)
106
# the URL of the backing transport itself. (e.g. filtered-36195:///)
107
107
# We need all three because:
108
108
# * other machines see the first
109
109
# * local commits on this machine should be able to be mapped to
113
113
# The latter two urls are different aliases to the servers url,
114
114
# so we group those in a list - as there might be more aliases
116
backing_urls = [self.backing_transport.base]
116
urls = [self.backing_transport.base]
118
backing_urls.append(self.backing_transport.external_url())
118
urls.append(self.backing_transport.external_url())
119
119
except errors.InProcessTransport:
123
def run_server_started_hooks(self, backing_urls=None):
124
if backing_urls is None:
125
backing_urls = self._backing_urls()
121
126
for hook in SmartTCPServer.hooks['server_started']:
122
127
hook(backing_urls, self.get_url())
123
128
for hook in SmartTCPServer.hooks['server_started_ex']:
124
129
hook(backing_urls, self)
131
def run_server_stopped_hooks(self, backing_urls=None):
132
if backing_urls is None:
133
backing_urls = self._backing_urls()
134
for hook in SmartTCPServer.hooks['server_stopped']:
135
hook(backing_urls, self.get_url())
137
def serve(self, thread_name_suffix=''):
138
self._should_terminate = False
139
# for hooks we are letting code know that a server has started (and
141
self.run_server_started_hooks()
125
142
self._started.set()
155
172
except self._socket_error:
156
173
# ignore errors on close
158
for hook in SmartTCPServer.hooks['server_stopped']:
159
hook(backing_urls, self.get_url())
175
self.run_server_stopped_hooks()
161
177
def get_url(self):
162
178
"""Return the url of the server"""
163
return "bzr://%s:%d/" % self._sockname
179
return "bzr://%s:%s/" % (self._sockname[0], self._sockname[1])
165
181
def serve_conn(self, conn, thread_name_suffix):
166
182
# For WIN32, where the timeout value from the listening socket
172
188
thread_name = 'smart-server-child' + thread_name_suffix
173
189
connection_thread = threading.Thread(
174
190
None, handler.serve, name=thread_name)
191
# FIXME: This thread is never joined, it should at least be collected
192
# somewhere so that tests that want to check for leaked threads can get
193
# rid of them -- vila 20100531
175
194
connection_thread.setDaemon(True)
176
195
connection_thread.start()
196
return connection_thread
178
198
def start_background_thread(self, thread_name_suffix=''):
179
199
self._started.clear()
219
239
These are all empty initially, because by default nothing should get
223
self.create_hook(HookPoint('server_started',
242
Hooks.__init__(self, "bzrlib.smart.server", "SmartTCPServer.hooks")
243
self.add_hook('server_started',
224
244
"Called by the bzr server when it starts serving a directory. "
225
245
"server_started is called with (backing urls, public url), "
226
246
"where backing_url is a list of URLs giving the "
227
247
"server-specific directory locations, and public_url is the "
228
"public URL for the directory being served.", (0, 16), None))
229
self.create_hook(HookPoint('server_started_ex',
248
"public URL for the directory being served.", (0, 16))
249
self.add_hook('server_started_ex',
230
250
"Called by the bzr server when it starts serving a directory. "
231
251
"server_started is called with (backing_urls, server_obj).",
233
self.create_hook(HookPoint('server_stopped',
253
self.add_hook('server_stopped',
234
254
"Called by the bzr server when it stops serving a directory. "
235
255
"server_stopped is called with the same parameters as the "
236
"server_started hook: (backing_urls, public_url).", (0, 16), None))
256
"server_started hook: (backing_urls, public_url).", (0, 16))
257
self.add_hook('server_exception',
258
"Called by the bzr server when an exception occurs. "
259
"server_exception is called with the sys.exc_info() tuple "
260
"return true for the hook if the exception has been handled, "
261
"in which case the server will exit normally.", (2, 4))
238
263
SmartTCPServer.hooks = SmartServerHooks()
305
330
chroot_server = chroot.ChrootServer(transport)
306
331
chroot_server.start_server()
307
332
self.cleanups.append(chroot_server.stop_server)
308
transport = get_transport(chroot_server.get_url())
333
transport = _mod_transport.get_transport(chroot_server.get_url())
309
334
if self.base_path is not None:
310
335
# Decorate the server's backing transport with a filter that can
311
336
# expand homedirs.
312
337
expand_userdirs = self._make_expand_userdirs_filter(transport)
313
338
expand_userdirs.start_server()
314
339
self.cleanups.append(expand_userdirs.stop_server)
315
transport = get_transport(expand_userdirs.get_url())
340
transport = _mod_transport.get_transport(expand_userdirs.get_url())
316
341
self.transport = transport
318
343
def _make_smart_server(self, host, port, inet):
324
349
host = medium.BZR_DEFAULT_INTERFACE
326
351
port = medium.BZR_DEFAULT_PORT
327
smart_server = SmartTCPServer(self.transport, host=host, port=port)
352
smart_server = SmartTCPServer(self.transport)
353
smart_server.start_server(host, port)
328
354
trace.note('listening on port: %s' % smart_server.port)
329
355
self.smart_server = smart_server
365
390
bzr_server.set_up(transport, host, port, inet)
366
391
bzr_server.smart_server.serve()
393
hook_caught_exception = False
394
for hook in SmartTCPServer.hooks['server_exception']:
395
hook_caught_exception = hook(sys.exc_info())
396
if not hook_caught_exception:
368
399
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
