import base64 from io import StringIO import orjson from django.conf import settings from zerver.lib.test_classes import ZulipTestCase from zerver.lib.test_helpers import ( create_s3_buckets, get_test_image_file, override_settings, use_s3_backend, ) from zerver.lib.upload import upload_backend, upload_emoji_image from zerver.lib.users import get_api_key class ThumbnailTest(ZulipTestCase): @use_s3_backend def test_s3_source_type(self) -> None: def get_file_path_urlpart(uri: str, size: str = "") -> str: url_in_result = "smart/filters:no_upscale()%s/%s/source_type/s3" sharpen_filter = "" if size: url_in_result = f"/{size}/{url_in_result}" sharpen_filter = ":sharpen(0.5,0.2,true)" hex_uri = base64.urlsafe_b64encode(uri.encode()).decode("utf-8") return url_in_result % (sharpen_filter, hex_uri) create_s3_buckets(settings.S3_AUTH_UPLOADS_BUCKET, settings.S3_AVATAR_BUCKET) hamlet = self.example_user("hamlet") self.login_user(hamlet) fp = StringIO("zulip!") fp.name = "zulip.jpeg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] base = "/user_uploads/" self.assertEqual(base, uri[: len(base)]) # Test full size image. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test thumbnail size. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "thumbnail"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri, "0x300") self.assertIn(expected_part_url, result.url) # Test custom emoji URLs in Zulip messages. user_profile = self.example_user("hamlet") file_name = "emoji.png" with get_test_image_file("img.png") as image_file: upload_emoji_image(image_file, file_name, user_profile) custom_emoji_url = upload_backend.get_emoji_url(file_name, user_profile.realm_id) emoji_url_base = "/user_avatars/" self.assertEqual(emoji_url_base, custom_emoji_url[: len(emoji_url_base)]) # Test full size custom emoji image (for emoji link in messages case). result = self.client_get("/thumbnail", {"url": custom_emoji_url[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) self.assertIn(custom_emoji_url, result.url) # Tests the /api/v1/thumbnail API endpoint with standard API auth self.logout() result = self.api_get(hamlet, "/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test with another user trying to access image using thumbor. self.login("iago") result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 403, result) self.assert_in_response("You are not authorized to view this file.", result) def test_external_source_type(self) -> None: def run_test_with_image_url(image_url: str) -> None: # Test full size image. self.login("hamlet") encoded_url = base64.urlsafe_b64encode(image_url.encode()).decode("utf-8") result = self.client_get("/thumbnail", {"url": image_url, "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/smart/filters:no_upscale()/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) # Test thumbnail size. result = self.client_get("/thumbnail", {"url": image_url, "size": "thumbnail"}) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) # Test API endpoint with standard API authentication. self.logout() user_profile = self.example_user("hamlet") result = self.api_get( user_profile, "/thumbnail", {"url": image_url, "size": "thumbnail"} ) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) # Test API endpoint with legacy API authentication. user_profile = self.example_user("hamlet") result = self.client_get( "/thumbnail", {"url": image_url, "size": "thumbnail", "api_key": get_api_key(user_profile)}, ) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) # Test a second logged-in user; they should also be able to access it user_profile = self.example_user("iago") result = self.client_get( "/thumbnail", {"url": image_url, "size": "thumbnail", "api_key": get_api_key(user_profile)}, ) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) # Test with another user trying to access image using thumbor. # File should be always accessible to user in case of external source self.login("iago") result = self.client_get("/thumbnail", {"url": image_url, "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = ( "/smart/filters:no_upscale()/" + encoded_url + "/source_type/external" ) self.assertIn(expected_part_url, result.url) image_url = "https://images.foobar.com/12345" run_test_with_image_url(image_url) image_url = "http://images.foobar.com/12345" run_test_with_image_url(image_url) image_url = "//images.foobar.com/12345" run_test_with_image_url(image_url) def test_local_file_type(self) -> None: def get_file_path_urlpart(uri: str, size: str = "") -> str: url_in_result = "smart/filters:no_upscale()%s/%s/source_type/local_file" sharpen_filter = "" if size: url_in_result = f"/{size}/{url_in_result}" sharpen_filter = ":sharpen(0.5,0.2,true)" hex_uri = base64.urlsafe_b64encode(uri.encode()).decode("utf-8") return url_in_result % (sharpen_filter, hex_uri) self.login("hamlet") fp = StringIO("zulip!") fp.name = "zulip.jpeg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] base = "/user_uploads/" self.assertEqual(base, uri[: len(base)]) # Test full size image. # We remove the forward slash infront of the `/user_uploads/` to match # Markdown behaviour. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test thumbnail size. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "thumbnail"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri, "0x300") self.assertIn(expected_part_url, result.url) # Test with a Unicode filename. fp = StringIO("zulip!") fp.name = "μένει.jpg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] # We remove the forward slash infront of the `/user_uploads/` to match # Markdown behaviour. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test custom emoji urls in Zulip messages. user_profile = self.example_user("hamlet") file_name = "emoji.png" with get_test_image_file("img.png") as image_file: upload_emoji_image(image_file, file_name, user_profile) custom_emoji_url = upload_backend.get_emoji_url(file_name, user_profile.realm_id) emoji_url_base = "/user_avatars/" self.assertEqual(emoji_url_base, custom_emoji_url[: len(emoji_url_base)]) # Test full size custom emoji image (for emoji link in messages case). result = self.client_get("/thumbnail", {"url": custom_emoji_url[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) self.assertIn(custom_emoji_url, result.url) # Tests the /api/v1/thumbnail API endpoint with HTTP basic auth. self.logout() user_profile = self.example_user("hamlet") result = self.api_get(user_profile, "/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Tests the /api/v1/thumbnail API endpoint with ?api_key # auth. user_profile = self.example_user("hamlet") result = self.client_get( "/thumbnail", {"url": uri[1:], "size": "full", "api_key": get_api_key(user_profile)} ) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test with another user trying to access image using thumbor. self.login("iago") result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 403, result) self.assert_in_response("You are not authorized to view this file.", result) @override_settings(THUMBOR_URL="127.0.0.1:9995") def test_with_static_files(self) -> None: self.login("hamlet") uri = "/static/images/cute/turtle.png" result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) self.assertEqual(uri, result.url) def test_with_thumbor_disabled(self) -> None: self.login("hamlet") fp = StringIO("zulip!") fp.name = "zulip.jpeg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] base = "/user_uploads/" self.assertEqual(base, uri[: len(base)]) with self.settings(THUMBOR_URL=""): result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) self.assertEqual(uri, result.url) uri = "https://www.google.com/images/srpr/logo4w.png" with self.settings(THUMBOR_URL=""): result = self.client_get("/thumbnail", {"url": uri, "size": "full"}) self.assertEqual(result.status_code, 302, result) base = "https://external-content.zulipcdn.net/external_content/56c362a24201593891955ff526b3b412c0f9fcd2/68747470733a2f2f7777772e676f6f676c652e636f6d2f696d616765732f737270722f6c6f676f34772e706e67" self.assertEqual(base, result.url) uri = "http://www.google.com/images/srpr/logo4w.png" with self.settings(THUMBOR_URL=""): result = self.client_get("/thumbnail", {"url": uri, "size": "full"}) self.assertEqual(result.status_code, 302, result) base = "https://external-content.zulipcdn.net/external_content/7b6552b60c635e41e8f6daeb36d88afc4eabde79/687474703a2f2f7777772e676f6f676c652e636f6d2f696d616765732f737270722f6c6f676f34772e706e67" self.assertEqual(base, result.url) uri = "//www.google.com/images/srpr/logo4w.png" with self.settings(THUMBOR_URL=""): result = self.client_get("/thumbnail", {"url": uri, "size": "full"}) self.assertEqual(result.status_code, 302, result) base = "https://external-content.zulipcdn.net/external_content/676530cf4b101d56f56cc4a37c6ef4d4fd9b0c03/2f2f7777772e676f6f676c652e636f6d2f696d616765732f737270722f6c6f676f34772e706e67" self.assertEqual(base, result.url) def test_with_different_THUMBOR_URL(self) -> None: self.login("hamlet") fp = StringIO("zulip!") fp.name = "zulip.jpeg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] base = "/user_uploads/" self.assertEqual(base, uri[: len(base)]) hex_uri = base64.urlsafe_b64encode(uri.encode()).decode("utf-8") with self.settings(THUMBOR_URL="http://test-thumborhost.com"): result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) base = "http://test-thumborhost.com/" self.assertEqual(base, result.url[: len(base)]) expected_part_url = "/smart/filters:no_upscale()/" + hex_uri + "/source_type/local_file" self.assertIn(expected_part_url, result.url) def test_with_different_sizes(self) -> None: def get_file_path_urlpart(uri: str, size: str = "") -> str: url_in_result = "smart/filters:no_upscale()%s/%s/source_type/local_file" sharpen_filter = "" if size: url_in_result = f"/{size}/{url_in_result}" sharpen_filter = ":sharpen(0.5,0.2,true)" hex_uri = base64.urlsafe_b64encode(uri.encode()).decode("utf-8") return url_in_result % (sharpen_filter, hex_uri) self.login("hamlet") fp = StringIO("zulip!") fp.name = "zulip.jpeg" result = self.client_post("/json/user_uploads", {"file": fp}) self.assert_json_success(result) json = orjson.loads(result.content) self.assertIn("uri", json) uri = json["uri"] base = "/user_uploads/" self.assertEqual(base, uri[: len(base)]) # Test with size supplied as a query parameter. # size=thumbnail should return a 0x300 sized image. # size=full should return the original resolution image. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "thumbnail"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri, "0x300") self.assertIn(expected_part_url, result.url) result = self.client_get("/thumbnail", {"url": uri[1:], "size": "full"}) self.assertEqual(result.status_code, 302, result) expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) # Test with size supplied as a query parameter where size is anything # else than 'full' or 'thumbnail'. Result should be an error message. result = self.client_get("/thumbnail", {"url": uri[1:], "size": "480x360"}) self.assertEqual(result.status_code, 403, result) self.assert_in_response("Invalid size.", result) # Test with no size param supplied. In this case as well we show an # error message. result = self.client_get("/thumbnail", {"url": uri[1:]}) self.assertEqual(result.status_code, 400, "Missing 'size' argument")