2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
1 |
# Copyright (C) 2006, 2007 Canonical Ltd
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
2 |
#
|
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.
|
|
7 |
#
|
|
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.
|
|
12 |
#
|
|
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
|
|
16 |
||
2018.5.19
by Andrew Bennetts
Add docstrings to all the new modules, and a few other places. |
17 |
"""Server for smart-server protocol."""
|
18 |
||
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
19 |
import errno |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
20 |
import socket |
21 |
import threading |
|
22 |
||
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
23 |
from bzrlib.hooks import Hooks |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
24 |
from bzrlib import ( |
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
25 |
errors, |
2018.5.15
by Andrew Bennetts
Tidy some imports, and bugs introduced when adding server.py |
26 |
trace, |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
27 |
transport, |
28 |
)
|
|
2400.1.3
by Andrew Bennetts
Split smart transport code into several separate modules. |
29 |
from bzrlib.smart.medium import SmartServerSocketStreamMedium |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
30 |
|
31 |
||
32 |
class SmartTCPServer(object): |
|
33 |
"""Listens on a TCP socket and accepts connections from smart clients.
|
|
2018.5.139
by Andrew Bennetts
Merge from bzr.dev, resolving conflicts. |
34 |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
35 |
Each connection will be served by a SmartServerSocketStreamMedium running in
|
2018.5.139
by Andrew Bennetts
Merge from bzr.dev, resolving conflicts. |
36 |
a thread.
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
37 |
|
38 |
hooks: An instance of SmartServerHooks.
|
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
39 |
"""
|
40 |
||
41 |
def __init__(self, backing_transport, host='127.0.0.1', port=0): |
|
42 |
"""Construct a new server.
|
|
43 |
||
44 |
To actually start it running, call either start_background_thread or
|
|
45 |
serve.
|
|
46 |
||
47 |
:param host: Name of the interface to listen on.
|
|
48 |
:param port: TCP port to listen on, or 0 to allocate a transient port.
|
|
49 |
"""
|
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
50 |
# let connections timeout so that we get a chance to terminate
|
51 |
# Keep a reference to the exceptions we want to catch because the socket
|
|
52 |
# module's globals get set to None during interpreter shutdown.
|
|
53 |
from socket import timeout as socket_timeout |
|
54 |
from socket import error as socket_error |
|
55 |
self._socket_error = socket_error |
|
56 |
self._socket_timeout = socket_timeout |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
57 |
self._server_socket = socket.socket() |
58 |
self._server_socket.bind((host, port)) |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
59 |
self._sockname = self._server_socket.getsockname() |
60 |
self.port = self._sockname[1] |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
61 |
self._server_socket.listen(1) |
62 |
self._server_socket.settimeout(1) |
|
63 |
self.backing_transport = backing_transport |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
64 |
self._started = threading.Event() |
65 |
self._stopped = threading.Event() |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
66 |
|
67 |
def serve(self): |
|
68 |
self._should_terminate = False |
|
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
69 |
# for hooks we are letting code know that a server has started (and
|
70 |
# later stopped).
|
|
71 |
# There are three interesting urls:
|
|
72 |
# The URL the server can be contacted on. (e.g. bzr://host/)
|
|
73 |
# The URL that a commit done on the same machine as the server will
|
|
74 |
# have within the servers space. (e.g. file:///home/user/source)
|
|
75 |
# The URL that will be given to other hooks in the same process -
|
|
76 |
# the URL of the backing transport itself. (e.g. chroot+:///)
|
|
77 |
# We need all three because:
|
|
78 |
# * other machines see the first
|
|
79 |
# * local commits on this machine should be able to be mapped to
|
|
80 |
# this server
|
|
81 |
# * commits the server does itself need to be mapped across to this
|
|
82 |
# server.
|
|
83 |
# The latter two urls are different aliases to the servers url,
|
|
84 |
# so we group those in a list - as there might be more aliases
|
|
85 |
# in the future.
|
|
86 |
backing_urls = [self.backing_transport.base] |
|
87 |
try: |
|
88 |
backing_urls.append(self.backing_transport.external_url()) |
|
89 |
except errors.InProcessTransport: |
|
90 |
pass
|
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
91 |
for hook in SmartTCPServer.hooks['server_started']: |
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
92 |
hook(backing_urls, self.get_url()) |
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
93 |
self._started.set() |
94 |
try: |
|
95 |
try: |
|
96 |
while not self._should_terminate: |
|
97 |
try: |
|
98 |
conn, client_addr = self._server_socket.accept() |
|
99 |
except self._socket_timeout: |
|
100 |
# just check if we're asked to stop
|
|
101 |
pass
|
|
102 |
except self._socket_error, e: |
|
103 |
# if the socket is closed by stop_background_thread
|
|
104 |
# we might get a EBADF here, any other socket errors
|
|
105 |
# should get logged.
|
|
106 |
if e.args[0] != errno.EBADF: |
|
107 |
trace.warning("listening socket error: %s", e) |
|
108 |
else: |
|
109 |
self.serve_conn(conn) |
|
110 |
except KeyboardInterrupt: |
|
111 |
# dont log when CTRL-C'd.
|
|
112 |
raise
|
|
113 |
except Exception, e: |
|
114 |
trace.error("Unhandled smart server error.") |
|
115 |
trace.log_exception_quietly() |
|
116 |
raise
|
|
117 |
finally: |
|
118 |
self._stopped.set() |
|
119 |
try: |
|
120 |
# ensure the server socket is closed.
|
|
121 |
self._server_socket.close() |
|
122 |
except self._socket_error: |
|
123 |
# ignore errors on close
|
|
124 |
pass
|
|
125 |
for hook in SmartTCPServer.hooks['server_stopped']: |
|
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
126 |
hook(backing_urls, self.get_url()) |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
127 |
|
128 |
def get_url(self): |
|
129 |
"""Return the url of the server"""
|
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
130 |
return "bzr://%s:%d/" % self._sockname |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
131 |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
132 |
def serve_conn(self, conn): |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
133 |
# For WIN32, where the timeout value from the listening socket
|
134 |
# propogates to the newly accepted socket.
|
|
135 |
conn.setblocking(True) |
|
136 |
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) |
|
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
137 |
handler = SmartServerSocketStreamMedium(conn, self.backing_transport) |
138 |
connection_thread = threading.Thread(None, handler.serve, name='smart-server-child') |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
139 |
connection_thread.setDaemon(True) |
140 |
connection_thread.start() |
|
141 |
||
142 |
def start_background_thread(self): |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
143 |
self._started.clear() |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
144 |
self._server_thread = threading.Thread(None, |
145 |
self.serve, |
|
146 |
name='server-' + self.get_url()) |
|
147 |
self._server_thread.setDaemon(True) |
|
148 |
self._server_thread.start() |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
149 |
self._started.wait() |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
150 |
|
151 |
def stop_background_thread(self): |
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
152 |
self._stopped.clear() |
153 |
# tell the main loop to quit on the next iteration.
|
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
154 |
self._should_terminate = True |
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
155 |
# close the socket - gives error to connections from here on in,
|
156 |
# rather than a connection reset error to connections made during
|
|
157 |
# the period between setting _should_terminate = True and
|
|
158 |
# the current request completing/aborting. It may also break out the
|
|
159 |
# main loop if it was currently in accept() (on some platforms).
|
|
160 |
try: |
|
161 |
self._server_socket.close() |
|
162 |
except self._socket_error: |
|
163 |
# ignore errors on close
|
|
164 |
pass
|
|
165 |
if not self._stopped.isSet(): |
|
166 |
# server has not stopped (though it may be stopping)
|
|
167 |
# its likely in accept(), so give it a connection
|
|
168 |
temp_socket = socket.socket() |
|
169 |
temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) |
|
170 |
if not temp_socket.connect_ex(self._sockname): |
|
171 |
# and close it immediately: we dont choose to send any requests.
|
|
172 |
temp_socket.close() |
|
173 |
self._stopped.wait() |
|
174 |
self._server_thread.join() |
|
175 |
||
176 |
||
177 |
class SmartServerHooks(Hooks): |
|
178 |
"""Hooks for the smart server."""
|
|
179 |
||
180 |
def __init__(self): |
|
181 |
"""Create the default hooks.
|
|
182 |
||
183 |
These are all empty initially, because by default nothing should get
|
|
184 |
notified.
|
|
185 |
"""
|
|
186 |
Hooks.__init__(self) |
|
187 |
# Introduced in 0.16:
|
|
188 |
# invoked whenever the server starts serving a directory.
|
|
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
189 |
# The api signature is (backing urls, public url).
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
190 |
self['server_started'] = [] |
191 |
# Introduced in 0.16:
|
|
192 |
# invoked whenever the server stops serving a directory.
|
|
2634.1.1
by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch. |
193 |
# The api signature is (backing urls, public url).
|
2400.1.7
by Andrew Bennetts
Merge from bzr.dev. |
194 |
self['server_stopped'] = [] |
195 |
||
196 |
SmartTCPServer.hooks = SmartServerHooks() |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
197 |
|
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
198 |
|
199 |
class SmartTCPServer_for_testing(SmartTCPServer): |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
200 |
"""Server suitable for use by transport tests.
|
201 |
|
|
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
202 |
This server is backed by the process's cwd.
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
203 |
"""
|
204 |
||
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
205 |
def __init__(self): |
2018.5.42
by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :). |
206 |
SmartTCPServer.__init__(self, None) |
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
207 |
|
208 |
def get_backing_transport(self, backing_transport_server): |
|
209 |
"""Get a backing transport from a server we are decorating."""
|
|
2018.5.104
by Andrew Bennetts
Completely rework chrooted transports. |
210 |
return transport.get_transport(backing_transport_server.get_url()) |
2400.1.2
by Andrew Bennetts
Move SmartTCPServer classes into bzrlib/smart/server.py |
211 |
|
2018.5.47
by Andrew Bennetts
Make SmartTCPServer_for_Testing.setUp's backing_transport_server argument optional. |
212 |
def setUp(self, backing_transport_server=None): |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
213 |
"""Set up server for testing"""
|
2018.5.104
by Andrew Bennetts
Completely rework chrooted transports. |
214 |
from bzrlib.transport.chroot import ChrootServer |
2018.5.47
by Andrew Bennetts
Make SmartTCPServer_for_Testing.setUp's backing_transport_server argument optional. |
215 |
if backing_transport_server is None: |
216 |
from bzrlib.transport.local import LocalURLServer |
|
217 |
backing_transport_server = LocalURLServer() |
|
2018.5.104
by Andrew Bennetts
Completely rework chrooted transports. |
218 |
self.chroot_server = ChrootServer( |
219 |
self.get_backing_transport(backing_transport_server)) |
|
220 |
self.chroot_server.setUp() |
|
221 |
self.backing_transport = transport.get_transport( |
|
222 |
self.chroot_server.get_url()) |
|
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
223 |
self.start_background_thread() |
224 |
||
225 |
def tearDown(self): |
|
226 |
self.stop_background_thread() |
|
2018.5.104
by Andrew Bennetts
Completely rework chrooted transports. |
227 |
self.chroot_server.tearDown() |
2018.5.14
by Andrew Bennetts
Move SmartTCPServer to smart/server.py, and SmartServerRequestHandler to smart/request.py. |
228 |
|
229 |
def get_bogus_url(self): |
|
230 |
"""Return a URL which will fail to connect"""
|
|
231 |
return 'bzr://127.0.0.1:1/' |
|
232 |
||
233 |
||
2018.5.42
by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :). |
234 |
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing): |
235 |
"""Get a readonly server for testing."""
|
|
236 |
||
237 |
def get_backing_transport(self, backing_transport_server): |
|
238 |
"""Get a backing transport from a server we are decorating."""
|
|
2018.5.104
by Andrew Bennetts
Completely rework chrooted transports. |
239 |
url = 'readonly+' + backing_transport_server.get_url() |
2018.5.42
by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :). |
240 |
return transport.get_transport(url) |
2018.5.95
by Andrew Bennetts
Add a Transport.is_readonly remote call, let {Branch,Repository}.lock_write remote call return UnlockableTransport, and miscellaneous test fixes. |
241 |