epicyon/webapp_column_left.py

__filename__ = "webapp_column_left.py"
__author__ = "Bob Mottram"
__license__ = "AGPL3+"
__version__ = "1.2.0"
__maintainer__ = "Bob Mottram"
__email__ = "bob@libreserver.org"
__status__ = "Production"
__module_group__ = "Web Interface Columns"

import os
from utils import get_config_param
from utils import getNicknameFromActor
from utils import is_editor
from utils import isArtist
from utils import removeDomainPort
from utils import local_actor_url
from webapp_utils import sharesTimelineJson
from webapp_utils import htmlPostSeparator
from webapp_utils import getLeftImageFile
from webapp_utils import headerButtonsFrontScreen
from webapp_utils import htmlHeaderWithExternalStyle
from webapp_utils import htmlFooter
from webapp_utils import getBannerFile
from webapp_utils import editTextField
from shares import shareCategoryIcon


def _linksExist(base_dir: str) -> bool:
    """Returns true if links have been created
    """
    linksFilename = base_dir + '/accounts/links.txt'
    return os.path.isfile(linksFilename)


def _getLeftColumnShares(base_dir: str,
                         http_prefix: str, domain: str, domain_full: str,
                         nickname: str,
                         maxSharesInLeftColumn: int,
                         translate: {},
                         shared_items_federated_domains: []) -> []:
    """get any shares and turn them into the left column links format
    """
    pageNumber = 1
    actor = local_actor_url(http_prefix, nickname, domain_full)
    # NOTE: this could potentially be slow if the number of federated
    # shared items is large
    sharesJson, lastPage = \
        sharesTimelineJson(actor, pageNumber, maxSharesInLeftColumn,
                           base_dir, domain, nickname, maxSharesInLeftColumn,
                           shared_items_federated_domains, 'shares')
    if not sharesJson:
        return []

    linksList = []
    ctr = 0
    for published, item in sharesJson.items():
        sharedesc = item['displayName']
        if '<' in sharedesc or '?' in sharedesc:
            continue
        shareId = item['shareId']
        # selecting this link calls htmlShowShare
        shareLink = actor + '?showshare=' + shareId
        if item.get('category'):
            shareLink += '?category=' + item['category']
            shareCategory = shareCategoryIcon(item['category'])

        linksList.append(shareCategory + sharedesc + ' ' + shareLink)
        ctr += 1
        if ctr >= maxSharesInLeftColumn:
            break

    if linksList:
        linksList = ['* ' + translate['Shares']] + linksList
    return linksList


def _getLeftColumnWanted(base_dir: str,
                         http_prefix: str, domain: str, domain_full: str,
                         nickname: str,
                         maxSharesInLeftColumn: int,
                         translate: {},
                         shared_items_federated_domains: []) -> []:
    """get any wanted items and turn them into the left column links format
    """
    pageNumber = 1
    actor = local_actor_url(http_prefix, nickname, domain_full)
    # NOTE: this could potentially be slow if the number of federated
    # wanted items is large
    sharesJson, lastPage = \
        sharesTimelineJson(actor, pageNumber, maxSharesInLeftColumn,
                           base_dir, domain, nickname, maxSharesInLeftColumn,
                           shared_items_federated_domains, 'wanted')
    if not sharesJson:
        return []

    linksList = []
    ctr = 0
    for published, item in sharesJson.items():
        sharedesc = item['displayName']
        if '<' in sharedesc or ';' in sharedesc:
            continue
        shareId = item['shareId']
        # selecting this link calls htmlShowShare
        shareLink = actor + '?showwanted=' + shareId
        linksList.append(sharedesc + ' ' + shareLink)
        ctr += 1
        if ctr >= maxSharesInLeftColumn:
            break

    if linksList:
        linksList = ['* ' + translate['Wanted']] + linksList
    return linksList


def getLeftColumnContent(base_dir: str, nickname: str, domain_full: str,
                         http_prefix: str, translate: {},
                         editor: bool, artist: bool,
                         showBackButton: bool, timelinePath: str,
                         rss_icon_at_top: bool, showHeaderImage: bool,
                         frontPage: bool, theme: str,
                         accessKeys: {},
                         shared_items_federated_domains: []) -> str:
    """Returns html content for the left column
    """
    htmlStr = ''

    separatorStr = htmlPostSeparator(base_dir, 'left')
    domain = removeDomainPort(domain_full)

    editImageClass = ''
    if showHeaderImage:
        leftImageFile, leftColumnImageFilename = \
            getLeftImageFile(base_dir, nickname, domain, theme)

        # show the image at the top of the column
        editImageClass = 'leftColEdit'
        if os.path.isfile(leftColumnImageFilename):
            editImageClass = 'leftColEditImage'
            htmlStr += \
                '\n      <center>\n        <img class="leftColImg" ' + \
                'alt="" loading="lazy" src="/users/' + \
                nickname + '/' + leftImageFile + '" />\n' + \
                '      </center>\n'

    if showBackButton:
        htmlStr += \
            '      <div>      <a href="' + timelinePath + '">' + \
            '<button class="cancelbtn">' + \
            translate['Go Back'] + '</button></a>\n'

    if (editor or rss_icon_at_top) and not showHeaderImage:
        htmlStr += '<div class="columnIcons">'

    if editImageClass == 'leftColEdit':
        htmlStr += '\n      <center>\n'

    htmlStr += '      <div class="leftColIcons">\n'

    if editor:
        # show the edit icon
        htmlStr += \
            '      <a href="/users/' + nickname + '/editlinks" ' + \
            'accesskey="' + accessKeys['menuEdit'] + '">' + \
            '<img class="' + editImageClass + '" loading="lazy" alt="' + \
            translate['Edit Links'] + ' | " title="' + \
            translate['Edit Links'] + '" src="/icons/edit.png" /></a>\n'

    if artist:
        # show the theme designer icon
        htmlStr += \
            '      <a href="/users/' + nickname + '/themedesigner" ' + \
            'accesskey="' + accessKeys['menuThemeDesigner'] + '">' + \
            '<img class="' + editImageClass + '" loading="lazy" alt="' + \
            translate['Theme Designer'] + ' | " title="' + \
            translate['Theme Designer'] + '" src="/icons/theme.png" /></a>\n'

    # RSS icon
    if nickname != 'news':
        # rss feed for this account
        rssUrl = http_prefix + '://' + domain_full + \
            '/blog/' + nickname + '/rss.xml'
    else:
        # rss feed for all accounts on the instance
        rssUrl = http_prefix + '://' + domain_full + '/blog/rss.xml'
    if not frontPage:
        rssTitle = translate['RSS feed for your blog']
    else:
        rssTitle = translate['RSS feed for this site']
    rssIconStr = \
        '      <a href="' + rssUrl + '"><img class="' + editImageClass + \
        '" loading="lazy" alt="' + rssTitle + '" title="' + rssTitle + \
        '" src="/icons/logorss.png" /></a>\n'
    if rss_icon_at_top:
        htmlStr += rssIconStr
    htmlStr += '      </div>\n'

    if editImageClass == 'leftColEdit':
        htmlStr += '      </center>\n'

    if (editor or rss_icon_at_top) and not showHeaderImage:
        htmlStr += '</div><br>'

    # if showHeaderImage:
    #     htmlStr += '<br>'

    # flag used not to show the first separator
    firstSeparatorAdded = False

    linksFilename = base_dir + '/accounts/links.txt'
    linksFileContainsEntries = False
    linksList = None
    if os.path.isfile(linksFilename):
        with open(linksFilename, 'r') as f:
            linksList = f.readlines()

    if not frontPage:
        # show a number of shares
        maxSharesInLeftColumn = 3
        sharesList = \
            _getLeftColumnShares(base_dir,
                                 http_prefix, domain, domain_full, nickname,
                                 maxSharesInLeftColumn, translate,
                                 shared_items_federated_domains)
        if linksList and sharesList:
            linksList = sharesList + linksList

        wantedList = \
            _getLeftColumnWanted(base_dir,
                                 http_prefix, domain, domain_full, nickname,
                                 maxSharesInLeftColumn, translate,
                                 shared_items_federated_domains)
        if linksList and wantedList:
            linksList = wantedList + linksList

    newTabStr = ' target="_blank" rel="nofollow noopener noreferrer"'
    if linksList:
        htmlStr += '<nav>\n'
        for lineStr in linksList:
            if ' ' not in lineStr:
                if '#' not in lineStr:
                    if '*' not in lineStr:
                        if not lineStr.startswith('['):
                            if not lineStr.startswith('=> '):
                                continue
            lineStr = lineStr.strip()
            linkStr = None
            if not lineStr.startswith('['):
                words = lineStr.split(' ')
                # get the link
                for word in words:
                    if word == '#':
                        continue
                    if word == '*':
                        continue
                    if word == '=>':
                        continue
                    if '://' in word:
                        linkStr = word
                        break
            else:
                # markdown link
                if ']' not in lineStr:
                    continue
                if '(' not in lineStr:
                    continue
                if ')' not in lineStr:
                    continue
                linkStr = lineStr.split('(')[1]
                if ')' not in linkStr:
                    continue
                linkStr = linkStr.split(')')[0]
                if '://' not in linkStr:
                    continue
                lineStr = lineStr.split('[')[1]
                if ']' not in lineStr:
                    continue
                lineStr = lineStr.split(']')[0]
            if linkStr:
                lineStr = lineStr.replace(linkStr, '').strip()
                # avoid any dubious scripts being added
                if '<' not in lineStr:
                    # remove trailing comma if present
                    if lineStr.endswith(','):
                        lineStr = lineStr[:len(lineStr)-1]
                    # add link to the returned html
                    if '?showshare=' not in linkStr and \
                       '?showwarning=' not in linkStr:
                        htmlStr += \
                            '      <p><a href="' + linkStr + \
                            '"' + newTabStr + '>' + \
                            lineStr + '</a></p>\n'
                    else:
                        htmlStr += \
                            '      <p><a href="' + linkStr + \
                            '">' + lineStr + '</a></p>\n'
                    linksFileContainsEntries = True
                elif lineStr.startswith('=> '):
                    # gemini style link
                    lineStr = lineStr.replace('=> ', '')
                    lineStr = lineStr.replace(linkStr, '')
                    # add link to the returned html
                    if '?showshare=' not in linkStr and \
                       '?showwarning=' not in linkStr:
                        htmlStr += \
                            '      <p><a href="' + linkStr + \
                            '"' + newTabStr + '>' + \
                            lineStr.strip() + '</a></p>\n'
                    else:
                        htmlStr += \
                            '      <p><a href="' + linkStr + \
                            '">' + lineStr.strip() + '</a></p>\n'
                    linksFileContainsEntries = True
            else:
                if lineStr.startswith('#') or lineStr.startswith('*'):
                    lineStr = lineStr[1:].strip()
                    if firstSeparatorAdded:
                        htmlStr += separatorStr
                    firstSeparatorAdded = True
                    htmlStr += \
                        '      <h3 class="linksHeader">' + \
                        lineStr + '</h3>\n'
                else:
                    htmlStr += \
                        '      <p>' + lineStr + '</p>\n'
                linksFileContainsEntries = True
        htmlStr += '</nav>\n'

    if firstSeparatorAdded:
        htmlStr += separatorStr
    htmlStr += \
        '<p class="login-text"><a href="/users/' + nickname + \
        '/catalog.csv">' + translate['Shares Catalog'] + '</a></p>'
    htmlStr += \
        '<p class="login-text"><a href="/users/' + \
        nickname + '/accesskeys" accesskey="' + \
        accessKeys['menuKeys'] + '">' + \
        translate['Key Shortcuts'] + '</a></p>'
    htmlStr += \
        '<p class="login-text"><a href="/about">' + \
        translate['About this Instance'] + '</a></p>'
    htmlStr += \
        '<p class="login-text"><a href="/terms">' + \
        translate['Terms of Service'] + '</a></p>'

    if linksFileContainsEntries and not rss_icon_at_top:
        htmlStr += '<br><div class="columnIcons">' + rssIconStr + '</div>'

    return htmlStr


def htmlLinksMobile(cssCache: {}, base_dir: str,
                    nickname: str, domain_full: str,
                    http_prefix: str, translate,
                    timelinePath: str, authorized: bool,
                    rss_icon_at_top: bool,
                    icons_as_buttons: bool,
                    defaultTimeline: str,
                    theme: str, accessKeys: {},
                    shared_items_federated_domains: []) -> str:
    """Show the left column links within mobile view
    """
    htmlStr = ''

    # the css filename
    cssFilename = base_dir + '/epicyon-profile.css'
    if os.path.isfile(base_dir + '/epicyon.css'):
        cssFilename = base_dir + '/epicyon.css'

    # is the user a site editor?
    if nickname == 'news':
        editor = False
        artist = False
    else:
        editor = is_editor(base_dir, nickname)
        artist = isArtist(base_dir, nickname)

    domain = removeDomainPort(domain_full)

    instanceTitle = \
        get_config_param(base_dir, 'instanceTitle')
    htmlStr = htmlHeaderWithExternalStyle(cssFilename, instanceTitle, None)
    bannerFile, bannerFilename = \
        getBannerFile(base_dir, nickname, domain, theme)
    htmlStr += \
        '<a href="/users/' + nickname + '/' + defaultTimeline + '" ' + \
        'accesskey="' + accessKeys['menuTimeline'] + '">' + \
        '<img loading="lazy" class="timeline-banner" ' + \
        'alt="' + translate['Switch to timeline view'] + '" ' + \
        'src="/users/' + nickname + '/' + bannerFile + '" /></a>\n'

    htmlStr += '<div class="col-left-mobile">\n'
    htmlStr += '<center>' + \
        headerButtonsFrontScreen(translate, nickname,
                                 'links', authorized,
                                 icons_as_buttons) + '</center>'
    htmlStr += \
        getLeftColumnContent(base_dir, nickname, domain_full,
                             http_prefix, translate,
                             editor, artist,
                             False, timelinePath,
                             rss_icon_at_top, False, False,
                             theme, accessKeys,
                             shared_items_federated_domains)
    if editor and not _linksExist(base_dir):
        htmlStr += '<br><br><br>\n<center>\n  '
        htmlStr += translate['Select the edit icon to add web links']
        htmlStr += '\n</center>\n'

    # end of col-left-mobile
    htmlStr += '</div>\n'

    htmlStr += '</div>\n' + htmlFooter()
    return htmlStr


def htmlEditLinks(cssCache: {}, translate: {}, base_dir: str, path: str,
                  domain: str, port: int, http_prefix: str,
                  defaultTimeline: str, theme: str,
                  accessKeys: {}) -> str:
    """Shows the edit links screen
    """
    if '/users/' not in path:
        return ''
    path = path.replace('/inbox', '').replace('/outbox', '')
    path = path.replace('/shares', '').replace('/wanted', '')

    nickname = getNicknameFromActor(path)
    if not nickname:
        return ''

    # is the user a moderator?
    if not is_editor(base_dir, nickname):
        return ''

    cssFilename = base_dir + '/epicyon-links.css'
    if os.path.isfile(base_dir + '/links.css'):
        cssFilename = base_dir + '/links.css'

    # filename of the banner shown at the top
    bannerFile, bannerFilename = \
        getBannerFile(base_dir, nickname, domain, theme)

    instanceTitle = \
        get_config_param(base_dir, 'instanceTitle')
    editLinksForm = \
        htmlHeaderWithExternalStyle(cssFilename, instanceTitle, None)

    # top banner
    editLinksForm += \
        '<header>\n' + \
        '<a href="/users/' + nickname + '/' + defaultTimeline + '" title="' + \
        translate['Switch to timeline view'] + '" alt="' + \
        translate['Switch to timeline view'] + '" ' + \
        'accesskey="' + accessKeys['menuTimeline'] + '">\n'
    editLinksForm += \
        '<img loading="lazy" class="timeline-banner" ' + \
        'alt = "" src="' + \
        '/users/' + nickname + '/' + bannerFile + '" /></a>\n' + \
        '</header>\n'

    editLinksForm += \
        '<form enctype="multipart/form-data" method="POST" ' + \
        'accept-charset="UTF-8" action="' + path + '/linksdata">\n'
    editLinksForm += \
        '  <div class="vertical-center">\n'
    editLinksForm += \
        '    <div class="containerSubmitNewPost">\n'
    editLinksForm += \
        '      <h1>' + translate['Edit Links'] + '</h1>'
    editLinksForm += \
        '      <input type="submit" name="submitLinks" value="' + \
        translate['Submit'] + '" ' + \
        'accesskey="' + accessKeys['submitButton'] + '">\n'
    editLinksForm += \
        '    </div>\n'

    linksFilename = base_dir + '/accounts/links.txt'
    linksStr = ''
    if os.path.isfile(linksFilename):
        with open(linksFilename, 'r') as fp:
            linksStr = fp.read()

    editLinksForm += \
        '<div class="container">'
    editLinksForm += \
        '  ' + \
        translate['One link per line. Description followed by the link.'] + \
        '<br>'
    newColLinkStr = translate['New link title and URL']
    editLinksForm += editTextField(None, 'newColLink', '', newColLinkStr)
    editLinksForm += \
        '  <textarea id="message" name="editedLinks" ' + \
        'style="height:80vh" spellcheck="false">' + linksStr + '</textarea>'
    editLinksForm += \
        '</div>'

    # the admin can edit terms of service and about text
    adminNickname = get_config_param(base_dir, 'admin')
    if adminNickname:
        if nickname == adminNickname:
            aboutFilename = base_dir + '/accounts/about.md'
            aboutStr = ''
            if os.path.isfile(aboutFilename):
                with open(aboutFilename, 'r') as fp:
                    aboutStr = fp.read()

            editLinksForm += \
                '<div class="container">'
            editLinksForm += \
                '  ' + \
                translate['About this Instance'] + \
                '<br>'
            editLinksForm += \
                '  <textarea id="message" name="editedAbout" ' + \
                'style="height:100vh" spellcheck="true" autocomplete="on">' + \
                aboutStr + '</textarea>'
            editLinksForm += \
                '</div>'

            TOSFilename = base_dir + '/accounts/tos.md'
            TOSStr = ''
            if os.path.isfile(TOSFilename):
                with open(TOSFilename, 'r') as fp:
                    TOSStr = fp.read()

            editLinksForm += \
                '<div class="container">'
            editLinksForm += \
                '  ' + \
                translate['Terms of Service'] + \
                '<br>'
            editLinksForm += \
                '  <textarea id="message" name="editedTOS" ' + \
                'style="height:100vh" spellcheck="true" autocomplete="on">' + \
                TOSStr + '</textarea>'
            editLinksForm += \
                '</div>'

    editLinksForm += htmlFooter()
    return editLinksForm