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

Always return a thumbnail of the requested size. #206

Merged
merged 8 commits into from
Aug 20, 2015
Merged

Always return a thumbnail of the requested size. #206

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ff7c2e4
Always return a thumbnail of the requested size.
erikjohnston Jul 23, 2015
33d83f3
Fix remote thumbnailing
erikjohnston Jul 23, 2015
4590851
Factor out thumbnail()
erikjohnston Jul 23, 2015
7e3d1c7
Make a config option for whether to generate new thumbnail sizes dyna…
Aug 12, 2015
fdb724c
Add config option for setting the list of thumbnail sizes to precalcu…
Aug 12, 2015
de3b7b5
Doc-string for config ultility function
Aug 12, 2015
b16cd18
Merge remote-tracking branch 'origin/develop' into erikj/generate_pre…
Aug 13, 2015
95b0f54
Fix flake8 warning
Aug 13, 2015
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
83 changes: 83 additions & 0 deletions synapse/rest/media/v1/base_resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,89 @@ def _get_thumbnail_requirements(self, media_type):
else:
return ()

@defer.inlineCallbacks
def _generate_local_exact_thumbnail(self, media_id, t_width, t_height,
t_method, t_type):
input_path = self.filepaths.local_media_filepath(media_id)

def thumbnail():
thumbnailer = Thumbnailer(input_path)
m_width = thumbnailer.width
m_height = thumbnailer.height

if m_width * m_height >= self.max_image_pixels:
logger.info(
"Image too large to thumbnail %r x %r > %r",
m_width, m_height, self.max_image_pixels
)
return

t_path = self.filepaths.local_media_thumbnail(
media_id, t_width, t_height, t_type, t_method
)
self._makedirs(t_path)

if t_method == "crop":
t_len = thumbnailer.crop(t_path, t_width, t_height, t_type)
elif t_method == "scale":
t_len = thumbnailer.scale(t_path, t_width, t_height, t_type)
else:
t_len = None

return t_len, t_path

res = yield threads.deferToThread(thumbnail)

if res:
t_len, t_path = res
yield self.store.store_local_thumbnail(
media_id, t_width, t_height, t_type, t_method, t_len
)

defer.returnValue(t_path)

@defer.inlineCallbacks
def _generate_remote_exact_thumbnail(self, server_name, file_id, media_id,
t_width, t_height, t_method, t_type):
input_path = self.filepaths.remote_media_filepath(server_name, file_id)

def thumbnail():
thumbnailer = Thumbnailer(input_path)
m_width = thumbnailer.width
m_height = thumbnailer.height

if m_width * m_height >= self.max_image_pixels:
logger.info(
"Image too large to thumbnail %r x %r > %r",
m_width, m_height, self.max_image_pixels
)
return

t_path = self.filepaths.remote_media_thumbnail(
server_name, file_id, t_width, t_height, t_type, t_method
)
self._makedirs(t_path)

if t_method == "crop":
t_len = thumbnailer.crop(t_path, t_width, t_height, t_type)
elif t_method == "scale":
t_len = thumbnailer.scale(t_path, t_width, t_height, t_type)
else:
t_len = None

return t_path, t_len

res = yield threads.deferToThread(thumbnail)

if res:
t_path, t_len = res
yield self.store.store_remote_media_thumbnail(
server_name, media_id, file_id,
t_width, t_height, t_type, t_method, t_len
)

defer.returnValue(t_path)

@defer.inlineCallbacks
def _generate_local_thumbnails(self, media_id, media_info):
media_type = media_info["media_type"]
Expand Down
85 changes: 83 additions & 2 deletions synapse/rest/media/v1/thumbnail_resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ def _async_render_GET(self, request):
m_type = parse_string(request, "type", "image/png")

if server_name == self.server_name:
yield self._respond_local_thumbnail(
yield self._select_or_generate_local_thumbnail(
request, media_id, width, height, method, m_type
)
else:
yield self._respond_remote_thumbnail(
yield self._select_or_generate_remote_thumbnail(
request, server_name, media_id,
Copy link
Contributor

Choose a reason for hiding this comment

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

Presumably this will switch between _respond_remote_thumbnail and _select_or_generate_remote_thumbnail when the config option is added.

width, height, method, m_type
)
Expand Down Expand Up @@ -82,6 +82,87 @@ def _respond_local_thumbnail(self, request, media_id, width, height,
request, media_info, width, height, method, m_type,
)

@defer.inlineCallbacks
def _select_or_generate_local_thumbnail(self, request, media_id, desired_width,
desired_height, desired_method,
desired_type):
media_info = yield self.store.get_local_media(media_id)

if not media_info:
self._respond_404(request)
return

thumbnail_infos = yield self.store.get_local_media_thumbnails(media_id)
for info in thumbnail_infos:
t_w = info["thumbnail_width"] == desired_width
t_h = info["thumbnail_height"] == desired_height
t_method = info["thumbnail_method"] == desired_method
t_type = info["thumbnail_type"] == desired_type

if t_w and t_h and t_method and t_type:
file_path = self.filepaths.local_media_thumbnail(
media_id, desired_width, desired_height, desired_type, desired_method,
)
yield self._respond_with_file(request, desired_type, file_path)
return

logger.debug("We don't have a local thumbnail of that size. Generating")

# Okay, so we generate one.
file_path = yield self._generate_local_exact_thumbnail(
media_id, desired_width, desired_height, desired_method, desired_type
)

if file_path:
yield self._respond_with_file(request, desired_type, file_path)
else:
yield self._respond_default_thumbnail(
request, media_info, desired_width, desired_height,
desired_method, desired_type,
)

@defer.inlineCallbacks
def _select_or_generate_remote_thumbnail(self, request, server_name, media_id,
desired_width, desired_height,
desired_method, desired_type):
media_info = yield self._get_remote_media(server_name, media_id)

thumbnail_infos = yield self.store.get_remote_media_thumbnails(
server_name, media_id,
)

file_id = media_info["filesystem_id"]

for info in thumbnail_infos:
t_w = info["thumbnail_width"] == desired_width
t_h = info["thumbnail_height"] == desired_height
t_method = info["thumbnail_method"] == desired_method
t_type = info["thumbnail_type"] == desired_type

if t_w and t_h and t_method and t_type:
file_path = self.filepaths.remote_media_thumbnail(
server_name, file_id, desired_width, desired_height,
desired_type, desired_method,
)
yield self._respond_with_file(request, desired_type, file_path)
return

logger.debug("We don't have a local thumbnail of that size. Generating")

# Okay, so we generate one.
file_path = yield self._generate_remote_exact_thumbnail(
server_name, file_id, media_id, desired_width,
desired_height, desired_method, desired_type
)

if file_path:
yield self._respond_with_file(request, desired_type, file_path)
else:
yield self._respond_default_thumbnail(
request, media_info, desired_width, desired_height,
desired_method, desired_type,
)

@defer.inlineCallbacks
def _respond_remote_thumbnail(self, request, server_name, media_id, width,
height, method, m_type):
Expand Down