/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/server.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
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
 
 
17
 
"""Server for smart-server protocol."""
18
 
 
19
 
import errno
20
 
import socket
21
 
import sys
22
 
import threading
23
 
 
24
 
from bzrlib.hooks import Hooks
25
 
from bzrlib import (
26
 
    errors,
27
 
    trace,
28
 
    transport,
29
 
)
30
 
from bzrlib.smart.medium import SmartServerSocketStreamMedium
31
 
 
32
 
 
33
 
class SmartTCPServer(object):
34
 
    """Listens on a TCP socket and accepts connections from smart clients.
35
 
 
36
 
    Each connection will be served by a SmartServerSocketStreamMedium running in
37
 
    a thread.
38
 
 
39
 
    hooks: An instance of SmartServerHooks.
40
 
    """
41
 
 
42
 
    def __init__(self, backing_transport, host='127.0.0.1', port=0,
43
 
                 root_client_path='/'):
44
 
        """Construct a new server.
45
 
 
46
 
        To actually start it running, call either start_background_thread or
47
 
        serve.
48
 
 
49
 
        :param backing_transport: The transport to serve.
50
 
        :param host: Name of the interface to listen on.
51
 
        :param port: TCP port to listen on, or 0 to allocate a transient port.
52
 
        :param root_client_path: The client path that will correspond to root
53
 
            of backing_transport.
54
 
        """
55
 
        # let connections timeout so that we get a chance to terminate
56
 
        # Keep a reference to the exceptions we want to catch because the socket
57
 
        # module's globals get set to None during interpreter shutdown.
58
 
        from socket import timeout as socket_timeout
59
 
        from socket import error as socket_error
60
 
        self._socket_error = socket_error
61
 
        self._socket_timeout = socket_timeout
62
 
        self._server_socket = socket.socket()
63
 
        # SO_REUSERADDR has a different meaning on Windows
64
 
        if sys.platform != 'win32':
65
 
            self._server_socket.setsockopt(socket.SOL_SOCKET,
66
 
                socket.SO_REUSEADDR, 1)
67
 
        self._server_socket.bind((host, port))
68
 
        self._sockname = self._server_socket.getsockname()
69
 
        self.port = self._sockname[1]
70
 
        self._server_socket.listen(1)
71
 
        self._server_socket.settimeout(1)
72
 
        self.backing_transport = backing_transport
73
 
        self._started = threading.Event()
74
 
        self._stopped = threading.Event()
75
 
        self.root_client_path = root_client_path
76
 
 
77
 
    def serve(self):
78
 
        self._should_terminate = False
79
 
        # for hooks we are letting code know that a server has started (and
80
 
        # later stopped).
81
 
        # There are three interesting urls:
82
 
        # The URL the server can be contacted on. (e.g. bzr://host/)
83
 
        # The URL that a commit done on the same machine as the server will
84
 
        # have within the servers space. (e.g. file:///home/user/source)
85
 
        # The URL that will be given to other hooks in the same process -
86
 
        # the URL of the backing transport itself. (e.g. chroot+:///)
87
 
        # We need all three because:
88
 
        #  * other machines see the first
89
 
        #  * local commits on this machine should be able to be mapped to
90
 
        #    this server 
91
 
        #  * commits the server does itself need to be mapped across to this
92
 
        #    server.
93
 
        # The latter two urls are different aliases to the servers url,
94
 
        # so we group those in a list - as there might be more aliases 
95
 
        # in the future.
96
 
        backing_urls = [self.backing_transport.base]
97
 
        try:
98
 
            backing_urls.append(self.backing_transport.external_url())
99
 
        except errors.InProcessTransport:
100
 
            pass
101
 
        for hook in SmartTCPServer.hooks['server_started']:
102
 
            hook(backing_urls, self.get_url())
103
 
        self._started.set()
104
 
        try:
105
 
            try:
106
 
                while not self._should_terminate:
107
 
                    try:
108
 
                        conn, client_addr = self._server_socket.accept()
109
 
                    except self._socket_timeout:
110
 
                        # just check if we're asked to stop
111
 
                        pass
112
 
                    except self._socket_error, e:
113
 
                        # if the socket is closed by stop_background_thread
114
 
                        # we might get a EBADF here, any other socket errors
115
 
                        # should get logged.
116
 
                        if e.args[0] != errno.EBADF:
117
 
                            trace.warning("listening socket error: %s", e)
118
 
                    else:
119
 
                        self.serve_conn(conn)
120
 
            except KeyboardInterrupt:
121
 
                # dont log when CTRL-C'd.
122
 
                raise
123
 
            except Exception, e:
124
 
                trace.error("Unhandled smart server error.")
125
 
                trace.log_exception_quietly()
126
 
                raise
127
 
        finally:
128
 
            self._stopped.set()
129
 
            try:
130
 
                # ensure the server socket is closed.
131
 
                self._server_socket.close()
132
 
            except self._socket_error:
133
 
                # ignore errors on close
134
 
                pass
135
 
            for hook in SmartTCPServer.hooks['server_stopped']:
136
 
                hook(backing_urls, self.get_url())
137
 
 
138
 
    def get_url(self):
139
 
        """Return the url of the server"""
140
 
        return "bzr://%s:%d/" % self._sockname
141
 
 
142
 
    def serve_conn(self, conn):
143
 
        # For WIN32, where the timeout value from the listening socket
144
 
        # propogates to the newly accepted socket.
145
 
        conn.setblocking(True)
146
 
        conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
147
 
        handler = SmartServerSocketStreamMedium(
148
 
            conn, self.backing_transport, self.root_client_path)
149
 
        connection_thread = threading.Thread(None, handler.serve, name='smart-server-child')
150
 
        connection_thread.setDaemon(True)
151
 
        connection_thread.start()
152
 
 
153
 
    def start_background_thread(self):
154
 
        self._started.clear()
155
 
        self._server_thread = threading.Thread(None,
156
 
                self.serve,
157
 
                name='server-' + self.get_url())
158
 
        self._server_thread.setDaemon(True)
159
 
        self._server_thread.start()
160
 
        self._started.wait()
161
 
 
162
 
    def stop_background_thread(self):
163
 
        self._stopped.clear()
164
 
        # tell the main loop to quit on the next iteration.
165
 
        self._should_terminate = True
166
 
        # close the socket - gives error to connections from here on in,
167
 
        # rather than a connection reset error to connections made during
168
 
        # the period between setting _should_terminate = True and 
169
 
        # the current request completing/aborting. It may also break out the
170
 
        # main loop if it was currently in accept() (on some platforms).
171
 
        try:
172
 
            self._server_socket.close()
173
 
        except self._socket_error:
174
 
            # ignore errors on close
175
 
            pass
176
 
        if not self._stopped.isSet():
177
 
            # server has not stopped (though it may be stopping)
178
 
            # its likely in accept(), so give it a connection
179
 
            temp_socket = socket.socket()
180
 
            temp_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
181
 
            if not temp_socket.connect_ex(self._sockname):
182
 
                # and close it immediately: we dont choose to send any requests.
183
 
                temp_socket.close()
184
 
        self._stopped.wait()
185
 
        self._server_thread.join()
186
 
 
187
 
 
188
 
class SmartServerHooks(Hooks):
189
 
    """Hooks for the smart server."""
190
 
 
191
 
    def __init__(self):
192
 
        """Create the default hooks.
193
 
 
194
 
        These are all empty initially, because by default nothing should get
195
 
        notified.
196
 
        """
197
 
        Hooks.__init__(self)
198
 
        # Introduced in 0.16:
199
 
        # invoked whenever the server starts serving a directory.
200
 
        # The api signature is (backing urls, public url).
201
 
        self['server_started'] = []
202
 
        # Introduced in 0.16:
203
 
        # invoked whenever the server stops serving a directory.
204
 
        # The api signature is (backing urls, public url).
205
 
        self['server_stopped'] = []
206
 
 
207
 
SmartTCPServer.hooks = SmartServerHooks()
208
 
 
209
 
 
210
 
class SmartTCPServer_for_testing(SmartTCPServer):
211
 
    """Server suitable for use by transport tests.
212
 
    
213
 
    This server is backed by the process's cwd.
214
 
    """
215
 
 
216
 
    def __init__(self):
217
 
        SmartTCPServer.__init__(self, None)
218
 
        self.client_path_extra = None
219
 
        
220
 
    def get_backing_transport(self, backing_transport_server):
221
 
        """Get a backing transport from a server we are decorating."""
222
 
        return transport.get_transport(backing_transport_server.get_url())
223
 
 
224
 
    def setUp(self, backing_transport_server=None,
225
 
              client_path_extra='/extra/'):
226
 
        """Set up server for testing.
227
 
        
228
 
        :param backing_transport_server: backing server to use.  If not
229
 
            specified, a LocalURLServer at the current working directory will
230
 
            be used.
231
 
        :param client_path_extra: a path segment starting with '/' to append to
232
 
            the root URL for this server.  For instance, a value of '/foo/bar/'
233
 
            will mean the root of the backing transport will be published at a
234
 
            URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
235
 
            `bzr://127.0.0.1:nnnn/`.  Default value is `extra`, so that tests
236
 
            by default will fail unless they do the necessary path translation.
237
 
        """
238
 
        assert client_path_extra.startswith('/')
239
 
        from bzrlib.transport.chroot import ChrootServer
240
 
        if backing_transport_server is None:
241
 
            from bzrlib.transport.local import LocalURLServer
242
 
            backing_transport_server = LocalURLServer()
243
 
        self.chroot_server = ChrootServer(
244
 
            self.get_backing_transport(backing_transport_server))
245
 
        self.chroot_server.setUp()
246
 
        self.backing_transport = transport.get_transport(
247
 
            self.chroot_server.get_url())
248
 
        self.root_client_path = self.client_path_extra = client_path_extra
249
 
        self.start_background_thread()
250
 
 
251
 
    def tearDown(self):
252
 
        self.stop_background_thread()
253
 
        self.chroot_server.tearDown()
254
 
 
255
 
    def get_url(self):
256
 
        url = super(SmartTCPServer_for_testing, self).get_url()
257
 
        assert url.endswith('/')
258
 
        return url[:-1] + self.client_path_extra
259
 
 
260
 
    def get_bogus_url(self):
261
 
        """Return a URL which will fail to connect"""
262
 
        return 'bzr://127.0.0.1:1/'
263
 
 
264
 
 
265
 
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
266
 
    """Get a readonly server for testing."""
267
 
 
268
 
    def get_backing_transport(self, backing_transport_server):
269
 
        """Get a backing transport from a server we are decorating."""
270
 
        url = 'readonly+' + backing_transport_server.get_url()
271
 
        return transport.get_transport(url)
272