Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zthumbor/loaders/helpers.py

48 lines
1.7 KiB
Python
Raw Normal View History

docs: Add documentation for `if False` mypy pattern in scripts. This should help make it clear what's going on with these scripts.
2018-12-17 19:52:08 +01:00
# This file is used by both Python 2.7 (thumbor) and 3 (zulip).
thumbor: Add thumbor on port 9995 in development. For now, this does nothing in a production environment, but it should simplify the process of doing testing on the Thumbor implementation, by integrating a lot of dependency management logic.
2017-11-09 16:31:57 +01:00
from __future__ import absolute_import
import os
thumbor: Complete implementation of thumbnailing. Various pieces of our thumbor-based thumbnailing system were already merged; this adds the remaining pieces required for it to work: * a THUMBOR_URL Django setting that controls whether thumbor is enabled on the Zulip server (and if so, where thumbor is hosted). * Replaces the overly complicated prototype cryptography logic * Adds a /thumbnail endpoint (supported both on web and mobile) for accessing thumbnails in messages, designed to support hosting both external URLs as well as uploaded files (and applying Zulip's security model for access to thumbnails of uploaded files). * Modifies bugdown to, when THUMBOR_URL is set, render images with the `src` attribute pointing /thumbnail (to provide a small thumbnail for the image), along with adding a "data-original" attribute that can be used to access the "original/full" size version of the image. There are a few things that don't work quite yet: * The S3 backend support is incomplete and doesn't work yet. * The error pages for unauthorized access are ugly. * We might want to rename data-original and /thumbnail?size=original to use some other name, like "full", that better reflects the fact that we're potentially not serving the original image URL.
2018-03-08 09:37:09 +01:00
import re
thumbor: Add thumbor on port 9995 in development. For now, this does nothing in a production environment, but it should simplify the process of doing testing on the Thumbor implementation, by integrating a lot of dependency management logic.
2017-11-09 16:31:57 +01:00
import sys
thumbor: Complete implementation of thumbnailing. Various pieces of our thumbor-based thumbnailing system were already merged; this adds the remaining pieces required for it to work: * a THUMBOR_URL Django setting that controls whether thumbor is enabled on the Zulip server (and if so, where thumbor is hosted). * Replaces the overly complicated prototype cryptography logic * Adds a /thumbnail endpoint (supported both on web and mobile) for accessing thumbnails in messages, designed to support hosting both external URLs as well as uploaded files (and applying Zulip's security model for access to thumbnails of uploaded files). * Modifies bugdown to, when THUMBOR_URL is set, render images with the `src` attribute pointing /thumbnail (to provide a small thumbnail for the image), along with adding a "data-original" attribute that can be used to access the "original/full" size version of the image. There are a few things that don't work quite yet: * The S3 backend support is incomplete and doesn't work yet. * The error pages for unauthorized access are ugly. * We might want to rename data-original and /thumbnail?size=original to use some other name, like "full", that better reflects the fact that we're potentially not serving the original image URL.
2018-03-08 09:37:09 +01:00
from typing import Any, Text, Tuple, Optional
thumbor: Add thumbor on port 9995 in development. For now, this does nothing in a production environment, but it should simplify the process of doing testing on the Thumbor implementation, by integrating a lot of dependency management logic.
2017-11-09 16:31:57 +01:00
ZULIP_PATH = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath('__file__'))))
sys.path.append(ZULIP_PATH)
# Piece of code below relating to secrets conf has been duplicated with that of
# django settings in zproject/settings.py
import six.moves.configparser
DEPLOY_ROOT = os.path.join(os.path.realpath(os.path.dirname(__file__)), '..', '..')
config_file = six.moves.configparser.RawConfigParser()
config_file.read("/etc/zulip/zulip.conf")
# Whether this instance of Zulip is running in a production environment.
PRODUCTION = config_file.has_option('machine', 'deploy_type')
DEVELOPMENT = not PRODUCTION
secrets_file = six.moves.configparser.RawConfigParser()
if PRODUCTION:
secrets_file.read("/etc/zulip/zulip-secrets.conf")
else:
secrets_file.read(os.path.join(DEPLOY_ROOT, "zproject/dev-secrets.conf"))
settings: Add a default value parameter to get_secret. This lets us have a slightly cleaner interface for cases where we need a custom default value than an `or None` in the definition (which might cause issues with other falsey values).
2018-08-09 18:55:06 +02:00
def get_secret(key, default_value=None, development_only=False):
# type: (str, Optional[Any], bool) -> Optional[Any]
if development_only and PRODUCTION:
return default_value
thumbor: Add thumbor on port 9995 in development. For now, this does nothing in a production environment, but it should simplify the process of doing testing on the Thumbor implementation, by integrating a lot of dependency management logic.
2017-11-09 16:31:57 +01:00
if secrets_file.has_option('secrets', key):
return secrets_file.get('secrets', key)
settings: Add a default value parameter to get_secret. This lets us have a slightly cleaner interface for cases where we need a custom default value than an `or None` in the definition (which might cause issues with other falsey values).
2018-08-09 18:55:06 +02:00
return default_value
thumbor: Add thumbor on port 9995 in development. For now, this does nothing in a production environment, but it should simplify the process of doing testing on the Thumbor implementation, by integrating a lot of dependency management logic.
2017-11-09 16:31:57 +01:00
THUMBOR_EXTERNAL_TYPE = 'external'
THUMBOR_S3_TYPE = 's3'
THUMBOR_LOCAL_FILE_TYPE = 'local_file'
thumbor: Complete implementation of thumbnailing. Various pieces of our thumbor-based thumbnailing system were already merged; this adds the remaining pieces required for it to work: * a THUMBOR_URL Django setting that controls whether thumbor is enabled on the Zulip server (and if so, where thumbor is hosted). * Replaces the overly complicated prototype cryptography logic * Adds a /thumbnail endpoint (supported both on web and mobile) for accessing thumbnails in messages, designed to support hosting both external URLs as well as uploaded files (and applying Zulip's security model for access to thumbnails of uploaded files). * Modifies bugdown to, when THUMBOR_URL is set, render images with the `src` attribute pointing /thumbnail (to provide a small thumbnail for the image), along with adding a "data-original" attribute that can be used to access the "original/full" size version of the image. There are a few things that don't work quite yet: * The S3 backend support is incomplete and doesn't work yet. * The error pages for unauthorized access are ugly. * We might want to rename data-original and /thumbnail?size=original to use some other name, like "full", that better reflects the fact that we're potentially not serving the original image URL.
2018-03-08 09:37:09 +01:00
def separate_url_and_source_type(url):
# type: (Text) -> Tuple[Text, Text]
THUMBNAIL_URL_PATT = re.compile('^(?P<actual_url>.+)/source_type/(?P<source_type>.+)')
matches = THUMBNAIL_URL_PATT.match(url)
return (matches.group('source_type'), matches.group('actual_url'))