Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add GET media/v1/config #3184

Merged
merged 18 commits into from
Aug 16, 2018
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions synapse/rest/media/v1/config_resource.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Will Hunt <will@half-shot.uk>
#
# 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 twisted.web.server import NOT_DONE_YET
from twisted.web.resource import Resource
from synapse.http.server import respond_with_json, respond_with_json_bytes


class MediaConfigResource(Resource):
isLeaf = True

def __init__(self, hs):
Resource.__init__(self)
config = hs.get_config()
self.limits_dict = {
"upload_size": config.max_upload_size,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m.upload.size

}

def render_GET(self, request):
respond_with_json(request, 200, self.limits_dict, send_cors=True)
return NOT_DONE_YET
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Presumably we shouldn't be returning NOT_DONE_YET if we have actually finished the request.

@hawkowl how is this meant to work in twisted?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this is correct. Your options for returning from a render_* method are:

  • return a bytes, which twisted will then render as the body and call request.finish()
  • return NOT_DONE_YET, which skips the above two.

the implication is that if you have rendered the body and called finish() yourself, you should call NOT_DONE_YET.

Note that this is exactly what happens with a whole bunch of our handlers that look like they are asynchronous, but actually complete synchronously.

HOWEVER. There is a problem here, in that wrap_json_request_handler does important things (1: adds exception handling, though that may be moot here; 2: adds logging). So, can haz wrap_json_request_handler please?


def render_OPTIONS(self, request):
respond_with_json_bytes(request, 200, {}, send_cors=True)
return NOT_DONE_YET
3 changes: 2 additions & 1 deletion synapse/rest/media/v1/media_repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from .thumbnail_resource import ThumbnailResource
from .identicon_resource import IdenticonResource
from .preview_url_resource import PreviewUrlResource
from .config_resource import MediaConfigResource
from .filepath import MediaFilePaths
from .thumbnailer import Thumbnailer
from .storage_provider import StorageProviderWrapper
Expand Down Expand Up @@ -745,7 +746,6 @@ def __init__(self, hs):
Resource.__init__(self)

media_repo = hs.get_media_repository()

self.putChild("upload", UploadResource(hs, media_repo))
self.putChild("download", DownloadResource(hs, media_repo))
self.putChild("thumbnail", ThumbnailResource(
Expand All @@ -756,3 +756,4 @@ def __init__(self, hs):
self.putChild("preview_url", PreviewUrlResource(
hs, media_repo, media_repo.media_storage,
))
self.putChild("limits", MediaLimitsResource(hs))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is config now