epicyon/webapp_specification.py

74 lines
3.0 KiB
Python

__filename__ = "webapp_about.py"
__author__ = "Bob Mottram"
__license__ = "AGPL3+"
__version__ = "1.7.0"
__maintainer__ = "Bob Mottram"
__email__ = "bob@libreserver.org"
__status__ = "Production"
__module_group__ = "Web Interface"
from shutil import copyfile
from utils import data_dir
from utils import get_config_param
from webapp_utils import html_header_with_website_markup
from webapp_utils import html_footer
from markdown import markdown_example_numbers
from markdown import markdown_to_html
from data import load_string
from data import is_a_file
def html_specification(base_dir: str, http_prefix: str,
domain_full: str, onion_domain: str, translate: {},
system_language: str) -> str:
"""Show the specification screen
"""
specification_filename: str = base_dir + '/specification/activitypub.md'
admin_nickname: str = get_config_param(base_dir, 'admin')
dir_str: str = data_dir(base_dir)
if is_a_file(dir_str + '/activitypub.md'):
specification_filename = dir_str + '/activitypub.md'
if is_a_file(dir_str + '/login-background-custom.jpg'):
if not is_a_file(dir_str + '/login-background.jpg'):
copyfile(dir_str + '/login-background-custom.jpg',
dir_str + '/login-background.jpg')
specification_text: str = 'ActivityPub Protocol Specification.'
if is_a_file(specification_filename):
md_text: str = load_string(specification_filename,
'EX: html_specification unable to read ' +
specification_filename)
if md_text:
md_text = markdown_example_numbers(md_text)
specification_text = markdown_to_html(md_text)
specification_form: str = ''
css_filename: str = base_dir + '/epicyon-profile.css'
if is_a_file(base_dir + '/epicyon.css'):
css_filename = base_dir + '/epicyon.css'
instance_title: str = get_config_param(base_dir, 'instanceTitle')
specification_form = \
html_header_with_website_markup(css_filename, instance_title,
http_prefix, domain_full,
system_language)
specification_form += \
'<div class="container">' + specification_text + '</div>'
if onion_domain:
specification_form += \
'<div class="container"><center>\n' + \
'<p class="administeredby">' + \
'http://' + onion_domain + '</p>\n</center></div>\n'
if admin_nickname:
admin_actor: str = '/users/' + admin_nickname
specification_form += \
'<div class="container"><center>\n' + \
'<p class="administeredby">' + \
translate['Administered by'] + ' <a href="' + \
admin_actor + '">' + admin_nickname + '</a>. ' + \
translate['Version'] + ' ' + __version__ + \
'</p>\n</center></div>\n'
specification_form += html_footer()
return specification_form