From ba10dfacc132c40074ea1b1a29b4daa0987ae456 Mon Sep 17 00:00:00 2001
From: Ian Wienand <iwienand@redhat.com>
Date: Mon, 6 Aug 2018 11:27:21 +1000
Subject: [PATCH] accessbot config: refactor

In responding to some comments on the original changes, it made me
realise that the global "alumni" and "mask" values are not actually
required.  Each channel looks up these values in the global dictionary
first, which is the correct place to put them.

This moves them into the global dictionary, but also adds and updates
(removes stackforge references) more details about what's happening
with the channel config keys.

Change-Id: Ic8fc5022d670e0dbcbb53ef803125317dfc008f7
---
 accessbot/channels.yaml | 91 +++++++++++++++++++++++++----------------
 1 file changed, 55 insertions(+), 36 deletions(-)

diff --git a/accessbot/channels.yaml b/accessbot/channels.yaml
index 6d0566f460..7ebc849f62 100755
--- a/accessbot/channels.yaml
+++ b/accessbot/channels.yaml
@@ -14,11 +14,42 @@
 
 # In general, to add a new channel for an official OpenStack project
 # to this file, just add the name to the list in "channels" without
-# anything else.  Stackforge projects can optionally set "mask" to
-# "full_mask" to keep full permissions.
+# anything else.  Projects who wish to maintain full permissions
+# outside the "official" infra list can optionally set "mask" to
+# "full_mask".
 
+# Each channel is a dictionary with a keys as follows
+#
+# name:
+#   (str) unique channel name (no #)
+# alumni:
+#   (list) list of nicks that should be removed from ChanServ access
+# mask:
+#   (str) default mask for users with chanserv access but not
+#   otherwise listed in the channel or global config.  Access is
+#   limited to the mask but otherwise left alone.
+# mode:
+#   (str) mode mask for mlock.  Note that flags here are enforced, but
+#   flags outside the list are left alone.
+# *:
+#   (list) every other key is assumed to be a key in the "access:"
+#   list.  The provided list of nicks will have the flags for that
+#   key applied.
+#
+# NOTE each channel looks up these values in the "global:" list first.
+# Channel specific values override the global values.
+
+#
 # Global definitions
-# First set up the access levels (map names in this file to chanserv flags):
+#
+
+# To forward unregistered users to a channel with +f you need to be an
+# op in that channel.  This pre-joins and ops (via chanserv) in the
+# given channels.
+op_channels:
+  - openstack-unregistered
+
+# Access levels (map names in this file to chanserv flags):
 access:
   masters: +AFRefiorstv
   status: +Vt
@@ -27,11 +58,28 @@ access:
   channel_op_mask: +AOVefortv
   full_mask: +AFORVefiorstv
 
-# Define access that should apply to all channels.  The label 'mask'
-# is special: anyone with perms on a channel that isn't otherwise
-# listed for the channel or in the global list will have their access
-# limited to the mask but otherwise left alone.
+# Define configuration that should apply to all channels.
 global:
+  # These entries can be removed after the next accessbot run should
+  # people desire, but it is also left here as the official OpenStack
+  # IRC Wall of Fame! :)
+  alumni:
+    - SergeyLukjanov
+    - lifeless
+    - lyz
+    - maffulli
+    - nibalizer
+    - yolanda
+    - Sam-I-Am
+  mask:
+    channel_op_mask
+  # This sets the following
+  #  c : no colors
+  #  n : message can not be sent from outside channel
+  #  r : registered users only
+  #  t : op to modify topic
+  #  f : forward unregistered users to #openstack-unregistered
+  mode: '+cnrtf #openstack-unregistered'
   masters:
     - openstackinfra
   operators:
@@ -51,35 +99,6 @@ global:
     - openstackstatus
   meetbots:
     - open_stack
-  mask:
-    channel_op_mask
-
-# Alumni have their access removed from all channels (note you can set
-# alumni: on an individual channel too).  These entries can be removed
-# after the next accessbot run should people desire, but it is also
-# left here as the official OpenStack IRC Wall of Fame! :)
-alumni:
-  - SergeyLukjanov
-  - lifeless
-  - lyz
-  - maffulli
-  - nibalizer
-  - yolanda
-  - Sam-I-Am
-
-# To forward unregistered users to a channel with +f you need to be an
-# op in that channel.  This pre-joins and ops (via chanserv) in the
-# given channels.
-op_channels:
-  - openstack-unregistered
-
-# This sets the following
-#  c : no colors
-#  n : message can not be sent from outside channel
-#  r : registered users only
-#  t : op to modify topic
-#  f : forward unregistered users to #openstack-unregistered
-mode: '+cnrtf #openstack-unregistered'
 
 # Individual channel configuration:
 channels: