13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Server for smart-server protocol."""
26
from ...hooks import Hooks
24
from bzrlib.hooks import Hooks
25
from bzrlib.smart import medium
30
transport as _mod_transport,
32
from ...i18n import gettext
33
from ...lazy_import import lazy_import
34
lazy_import(globals(), """
35
from breezy.bzr.smart import (
39
from breezy.transport import (
31
from bzrlib.smart.medium import SmartServerSocketStreamMedium
50
34
class SmartTCPServer(object):
51
"""Listens on a TCP socket and accepts connections from smart clients.
53
Each connection will be served by a SmartServerSocketStreamMedium running in
35
"""Listens on a TCP socket and accepts connections from smart clients
56
37
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='/',
40
def __init__(self, backing_transport, host='127.0.0.1', port=0):
70
41
"""Construct a new server.
72
43
To actually start it running, call either start_background_thread or
75
:param backing_transport: The transport to serve.
76
:param root_client_path: The client path that will correspond to root
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
46
:param host: Name of the interface to listen on.
93
47
:param port: TCP port to listen on, or 0 to allocate a transient port.
99
53
from socket import error as socket_error
100
54
self._socket_error = socket_error
101
55
self._socket_timeout = socket_timeout
102
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
103
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
105
(family, socktype, proto, canonname, sockaddr) = addrs
107
self._server_socket = socket.socket(family, socktype, proto)
108
# SO_REUSERADDR has a different meaning on Windows
109
if sys.platform != 'win32':
110
self._server_socket.setsockopt(socket.SOL_SOCKET,
111
socket.SO_REUSEADDR, 1)
113
self._server_socket.bind(sockaddr)
114
except self._socket_error as message:
115
raise errors.CannotBindAddress(host, port, message)
56
self._server_socket = socket.socket()
57
self._server_socket.bind((host, port))
116
58
self._sockname = self._server_socket.getsockname()
117
59
self.port = self._sockname[1]
118
60
self._server_socket.listen(1)
119
self._server_socket.settimeout(self._ACCEPT_TIMEOUT)
120
# Once we start accept()ing connections, we set started.
61
self._server_socket.settimeout(1)
62
self.backing_transport = backing_transport
121
63
self._started = threading.Event()
122
# Once we stop accept()ing connections (and are closing the socket) we
124
64
self._stopped = threading.Event()
125
# Once we have finished waiting for all clients, etc. We set
127
self._fully_stopped = threading.Event()
129
def _backing_urls(self):
130
# There are three interesting urls:
131
# The URL the server can be contacted on. (e.g. bzr://host/)
132
# The URL that a commit done on the same machine as the server will
133
# have within the servers space. (e.g. file:///home/user/source)
134
# 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:///)
136
# We need all three because:
137
# * other machines see the first
138
# * local commits on this machine should be able to be mapped to
140
# * commits the server does itself need to be mapped across to this
142
# The latter two urls are different aliases to the servers url,
143
# so we group those in a list - as there might be more aliases
145
urls = [self.backing_transport.base]
147
urls.append(self.backing_transport.external_url())
148
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()
67
self._should_terminate = False
155
68
for hook in SmartTCPServer.hooks['server_started']:
156
hook(backing_urls, self.get_url())
157
for hook in SmartTCPServer.hooks['server_started_ex']:
158
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()
69
hook(self.backing_transport.base, self.get_url())
202
70
self._started.set()
208
76
except self._socket_timeout:
209
77
# just check if we're asked to stop
211
except self._socket_error as e:
79
except self._socket_error, e:
212
80
# 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")
81
# we might get a EBADF here, any other socket errors
83
if e.args[0] != errno.EBADF:
84
trace.warning("listening socket error: %s", e)
220
if self._should_terminate:
223
self.serve_conn(conn, thread_name_suffix)
224
# Cleanout any threads that have finished processing.
225
self._poll_active_connections()
226
87
except KeyboardInterrupt:
227
88
# dont log when CTRL-C'd.
229
except Exception as e:
230
trace.report_exception(sys.exc_info(), sys.stderr)
91
trace.error("Unhandled smart server error.")
92
trace.log_exception_quietly()
234
97
# ensure the server socket is closed.
235
98
self._server_socket.close()
236
99
except self._socket_error:
237
100
# 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()
102
for hook in SmartTCPServer.hooks['server_stopped']:
103
hook(self.backing_transport.base, self.get_url())
246
105
def get_url(self):
247
106
"""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
272
def serve_conn(self, conn, thread_name_suffix):
107
return "bzr://%s:%d/" % self._sockname
109
def serve_conn(self, conn):
273
110
# For WIN32, where the timeout value from the listening socket
274
# propagates to the newly accepted socket.
111
# propogates to the newly accepted socket.
275
112
conn.setblocking(True)
276
113
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
277
thread_name = 'smart-server-child' + thread_name_suffix
278
handler = self._make_handler(conn)
279
connection_thread = threading.Thread(
280
None, handler.serve, name=thread_name)
281
self._active_connections.append((handler, connection_thread))
114
handler = SmartServerSocketStreamMedium(conn, self.backing_transport)
115
connection_thread = threading.Thread(None, handler.serve, name='smart-server-child')
282
116
connection_thread.setDaemon(True)
283
117
connection_thread.start()
284
return connection_thread
286
def start_background_thread(self, thread_name_suffix=''):
119
def start_background_thread(self):
287
120
self._started.clear()
288
121
self._server_thread = threading.Thread(None,
290
thread_name_suffix,),
291
name='server-' + self.get_url())
123
name='server-' + self.get_url())
292
124
self._server_thread.setDaemon(True)
293
125
self._server_thread.start()
294
126
self._started.wait()
328
160
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))
164
# Introduced in 0.16:
165
# invoked whenever the server starts serving a directory.
166
# The api signature is (backing url, public url).
167
self['server_started'] = []
168
# Introduced in 0.16:
169
# invoked whenever the server stops serving a directory.
170
# The api signature is (backing url, public url).
171
self['server_stopped'] = []
353
173
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):
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)
471
ui.ui_factory = ui.SilentUIFactory()
472
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()
176
class SmartTCPServer_for_testing(SmartTCPServer):
177
"""Server suitable for use by transport tests.
179
This server is backed by the process's cwd.
183
self._homedir = urlutils.local_path_to_url(os.getcwd())[7:]
184
# The server is set up by default like for ssh access: the client
185
# passes filesystem-absolute paths; therefore the server must look
186
# them up relative to the root directory. it might be better to act
187
# a public server and have the server rewrite paths into the test
189
SmartTCPServer.__init__(self,
190
transport.get_transport(urlutils.local_path_to_url('/')))
192
def get_backing_transport(self, backing_transport_server):
193
"""Get a backing transport from a server we are decorating."""
194
return transport.get_transport(backing_transport_server.get_url())
196
def setUp(self, backing_transport_server=None):
197
"""Set up server for testing"""
198
from bzrlib.transport.chroot import TestingChrootServer
199
if backing_transport_server is None:
200
from bzrlib.transport.local import LocalURLServer
201
backing_transport_server = LocalURLServer()
202
self.chroot_server = TestingChrootServer()
203
self.chroot_server.setUp(backing_transport_server)
204
self.backing_transport = transport.get_transport(
205
self.chroot_server.get_url())
206
self.start_background_thread()
209
self.stop_background_thread()
211
def get_bogus_url(self):
212
"""Return a URL which will fail to connect"""
213
return 'bzr://127.0.0.1:1/'
added
removed
bzrlib/smart/server.py
