Merge the cloak_account and cloak_nick modules.

These modules are 90% identical and were only separate because
before commit 78cd3898f5 we could not conditionally regenerate
cloaks.

1 files changed, 50 insertions, 76 deletions

diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index afaf3861a..599ed7e8e 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -517,47 +517,6 @@
 #<module name="cloak">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Account cloak module: Adds the "account" (services account name) and
-# "account-id" (services account identifier) cloak methods.
-#<module name="cloak_account">
-#
-#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-# To use the cloak_account module you must define a <cloak> tag. This #
-# tag can have the following fields.                                  #
-#                                                                     #
-#  class    - If non-empty then a comma-delimited list of connect     #
-#             class names that a user has to be in to get the cloak   #
-#             from this tag.                                          #
-#                                                                     #
-#  prefix   - A freeform value to prefix cloaks with. This must not   #
-#             contain spaces.                                         #
-#                                                                     #
-#  suffix   - A freeform value to suffix IPv4/IPv6 cloaks with. This  #
-#             must not contain spaces.                                #
-#                                                                     #
-#  sanitize - If enabled then any characters in the account name/id   #
-#             that are not valid in a hostname will be removed rather #
-#             than skipping the cloak method. Defaults to yes.        #
-#                                                                     #
-# IMPORTANT: Changing these details will break all of your existing   #
-# bans. If you do not want this to happen you can define multiple     #
-# cloak tags. The first will be used for hostnames and the rest will  #
-# be used for checking if a user is banned in a channel.              #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#
-#<cloak method="account"
-#       class=""
-#       prefix="MyNet"
-#       suffix="ip"
-#       sanitize="yes">
-#
-#<cloak method="account-id"
-#       class=""
-#       prefix="MyNet"
-#       suffix="ip"
-#       sanitize="yes">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # MD5 cloak module: Adds the "half" and "full" cloak methods. These
 # methods are obsolete and should only be used on a network which is
 # upgrading from v3 and wishes to keep ban compatibility. New networks
@@ -613,40 +572,6 @@
 #       suffix=".IP">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Nickname cloak module: Adds the "nick" (user nickname) cloak method.
-#<module name="cloak_nick">
-#
-#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-# To use the cloak_nick module you must define a <cloak> tag. This    #
-# tag can have the following fields.                                  #
-#                                                                     #
-#  class    - If non-empty then a comma-delimited list of connect     #
-#             class names that a user has to be in to get the cloak   #
-#             from this tag.                                          #
-#                                                                     #
-#  prefix   - A freeform value to prefix cloaks with. This must not   #
-#             contain spaces.                                         #
-#                                                                     #
-#  suffix    - A freeform value to suffix cloaks with. This must not  #
-#              contain spaces.                                        #
-#                                                                     #
-#  sanitize - If enabled then any characters in the nickname that are #
-#             not valid in a hostname will be removed rather than     #
-#             than skipping the cloak method.                         #
-#                                                                     #
-# IMPORTANT: Changing these details will break all of your existing   #
-# bans. If you do not want this to happen you can define multiple     #
-# cloak tags. The first will be used for hostnames and the rest will  #
-# be used for checking if a user is banned in a channel.              #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#
-#<cloak method="nick"
-#       class=""
-#       prefix="MyNet"
-#       suffix="ip"
-#       sanitize="yes">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # HMAC-SHA256 cloak module: Adds the "hmac-sha256" (hostname or IP) and
 # "hmac-sha256-ip" (IP only) cloak methods. This is the recommended
 # cloak module for new networks.
@@ -715,7 +640,7 @@
 # Static cloak module: Adds the "static" (fixed value) cloak method.
 #<module name="cloak_static">
 #
-#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#- STATIC CLOAK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
 # To use the cloak_static module you must define a <cloak> tag. This  #
 # tag can have the following fields.                                  #
 #                                                                     #
@@ -735,6 +660,55 @@
 #       cloak="some.fixed.value">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# User data cloak module: Adds the "account" (services account name),
+# "account-id" (services account identifier), and "nick" (nickname)
+# cloak methods.
+#<module name="cloak_user">
+#
+#-#-#-#-#-#-#-#-#-#-#- USER CLOAK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
+# To use the cloak_user module you must define a <cloak> tag. This    #
+# tag can have the following fields.                                  #
+#                                                                     #
+#  class    - If non-empty then a comma-delimited list of connect     #
+#             class names that a user has to be in to get the cloak   #
+#             from this tag.                                          #
+#                                                                     #
+#  prefix   - A freeform value to prefix cloaks with. This must not   #
+#             contain spaces.                                         #
+#                                                                     #
+#  suffix   - A freeform value to suffix IPv4/IPv6 cloaks with. This  #
+#             must not contain spaces.                                #
+#                                                                     #
+#  sanitize - If enabled then any characters in the account name,     #
+#             account id or nickname that are not valid in a hostname #
+#             will be removed rather  than skipping the cloak method. #
+#             Defaults to yes.                                        #
+#                                                                     #
+# IMPORTANT: Changing these details will break all of your existing   #
+# bans. If you do not want this to happen you can define multiple     #
+# cloak tags. The first will be used for hostnames and the rest will  #
+# be used for checking if a user is banned in a channel.              #
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#
+#<cloak method="account"
+#       class=""
+#       prefix=""
+#       suffix=".users.example.com"
+#       sanitize="yes">
+#
+#<cloak method="account-id"
+#       class=""
+#       prefix=""
+#       suffix=".users.example.com"
+#       sanitize="yes">
+#
+#<cloak method="nick"
+#       class=""
+#       prefix="Users/"
+#       suffix=""
+#       sanitize="yes">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Codepage module: Allows using a custom 8-bit codepage for nicknames
 # and case mapping.
 #<module name="codepage">