mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
221 lines
7.5 KiB
Python
221 lines
7.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
|
|
from syutil.jsonutil import (
|
|
encode_canonical_json, encode_pretty_printed_json
|
|
)
|
|
from synapse.api.errors import (
|
|
cs_exception, SynapseError, CodeMessageException
|
|
)
|
|
|
|
from twisted.internet import defer, reactor
|
|
from twisted.web import server, resource
|
|
from twisted.web.server import NOT_DONE_YET
|
|
from twisted.web.util import redirectTo
|
|
|
|
import collections
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class HttpServer(object):
|
|
""" Interface for registering callbacks on a HTTP server
|
|
"""
|
|
|
|
def register_path(self, method, path_pattern, callback):
|
|
""" Register a callback that get's fired if we receive a http request
|
|
with the given method for a path that matches the given regex.
|
|
|
|
If the regex contains groups these get's passed to the calback via
|
|
an unpacked tuple.
|
|
|
|
Args:
|
|
method (str): The method to listen to.
|
|
path_pattern (str): The regex used to match requests.
|
|
callback (function): The function to fire if we receive a matched
|
|
request. The first argument will be the request object and
|
|
subsequent arguments will be any matched groups from the regex.
|
|
This should return a tuple of (code, response).
|
|
"""
|
|
pass
|
|
|
|
|
|
class JsonResource(HttpServer, resource.Resource):
|
|
""" This implements the HttpServer interface and provides JSON support for
|
|
Resources.
|
|
|
|
Register callbacks via register_path()
|
|
"""
|
|
|
|
isLeaf = True
|
|
|
|
_PathEntry = collections.namedtuple("_PathEntry", ["pattern", "callback"])
|
|
|
|
def __init__(self):
|
|
resource.Resource.__init__(self)
|
|
|
|
self.path_regexs = {}
|
|
|
|
def register_path(self, method, path_pattern, callback):
|
|
self.path_regexs.setdefault(method, []).append(
|
|
self._PathEntry(path_pattern, callback)
|
|
)
|
|
|
|
def start_listening(self, port):
|
|
""" Registers the http server with the twisted reactor.
|
|
|
|
Args:
|
|
port (int): The port to listen on.
|
|
|
|
"""
|
|
reactor.listenTCP(port, server.Site(self))
|
|
|
|
# Gets called by twisted
|
|
def render(self, request):
|
|
""" This get's called by twisted every time someone sends us a request.
|
|
"""
|
|
self._async_render(request)
|
|
return server.NOT_DONE_YET
|
|
|
|
@defer.inlineCallbacks
|
|
def _async_render(self, request):
|
|
""" This get's called by twisted every time someone sends us a request.
|
|
This checks if anyone has registered a callback for that method and
|
|
path.
|
|
"""
|
|
try:
|
|
# Just say yes to OPTIONS.
|
|
if request.method == "OPTIONS":
|
|
self._send_response(request, 200, {})
|
|
return
|
|
|
|
# Loop through all the registered callbacks to check if the method
|
|
# and path regex match
|
|
for path_entry in self.path_regexs.get(request.method, []):
|
|
m = path_entry.pattern.match(request.path)
|
|
if m:
|
|
# We found a match! Trigger callback and then return the
|
|
# returned response. We pass both the request and any
|
|
# matched groups from the regex to the callback.
|
|
code, response = yield path_entry.callback(
|
|
request,
|
|
*m.groups()
|
|
)
|
|
|
|
self._send_response(request, code, response)
|
|
return
|
|
|
|
# Huh. No one wanted to handle that? Fiiiiiine. Send 400.
|
|
self._send_response(
|
|
request,
|
|
400,
|
|
{"error": "Unrecognized request"}
|
|
)
|
|
except CodeMessageException as e:
|
|
if isinstance(e, SynapseError):
|
|
logger.error("%s SynapseError: %s - %s", request, e.code,
|
|
e.msg)
|
|
else:
|
|
logger.exception(e)
|
|
self._send_response(
|
|
request,
|
|
e.code,
|
|
cs_exception(e),
|
|
response_code_message=e.response_code_message
|
|
)
|
|
except Exception as e:
|
|
logger.exception(e)
|
|
self._send_response(
|
|
request,
|
|
500,
|
|
{"error": "Internal server error"}
|
|
)
|
|
|
|
def _send_response(self, request, code, response_json_object,
|
|
response_code_message=None):
|
|
# could alternatively use request.notifyFinish() and flip a flag when
|
|
# the Deferred fires, but since the flag is RIGHT THERE it seems like
|
|
# a waste.
|
|
if request._disconnected:
|
|
logger.warn(
|
|
"Not sending response to request %s, already disconnected.",
|
|
request)
|
|
return
|
|
|
|
if not self._request_user_agent_is_curl(request):
|
|
json_bytes = encode_canonical_json(response_json_object)
|
|
else:
|
|
json_bytes = encode_pretty_printed_json(response_json_object)
|
|
|
|
# TODO: Only enable CORS for the requests that need it.
|
|
respond_with_json_bytes(request, code, json_bytes, send_cors=True,
|
|
response_code_message=response_code_message)
|
|
|
|
@staticmethod
|
|
def _request_user_agent_is_curl(request):
|
|
user_agents = request.requestHeaders.getRawHeaders(
|
|
"User-Agent", default=[]
|
|
)
|
|
for user_agent in user_agents:
|
|
if "curl" in user_agent:
|
|
return True
|
|
return False
|
|
|
|
|
|
class RootRedirect(resource.Resource):
|
|
"""Redirects the root '/' path to another path."""
|
|
|
|
def __init__(self, path):
|
|
resource.Resource.__init__(self)
|
|
self.url = path
|
|
|
|
def render_GET(self, request):
|
|
return redirectTo(self.url, request)
|
|
|
|
def getChild(self, name, request):
|
|
if len(name) == 0:
|
|
return self # select ourselves as the child to render
|
|
return resource.Resource.getChild(self, name, request)
|
|
|
|
|
|
def respond_with_json_bytes(request, code, json_bytes, send_cors=False,
|
|
response_code_message=None):
|
|
"""Sends encoded JSON in response to the given request.
|
|
|
|
Args:
|
|
request (twisted.web.http.Request): The http request to respond to.
|
|
code (int): The HTTP response code.
|
|
json_bytes (bytes): The json bytes to use as the response body.
|
|
send_cors (bool): Whether to send Cross-Origin Resource Sharing headers
|
|
http://www.w3.org/TR/cors/
|
|
Returns:
|
|
twisted.web.server.NOT_DONE_YET"""
|
|
|
|
request.setResponseCode(code, message=response_code_message)
|
|
request.setHeader(b"Content-Type", b"application/json")
|
|
|
|
if send_cors:
|
|
request.setHeader("Access-Control-Allow-Origin", "*")
|
|
request.setHeader("Access-Control-Allow-Methods",
|
|
"GET, POST, PUT, DELETE, OPTIONS")
|
|
request.setHeader("Access-Control-Allow-Headers",
|
|
"Origin, X-Requested-With, Content-Type, Accept")
|
|
|
|
request.write(json_bytes)
|
|
request.finish()
|
|
return NOT_DONE_YET
|