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."""
25
from bzrlib.hooks import Hooks
29
transport as _mod_transport,
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
33
from bzrlib.smart import medium
34
from bzrlib.transport import (
44
class SmartTCPServer(object):
45
"""Listens on a TCP socket and accepts connections from smart clients.
47
Each connection will be served by a SmartServerSocketStreamMedium running in
50
hooks: An instance of SmartServerHooks.
53
def __init__(self, backing_transport, root_client_path='/'):
54
"""Construct a new server.
56
To actually start it running, call either start_background_thread or
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.
69
:param host: Name of the interface to listen on.
70
:param port: TCP port to listen on, or 0 to allocate a transient port.
72
# let connections timeout so that we get a chance to terminate
73
# Keep a reference to the exceptions we want to catch because the socket
74
# module's globals get set to None during interpreter shutdown.
75
from socket import timeout as socket_timeout
76
from socket import error as socket_error
77
self._socket_error = socket_error
78
self._socket_timeout = socket_timeout
79
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
80
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
82
(family, socktype, proto, canonname, sockaddr) = addrs
84
self._server_socket = socket.socket(family, socktype, proto)
85
# SO_REUSERADDR has a different meaning on Windows
86
if sys.platform != 'win32':
87
self._server_socket.setsockopt(socket.SOL_SOCKET,
88
socket.SO_REUSEADDR, 1)
90
self._server_socket.bind(sockaddr)
91
except self._socket_error, message:
92
raise errors.CannotBindAddress(host, port, message)
93
self._sockname = self._server_socket.getsockname()
94
self.port = self._sockname[1]
95
self._server_socket.listen(1)
96
self._server_socket.settimeout(1)
97
self._started = threading.Event()
98
self._stopped = threading.Event()
100
def _backing_urls(self):
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. filtered-36195:///)
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
urls = [self.backing_transport.base]
118
urls.append(self.backing_transport.external_url())
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()
126
for hook in SmartTCPServer.hooks['server_started']:
127
hook(backing_urls, self.get_url())
128
for hook in SmartTCPServer.hooks['server_started_ex']:
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()
145
while not self._should_terminate:
147
conn, client_addr = self._server_socket.accept()
148
except self._socket_timeout:
149
# just check if we're asked to stop
151
except self._socket_error, e:
152
# if the socket is closed by stop_background_thread
153
# we might get a EBADF here, any other socket errors
155
if e.args[0] != errno.EBADF:
156
trace.warning("listening socket error: %s", e)
158
if self._should_terminate:
160
self.serve_conn(conn, thread_name_suffix)
161
except KeyboardInterrupt:
162
# dont log when CTRL-C'd.
165
trace.report_exception(sys.exc_info(), sys.stderr)
170
# ensure the server socket is closed.
171
self._server_socket.close()
172
except self._socket_error:
173
# ignore errors on close
175
self.run_server_stopped_hooks()
178
"""Return the url of the server"""
179
return "bzr://%s:%s/" % (self._sockname[0], self._sockname[1])
181
def serve_conn(self, conn, thread_name_suffix):
182
# For WIN32, where the timeout value from the listening socket
183
# propagates to the newly accepted socket.
184
conn.setblocking(True)
185
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
186
handler = medium.SmartServerSocketStreamMedium(
187
conn, self.backing_transport, self.root_client_path)
188
thread_name = 'smart-server-child' + thread_name_suffix
189
connection_thread = threading.Thread(
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
194
connection_thread.setDaemon(True)
195
connection_thread.start()
196
return connection_thread
198
def start_background_thread(self, thread_name_suffix=''):
199
self._started.clear()
200
self._server_thread = threading.Thread(None,
201
self.serve, args=(thread_name_suffix,),
202
name='server-' + self.get_url())
203
self._server_thread.setDaemon(True)
204
self._server_thread.start()
207
def stop_background_thread(self):
208
self._stopped.clear()
209
# tell the main loop to quit on the next iteration.
210
self._should_terminate = True
211
# close the socket - gives error to connections from here on in,
212
# rather than a connection reset error to connections made during
213
# the period between setting _should_terminate = True and
214
# the current request completing/aborting. It may also break out the
215
# main loop if it was currently in accept() (on some platforms).
217
self._server_socket.close()
218
except self._socket_error:
219
# ignore errors on close
221
if not self._stopped.isSet():
222
# server has not stopped (though it may be stopping)
223
# its likely in accept(), so give it a connection
224
temp_socket = socket.socket()
225
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
226
if not temp_socket.connect_ex(self._sockname):
227
# and close it immediately: we dont choose to send any requests.
230
self._server_thread.join()
233
class SmartServerHooks(Hooks):
234
"""Hooks for the smart server."""
237
"""Create the default hooks.
239
These are all empty initially, because by default nothing should get
242
Hooks.__init__(self, "bzrlib.smart.server", "SmartTCPServer.hooks")
243
self.add_hook('server_started',
244
"Called by the bzr server when it starts serving a directory. "
245
"server_started is called with (backing urls, public url), "
246
"where backing_url is a list of URLs giving the "
247
"server-specific directory locations, and public_url is the "
248
"public URL for the directory being served.", (0, 16))
249
self.add_hook('server_started_ex',
250
"Called by the bzr server when it starts serving a directory. "
251
"server_started is called with (backing_urls, server_obj).",
253
self.add_hook('server_stopped',
254
"Called by the bzr server when it stops serving a directory. "
255
"server_stopped is called with the same parameters as the "
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))
263
SmartTCPServer.hooks = SmartServerHooks()
266
def _local_path_for_transport(transport):
267
"""Return a local path for transport, if reasonably possible.
269
This function works even if transport's url has a "readonly+" prefix,
270
unlike local_path_from_url.
272
This essentially recovers the --directory argument the user passed to "bzr
273
serve" from the transport passed to serve_bzr.
276
base_url = transport.external_url()
277
except (errors.InProcessTransport, NotImplementedError):
280
# Strip readonly prefix
281
if base_url.startswith('readonly+'):
282
base_url = base_url[len('readonly+'):]
284
return urlutils.local_path_from_url(base_url)
285
except errors.InvalidURL:
289
class BzrServerFactory(object):
290
"""Helper class for serve_bzr."""
292
def __init__(self, userdir_expander=None, get_base_path=None):
294
self.base_path = None
295
self.backing_transport = None
296
if userdir_expander is None:
297
userdir_expander = os.path.expanduser
298
self.userdir_expander = userdir_expander
299
if get_base_path is None:
300
get_base_path = _local_path_for_transport
301
self.get_base_path = get_base_path
303
def _expand_userdirs(self, path):
304
"""Translate /~/ or /~user/ to e.g. /home/foo, using
305
self.userdir_expander (os.path.expanduser by default).
307
If the translated path would fall outside base_path, or the path does
308
not start with ~, then no translation is applied.
310
If the path is inside, it is adjusted to be relative to the base path.
312
e.g. if base_path is /home, and the expanded path is /home/joe, then
313
the translated path is joe.
316
if path.startswith('~'):
317
expanded = self.userdir_expander(path)
318
if not expanded.endswith('/'):
320
if expanded.startswith(self.base_path):
321
result = expanded[len(self.base_path):]
324
def _make_expand_userdirs_filter(self, transport):
325
return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
327
def _make_backing_transport(self, transport):
328
"""Chroot transport, and decorate with userdir expander."""
329
self.base_path = self.get_base_path(transport)
330
chroot_server = chroot.ChrootServer(transport)
331
chroot_server.start_server()
332
self.cleanups.append(chroot_server.stop_server)
333
transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
334
if self.base_path is not None:
335
# Decorate the server's backing transport with a filter that can
337
expand_userdirs = self._make_expand_userdirs_filter(transport)
338
expand_userdirs.start_server()
339
self.cleanups.append(expand_userdirs.stop_server)
340
transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
341
self.transport = transport
343
def _make_smart_server(self, host, port, inet):
345
smart_server = medium.SmartServerPipeStreamMedium(
346
sys.stdin, sys.stdout, self.transport)
349
host = medium.BZR_DEFAULT_INTERFACE
351
port = medium.BZR_DEFAULT_PORT
352
smart_server = SmartTCPServer(self.transport)
353
smart_server.start_server(host, port)
354
trace.note('listening on port: %s' % smart_server.port)
355
self.smart_server = smart_server
357
def _change_globals(self):
358
from bzrlib import lockdir, ui
359
# For the duration of this server, no UI output is permitted. note
360
# that this may cause problems with blackbox tests. This should be
361
# changed with care though, as we dont want to use bandwidth sending
362
# progress over stderr to smart server clients!
363
old_factory = ui.ui_factory
364
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
365
def restore_default_ui_factory_and_lockdir_timeout():
366
ui.ui_factory = old_factory
367
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
368
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
369
ui.ui_factory = ui.SilentUIFactory()
370
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
372
def set_up(self, transport, host, port, inet):
373
self._make_backing_transport(transport)
374
self._make_smart_server(host, port, inet)
375
self._change_globals()
378
for cleanup in reversed(self.cleanups):
381
def serve_bzr(transport, host=None, port=None, inet=False):
382
"""This is the default implementation of 'bzr serve'.
384
It creates a TCP or pipe smart server on 'transport, and runs it. The
385
transport will be decorated with a chroot and pathfilter (using
388
bzr_server = BzrServerFactory()
390
bzr_server.set_up(transport, host, port, inet)
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:
399
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
