15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Copyright 2011, Google Inc. 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Redistribution and use in source and binary forms, with or without 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# modification, are permitted provided that the following conditions are 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# met: 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# * Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# * Redistributions in binary form must reproduce the above 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# copyright notice, this list of conditions and the following disclaimer 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# in the documentation and/or other materials provided with the 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# distribution. 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# * Neither the name of Google Inc. nor the names of its 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# contributors may be used to endorse or promote products derived from 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# this software without specific prior written permission. 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)"""PythonHeaderParserHandler for mod_pywebsocket. 325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)Apache HTTP Server and mod_python must be configured such that this 345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)function is called to handle WebSocket request. 355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)""" 365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)import logging 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)from mod_python import apache 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)from mod_pywebsocket import common 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)from mod_pywebsocket import dispatch 445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)from mod_pywebsocket import handshake 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)from mod_pywebsocket import util 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# PythonOption to specify the handler root directory. 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_HANDLER_ROOT = 'mod_pywebsocket.handler_root' 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# PythonOption to specify the handler scan directory. 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# This must be a directory under the root directory. 535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# The default is the root directory. 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_HANDLER_SCAN = 'mod_pywebsocket.handler_scan' 555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# PythonOption to allow handlers whose canonical path is 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# not under the root directory. It's disallowed by default. 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Set this option with value of 'yes' to allow. 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_ALLOW_HANDLERS_OUTSIDE_ROOT = ( 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 'mod_pywebsocket.allow_handlers_outside_root_dir') 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Map from values to their meanings. 'Yes' and 'No' are allowed just for 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# compatibility. 635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_ALLOW_HANDLERS_OUTSIDE_ROOT_DEFINITION = { 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 'off': False, 'no': False, 'on': True, 'yes': True} 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# (Obsolete option. Ignored.) 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# PythonOption to specify to allow handshake defined in Hixie 75 version 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# protocol. The default is None (Off) 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_ALLOW_DRAFT75 = 'mod_pywebsocket.allow_draft75' 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Map from values to their meanings. 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_PYOPT_ALLOW_DRAFT75_DEFINITION = {'off': False, 'on': True} 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ApacheLogHandler(logging.Handler): 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) """Wrapper logging.Handler to emit log message to apache's error.log.""" 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _LEVELS = { 785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.DEBUG: apache.APLOG_DEBUG, 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.INFO: apache.APLOG_INFO, 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.WARNING: apache.APLOG_WARNING, 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.ERROR: apache.APLOG_ERR, 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.CRITICAL: apache.APLOG_CRIT, 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) def __init__(self, request=None): 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logging.Handler.__init__(self) 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) self._log_error = apache.log_error 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if request is not None: 895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) self._log_error = request.log_error 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Time and level will be printed by Apache. 925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) self._formatter = logging.Formatter('%(name)s: %(message)s') 935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) def emit(self, record): 955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) apache_level = apache.APLOG_DEBUG 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if record.levelno in ApacheLogHandler._LEVELS: 975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) apache_level = ApacheLogHandler._LEVELS[record.levelno] 985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) msg = self._formatter.format(record) 1005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # "server" parameter must be passed to have "level" parameter work. 1025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # If only "level" parameter is passed, nothing shows up on Apache's 1035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # log. However, at this point, we cannot get the server object of the 1045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # virtual host which will process WebSocket requests. The only server 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # object we can get here is apache.main_server. But Wherever (server 1065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # configuration context or virtual host context) we put 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # PythonHeaderParserHandler directive, apache.main_server just points 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # the main server instance (not any of virtual server instance). Then, 1095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Apache follows LogLevel directive in the server configuration context 1105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # to filter logs. So, we need to specify LogLevel in the server 1115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # configuration context. Even if we specify "LogLevel debug" in the 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # virtual host context which actually handles WebSocket connections, 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # DEBUG level logs never show up unless "LogLevel debug" is specified 1145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # in the server configuration context. 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # TODO(tyoshino): Provide logging methods on request object. When 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # request is mp_request object (when used together with Apache), the 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # methods call request.log_error indirectly. When request is 1195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # _StandaloneRequest, the methods call Python's logging facility which 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # we create in standalone.py. 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) self._log_error(msg, apache_level, apache.main_server) 1225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)def _configure_logging(): 1255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logger = logging.getLogger() 1265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Logs are filtered by Apache based on LogLevel directive in Apache 1275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # configuration file. We must just pass logs for all levels to 1285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # ApacheLogHandler. 1295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logger.setLevel(logging.DEBUG) 1305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) logger.addHandler(ApacheLogHandler()) 1315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_configure_logging() 1345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_LOGGER = logging.getLogger(__name__) 1365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)def _parse_option(name, value, definition): 1395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if value is None: 1405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return False 1415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) meaning = definition.get(value.lower()) 1435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if meaning is None: 1445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) raise Exception('Invalid value for PythonOption %s: %r' % 1455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) (name, value)) 1465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return meaning 1475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)def _create_dispatcher(): 1505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _LOGGER.info('Initializing Dispatcher') 1515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) options = apache.main_server.get_options() 1535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handler_root = options.get(_PYOPT_HANDLER_ROOT, None) 1555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if not handler_root: 1565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) raise Exception('PythonOption %s is not defined' % _PYOPT_HANDLER_ROOT, 1575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) apache.APLOG_ERR) 1585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handler_scan = options.get(_PYOPT_HANDLER_SCAN, handler_root) 1605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) allow_handlers_outside_root = _parse_option( 1625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _PYOPT_ALLOW_HANDLERS_OUTSIDE_ROOT, 1635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) options.get(_PYOPT_ALLOW_HANDLERS_OUTSIDE_ROOT), 1645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _PYOPT_ALLOW_HANDLERS_OUTSIDE_ROOT_DEFINITION) 1655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) dispatcher = dispatch.Dispatcher( 1675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handler_root, handler_scan, allow_handlers_outside_root) 1685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) for warning in dispatcher.source_warnings(): 17053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.log_error( 17153e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: Warning in source loading: %s' % warning, 17253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.APLOG_WARNING) 1735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return dispatcher 1755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# Initialize 1785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)_dispatcher = _create_dispatcher() 1795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)def headerparserhandler(request): 1825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) """Handle request. 1835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) Args: 1855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) request: mod_python request. 1865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) This function is named headerparserhandler because it is the default 1885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) name for a PythonHeaderParserHandler. 1895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) """ 1905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handshake_is_done = False 1925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) try: 1935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Fallback to default http handler for request paths for which 1945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # we don't have request handlers. 1955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if not _dispatcher.get_handler_suite(request.uri): 19653e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error( 19753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: No handler for resource: %r' % request.uri, 19853e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.APLOG_INFO) 19953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error( 20053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: Fallback to Apache', apache.APLOG_INFO) 2015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return apache.DECLINED 2025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) except dispatch.DispatchException, e: 20353e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error( 20453e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: Dispatch failed for error: %s' % e, 20553e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.APLOG_INFO) 2065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if not handshake_is_done: 2075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return e.status 2085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) try: 2105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) allow_draft75 = _parse_option( 2115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _PYOPT_ALLOW_DRAFT75, 2125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) apache.main_server.get_options().get(_PYOPT_ALLOW_DRAFT75), 2135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _PYOPT_ALLOW_DRAFT75_DEFINITION) 2145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) try: 2165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handshake.do_handshake( 2175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) request, _dispatcher, allowDraft75=allow_draft75) 2185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) except handshake.VersionException, e: 21953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error( 22053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: Handshake failed for version error: %s' % e, 22153e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.APLOG_INFO) 2225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) request.err_headers_out.add(common.SEC_WEBSOCKET_VERSION_HEADER, 2235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) e.supported_versions) 2245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return apache.HTTP_BAD_REQUEST 2255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) except handshake.HandshakeException, e: 2265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Handshake for ws/wss failed. 2275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Send http response with error status. 22853e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error( 22953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 'mod_pywebsocket: Handshake failed for error: %s' % e, 23053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) apache.APLOG_INFO) 2315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return e.status 2325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) handshake_is_done = True 2345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) request._dispatcher = _dispatcher 2355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) _dispatcher.transfer_data(request) 2365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) except handshake.AbortedByUserException, e: 23753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error('mod_pywebsocket: Aborted: %s' % e, apache.APLOG_INFO) 2385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) except Exception, e: 2395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # DispatchException can also be thrown if something is wrong in 2405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # pywebsocket code. It's caught here, then. 2415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 24253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) request.log_error('mod_pywebsocket: Exception occurred: %s\n%s' % 2435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) (e, util.get_stack_trace()), 2445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) apache.APLOG_ERR) 2455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Unknown exceptions before handshake mean Apache must handle its 2465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # request with another handler. 2475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if not handshake_is_done: 2485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return apache.DECLINED 2495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) # Set assbackwards to suppress response header generation by Apache. 2505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) request.assbackwards = 1 2515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return apache.DONE # Return DONE such that no other handlers are invoked. 2525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)# vi:sts=4 sw=4 et 255