Sith/core/utils.py

264 lines
9.4 KiB
Python
Raw Normal View History

# -*- coding:utf-8 -*
#
# Copyright 2023 © AE UTBM
# ae@utbm.fr / ae.info@utbm.fr
#
# This file is part of the website of the UTBM Student Association (AE UTBM),
# https://ae.utbm.fr.
#
# You can find the source code of the website at https://github.com/ae-utbm/sith3
#
# LICENSED UNDER THE GNU GENERAL PUBLIC LICENSE VERSION 3 (GPLv3)
# SEE : https://raw.githubusercontent.com/ae-utbm/sith3/master/LICENSE
# OR WITHIN THE LOCAL FILE "LICENSE"
#
#
import os
import subprocess
2017-05-14 01:14:38 +00:00
import re
# Image utils
from io import BytesIO
2017-06-12 07:42:03 +00:00
from datetime import date
2017-06-12 07:42:03 +00:00
from PIL import ExifTags
2018-10-04 19:29:19 +00:00
2016-08-22 12:21:17 +00:00
import PIL
from django.conf import settings
2016-08-22 12:21:17 +00:00
from django.core.files.base import ContentFile
def get_git_revision_short_hash() -> str:
"""
Return the short hash of the current commit
"""
2023-05-10 09:56:33 +00:00
try:
output = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
if isinstance(output, bytes):
return output.decode("ascii").strip()
return output.strip()
except subprocess.CalledProcessError:
return ""
def get_start_of_semester(d=date.today()):
"""
This function computes the start date of the semester with respect to the given date (default is today),
and the start date given in settings.SITH_START_DATE.
It takes the nearest past start date.
Exemples: with SITH_START_DATE = (8, 15)
Today -> Start date
2015-03-17 -> 2015-02-15
2015-01-11 -> 2014-08-15
"""
today = d
year = today.year
start = date(year, settings.SITH_START_DATE[0], settings.SITH_START_DATE[1])
2017-06-12 07:42:03 +00:00
start2 = start.replace(month=(start.month + 6) % 12)
spring, autumn = min(start, start2), max(start, start2)
if today > autumn: # autumn semester
return autumn
if today > spring: # spring semester
return spring
return autumn.replace(year=year - 1) # autumn semester of last year
2017-06-12 07:42:03 +00:00
def get_semester(d=date.today()):
start = get_start_of_semester(d)
if start.month <= 6:
return "P" + str(start.year)[-2:]
else:
return "A" + str(start.year)[-2:]
2017-06-12 07:42:03 +00:00
def file_exist(path):
return os.path.exists(path)
def scale_dimension(width, height, long_edge):
if width > height:
2018-10-04 19:29:19 +00:00
ratio = long_edge * 1.0 / width
else:
2018-10-04 19:29:19 +00:00
ratio = long_edge * 1.0 / height
return int(width * ratio), int(height * ratio)
2017-06-12 07:42:03 +00:00
2016-11-20 10:56:33 +00:00
def resize_image(im, edge, format):
(w, h) = im.size
(width, height) = scale_dimension(w, h, long_edge=edge)
content = BytesIO()
2016-08-22 12:21:17 +00:00
im = im.resize((width, height), PIL.Image.ANTIALIAS)
try:
2018-10-04 19:29:19 +00:00
im.save(
fp=content,
format=format.upper(),
quality=90,
optimize=True,
progressive=True,
)
2016-08-22 12:21:17 +00:00
except IOError:
PIL.ImageFile.MAXBLOCK = im.size[0] * im.size[1]
2018-10-04 19:29:19 +00:00
im.save(
fp=content,
format=format.upper(),
quality=90,
optimize=True,
progressive=True,
)
return ContentFile(content.getvalue())
2016-11-20 12:39:04 +00:00
2017-06-12 07:42:03 +00:00
def exif_auto_rotate(image):
for orientation in ExifTags.TAGS.keys():
2018-10-04 19:29:19 +00:00
if ExifTags.TAGS[orientation] == "Orientation":
2017-06-12 07:42:03 +00:00
break
exif = dict(image._getexif().items())
if exif[orientation] == 3:
image = image.rotate(180, expand=True)
elif exif[orientation] == 6:
image = image.rotate(270, expand=True)
elif exif[orientation] == 8:
image = image.rotate(90, expand=True)
2016-11-20 12:39:04 +00:00
return image
2017-05-14 01:14:38 +00:00
2017-06-12 07:42:03 +00:00
2017-05-14 01:14:38 +00:00
def doku_to_markdown(text):
"""This is a quite correct doku translator"""
2018-10-04 19:29:19 +00:00
text = re.sub(
r"([^:]|^)\/\/(.*?)\/\/", r"*\2*", text
) # Italic (prevents protocol:// conflict)
text = re.sub(
r"<del>(.*?)<\/del>", r"~~\1~~", text, flags=re.DOTALL
) # Strike (may be multiline)
text = re.sub(
r"<sup>(.*?)<\/sup>", r"^\1^", text
) # Superscript (multiline not supported, because almost never used)
text = re.sub(r"<sub>(.*?)<\/sub>", r"_\1_", text) # Subscript (idem)
text = re.sub(r"^======(.*?)======", r"#\1", text, flags=re.MULTILINE) # Titles
text = re.sub(r"^=====(.*?)=====", r"##\1", text, flags=re.MULTILINE)
text = re.sub(r"^====(.*?)====", r"###\1", text, flags=re.MULTILINE)
text = re.sub(r"^===(.*?)===", r"####\1", text, flags=re.MULTILINE)
text = re.sub(r"^==(.*?)==", r"#####\1", text, flags=re.MULTILINE)
text = re.sub(r"^=(.*?)=", r"######\1", text, flags=re.MULTILINE)
text = re.sub(r"<nowiki>", r"<nosyntax>", text)
text = re.sub(r"</nowiki>", r"</nosyntax>", text)
text = re.sub(r"<code>", r"```\n", text)
text = re.sub(r"</code>", r"\n```", text)
text = re.sub(r"article://", r"page://", text)
text = re.sub(r"dfile://", r"file://", text)
2017-05-14 01:14:38 +00:00
i = 1
2018-10-04 19:29:19 +00:00
for fn in re.findall(r"\(\((.*?)\)\)", text): # Footnotes
text = re.sub(r"\(\((.*?)\)\)", r"[^%s]" % i, text, count=1)
2017-05-14 01:14:38 +00:00
text += "\n[^%s]: %s\n" % (i, fn)
i += 1
2018-10-04 19:29:19 +00:00
text = re.sub(r"\\{2,}[\s]", r" \n", text) # Carriage return
2017-05-14 01:14:38 +00:00
2018-10-04 19:29:19 +00:00
text = re.sub(r"\[\[(.*?)\|(.*?)\]\]", r"[\2](\1)", text) # Links
text = re.sub(r"\[\[(.*?)\]\]", r"[\1](\1)", text) # Links 2
text = re.sub(r"{{(.*?)\|(.*?)}}", r'![\2](\1 "\2")', text) # Images
text = re.sub(r"{{(.*?)(\|(.*?))?}}", r'![\1](\1 "\1")', text) # Images 2
text = re.sub(
r"{\[(.*?)(\|(.*?))?\]}", r"[\1](\1)", text
) # Video (transform to classic links, since we can't integrate them)
2017-05-14 01:14:38 +00:00
2018-10-04 19:29:19 +00:00
text = re.sub(r"###(\d*?)###", r"[[[\1]]]", text) # Progress bar
2017-05-14 01:14:38 +00:00
2018-10-04 19:29:19 +00:00
text = re.sub(
r"(\n +[^* -][^\n]*(\n +[^* -][^\n]*)*)", r"```\1\n```", text, flags=re.DOTALL
) # Block code without lists
2017-05-14 01:14:38 +00:00
2018-10-04 19:29:19 +00:00
text = re.sub(r"( +)-(.*)", r"1.\2", text) # Ordered lists
2017-05-14 01:14:38 +00:00
new_text = []
quote_level = 0
2017-06-12 07:42:03 +00:00
for line in text.splitlines(): # Tables and quotes
2018-10-04 19:29:19 +00:00
enter = re.finditer(r"\[quote(=(.+?))?\]", line)
quit = re.finditer(r"\[/quote\]", line)
if re.search(r"\A\s*\^(([^\^]*?)\^)*", line): # Table part
line = line.replace("^", "|")
2017-05-14 01:14:38 +00:00
new_text.append("> " * quote_level + line)
2018-10-04 19:29:19 +00:00
new_text.append(
"> " * quote_level + "|---|"
) # Don't keep the text alignement in tables it's really too complex for what it's worth
2017-06-12 07:42:03 +00:00
elif enter or quit: # Quote part
for quote in enter: # Enter quotes (support multiple at a time)
quote_level += 1
try:
new_text.append("> " * quote_level + "##### " + quote.group(2))
except:
new_text.append("> " * quote_level)
2018-10-04 19:29:19 +00:00
line = line.replace(quote.group(0), "")
2019-11-04 12:46:09 +00:00
final_quote_level = quote_level # Store quote_level to use at the end, since it will be modified during quit iteration
final_newline = False
2017-06-12 07:42:03 +00:00
for quote in quit: # Quit quotes (support multiple at a time)
2018-10-04 19:29:19 +00:00
line = line.replace(quote.group(0), "")
quote_level -= 1
final_newline = True
2017-06-12 07:42:03 +00:00
new_text.append("> " * final_quote_level + line) # Finally append the line
if final_newline:
2018-10-04 19:29:19 +00:00
new_text.append(
"\n"
) # Add a new line to ensure the separation between the quote and the following text
else:
new_text.append(line)
return "\n".join(new_text)
2017-06-12 07:42:03 +00:00
def bbcode_to_markdown(text):
"""This is a very basic BBcode translator"""
2018-10-04 19:29:19 +00:00
text = re.sub(r"\[b\](.*?)\[\/b\]", r"**\1**", text, flags=re.DOTALL) # Bold
text = re.sub(r"\[i\](.*?)\[\/i\]", r"*\1*", text, flags=re.DOTALL) # Italic
text = re.sub(r"\[u\](.*?)\[\/u\]", r"__\1__", text, flags=re.DOTALL) # Underline
text = re.sub(
r"\[s\](.*?)\[\/s\]", r"~~\1~~", text, flags=re.DOTALL
) # Strike (may be multiline)
text = re.sub(
r"\[strike\](.*?)\[\/strike\]", r"~~\1~~", text, flags=re.DOTALL
) # Strike 2
text = re.sub(r"article://", r"page://", text)
text = re.sub(r"dfile://", r"file://", text)
text = re.sub(r"\[url=(.*?)\](.*)\[\/url\]", r"[\2](\1)", text) # Links
text = re.sub(r"\[url\](.*)\[\/url\]", r"\1", text) # Links 2
text = re.sub(r"\[img\](.*)\[\/img\]", r'![\1](\1 "\1")', text) # Images
new_text = []
quote_level = 0
2017-06-12 07:42:03 +00:00
for line in text.splitlines(): # Tables and quotes
2018-10-04 19:29:19 +00:00
enter = re.finditer(r"\[quote(=(.+?))?\]", line)
quit = re.finditer(r"\[/quote\]", line)
2017-06-12 07:42:03 +00:00
if enter or quit: # Quote part
for quote in enter: # Enter quotes (support multiple at a time)
2017-05-14 01:14:38 +00:00
quote_level += 1
try:
new_text.append("> " * quote_level + "##### " + quote.group(2))
except:
new_text.append("> " * quote_level)
2018-10-04 19:29:19 +00:00
line = line.replace(quote.group(0), "")
2019-11-04 12:46:09 +00:00
final_quote_level = quote_level # Store quote_level to use at the end, since it will be modified during quit iteration
final_newline = False
2017-06-12 07:42:03 +00:00
for quote in quit: # Quit quotes (support multiple at a time)
2018-10-04 19:29:19 +00:00
line = line.replace(quote.group(0), "")
2017-05-14 01:14:38 +00:00
quote_level -= 1
final_newline = True
2017-06-12 07:42:03 +00:00
new_text.append("> " * final_quote_level + line) # Finally append the line
if final_newline:
2018-10-04 19:29:19 +00:00
new_text.append(
"\n"
) # Add a new line to ensure the separation between the quote and the following text
2017-05-14 01:14:38 +00:00
else:
new_text.append(line)
return "\n".join(new_text)