1
# Copyright (C) 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Server for smart-server protocol."""
24
from bzrlib.hooks import Hooks
30
from bzrlib.lazy_import import lazy_import
31
lazy_import(globals(), """
32
from bzrlib.smart import medium
36
class SmartTCPServer(object):
37
"""Listens on a TCP socket and accepts connections from smart clients.
39
Each connection will be served by a SmartServerSocketStreamMedium running in
42
hooks: An instance of SmartServerHooks.
45
def __init__(self, backing_transport, host='127.0.0.1', port=0,
46
root_client_path='/'):
47
"""Construct a new server.
49
To actually start it running, call either start_background_thread or
52
:param backing_transport: The transport to serve.
53
:param host: Name of the interface to listen on.
54
:param port: TCP port to listen on, or 0 to allocate a transient port.
55
:param root_client_path: The client path that will correspond to root
58
# let connections timeout so that we get a chance to terminate
59
# Keep a reference to the exceptions we want to catch because the socket
60
# module's globals get set to None during interpreter shutdown.
61
from socket import timeout as socket_timeout
62
from socket import error as socket_error
63
self._socket_error = socket_error
64
self._socket_timeout = socket_timeout
65
addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
66
socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
68
(family, socktype, proto, canonname, sockaddr) = addrs
70
self._server_socket = socket.socket(family, socktype, proto)
71
# SO_REUSERADDR has a different meaning on Windows
72
if sys.platform != 'win32':
73
self._server_socket.setsockopt(socket.SOL_SOCKET,
74
socket.SO_REUSEADDR, 1)
76
self._server_socket.bind(sockaddr)
77
except self._socket_error, message:
78
raise errors.CannotBindAddress(host, port, message)
79
self._sockname = self._server_socket.getsockname()
80
self.port = self._sockname[1]
81
self._server_socket.listen(1)
82
self._server_socket.settimeout(1)
83
self.backing_transport = backing_transport
84
self._started = threading.Event()
85
self._stopped = threading.Event()
86
self.root_client_path = root_client_path
88
def serve(self, thread_name_suffix=''):
89
self._should_terminate = False
90
# for hooks we are letting code know that a server has started (and
92
# There are three interesting urls:
93
# The URL the server can be contacted on. (e.g. bzr://host/)
94
# The URL that a commit done on the same machine as the server will
95
# have within the servers space. (e.g. file:///home/user/source)
96
# The URL that will be given to other hooks in the same process -
97
# the URL of the backing transport itself. (e.g. chroot+:///)
98
# We need all three because:
99
# * other machines see the first
100
# * local commits on this machine should be able to be mapped to
102
# * commits the server does itself need to be mapped across to this
104
# The latter two urls are different aliases to the servers url,
105
# so we group those in a list - as there might be more aliases
107
backing_urls = [self.backing_transport.base]
109
backing_urls.append(self.backing_transport.external_url())
110
except errors.InProcessTransport:
112
for hook in SmartTCPServer.hooks['server_started']:
113
hook(backing_urls, self.get_url())
117
while not self._should_terminate:
119
conn, client_addr = self._server_socket.accept()
120
except self._socket_timeout:
121
# just check if we're asked to stop
123
except self._socket_error, e:
124
# if the socket is closed by stop_background_thread
125
# we might get a EBADF here, any other socket errors
127
if e.args[0] != errno.EBADF:
128
trace.warning("listening socket error: %s", e)
130
self.serve_conn(conn, thread_name_suffix)
131
except KeyboardInterrupt:
132
# dont log when CTRL-C'd.
135
trace.error("Unhandled smart server error.")
136
trace.log_exception_quietly()
141
# ensure the server socket is closed.
142
self._server_socket.close()
143
except self._socket_error:
144
# ignore errors on close
146
for hook in SmartTCPServer.hooks['server_stopped']:
147
hook(backing_urls, self.get_url())
150
"""Return the url of the server"""
151
return "bzr://%s:%d/" % self._sockname
153
def serve_conn(self, conn, thread_name_suffix):
154
# For WIN32, where the timeout value from the listening socket
155
# propogates to the newly accepted socket.
156
conn.setblocking(True)
157
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
158
handler = medium.SmartServerSocketStreamMedium(
159
conn, self.backing_transport, self.root_client_path)
160
thread_name = 'smart-server-child' + thread_name_suffix
161
connection_thread = threading.Thread(
162
None, handler.serve, name=thread_name)
163
connection_thread.setDaemon(True)
164
connection_thread.start()
166
def start_background_thread(self, thread_name_suffix=''):
167
self._started.clear()
168
self._server_thread = threading.Thread(None,
169
self.serve, args=(thread_name_suffix,),
170
name='server-' + self.get_url())
171
self._server_thread.setDaemon(True)
172
self._server_thread.start()
175
def stop_background_thread(self):
176
self._stopped.clear()
177
# tell the main loop to quit on the next iteration.
178
self._should_terminate = True
179
# close the socket - gives error to connections from here on in,
180
# rather than a connection reset error to connections made during
181
# the period between setting _should_terminate = True and
182
# the current request completing/aborting. It may also break out the
183
# main loop if it was currently in accept() (on some platforms).
185
self._server_socket.close()
186
except self._socket_error:
187
# ignore errors on close
189
if not self._stopped.isSet():
190
# server has not stopped (though it may be stopping)
191
# its likely in accept(), so give it a connection
192
temp_socket = socket.socket()
193
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
194
if not temp_socket.connect_ex(self._sockname):
195
# and close it immediately: we dont choose to send any requests.
198
self._server_thread.join()
201
class SmartServerHooks(Hooks):
202
"""Hooks for the smart server."""
205
"""Create the default hooks.
207
These are all empty initially, because by default nothing should get
211
# Introduced in 0.16:
212
# invoked whenever the server starts serving a directory.
213
# The api signature is (backing urls, public url).
214
self['server_started'] = []
215
# Introduced in 0.16:
216
# invoked whenever the server stops serving a directory.
217
# The api signature is (backing urls, public url).
218
self['server_stopped'] = []
220
SmartTCPServer.hooks = SmartServerHooks()
223
class SmartTCPServer_for_testing(SmartTCPServer):
224
"""Server suitable for use by transport tests.
226
This server is backed by the process's cwd.
229
def __init__(self, thread_name_suffix=''):
230
SmartTCPServer.__init__(self, None)
231
self.client_path_extra = None
232
self.thread_name_suffix = thread_name_suffix
234
def get_backing_transport(self, backing_transport_server):
235
"""Get a backing transport from a server we are decorating."""
236
return transport.get_transport(backing_transport_server.get_url())
238
def setUp(self, backing_transport_server=None,
239
client_path_extra='/extra/'):
240
"""Set up server for testing.
242
:param backing_transport_server: backing server to use. If not
243
specified, a LocalURLServer at the current working directory will
245
:param client_path_extra: a path segment starting with '/' to append to
246
the root URL for this server. For instance, a value of '/foo/bar/'
247
will mean the root of the backing transport will be published at a
248
URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
249
`bzr://127.0.0.1:nnnn/`. Default value is `extra`, so that tests
250
by default will fail unless they do the necessary path translation.
252
if not client_path_extra.startswith('/'):
253
raise ValueError(client_path_extra)
254
from bzrlib.transport.chroot import ChrootServer
255
if backing_transport_server is None:
256
from bzrlib.transport.local import LocalURLServer
257
backing_transport_server = LocalURLServer()
258
self.chroot_server = ChrootServer(
259
self.get_backing_transport(backing_transport_server))
260
self.chroot_server.setUp()
261
self.backing_transport = transport.get_transport(
262
self.chroot_server.get_url())
263
self.root_client_path = self.client_path_extra = client_path_extra
264
self.start_background_thread(self.thread_name_suffix)
267
self.stop_background_thread()
268
self.chroot_server.tearDown()
271
url = super(SmartTCPServer_for_testing, self).get_url()
272
return url[:-1] + self.client_path_extra
274
def get_bogus_url(self):
275
"""Return a URL which will fail to connect"""
276
return 'bzr://127.0.0.1:1/'
279
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
280
"""Get a readonly server for testing."""
282
def get_backing_transport(self, backing_transport_server):
283
"""Get a backing transport from a server we are decorating."""
284
url = 'readonly+' + backing_transport_server.get_url()
285
return transport.get_transport(url)
288
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
289
"""A variation of SmartTCPServer_for_testing that limits the client to
290
using RPCs in protocol v2 (i.e. bzr <= 1.5).
294
url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
295
url = 'bzr-v2://' + url[len('bzr://'):]
299
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
300
"""Get a readonly server for testing."""
302
def get_backing_transport(self, backing_transport_server):
303
"""Get a backing transport from a server we are decorating."""
304
url = 'readonly+' + backing_transport_server.get_url()
305
return transport.get_transport(url)
added
removed
bzrlib/smart/server.py
