mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-26 19:09:24 -05:00
2ec8ca5e60
SynapseRequest is in danger of becoming a bit of a dumping-ground for "useful stuff relating to Requests", which isn't really its intention (its purpose is to override render, finished and connectionLost to set up the LoggingContext and write the right entries to the request log). Putting utility functions inside SynapseRequest means that lots of our code ends up requiring a SynapseRequest when there is nothing synapse-specific about the Request at all, and any old twisted.web.iweb.IRequest will do. This increases code coupling and makes testing more difficult. In short: move get_user_agent out to a utility function.
68 lines
2.2 KiB
Python
68 lines
2.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
# Copyright 2018 New Vector 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.
|
|
import re
|
|
|
|
from twisted.internet import task
|
|
from twisted.web.client import FileBodyProducer
|
|
from twisted.web.iweb import IRequest
|
|
|
|
from synapse.api.errors import SynapseError
|
|
|
|
|
|
class RequestTimedOutError(SynapseError):
|
|
"""Exception representing timeout of an outbound request"""
|
|
|
|
def __init__(self, msg):
|
|
super().__init__(504, msg)
|
|
|
|
|
|
ACCESS_TOKEN_RE = re.compile(r"(\?.*access(_|%5[Ff])token=)[^&]*(.*)$")
|
|
CLIENT_SECRET_RE = re.compile(r"(\?.*client(_|%5[Ff])secret=)[^&]*(.*)$")
|
|
|
|
|
|
def redact_uri(uri):
|
|
"""Strips sensitive information from the uri replaces with <redacted>"""
|
|
uri = ACCESS_TOKEN_RE.sub(r"\1<redacted>\3", uri)
|
|
return CLIENT_SECRET_RE.sub(r"\1<redacted>\3", uri)
|
|
|
|
|
|
class QuieterFileBodyProducer(FileBodyProducer):
|
|
"""Wrapper for FileBodyProducer that avoids CRITICAL errors when the connection drops.
|
|
|
|
Workaround for https://github.com/matrix-org/synapse/issues/4003 /
|
|
https://twistedmatrix.com/trac/ticket/6528
|
|
"""
|
|
|
|
def stopProducing(self):
|
|
try:
|
|
FileBodyProducer.stopProducing(self)
|
|
except task.TaskStopped:
|
|
pass
|
|
|
|
|
|
def get_request_user_agent(request: IRequest, default: str = "") -> str:
|
|
"""Return the last User-Agent header, or the given default.
|
|
"""
|
|
# There could be raw utf-8 bytes in the User-Agent header.
|
|
|
|
# N.B. if you don't do this, the logger explodes cryptically
|
|
# with maximum recursion trying to log errors about
|
|
# the charset problem.
|
|
# c.f. https://github.com/matrix-org/synapse/issues/3471
|
|
|
|
h = request.getHeader(b"User-Agent")
|
|
return h.decode("ascii", "replace") if h else default
|