MatrixSynapse/synapse/http/client.py

154 lines
4.6 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2015-01-06 14:21:39 +01:00
# Copyright 2014, 2015 OpenMarket Ltd
2014-08-12 16:10:52 +02:00
#
# 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 synapse.http.agent_name import AGENT_NAME
2014-08-12 16:10:52 +02:00
from twisted.internet import defer, reactor
2014-10-30 02:21:33 +01:00
from twisted.web.client import (
Agent, readBody, FileBodyProducer, PartialDownloadError
2014-10-30 02:21:33 +01:00
)
2014-08-12 16:10:52 +02:00
from twisted.web.http_headers import Headers
from StringIO import StringIO
2014-08-12 16:10:52 +02:00
import json
import logging
import urllib
logger = logging.getLogger(__name__)
class SimpleHttpClient(object):
"""
2014-11-20 19:00:10 +01:00
A simple, no-frills HTTP client with methods that wrap up common ways of
using HTTP in Matrix
"""
def __init__(self, hs):
self.hs = hs
# The default context factory in Twisted 14.0.0 (which we require) is
2014-11-20 19:00:10 +01:00
# BrowserLikePolicyForHTTPS which will do regular cert validation
# 'like a browser'
self.agent = Agent(reactor)
2014-11-20 14:53:34 +01:00
@defer.inlineCallbacks
def post_urlencoded_get_json(self, uri, args={}):
2014-11-20 14:53:34 +01:00
logger.debug("post_urlencoded_get_json args: %s", args)
query_bytes = urllib.urlencode(args, True)
response = yield self.agent.request(
2014-11-20 14:53:34 +01:00
"POST",
uri.encode("ascii"),
headers=Headers({
b"Content-Type": [b"application/x-www-form-urlencoded"],
2015-01-08 10:41:11 +01:00
b"User-Agent": [AGENT_NAME],
}),
bodyProducer=FileBodyProducer(StringIO(query_bytes))
2014-11-20 14:53:34 +01:00
)
body = yield readBody(response)
defer.returnValue(json.loads(body))
@defer.inlineCallbacks
def post_json_get_json(self, uri, post_json):
json_str = json.dumps(post_json)
logger.info("HTTP POST %s -> %s", json_str, uri)
response = yield self.agent.request(
"POST",
uri.encode("ascii"),
headers=Headers({
"Content-Type": ["application/json"]
}),
bodyProducer=FileBodyProducer(StringIO(json_str))
)
body = yield readBody(response)
defer.returnValue(json.loads(body))
2014-11-20 14:53:34 +01:00
@defer.inlineCallbacks
def get_json(self, uri, args={}):
2014-11-20 14:53:34 +01:00
""" Get's some json from the given host and path
Args:
uri (str): The URI to request, not including query parameters
2014-11-20 14:53:34 +01:00
args (dict): A dictionary used to create query strings, defaults to
None.
**Note**: The value of each key is assumed to be an iterable
and *not* a string.
Returns:
Deferred: Succeeds when we get *any* HTTP response.
The result of the deferred is a tuple of `(code, response)`,
where `response` is a dict representing the decoded JSON body.
"""
yield
if len(args):
query_bytes = urllib.urlencode(args, True)
uri = "%s?%s" % (uri, query_bytes)
2014-11-20 14:53:34 +01:00
response = yield self.agent.request(
2014-11-20 14:53:34 +01:00
"GET",
uri.encode("ascii"),
headers=Headers({
2015-01-08 10:41:11 +01:00
b"User-Agent": [AGENT_NAME],
})
2014-11-20 14:53:34 +01:00
)
body = yield readBody(response)
defer.returnValue(json.loads(body))
class CaptchaServerHttpClient(SimpleHttpClient):
2014-11-20 14:53:34 +01:00
"""
Separate HTTP client for talking to google's captcha servers
Only slightly special because accepts partial download responses
"""
@defer.inlineCallbacks
def post_urlencoded_get_raw(self, url, args={}):
query_bytes = urllib.urlencode(args, True)
response = yield self.agent.request(
"POST",
url.encode("ascii"),
bodyProducer=FileBodyProducer(StringIO(query_bytes)),
headers=Headers({
b"Content-Type": [b"application/x-www-form-urlencoded"],
2015-01-08 10:41:11 +01:00
b"User-Agent": [AGENT_NAME],
})
)
try:
body = yield readBody(response)
defer.returnValue(body)
except PartialDownloadError as e:
# twisted dislikes google's response, no content length.
2014-11-20 14:53:34 +01:00
defer.returnValue(e.response)
2014-08-12 16:10:52 +02:00
2014-10-30 12:10:17 +01:00
2014-08-12 16:10:52 +02:00
def _print_ex(e):
if hasattr(e, "reasons") and e.reasons:
for ex in e.reasons:
_print_ex(ex)
else:
logger.exception(e)