ircbot: add shorturl plugin

ircbot/plugin/help.py

@@ -10,7 +10,8 @@
 def register(bot):
     threading.Thread(target=help_server, args=(bot,), daemon=True).start()
     bot.listen(r'^help$', help, require_mention=True)
-    bot.listen(r'^macros$', help_macro, require_mention=True)
+    bot.listen(r'^macros?$', help_macro, require_mention=True)
+    bot.listen(r'^shorturls?$', help_shorturls, require_mention=True)
 
 
 def help(bot, msg):
@@ -23,6 +24,11 @@ def help_macro(bot, msg):
     msg.respond('https://ircbot.ocf.berkeley.edu/macros')
 
 
+def help_shorturls(bot, msg):
+    """Provide a link to the list of shorturls."""
+    msg.respond('https://ircbot.ocf.berkeley.edu/shorturls')
+
+
 def build_request_handler(bot):
     jinja_env = jinja2.Environment(
         loader=jinja2.PackageLoader('ircbot', ''),
@@ -39,6 +45,11 @@ def render_response(self, template, **context):
             self.end_headers()
             self.wfile.write(rendered)
 
+        def render_404(self):
+            self.send_response(404, 'File not found')
+            self.end_headers()
+            self.wfile.write(b'404 File not found')
+
         def do_GET(self):
             if self.path == '/':
                 plugins = collections.defaultdict(set)
@@ -54,10 +65,26 @@ def do_GET(self):
                     'plugin/templates/macros.html',
                     macros=bot.plugins['macros'].list(bot),
                 )
+            elif self.path.startswith('/shorturls'):
+                query_items = self.path.lstrip('/').split('/')
+
+                if len(query_items) < 2 or not query_items[1]:
+                    self.render_response(
+                        'plugin/templates/shorturls.html',
+                        shorturls=bot.plugins['shorturls'].list(bot),
+                    )
+                else:
+                    candidate_target = bot.plugins['shorturls'].retrieve(bot, '/'.join(query_items[1:]))
+
+                    if candidate_target:
+                        self.send_response(302, 'Found')
+                        self.send_header('Content-Length', 0)
+                        self.send_header('Location', candidate_target)
+                        self.end_headers()
+                    else:
+                        self.render_404()
             else:
-                self.send_response(404, 'File not found')
-                self.end_headers()
-                self.wfile.write(b'404 File not found')
+                self.render_404()
 
     return RequestHandler
 

ircbot/plugin/shorturls.py

@@ -0,0 +1,130 @@
+"""Control ocfweb shorturls through ircbot."""
+from ircbot import db
+
+KEYWORDS = {'add', 'delete', 'rename', 'replace'}
+
+
+def register(bot):
+    # [!-~] is all printable ascii except spaces
+    bot.listen(r'^!shorturl ([\w/]+)', show)
+    bot.listen(r'^!shorturl add ([\w/]+) (.+)$', add)
+    bot.listen(r'^!shorturl delete ([\w/]+)$', delete)
+    bot.listen(r'^!shorturl rename ([\w/]+) ([\w/]+)$', rename)
+    bot.listen(r'^!shorturl replace ([\w/]+) (.+)$', replace)
+
+
+def list(bot):
+    """List all shorturls for shorturls help page."""
+
+    with db.cursor(password=bot.mysql_password) as c:
+        c.execute('SELECT slug, target FROM shorturls ORDER BY slug')
+
+    for entry in c.fetchall():
+        yield entry['slug'], entry['target']
+
+
+def retrieve(bot, slug):
+    """Reusable function to retrieve a shorturl by slug from the DB."""
+
+    with db.cursor(password=bot.mysql_password) as c:
+        c.execute(
+            'SELECT target FROM shorturls WHERE slug = %s',
+            (slug,),
+        )
+        target = c.fetchone()
+
+        return target['target'] if target else None
+
+
+def show(bot, msg):
+    """Return a shorturl by slug."""
+
+    slug = msg.match.group(1)
+
+    # special case these so show doesn't trigger on add/delete
+    # while still letting the trigger appear anywhere in the msg
+    if slug in KEYWORDS:
+        return
+
+    target = retrieve(bot, slug)
+    if not target:
+        msg.respond('shorturl `{}` does not exist.'.format(slug))
+    else:
+        msg.respond(target['target'], ping=False)
+
+
+def add(bot, msg):
+    """Add a new shorturl."""
+
+    slug = msg.match.group(1)
+    target = msg.match.group(2)
+
+    if slug in KEYWORDS:
+        msg.respond('`{}` is a reserved keyword.'.format(slug))
+        return
+
+    if len(slug) > 255:
+        msg.respond('shorturl slugs must be <= 255 characters')
+        return
+
+    with db.cursor(password=bot.mysql_password) as c:
+
+        c.execute('SELECT * FROM shorturls WHERE slug = %s', (slug,))
+        result = c.fetchone()
+        if result is not None:
+            msg.respond(
+                'shorturl `{}` already exists as {}'.format(
+                    result['slug'],
+                    result['target'],
+                ),
+            )
+        else:
+            c.execute(
+                'INSERT INTO shorturls (slug, target) VALUES (%s, %s)',
+                (slug, target),
+            )
+            msg.respond('shorturl added as `{}`'.format(slug))
+
+
+def delete(bot, msg):
+    """Delete a shorturl."""
+
+    slug = msg.match.group(1)
+    with db.cursor(password=bot.mysql_password) as c:
+        c.execute(
+            'DELETE FROM shorturls WHERE slug = %s',
+            (slug,),
+        )
+        msg.respond('shorturl `{}` has been deleted.'.format(slug))
+
+
+def rename(bot, msg):
+    """Rename a shorturl."""
+
+    old_slug = msg.match.group(1)
+    new_slug = msg.match.group(2)
+
+    if new_slug in KEYWORDS:
+        msg.respond('`{}` is a reserved keyword.'.format(new_slug))
+        return
+
+    with db.cursor(password=bot.mysql_password) as c:
+        c.execute(
+            'UPDATE shorturls SET slug = %s WHERE slug = %s',
+            (new_slug, old_slug),
+        )
+        msg.respond('shorturl `{}` has been renamed to `{}`'.format(old_slug, new_slug))
+
+
+def replace(bot, msg):
+    """Replace the target of a shorturl slug."""
+
+    slug = msg.match.group(1)
+    new_target = msg.match.group(2)
+
+    with db.cursor(password=bot.mysql_password) as c:
+        c.execute(
+            'UPDATE shorturls SET target = %s WHERE slug = %s',
+            (new_target, slug),
+        )
+        msg.respond('shorturl `{}` updated'.format(slug))

ircbot/plugin/templates/shorturls.html

@@ -0,0 +1,26 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>ocf shorturls</title>
+        <style>
+          code { background-color: #eee; padding: 3px; }
+	  .slug { font-weight: bold }
+	  .link {}
+        </style>
+    </head>
+    <body>
+        <h1>shorturls available at ocf</h1>
+        <hr />
+
+        <p>Available shorturls are:</p>
+	<ul>
+          {% for slug, target in shorturls %}
+	  <li>
+            <p><span class="slug">{{slug}}</span>: <span class="link"><a href="{{ target }}">{{ target }}</a></span></p>
+	  </li>
+          {% endfor %}
+	</ul>
+    </body>
+</html>
+{# vim: ft=jinja
+#}