2024-01-26 01:54:13 -05:00
|
|
|
from __future__ import annotations
|
|
|
|
|
2024-01-13 09:37:36 -05:00
|
|
|
import re
|
|
|
|
from io import BytesIO
|
|
|
|
import base64
|
2024-01-29 12:14:46 -05:00
|
|
|
from .typing import ImageType, Union, Image
|
2024-01-26 01:54:13 -05:00
|
|
|
|
|
|
|
try:
|
2024-01-29 12:14:46 -05:00
|
|
|
from PIL.Image import open as open_image, new as new_image
|
2024-01-26 01:54:13 -05:00
|
|
|
from PIL.Image import FLIP_LEFT_RIGHT, ROTATE_180, ROTATE_270, ROTATE_90
|
|
|
|
has_requirements = True
|
|
|
|
except ImportError:
|
|
|
|
has_requirements = False
|
|
|
|
|
|
|
|
from .errors import MissingRequirementsError
|
2024-01-13 09:37:36 -05:00
|
|
|
|
2024-01-22 19:47:55 -05:00
|
|
|
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif', 'webp', 'svg'}
|
2024-01-13 09:37:36 -05:00
|
|
|
|
2024-01-26 01:54:13 -05:00
|
|
|
def to_image(image: ImageType, is_svg: bool = False) -> Image:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Converts the input image to a PIL Image object.
|
|
|
|
|
|
|
|
Args:
|
2024-01-26 01:54:13 -05:00
|
|
|
image (Union[str, bytes, Image]): The input image.
|
2024-01-14 01:45:41 -05:00
|
|
|
|
|
|
|
Returns:
|
2024-01-26 01:54:13 -05:00
|
|
|
Image: The converted PIL Image object.
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
2024-01-26 01:54:13 -05:00
|
|
|
if not has_requirements:
|
|
|
|
raise MissingRequirementsError('Install "pillow" package for images')
|
2024-01-29 12:14:46 -05:00
|
|
|
if isinstance(image, str):
|
|
|
|
is_data_uri_an_image(image)
|
|
|
|
image = extract_data_uri(image)
|
2024-01-22 19:47:55 -05:00
|
|
|
if is_svg:
|
|
|
|
try:
|
|
|
|
import cairosvg
|
|
|
|
except ImportError:
|
2024-01-26 01:54:13 -05:00
|
|
|
raise MissingRequirementsError('Install "cairosvg" package for svg images')
|
2024-01-22 19:47:55 -05:00
|
|
|
if not isinstance(image, bytes):
|
|
|
|
image = image.read()
|
|
|
|
buffer = BytesIO()
|
|
|
|
cairosvg.svg2png(image, write_to=buffer)
|
2024-01-26 01:54:13 -05:00
|
|
|
return open_image(buffer)
|
2024-01-13 09:37:36 -05:00
|
|
|
if isinstance(image, bytes):
|
|
|
|
is_accepted_format(image)
|
2024-01-26 01:54:13 -05:00
|
|
|
return open_image(BytesIO(image))
|
|
|
|
elif not isinstance(image, Image):
|
|
|
|
image = open_image(image)
|
2024-01-13 09:37:36 -05:00
|
|
|
copy = image.copy()
|
|
|
|
copy.format = image.format
|
2024-01-23 10:48:52 -05:00
|
|
|
return copy
|
2024-01-13 09:37:36 -05:00
|
|
|
return image
|
|
|
|
|
2024-01-14 01:45:41 -05:00
|
|
|
def is_allowed_extension(filename: str) -> bool:
|
|
|
|
"""
|
|
|
|
Checks if the given filename has an allowed extension.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
filename (str): The filename to check.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
bool: True if the extension is allowed, False otherwise.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
return '.' in filename and \
|
|
|
|
filename.rsplit('.', 1)[1].lower() in ALLOWED_EXTENSIONS
|
|
|
|
|
|
|
|
def is_data_uri_an_image(data_uri: str) -> bool:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Checks if the given data URI represents an image.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
data_uri (str): The data URI to check.
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
ValueError: If the data URI is invalid or the image format is not allowed.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
# Check if the data URI starts with 'data:image' and contains an image format (e.g., jpeg, png, gif)
|
|
|
|
if not re.match(r'data:image/(\w+);base64,', data_uri):
|
|
|
|
raise ValueError("Invalid data URI image.")
|
2024-01-14 01:45:41 -05:00
|
|
|
# Extract the image format from the data URI
|
2024-01-29 12:14:46 -05:00
|
|
|
image_format = re.match(r'data:image/(\w+);base64,', data_uri).group(1).lower()
|
2024-01-13 09:37:36 -05:00
|
|
|
# Check if the image format is one of the allowed formats (jpg, jpeg, png, gif)
|
2024-01-29 12:14:46 -05:00
|
|
|
if image_format not in ALLOWED_EXTENSIONS and image_format != "svg+xml":
|
2024-01-13 09:37:36 -05:00
|
|
|
raise ValueError("Invalid image format (from mime file type).")
|
|
|
|
|
|
|
|
def is_accepted_format(binary_data: bytes) -> bool:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Checks if the given binary data represents an image with an accepted format.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
binary_data (bytes): The binary data to check.
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
ValueError: If the image format is not allowed.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
if binary_data.startswith(b'\xFF\xD8\xFF'):
|
|
|
|
pass # It's a JPEG image
|
|
|
|
elif binary_data.startswith(b'\x89PNG\r\n\x1a\n'):
|
|
|
|
pass # It's a PNG image
|
|
|
|
elif binary_data.startswith(b'GIF87a') or binary_data.startswith(b'GIF89a'):
|
|
|
|
pass # It's a GIF image
|
|
|
|
elif binary_data.startswith(b'\x89JFIF') or binary_data.startswith(b'JFIF\x00'):
|
|
|
|
pass # It's a JPEG image
|
|
|
|
elif binary_data.startswith(b'\xFF\xD8'):
|
|
|
|
pass # It's a JPEG image
|
|
|
|
elif binary_data.startswith(b'RIFF') and binary_data[8:12] == b'WEBP':
|
|
|
|
pass # It's a WebP image
|
|
|
|
else:
|
|
|
|
raise ValueError("Invalid image format (from magic code).")
|
2024-01-14 01:45:41 -05:00
|
|
|
|
2024-01-13 09:37:36 -05:00
|
|
|
def extract_data_uri(data_uri: str) -> bytes:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Extracts the binary data from the given data URI.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
data_uri (str): The data URI.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
bytes: The extracted binary data.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
data = data_uri.split(",")[1]
|
|
|
|
data = base64.b64decode(data)
|
|
|
|
return data
|
|
|
|
|
2024-01-26 01:54:13 -05:00
|
|
|
def get_orientation(image: Image) -> int:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Gets the orientation of the given image.
|
|
|
|
|
|
|
|
Args:
|
2024-01-26 01:54:13 -05:00
|
|
|
image (Image): The image.
|
2024-01-14 01:45:41 -05:00
|
|
|
|
|
|
|
Returns:
|
|
|
|
int: The orientation value.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
exif_data = image.getexif() if hasattr(image, 'getexif') else image._getexif()
|
|
|
|
if exif_data is not None:
|
2024-01-20 20:20:23 -05:00
|
|
|
orientation = exif_data.get(274) # 274 corresponds to the orientation tag in EXIF
|
2024-01-13 09:37:36 -05:00
|
|
|
if orientation is not None:
|
|
|
|
return orientation
|
|
|
|
|
2024-01-26 01:54:13 -05:00
|
|
|
def process_image(img: Image, new_width: int, new_height: int) -> Image:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Processes the given image by adjusting its orientation and resizing it.
|
|
|
|
|
|
|
|
Args:
|
2024-01-26 01:54:13 -05:00
|
|
|
img (Image): The image to process.
|
2024-01-14 01:45:41 -05:00
|
|
|
new_width (int): The new width of the image.
|
|
|
|
new_height (int): The new height of the image.
|
|
|
|
|
|
|
|
Returns:
|
2024-01-26 01:54:13 -05:00
|
|
|
Image: The processed image.
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
2024-01-23 10:48:52 -05:00
|
|
|
# Fix orientation
|
2024-01-13 09:37:36 -05:00
|
|
|
orientation = get_orientation(img)
|
|
|
|
if orientation:
|
|
|
|
if orientation > 4:
|
2024-01-26 01:54:13 -05:00
|
|
|
img = img.transpose(FLIP_LEFT_RIGHT)
|
2024-01-13 09:37:36 -05:00
|
|
|
if orientation in [3, 4]:
|
2024-01-26 01:54:13 -05:00
|
|
|
img = img.transpose(ROTATE_180)
|
2024-01-13 09:37:36 -05:00
|
|
|
if orientation in [5, 6]:
|
2024-01-26 01:54:13 -05:00
|
|
|
img = img.transpose(ROTATE_270)
|
2024-01-13 09:37:36 -05:00
|
|
|
if orientation in [7, 8]:
|
2024-01-26 01:54:13 -05:00
|
|
|
img = img.transpose(ROTATE_90)
|
2024-01-23 10:48:52 -05:00
|
|
|
# Resize image
|
2024-01-13 12:10:43 -05:00
|
|
|
img.thumbnail((new_width, new_height))
|
2024-01-23 10:48:52 -05:00
|
|
|
# Remove transparency
|
|
|
|
if img.mode != "RGB":
|
|
|
|
img.load()
|
2024-01-26 01:54:13 -05:00
|
|
|
white = new_image('RGB', img.size, (255, 255, 255))
|
2024-01-23 10:48:52 -05:00
|
|
|
white.paste(img, mask=img.split()[3])
|
|
|
|
return white
|
2024-01-13 12:10:43 -05:00
|
|
|
return img
|
2024-01-14 01:45:41 -05:00
|
|
|
|
2024-01-26 01:54:13 -05:00
|
|
|
def to_base64_jpg(image: Image, compression_rate: float) -> str:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Converts the given image to a base64-encoded string.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
image (Image.Image): The image to convert.
|
|
|
|
compression_rate (float): The compression rate (0.0 to 1.0).
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
str: The base64-encoded image.
|
|
|
|
"""
|
2024-01-13 09:37:36 -05:00
|
|
|
output_buffer = BytesIO()
|
|
|
|
image.save(output_buffer, format="JPEG", quality=int(compression_rate * 100))
|
|
|
|
return base64.b64encode(output_buffer.getvalue()).decode()
|
|
|
|
|
2024-01-29 12:14:46 -05:00
|
|
|
def format_images_markdown(images, alt: str, preview: str = None) -> str:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Formats the given images as a markdown string.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
images: The images to format.
|
2024-01-20 20:20:23 -05:00
|
|
|
alt (str): The alt for the images.
|
2024-01-14 01:45:41 -05:00
|
|
|
preview (str, optional): The preview URL format. Defaults to "{image}?w=200&h=200".
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
str: The formatted markdown string.
|
|
|
|
"""
|
2024-01-20 20:20:23 -05:00
|
|
|
if isinstance(images, str):
|
2024-01-29 12:14:46 -05:00
|
|
|
images = f"[![{alt}]({preview.replace('{image}', images) if preview else images})]({images})"
|
2024-01-13 09:37:36 -05:00
|
|
|
else:
|
2024-01-29 12:14:46 -05:00
|
|
|
images = [
|
|
|
|
f"[![#{idx+1} {alt}]({preview.replace('{image}', image) if preview else image})]({image})"
|
|
|
|
for idx, image in enumerate(images)
|
|
|
|
]
|
2024-01-20 20:20:23 -05:00
|
|
|
images = "\n".join(images)
|
2024-01-13 09:37:36 -05:00
|
|
|
start_flag = "<!-- generated images start -->\n"
|
|
|
|
end_flag = "<!-- generated images end -->\n"
|
|
|
|
return f"\n{start_flag}{images}\n{end_flag}\n"
|
|
|
|
|
2024-02-08 16:02:52 -05:00
|
|
|
def to_bytes(image: ImageType) -> bytes:
|
2024-01-14 01:45:41 -05:00
|
|
|
"""
|
|
|
|
Converts the given image to bytes.
|
|
|
|
|
|
|
|
Args:
|
2024-02-08 16:02:52 -05:00
|
|
|
image (ImageType): The image to convert.
|
2024-01-14 01:45:41 -05:00
|
|
|
|
|
|
|
Returns:
|
|
|
|
bytes: The image as bytes.
|
|
|
|
"""
|
2024-02-08 16:02:52 -05:00
|
|
|
if isinstance(image, bytes):
|
|
|
|
return image
|
|
|
|
elif isinstance(image, str):
|
|
|
|
is_data_uri_an_image(image)
|
|
|
|
return extract_data_uri(image)
|
|
|
|
elif isinstance(image, Image):
|
|
|
|
bytes_io = BytesIO()
|
|
|
|
image.save(bytes_io, image.format)
|
|
|
|
image.seek(0)
|
|
|
|
return bytes_io.getvalue()
|
|
|
|
else:
|
|
|
|
return image.read()
|
2024-01-13 09:37:36 -05:00
|
|
|
|
2024-01-29 12:14:46 -05:00
|
|
|
class ImageResponse:
|
2024-01-13 09:37:36 -05:00
|
|
|
def __init__(
|
|
|
|
self,
|
|
|
|
images: Union[str, list],
|
|
|
|
alt: str,
|
|
|
|
options: dict = {}
|
|
|
|
):
|
|
|
|
self.images = images
|
|
|
|
self.alt = alt
|
|
|
|
self.options = options
|
|
|
|
|
|
|
|
def __str__(self) -> str:
|
2024-01-29 12:14:46 -05:00
|
|
|
return format_images_markdown(self.images, self.alt, self.get("preview"))
|
2024-01-13 09:37:36 -05:00
|
|
|
|
|
|
|
def get(self, key: str):
|
2024-01-26 01:54:13 -05:00
|
|
|
return self.options.get(key)
|
|
|
|
|
2024-01-29 12:14:46 -05:00
|
|
|
class ImageRequest:
|
|
|
|
def __init__(
|
|
|
|
self,
|
|
|
|
options: dict = {}
|
|
|
|
):
|
|
|
|
self.options = options
|
|
|
|
|
|
|
|
def get(self, key: str):
|
|
|
|
return self.options.get(key)
|