Switch profile.py over to using Pager class, and cleaned up the code

Author: linuxdaemon

plugins/profile.py

@@ -1,6 +1,6 @@
+import random
 import re
 import string
-import random
 from collections import defaultdict
 
 from sqlalchemy import Column
@@ -10,13 +10,13 @@
 
 from cloudbot import hook
 from cloudbot.util import database
+from cloudbot.util.pager import paginated_list
 
 category_re = r"[A-Za-z0-9]+"
 data_re = re.compile(r"({})\s(.+)".format(category_re))
 
 # borrowed pagination code from grab.py
 cat_pages = defaultdict(dict)
-cat_page_index = defaultdict(dict)
 confirm_keys = defaultdict(dict)
 
 table = Table(
@@ -36,8 +36,7 @@ def load_cache(db):
     """
     :type db: sqlalchemy.orm.Session
     """
-    global profile_cache
-    profile_cache = {}
+    profile_cache.clear()
     for row in db.execute(table.select().order_by(table.c.category)):
         nick = row["nick"].lower()
         cat = row["category"]
@@ -46,29 +45,6 @@ def load_cache(db):
         profile_cache.setdefault(chan, {}).setdefault(nick, {})[cat] = text
 
 
-# modified from grab.py
-def two_lines(bigstring, chan, nick):
-    """Receives a string with new lines. Groups the string into a list of strings with up to 3 new lines per string element. Returns first string element then stores the remaining list in search_pages."""
-    global cat_pages
-    global cat_page_index
-    if nick not in cat_pages[chan]:
-        cat_pages[chan][nick] = []
-    temp = bigstring.split('\n')
-    for i in range(0, len(temp), 2):
-        cat_pages[chan][nick].append('\n'.join(temp[i:i + 2]))
-    cat_page_index[chan][nick] = 0
-    return cat_pages[chan][nick][0]
-
-
-# modified from grab.py
-def smart_truncate(content, length=355, suffix='...\n'):
-    if len(content) <= length:
-        return content
-    else:
-        return content[:length].rsplit(', ', 1)[0] + suffix + \
-               content[:length].rsplit(', ', 1)[1] + smart_truncate(content[length:])
-
-
 def format_profile(nick, category, text):
     # Add zwsp to avoid pinging users
     nick = "{}{}{}".format(nick[0], "\u200B", nick[1:])
@@ -80,114 +56,106 @@ def format_profile(nick, category, text):
 @hook.command("moreprofile", autohelp=False)
 def moreprofile(text, chan, nick, notice):
     """If a category search has lots of results the results are paginated. If the most recent search is paginated the pages are stored for retrieval. If no argument is given the next page will be returned else a page number can be specified."""
-    if nick.lower() not in cat_pages[chan.lower()] or not cat_pages[chan.lower()][nick.lower()]:
+    chan_pages = cat_pages[chan.casefold()]
+    pages = chan_pages.get(nick.casefold())
+    if not pages:
         notice("There are no category pages to show.")
         return
 
     if text:
-        index = ""
-        if text.isnumeric():
+        try:
             index = int(text)
-        else:
+        except ValueError:
             notice("Please specify a positive integer value")
             return
 
-        if index > len(cat_pages[chan.lower()][nick.lower()]) or index == 0:
-            notice("Please specify a valid page number between 1 and {}.".format(len(cat_pages[chan.lower()][nick.lower()])))
+        page = pages[index - 1]
+        if page is None:
+            notice("Please specify a valid page number between 1 and {}.".format(len(pages)))
             return
         else:
-            msg = "{}(page {}/{})".format(cat_pages[chan.lower()][nick.lower()][index - 1], index, len(cat_pages[chan.lower()][nick.lower()]))
-            for line in msg.splitlines():
+            for line in page:
                 notice(line)
-            return
     else:
-        cat_page_index[chan.lower()][nick.lower()] += 1
-        if cat_page_index[chan.lower()][nick.lower()] < len(cat_pages[chan.lower()][nick.lower()]):
-            msg = "{}(page {}/{})".format(cat_pages[chan.lower()][nick.lower()][cat_page_index[chan.lower()][nick.lower()]],
-                                          cat_page_index[chan.lower()][nick.lower()] + 1,
-                                          len(cat_pages[chan.lower()][nick.lower()]))
-            for line in msg.splitlines():
+        page = pages.next()
+        if page is not None:
+            for line in page:
                 notice(line)
-            return
         else:
             notice("All pages have been shown. You can specify a page number or start a new search")
-            return
 
 
 @hook.command()
 def profile(text, chan, notice, nick):
     """<nick> [category] Returns a user's saved profile data from \"<category>\", or lists all available profile categories for the user if no category specified"""
-    global cat_pages
-    global cat_page_index
+    chan_cf = chan.casefold()
+    nick_cf = nick.casefold()
 
     # Check if we are in a PM with the user
-    if nick.lower() == chan.lower():
+    if nick_cf == chan_cf:
         return "Profile data not available outside of channels"
 
+    chan_profiles = profile_cache.get(chan_cf, {})
+
     # Split the text in to the nick and requested category
     unpck = text.split(None, 1)
+    pnick = unpck.pop(0)
+    pnick_cf = pnick.casefold()
+    user_profile = chan_profiles.get(pnick_cf, {})
+    if not user_profile:
+        notice("User {} has no profile data saved in this channel".format(pnick))
+        return
 
     # Check if the caller specified a profile category, if not, send a NOTICE with the users registered categories
-    if len(unpck) < 2:
-        cats = []
-        cat_pages[chan.lower()][nick.lower()] = []
-        cat_page_index[chan.lower()][nick.lower()] = 0
-        pnick = unpck[0]
-        if len(profile_cache.get(chan.lower(), {}).get(pnick.lower(), {})) == 0:
-            notice("User {} has no profile data saved in this channel".format(pnick))
-            return
+    if not unpck:
+        cats = list(user_profile.keys())
 
-        for e in profile_cache.get(chan.lower(), {}).get(pnick.lower(), {}):
-            cats.append(e)
-
-        out = "Categories: "
-        for cat in cats:
-            out += "{}, ".format(cat)
-        out = smart_truncate(out)
-        out = out[:-2]
-        out = two_lines(out, chan, nick)
-        if len(cat_pages[chan].get(nick, [])) > 1:
-            msg = "{}(page {}/{}) .moreprofile".format(out, cat_page_index[chan.lower()][nick.lower()] + 1,
-                                                       len(cat_pages[chan.lower()][nick.lower()]))
-            for line in msg.splitlines():
-                notice(line)
-            return
+        pager = paginated_list(cats, ', ')
+        cat_pages[chan_cf][nick_cf] = pager
+        page = pager.next()
+        page[0] = "Categories: {}".format(page[0])
+        if len(page) > 1:
+            page[-1] += " .moreprofile"
 
-        for line in out.splitlines():
+        for line in page:
             notice(line)
-        return
-
-    pnick, category = unpck
-    if category.lower() not in profile_cache.get(chan.lower(), {}).get(pnick.lower(), {}):
-        notice("User {} has no profile data for category {} in this channel".format(pnick, category))
 
     else:
-        content = profile_cache[chan.lower()][pnick.lower()][category.lower()]
-        return format_profile(pnick, category, content)
+        category = unpck.pop(0)
+        cat_cf = category.casefold()
+        if cat_cf not in user_profile:
+            notice("User {} has no profile data for category {} in this channel".format(pnick, category))
+
+        else:
+            content = user_profile[cat_cf]
+            return format_profile(pnick, category, content)
 
 
 @hook.command()
 def profileadd(text, chan, nick, notice, db):
     """<category> <content> Adds data to your profile in the current channel under \"<category>\""""
-    if nick.lower() == chan.lower():
+    if nick.casefold() == chan.casefold():
         return "Profile data can not be set outside of channels"
 
     match = data_re.match(text)
 
     if not match:
         notice("Invalid data")
     else:
+        chan_profiles = profile_cache.get(chan.casefold(), {})
+        user_profile = chan_profiles.get(nick.casefold(), {})
         cat, data = match.groups()
-        if cat.lower() not in profile_cache.get(chan.lower(), {}).get(nick.lower(), {}):
-            db.execute(table.insert().values(chan=chan.lower(), nick=nick.lower(), category=cat.lower(), text=data))
+        if cat.casefold() not in user_profile:
+            db.execute(
+                table.insert().values(chan=chan.casefold(), nick=nick.casefold(), category=cat.casefold(), text=data))
             db.commit()
             load_cache(db)
             return "Created new profile category {}".format(cat)
 
         else:
-            db.execute(table.update().values(text=data).where((and_(table.c.nick == nick.lower(),
-                                                                    table.c.chan == chan.lower(),
-                                                                    table.c.category == cat.lower()))))
+            db.execute(table.update().values(text=data).where((and_(table.c.nick == nick.casefold(),
+                                                                    table.c.chan == chan.casefold(),
+                                                                    table.c.category == cat.casefold()))))
             db.commit()
             load_cache(db)
             return "Updated profile category {}".format(cat)
@@ -196,17 +164,20 @@ def profileadd(text, chan, nick, notice, db):
 @hook.command()
 def profiledel(nick, chan, text, notice, db):
     """<category> Deletes \"<category>\" from a user's profile"""
-    if nick.lower() == chan.lower():
+    if nick.casefold() == chan.casefold():
         return "Profile data can not be set outside of channels"
 
     category = text.split()[0]
-    if category.lower() not in profile_cache.get(chan.lower(), {}).get(nick.lower(), {}):
+
+    chan_profiles = profile_cache.get(chan.casefold(), {})
+    user_profile = chan_profiles.get(nick.casefold(), {})
+    if category.casefold() not in user_profile:
         notice("That category does not exist in your profile")
         return
 
-    db.execute(table.delete().where((and_(table.c.nick == nick.lower(),
-                                          table.c.chan == chan.lower(),
-                                          table.c.category == category.lower()))))
+    db.execute(table.delete().where((and_(table.c.nick == nick.casefold(),
+                                          table.c.chan == chan.casefold(),
+                                          table.c.category == category.casefold()))))
     db.commit()
     load_cache(db)
     return "Deleted profile category {}".format(category)
@@ -215,23 +186,24 @@ def profiledel(nick, chan, text, notice, db):
 @hook.command(autohelp=False)
 def profileclear(nick, chan, text, notice, db):
     """Clears all of your profile data in the current channel"""
-    if nick.lower() == chan.lower():
+    if nick.casefold() == chan.casefold():
         return "Profile data can not be set outside of channels"
 
     if text:
-        if nick in confirm_keys[chan.lower()] and text == confirm_keys[chan.lower()][nick.lower()]:
-            del confirm_keys[chan.lower()][nick.lower()]
-            db.execute(table.delete().where((and_(table.c.nick == nick.lower(),
-                                                  table.c.chan == chan.lower()))))
+        if nick in confirm_keys[chan.casefold()] and text == confirm_keys[chan.casefold()][nick.casefold()]:
+            del confirm_keys[chan.casefold()][nick.casefold()]
+            db.execute(table.delete().where((and_(table.c.nick == nick.casefold(),
+                                                  table.c.chan == chan.casefold()))))
             db.commit()
             load_cache(db)
             return "Profile data cleared for {}.".format(nick)
         else:
             notice("Invalid confirm key")
             return
     else:
-        confirm_keys[chan.lower()][nick.lower()] = "".join(random.choice(string.ascii_letters + string.digits) for i in range(10))
+        key = "".join(random.choice(string.ascii_letters + string.digits) for i in range(10))
+        confirm_keys[chan.casefold()][nick.casefold()] = key
         notice("Are you sure you want to clear all of your profile data in {}? use \".profileclear {}\" to confirm"
-               .format(chan, confirm_keys[chan.lower()][nick.lower()]))
+               .format(chan, key))
         return