From ced5acc8f6031906c900540b2f3ec57efe011750 Mon Sep 17 00:00:00 2001
From: Bob Mottram <bob@freedombone.net>
Date: Tue, 4 Jan 2022 10:33:30 +0000
Subject: [PATCH] Snake case

---
 webapp_person_options.py | 371 ++++++++++++++++++++-------------------
 1 file changed, 186 insertions(+), 185 deletions(-)

diff --git a/webapp_person_options.py b/webapp_person_options.py
index 2dd005a90..dde38c44b 100644
--- a/webapp_person_options.py
+++ b/webapp_person_options.py
@@ -34,13 +34,13 @@ from webapp_utils import html_keyboard_navigation
 def html_person_options(default_timeline: str,
                         css_cache: {}, translate: {}, base_dir: str,
                         domain: str, domain_full: str,
-                        originPathStr: str,
-                        optionsActor: str,
-                        optionsProfileUrl: str,
-                        optionsLink: str,
-                        pageNumber: int,
+                        origin_path_str: str,
+                        options_actor: str,
+                        options_profile_url: str,
+                        options_link: str,
+                        page_number: int,
                         donate_url: str,
-                        webAddress: str,
+                        web_address: str,
                         xmpp_address: str,
                         matrix_address: str,
                         ssb_address: str,
@@ -54,19 +54,19 @@ def html_person_options(default_timeline: str,
                         pgp_fingerprint: str,
                         email_address: str,
                         dormant_months: int,
-                        backToPath: str,
-                        lockedAccount: bool,
-                        movedTo: str,
-                        alsoKnownAs: [],
+                        back_to_path: str,
+                        locked_account: bool,
+                        moved_to: str,
+                        also_known_as: [],
                         text_mode_banner: str,
                         news_instance: bool,
                         authorized: bool,
                         access_keys: {},
-                        isGroup: bool) -> str:
+                        is_group: bool) -> str:
     """Show options for a person: view/follow/block/report
     """
-    optionsDomain, optionsPort = get_domain_from_actor(optionsActor)
-    optionsDomainFull = get_full_domain(optionsDomain, optionsPort)
+    options_domain, options_port = get_domain_from_actor(options_actor)
+    options_domain_full = get_full_domain(options_domain, options_port)
 
     if os.path.isfile(base_dir + '/accounts/options-background-custom.jpg'):
         if not os.path.isfile(base_dir + '/accounts/options-background.jpg'):
@@ -74,184 +74,184 @@ def html_person_options(default_timeline: str,
                      base_dir + '/accounts/options-background.jpg')
 
     dormant = False
-    followStr = 'Follow'
-    if isGroup:
-        followStr = 'Join'
-    blockStr = 'Block'
+    follow_str = 'Follow'
+    if is_group:
+        follow_str = 'Join'
+    block_str = 'Block'
     nickname = None
-    optionsNickname = None
-    followsYou = False
-    if originPathStr.startswith('/users/'):
-        nickname = originPathStr.split('/users/')[1]
+    options_nickname = None
+    follows_you = False
+    if origin_path_str.startswith('/users/'):
+        nickname = origin_path_str.split('/users/')[1]
         if '/' in nickname:
             nickname = nickname.split('/')[0]
         if '?' in nickname:
             nickname = nickname.split('?')[0]
-        followerDomain, followerPort = get_domain_from_actor(optionsActor)
-        if is_following_actor(base_dir, nickname, domain, optionsActor):
-            followStr = 'Unfollow'
-            if isGroup:
-                followStr = 'Leave'
+#        follower_domain, follower_port = get_domain_from_actor(options_actor)
+        if is_following_actor(base_dir, nickname, domain, options_actor):
+            follow_str = 'Unfollow'
+            if is_group:
+                follow_str = 'Leave'
             dormant = \
-                is_dormant(base_dir, nickname, domain, optionsActor,
+                is_dormant(base_dir, nickname, domain, options_actor,
                            dormant_months)
 
-        optionsNickname = get_nickname_from_actor(optionsActor)
-        optionsDomainFull = get_full_domain(optionsDomain, optionsPort)
-        followsYou = \
+        options_nickname = get_nickname_from_actor(options_actor)
+        options_domain_full = get_full_domain(options_domain, options_port)
+        follows_you = \
             is_follower_of_person(base_dir,
                                   nickname, domain,
-                                  optionsNickname, optionsDomainFull)
+                                  options_nickname, options_domain_full)
         if is_blocked(base_dir, nickname, domain,
-                      optionsNickname, optionsDomainFull):
-            blockStr = 'Block'
+                      options_nickname, options_domain_full):
+            block_str = 'Block'
 
-    optionsLinkStr = ''
-    if optionsLink:
-        optionsLinkStr = \
+    options_link_str = ''
+    if options_link:
+        options_link_str = \
             '    <input type="hidden" name="postUrl" value="' + \
-            optionsLink + '">\n'
+            options_link + '">\n'
     css_filename = base_dir + '/epicyon-options.css'
     if os.path.isfile(base_dir + '/options.css'):
         css_filename = base_dir + '/options.css'
 
     # To snooze, or not to snooze? That is the question
-    snoozeButtonStr = 'Snooze'
+    snooze_button_str = 'Snooze'
     if nickname:
-        if is_person_snoozed(base_dir, nickname, domain, optionsActor):
-            snoozeButtonStr = 'Unsnooze'
+        if is_person_snoozed(base_dir, nickname, domain, options_actor):
+            snooze_button_str = 'Unsnooze'
 
-    donateStr = ''
+    donate_str = ''
     if donate_url:
-        donateStr = \
+        donate_str = \
             '    <a href="' + donate_url + \
             ' tabindex="-1""><button class="button" name="submitDonate">' + \
             translate['Donate'] + '</button></a>\n'
 
-    instanceTitle = \
+    instance_title = \
         get_config_param(base_dir, 'instanceTitle')
-    optionsStr = \
-        html_header_with_external_style(css_filename, instanceTitle, None)
-    optionsStr += html_keyboard_navigation(text_mode_banner, {}, {})
-    optionsStr += '<br><br>\n'
-    optionsStr += '<div class="options">\n'
-    optionsStr += '  <div class="optionsAvatar">\n'
-    optionsStr += '  <center>\n'
-    optionsStr += '  <a href="' + optionsActor + '">\n'
-    optionsStr += '  <img loading="lazy" src="' + optionsProfileUrl + \
+    options_str = \
+        html_header_with_external_style(css_filename, instance_title, None)
+    options_str += html_keyboard_navigation(text_mode_banner, {}, {})
+    options_str += '<br><br>\n'
+    options_str += '<div class="options">\n'
+    options_str += '  <div class="optionsAvatar">\n'
+    options_str += '  <center>\n'
+    options_str += '  <a href="' + options_actor + '">\n'
+    options_str += '  <img loading="lazy" src="' + options_profile_url + \
         '" alt="" ' + get_broken_link_substitute() + '/></a>\n'
-    handle = get_nickname_from_actor(optionsActor) + '@' + optionsDomain
-    handleShown = handle
-    if lockedAccount:
-        handleShown += '🔒'
-    if movedTo:
-        handleShown += ' ⌂'
+    handle = get_nickname_from_actor(options_actor) + '@' + options_domain
+    handle_shown = handle
+    if locked_account:
+        handle_shown += '🔒'
+    if moved_to:
+        handle_shown += ' ⌂'
     if dormant:
-        handleShown += ' 💤'
-    optionsStr += \
+        handle_shown += ' 💤'
+    options_str += \
         '  <p class="optionsText">' + translate['Options for'] + \
-        ' @' + handleShown + '</p>\n'
-    if followsYou:
-        optionsStr += \
+        ' @' + handle_shown + '</p>\n'
+    if follows_you:
+        options_str += \
             '  <p class="optionsText">' + translate['Follows you'] + '</p>\n'
-    if movedTo:
-        newNickname = get_nickname_from_actor(movedTo)
-        newDomain, newPort = get_domain_from_actor(movedTo)
-        if newNickname and newDomain:
-            newHandle = newNickname + '@' + newDomain
-            optionsStr += \
+    if moved_to:
+        new_nickname = get_nickname_from_actor(moved_to)
+        new_domain, _ = get_domain_from_actor(moved_to)
+        if new_nickname and new_domain:
+            new_handle = new_nickname + '@' + new_domain
+            options_str += \
                 '  <p class="optionsText">' + \
                 translate['New account'] + \
-                ': <a href="' + movedTo + '">@' + newHandle + '</a></p>\n'
-    elif alsoKnownAs:
-        otherAccountsHtml = \
+                ': <a href="' + moved_to + '">@' + new_handle + '</a></p>\n'
+    elif also_known_as:
+        other_accounts_html = \
             '  <p class="optionsText">' + \
             translate['Other accounts'] + ': '
 
         ctr = 0
-        if isinstance(alsoKnownAs, list):
-            for altActor in alsoKnownAs:
-                if altActor == optionsActor:
+        if isinstance(also_known_as, list):
+            for alt_actor in also_known_as:
+                if alt_actor == options_actor:
                     continue
                 if ctr > 0:
-                    otherAccountsHtml += ' '
+                    other_accounts_html += ' '
                 ctr += 1
-                altDomain, altPort = get_domain_from_actor(altActor)
-                otherAccountsHtml += \
-                    '<a href="' + altActor + '">' + altDomain + '</a>'
-        elif isinstance(alsoKnownAs, str):
-            if alsoKnownAs != optionsActor:
+                alt_domain, _ = get_domain_from_actor(alt_actor)
+                other_accounts_html += \
+                    '<a href="' + alt_actor + '">' + alt_domain + '</a>'
+        elif isinstance(also_known_as, str):
+            if also_known_as != options_actor:
                 ctr += 1
-                altDomain, altPort = get_domain_from_actor(alsoKnownAs)
-                otherAccountsHtml += \
-                    '<a href="' + alsoKnownAs + '">' + altDomain + '</a>'
-        otherAccountsHtml += '</p>\n'
+                alt_domain, _ = get_domain_from_actor(also_known_as)
+                other_accounts_html += \
+                    '<a href="' + also_known_as + '">' + alt_domain + '</a>'
+        other_accounts_html += '</p>\n'
         if ctr > 0:
-            optionsStr += otherAccountsHtml
+            options_str += other_accounts_html
     if email_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">' + translate['Email'] + \
             ': <a href="mailto:' + \
             email_address + '">' + remove_html(email_address) + '</a></p>\n'
     if xmpp_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">' + translate['XMPP'] + \
             ': <a href="xmpp:' + remove_html(xmpp_address) + '">' + \
             xmpp_address + '</a></p>\n'
     if matrix_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">' + translate['Matrix'] + ': ' + \
             remove_html(matrix_address) + '</p>\n'
     if ssb_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">SSB: ' + remove_html(ssb_address) + '</p>\n'
     if blog_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">Blog: <a href="' + \
             remove_html(blog_address) + '">' + \
             remove_html(blog_address) + '</a></p>\n'
     if tox_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">Tox: ' + remove_html(tox_address) + '</p>\n'
     if briar_address:
         if briar_address.startswith('briar://'):
-            optionsStr += \
+            options_str += \
                 '<p class="imText">' + \
                 remove_html(briar_address) + '</p>\n'
         else:
-            optionsStr += \
+            options_str += \
                 '<p class="imText">briar://' + \
                 remove_html(briar_address) + '</p>\n'
     if jami_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">Jami: ' + remove_html(jami_address) + '</p>\n'
     if cwtch_address:
-        optionsStr += \
+        options_str += \
             '<p class="imText">Cwtch: ' + remove_html(cwtch_address) + '</p>\n'
     if enigma_pub_key:
-        optionsStr += \
+        options_str += \
             '<p class="imText">Enigma: ' + \
             remove_html(enigma_pub_key) + '</p>\n'
     if pgp_fingerprint:
-        optionsStr += '<p class="pgp">PGP: ' + \
+        options_str += '<p class="pgp">PGP: ' + \
             remove_html(pgp_fingerprint).replace('\n', '<br>') + '</p>\n'
     if pgp_pub_key:
-        optionsStr += '<p class="pgp">' + \
+        options_str += '<p class="pgp">' + \
             remove_html(pgp_pub_key).replace('\n', '<br>') + '</p>\n'
-    optionsStr += '  <form method="POST" action="' + \
-        originPathStr + '/personoptions">\n'
-    optionsStr += '    <input type="hidden" name="pageNumber" value="' + \
-        str(pageNumber) + '">\n'
-    optionsStr += '    <input type="hidden" name="actor" value="' + \
-        optionsActor + '">\n'
-    optionsStr += '    <input type="hidden" name="avatarUrl" value="' + \
-        optionsProfileUrl + '">\n'
+    options_str += '  <form method="POST" action="' + \
+        origin_path_str + '/personoptions">\n'
+    options_str += '    <input type="hidden" name="pageNumber" value="' + \
+        str(page_number) + '">\n'
+    options_str += '    <input type="hidden" name="actor" value="' + \
+        options_actor + '">\n'
+    options_str += '    <input type="hidden" name="avatarUrl" value="' + \
+        options_profile_url + '">\n'
     if authorized:
-        if originPathStr == '/users/' + nickname:
-            if optionsNickname:
-                # handle = optionsNickname + '@' + optionsDomainFull
+        if origin_path_str == '/users/' + nickname:
+            if options_nickname:
+                # handle = options_nickname + '@' + options_domain_full
                 petname = get_pet_name(base_dir, nickname, domain, handle)
-                optionsStr += \
+                options_str += \
                     '    ' + translate['Petname'] + ': \n' + \
                     '    <input type="text" name="optionpetname" value="' + \
                     petname + '" ' + \
@@ -261,8 +261,8 @@ def html_person_options(default_timeline: str,
                     translate['Submit'] + '</button><br>\n'
 
             # Notify when a post arrives from this person
-            if is_following_actor(base_dir, nickname, domain, optionsActor):
-                checkboxStr = \
+            if is_following_actor(base_dir, nickname, domain, options_actor):
+                checkbox_str = \
                     '    <input type="checkbox" class="profilecheckbox" ' + \
                     'name="notifyOnPost" checked> 🔔' + \
                     translate['Notify me when this account posts'] + \
@@ -270,12 +270,12 @@ def html_person_options(default_timeline: str,
                     'name="submitNotifyOnPost">' + \
                     translate['Submit'] + '</button><br>\n'
                 if not notify_when_person_posts(base_dir, nickname, domain,
-                                                optionsNickname,
-                                                optionsDomainFull):
-                    checkboxStr = checkboxStr.replace(' checked>', '>')
-                optionsStr += checkboxStr
+                                                options_nickname,
+                                                options_domain_full):
+                    checkbox_str = checkbox_str.replace(' checked>', '>')
+                options_str += checkbox_str
 
-                checkboxStr = \
+                checkbox_str = \
                     '    <input type="checkbox" ' + \
                     'class="profilecheckbox" name="onCalendar" checked> ' + \
                     translate['Receive calendar events from this account'] + \
@@ -283,22 +283,23 @@ def html_person_options(default_timeline: str,
                     'name="submitOnCalendar">' + \
                     translate['Submit'] + '</button><br>\n'
                 if not receiving_calendar_events(base_dir, nickname, domain,
-                                                 optionsNickname,
-                                                 optionsDomainFull):
-                    checkboxStr = checkboxStr.replace(' checked>', '>')
-                optionsStr += checkboxStr
+                                                 options_nickname,
+                                                 options_domain_full):
+                    checkbox_str = checkbox_str.replace(' checked>', '>')
+                options_str += checkbox_str
 
             # checkbox for permission to post to newswire
-            newswirePostsPermitted = False
-            if optionsDomainFull == domain_full:
+            newswire_posts_permitted = False
+            if options_domain_full == domain_full:
                 admin_nickname = get_config_param(base_dir, 'admin')
                 if (nickname == admin_nickname or
                     (is_moderator(base_dir, nickname) and
-                     not is_moderator(base_dir, optionsNickname))):
-                    newswireBlockedFilename = \
+                     not is_moderator(base_dir, options_nickname))):
+                    newswire_blocked_filename = \
                         base_dir + '/accounts/' + \
-                        optionsNickname + '@' + optionsDomain + '/.nonewswire'
-                    checkboxStr = \
+                        options_nickname + '@' + options_domain + \
+                        '/.nonewswire'
+                    checkbox_str = \
                         '    <input type="checkbox" ' + \
                         'class="profilecheckbox" ' + \
                         'name="postsToNews" checked> ' + \
@@ -306,37 +307,37 @@ def html_person_options(default_timeline: str,
                         '\n    <button type="submit" class="buttonsmall" ' + \
                         'name="submitPostToNews">' + \
                         translate['Submit'] + '</button><br>\n'
-                    if os.path.isfile(newswireBlockedFilename):
-                        checkboxStr = checkboxStr.replace(' checked>', '>')
+                    if os.path.isfile(newswire_blocked_filename):
+                        checkbox_str = checkbox_str.replace(' checked>', '>')
                     else:
-                        newswirePostsPermitted = True
-                    optionsStr += checkboxStr
+                        newswire_posts_permitted = True
+                    options_str += checkbox_str
 
             # whether blogs created by this account are moderated on
             # the newswire
-            if newswirePostsPermitted:
-                moderatedFilename = \
+            if newswire_posts_permitted:
+                moderated_filename = \
                     base_dir + '/accounts/' + \
-                    optionsNickname + '@' + \
-                    optionsDomain + '/.newswiremoderated'
-                checkboxStr = \
+                    options_nickname + '@' + \
+                    options_domain + '/.newswiremoderated'
+                checkbox_str = \
                     '    <input type="checkbox" ' + \
                     'class="profilecheckbox" name="modNewsPosts" checked> ' + \
                     translate['News posts are moderated'] + \
                     '\n    <button type="submit" class="buttonsmall" ' + \
                     'name="submitModNewsPosts">' + \
                     translate['Submit'] + '</button><br>\n'
-                if not os.path.isfile(moderatedFilename):
-                    checkboxStr = checkboxStr.replace(' checked>', '>')
-                optionsStr += checkboxStr
+                if not os.path.isfile(moderated_filename):
+                    checkbox_str = checkbox_str.replace(' checked>', '>')
+                options_str += checkbox_str
 
             # checkbox for permission to post to featured articles
-            if news_instance and optionsDomainFull == domain_full:
+            if news_instance and options_domain_full == domain_full:
                 admin_nickname = get_config_param(base_dir, 'admin')
                 if (nickname == admin_nickname or
                     (is_moderator(base_dir, nickname) and
-                     not is_moderator(base_dir, optionsNickname))):
-                    checkboxStr = \
+                     not is_moderator(base_dir, options_nickname))):
+                    checkbox_str = \
                         '    <input type="checkbox" ' + \
                         'class="profilecheckbox" ' + \
                         'name="postsToFeatures" checked> ' + \
@@ -344,92 +345,92 @@ def html_person_options(default_timeline: str,
                         '\n    <button type="submit" class="buttonsmall" ' + \
                         'name="submitPostToFeatures">' + \
                         translate['Submit'] + '</button><br>\n'
-                    if not is_featured_writer(base_dir, optionsNickname,
-                                              optionsDomain):
-                        checkboxStr = checkboxStr.replace(' checked>', '>')
-                    optionsStr += checkboxStr
+                    if not is_featured_writer(base_dir, options_nickname,
+                                              options_domain):
+                        checkbox_str = checkbox_str.replace(' checked>', '>')
+                    options_str += checkbox_str
 
-    optionsStr += optionsLinkStr
-    backPath = '/'
+    options_str += options_link_str
+    back_path = '/'
     if nickname:
-        backPath = '/users/' + nickname + '/' + default_timeline
-        if 'moderation' in backToPath:
-            backPath = '/users/' + nickname + '/moderation'
-    if authorized and originPathStr == '/users/' + nickname:
-        optionsStr += \
-            '    <a href="' + backPath + '"><button type="button" ' + \
+        back_path = '/users/' + nickname + '/' + default_timeline
+        if 'moderation' in back_to_path:
+            back_path = '/users/' + nickname + '/moderation'
+    if authorized and origin_path_str == '/users/' + nickname:
+        options_str += \
+            '    <a href="' + back_path + '"><button type="button" ' + \
             'class="buttonIcon" name="submitBack" ' + \
             'accesskey="' + access_keys['menuTimeline'] + '">' + \
             translate['Go Back'] + '</button></a>\n'
     else:
-        optionsStr += \
-            '    <a href="' + originPathStr + '"><button type="button" ' + \
+        options_str += \
+            '    <a href="' + origin_path_str + '"><button type="button" ' + \
             'class="buttonIcon" name="submitBack" accesskey="' + \
             access_keys['menuTimeline'] + '">' + translate['Go Back'] + \
             '</button></a>\n'
     if authorized:
-        optionsStr += \
+        options_str += \
             '    <button type="submit" class="button" ' + \
             'name="submitView" accesskey="' + \
             access_keys['viewButton'] + '">' + \
             translate['View'] + '</button>\n'
-    optionsStr += donateStr
+    options_str += donate_str
     if authorized:
-        optionsStr += \
+        options_str += \
             '    <button type="submit" class="button" name="submit' + \
-            followStr + \
+            follow_str + \
             '" accesskey="' + access_keys['followButton'] + '">' + \
-            translate[followStr] + '</button>\n'
-        optionsStr += \
+            translate[follow_str] + '</button>\n'
+        options_str += \
             '    <button type="submit" class="button" name="submit' + \
-            blockStr + '" accesskey="' + access_keys['blockButton'] + '">' + \
-            translate[blockStr] + '</button>\n'
-        optionsStr += \
+            block_str + '" accesskey="' + access_keys['blockButton'] + '">' + \
+            translate[block_str] + '</button>\n'
+        options_str += \
             '    <button type="submit" class="button" name="submitDM" ' + \
             'accesskey="' + access_keys['menuDM'] + '">' + \
             translate['DM'] + '</button>\n'
-        optionsStr += \
+        options_str += \
             '    <button type="submit" class="button" name="submit' + \
-            snoozeButtonStr + '" accesskey="' + \
-            access_keys['snoozeButton'] + '">' + translate[snoozeButtonStr] + \
-            '</button>\n'
-        optionsStr += \
+            snooze_button_str + '" accesskey="' + \
+            access_keys['snoozeButton'] + '">' + \
+            translate[snooze_button_str] + '</button>\n'
+        options_str += \
             '    <button type="submit" class="button" ' + \
             'name="submitReport" accesskey="' + \
             access_keys['reportButton'] + '">' + \
             translate['Report'] + '</button>\n'
 
         if is_moderator(base_dir, nickname):
-            optionsStr += \
+            options_str += \
                 '    <button type="submit" class="button" ' + \
                 'name="submitPersonInfo" accesskey="' + \
                 access_keys['infoButton'] + '">' + \
                 translate['Info'] + '</button>\n'
 
-        personNotes = ''
-        if originPathStr == '/users/' + nickname:
-            personNotesFilename = \
+        person_notes = ''
+        if origin_path_str == '/users/' + nickname:
+            person_notes_filename = \
                 acct_dir(base_dir, nickname, domain) + \
                 '/notes/' + handle + '.txt'
-            if os.path.isfile(personNotesFilename):
-                with open(personNotesFilename, 'r') as fp:
-                    personNotes = fp.read()
+            if os.path.isfile(person_notes_filename):
+                with open(person_notes_filename, 'r') as fp_notes:
+                    person_notes = fp_notes.read()
 
-        optionsStr += \
+        options_str += \
             '    <br><br>' + translate['Notes'] + ': \n'
-        optionsStr += '    <button type="submit" class="buttonsmall" ' + \
+        options_str += '    <button type="submit" class="buttonsmall" ' + \
             'name="submitPersonNotes">' + \
             translate['Submit'] + '</button><br>\n'
-        optionsStr += \
+        options_str += \
             '    <textarea id="message" ' + \
             'name="optionnotes" style="height:400px" spellcheck="true" ' + \
             'accesskey="' + access_keys['enterNotes'] + '">' + \
-            personNotes + '</textarea>\n'
+            person_notes + '</textarea>\n'
 
-    optionsStr += \
+    options_str += \
         '  </form>\n' + \
         '</center>\n' + \
         '</div>\n' + \
         '</div>\n'
-    optionsStr += html_footer()
-    return optionsStr
+    options_str += html_footer()
+    return options_str