1# Copyright 2012, Google Inc.
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met:
7#
8#     * Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10#     * Redistributions in binary form must reproduce the above
11# copyright notice, this list of conditions and the following disclaimer
12# in the documentation and/or other materials provided with the
13# distribution.
14#     * Neither the name of Google Inc. nor the names of its
15# contributors may be used to endorse or promote products derived from
16# this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30import struct
31
32from mod_pywebsocket import common
33from mod_pywebsocket import stream
34
35
36def web_socket_do_extra_handshake(request):
37    pass
38
39
40def web_socket_transfer_data(request):
41    while True:
42        line = request.ws_stream.receive_message()
43        if line is None:
44            return
45        code, reason = line.split(' ', 1)
46        if code is None or reason is None:
47            return
48        request.ws_stream.close_connection(int(code), reason)
49        # close_connection() initiates closing handshake. It validates code
50        # and reason. If you want to send a broken close frame for a test,
51        # following code will be useful.
52        # > data = struct.pack('!H', int(code)) + reason.encode('UTF-8')
53        # > request.connection.write(stream.create_close_frame(data))
54        # > # Suppress to re-respond client responding close frame.
55        # > raise Exception("customized server initiated closing handshake")
56
57
58def web_socket_passive_closing_handshake(request):
59    # Simply echo a close status code
60    code, reason = request.ws_close_code, request.ws_close_reason
61
62    # pywebsocket sets pseudo code for receiving an empty body close frame.
63    if code == common.STATUS_NO_STATUS_RECEIVED:
64        code = None
65        reason = ''
66    return code, reason
67
68
69# vi:sts=4 sw=4 et
70