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.i18n import gettext
32
from bzrlib.lazy_import import lazy_import
33
lazy_import(globals(), """
34
from bzrlib.smart import medium
35
from bzrlib.transport import (
45
class SmartTCPServer(object):
46
"""Listens on a TCP socket and accepts connections from smart clients.
48
Each connection will be served by a SmartServerSocketStreamMedium running in
51
hooks: An instance of SmartServerHooks.
54
def __init__(self, backing_transport, root_client_path='/'):
55
"""Construct a new server.
57
To actually start it running, call either start_background_thread or
60
:param backing_transport: The transport to serve.
61
:param root_client_path: The client path that will correspond to root
64
self.backing_transport = backing_transport
65
self.root_client_path = root_client_path
67
def start_server(self, host, port):
68
"""Create the server listening socket.
70
:param host: Name of the interface to listen on.
71
:param port: TCP port to listen on, or 0 to allocate a transient port.
73
# let connections timeout so that we get a chance to terminate
74
# Keep a reference to the exceptions we want to catch because the socket
75
# module's globals get set to None during interpreter shutdown.
76
from socket import timeout as socket_timeout
77
from socket import error as socket_error
78
self._socket_error = socket_error
79
self._socket_timeout = socket_timeout
80
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
81
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
83
(family, socktype, proto, canonname, sockaddr) = addrs
85
self._server_socket = socket.socket(family, socktype, proto)
86
# SO_REUSERADDR has a different meaning on Windows
87
if sys.platform != 'win32':
88
self._server_socket.setsockopt(socket.SOL_SOCKET,
89
socket.SO_REUSEADDR, 1)
91
self._server_socket.bind(sockaddr)
92
except self._socket_error, message:
93
raise errors.CannotBindAddress(host, port, message)
94
self._sockname = self._server_socket.getsockname()
95
self.port = self._sockname[1]
96
self._server_socket.listen(1)
97
self._server_socket.settimeout(1)
98
self._started = threading.Event()
99
self._stopped = threading.Event()
101
def _backing_urls(self):
102
# There are three interesting urls:
103
# The URL the server can be contacted on. (e.g. bzr://host/)
104
# The URL that a commit done on the same machine as the server will
105
# have within the servers space. (e.g. file:///home/user/source)
106
# The URL that will be given to other hooks in the same process -
107
# the URL of the backing transport itself. (e.g. filtered-36195:///)
108
# We need all three because:
109
# * other machines see the first
110
# * local commits on this machine should be able to be mapped to
112
# * commits the server does itself need to be mapped across to this
114
# The latter two urls are different aliases to the servers url,
115
# so we group those in a list - as there might be more aliases
117
urls = [self.backing_transport.base]
119
urls.append(self.backing_transport.external_url())
120
except errors.InProcessTransport:
124
def run_server_started_hooks(self, backing_urls=None):
125
if backing_urls is None:
126
backing_urls = self._backing_urls()
127
for hook in SmartTCPServer.hooks['server_started']:
128
hook(backing_urls, self.get_url())
129
for hook in SmartTCPServer.hooks['server_started_ex']:
130
hook(backing_urls, self)
132
def run_server_stopped_hooks(self, backing_urls=None):
133
if backing_urls is None:
134
backing_urls = self._backing_urls()
135
for hook in SmartTCPServer.hooks['server_stopped']:
136
hook(backing_urls, self.get_url())
138
def serve(self, thread_name_suffix=''):
139
self._should_terminate = False
140
# for hooks we are letting code know that a server has started (and
142
self.run_server_started_hooks()
146
while not self._should_terminate:
148
conn, client_addr = self._server_socket.accept()
149
except self._socket_timeout:
150
# just check if we're asked to stop
152
except self._socket_error, e:
153
# if the socket is closed by stop_background_thread
154
# we might get a EBADF here, any other socket errors
156
if e.args[0] != errno.EBADF:
157
trace.warning("listening socket error: %s", e)
159
if self._should_terminate:
161
self.serve_conn(conn, thread_name_suffix)
162
except KeyboardInterrupt:
163
# dont log when CTRL-C'd.
166
trace.report_exception(sys.exc_info(), sys.stderr)
171
# ensure the server socket is closed.
172
self._server_socket.close()
173
except self._socket_error:
174
# ignore errors on close
176
self.run_server_stopped_hooks()
179
"""Return the url of the server"""
180
return "bzr://%s:%s/" % (self._sockname[0], self._sockname[1])
182
def serve_conn(self, conn, thread_name_suffix):
183
# For WIN32, where the timeout value from the listening socket
184
# propagates to the newly accepted socket.
185
conn.setblocking(True)
186
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
187
handler = medium.SmartServerSocketStreamMedium(
188
conn, self.backing_transport, self.root_client_path)
189
thread_name = 'smart-server-child' + thread_name_suffix
190
connection_thread = threading.Thread(
191
None, handler.serve, name=thread_name)
192
# FIXME: This thread is never joined, it should at least be collected
193
# somewhere so that tests that want to check for leaked threads can get
194
# rid of them -- vila 20100531
195
connection_thread.setDaemon(True)
196
connection_thread.start()
197
return connection_thread
199
def start_background_thread(self, thread_name_suffix=''):
200
self._started.clear()
201
self._server_thread = threading.Thread(None,
202
self.serve, args=(thread_name_suffix,),
203
name='server-' + self.get_url())
204
self._server_thread.setDaemon(True)
205
self._server_thread.start()
208
def stop_background_thread(self):
209
self._stopped.clear()
210
# tell the main loop to quit on the next iteration.
211
self._should_terminate = True
212
# close the socket - gives error to connections from here on in,
213
# rather than a connection reset error to connections made during
214
# the period between setting _should_terminate = True and
215
# the current request completing/aborting. It may also break out the
216
# main loop if it was currently in accept() (on some platforms).
218
self._server_socket.close()
219
except self._socket_error:
220
# ignore errors on close
222
if not self._stopped.isSet():
223
# server has not stopped (though it may be stopping)
224
# its likely in accept(), so give it a connection
225
temp_socket = socket.socket()
226
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
227
if not temp_socket.connect_ex(self._sockname):
228
# and close it immediately: we dont choose to send any requests.
231
self._server_thread.join()
234
class SmartServerHooks(Hooks):
235
"""Hooks for the smart server."""
238
"""Create the default hooks.
240
These are all empty initially, because by default nothing should get
243
Hooks.__init__(self, "bzrlib.smart.server", "SmartTCPServer.hooks")
244
self.add_hook('server_started',
245
"Called by the bzr server when it starts serving a directory. "
246
"server_started is called with (backing urls, public url), "
247
"where backing_url is a list of URLs giving the "
248
"server-specific directory locations, and public_url is the "
249
"public URL for the directory being served.", (0, 16))
250
self.add_hook('server_started_ex',
251
"Called by the bzr server when it starts serving a directory. "
252
"server_started is called with (backing_urls, server_obj).",
254
self.add_hook('server_stopped',
255
"Called by the bzr server when it stops serving a directory. "
256
"server_stopped is called with the same parameters as the "
257
"server_started hook: (backing_urls, public_url).", (0, 16))
258
self.add_hook('server_exception',
259
"Called by the bzr server when an exception occurs. "
260
"server_exception is called with the sys.exc_info() tuple "
261
"return true for the hook if the exception has been handled, "
262
"in which case the server will exit normally.", (2, 4))
264
SmartTCPServer.hooks = SmartServerHooks()
267
def _local_path_for_transport(transport):
268
"""Return a local path for transport, if reasonably possible.
270
This function works even if transport's url has a "readonly+" prefix,
271
unlike local_path_from_url.
273
This essentially recovers the --directory argument the user passed to "bzr
274
serve" from the transport passed to serve_bzr.
277
base_url = transport.external_url()
278
except (errors.InProcessTransport, NotImplementedError):
281
# Strip readonly prefix
282
if base_url.startswith('readonly+'):
283
base_url = base_url[len('readonly+'):]
285
return urlutils.local_path_from_url(base_url)
286
except errors.InvalidURL:
290
class BzrServerFactory(object):
291
"""Helper class for serve_bzr."""
293
def __init__(self, userdir_expander=None, get_base_path=None):
295
self.base_path = None
296
self.backing_transport = None
297
if userdir_expander is None:
298
userdir_expander = os.path.expanduser
299
self.userdir_expander = userdir_expander
300
if get_base_path is None:
301
get_base_path = _local_path_for_transport
302
self.get_base_path = get_base_path
304
def _expand_userdirs(self, path):
305
"""Translate /~/ or /~user/ to e.g. /home/foo, using
306
self.userdir_expander (os.path.expanduser by default).
308
If the translated path would fall outside base_path, or the path does
309
not start with ~, then no translation is applied.
311
If the path is inside, it is adjusted to be relative to the base path.
313
e.g. if base_path is /home, and the expanded path is /home/joe, then
314
the translated path is joe.
317
if path.startswith('~'):
318
expanded = self.userdir_expander(path)
319
if not expanded.endswith('/'):
321
if expanded.startswith(self.base_path):
322
result = expanded[len(self.base_path):]
325
def _make_expand_userdirs_filter(self, transport):
326
return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
328
def _make_backing_transport(self, transport):
329
"""Chroot transport, and decorate with userdir expander."""
330
self.base_path = self.get_base_path(transport)
331
chroot_server = chroot.ChrootServer(transport)
332
chroot_server.start_server()
333
self.cleanups.append(chroot_server.stop_server)
334
transport = _mod_transport.get_transport_from_url(chroot_server.get_url())
335
if self.base_path is not None:
336
# Decorate the server's backing transport with a filter that can
338
expand_userdirs = self._make_expand_userdirs_filter(transport)
339
expand_userdirs.start_server()
340
self.cleanups.append(expand_userdirs.stop_server)
341
transport = _mod_transport.get_transport_from_url(expand_userdirs.get_url())
342
self.transport = transport
344
def _make_smart_server(self, host, port, inet):
346
smart_server = medium.SmartServerPipeStreamMedium(
347
sys.stdin, sys.stdout, self.transport)
350
host = medium.BZR_DEFAULT_INTERFACE
352
port = medium.BZR_DEFAULT_PORT
353
smart_server = SmartTCPServer(self.transport)
354
smart_server.start_server(host, port)
355
trace.note(gettext('listening on port: %s') % smart_server.port)
356
self.smart_server = smart_server
358
def _change_globals(self):
359
from bzrlib import lockdir, ui
360
# For the duration of this server, no UI output is permitted. note
361
# that this may cause problems with blackbox tests. This should be
362
# changed with care though, as we dont want to use bandwidth sending
363
# progress over stderr to smart server clients!
364
old_factory = ui.ui_factory
365
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
366
def restore_default_ui_factory_and_lockdir_timeout():
367
ui.ui_factory = old_factory
368
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
369
self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
370
ui.ui_factory = ui.SilentUIFactory()
371
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
373
def set_up(self, transport, host, port, inet):
374
self._make_backing_transport(transport)
375
self._make_smart_server(host, port, inet)
376
self._change_globals()
379
for cleanup in reversed(self.cleanups):
382
def serve_bzr(transport, host=None, port=None, inet=False):
383
"""This is the default implementation of 'bzr serve'.
385
It creates a TCP or pipe smart server on 'transport, and runs it. The
386
transport will be decorated with a chroot and pathfilter (using
389
bzr_server = BzrServerFactory()
391
bzr_server.set_up(transport, host, port, inet)
392
bzr_server.smart_server.serve()
394
hook_caught_exception = False
395
for hook in SmartTCPServer.hooks['server_exception']:
396
hook_caught_exception = hook(sys.exc_info())
397
if not hook_caught_exception:
400
bzr_server.tear_down()
added
removed
bzrlib/smart/server.py
