Merge branch 'develop'

CHANGELOG.md

@@ -1,3 +1,30 @@
+ 0.32.0 (2021-10-18)
+====================
+
+No significant changes.
+
+
+0.32.0-rc2 (2021-10-15)
+========================
+
+Bugfixes
+--------
+
+- Fix an issue where the bridge would excessively log state event content ([\#1487](https://github.com/matrix-org/matrix-appservice-irc/issues/1487))
+
+
+0.32.0-rc1 (2021-10-08)
+========================
+
+Features
+--------
+
+- Add optional bridge blocking upon exceeding a monthly active user limit ([\#1472](https://github.com/matrix-org/matrix-appservice-irc/issues/1472))
+- **Breaking**: Upgrade to `matrix-appservice-bridge` 3.1.0.
+
+  This change removes the `ruleFile` option from the config, and replaces it with `rules`. See `config.sample.yaml` for an example. ([\#1485](https://github.com/matrix-org/matrix-appservice-irc/issues/1485))
+
+
 0.31.0 (2021-09-20)
 ========================
 

config.sample.yaml

@@ -521,9 +521,20 @@ ircService:
     # allotted time period, the provisioning request will fail.
     # Default: 300 seconds (5 mins)
     requestTimeoutSeconds: 300
-    # A file defining the provisioning rules for rooms. Format is documented
-    # in rules.sample.yaml. Leave undefined to not specify any rules.
-    ruleFile: "./provisioning.rules.yaml"
+    # When provisioning a room, disallow rooms that match these critera
+    rules:
+      # The bridge checks the joined members of a propective room and checks to see
+      # if any users matching these regex sets are in the room. `exempt` users never
+      # match, and will be ignored. If any user matches `conflict`, the room will not
+      # be allowed to be bridged until the user is removed. Both sets take a regular expression.
+      userIds:
+        exempt: 
+          # These users never conflict, even if matching
+          - "@doubleagent:badguys.com"
+        conflict:
+          # These users will deny a room from being bridged.
+          - "@.*:badguys.com"
+
     # Watch the file for changes, and apply the rules. Default: false
     enableReload: true
     # Number of channels allowed to be bridged
@@ -556,6 +567,15 @@ ircService:
     # how much time needs to pass between the reply and the original message to switch to the long format
     shortReplyTresholdSeconds: 300
 
+  # Maximum number of montly active users, beyond which the bridge gets blocked (both ways)
+  # RMAUlimit: 100
+
+  # userActivity:
+    # The "grace period" before we start counting users as active
+    # minUserActiveDays: 1
+    # Time before users are considered inactive again
+    # inactiveAfterDays: 30
+
   ircHandler:
     # Should we attempt to match an IRC side mention (nickaname match)
     # with the nickname's owner's matrixId, if we are bridging them?

config.schema.yml

@@ -108,14 +108,36 @@ properties:
                         type: "boolean"
                     requestTimeoutSeconds:
                         type: "number"
-                    ruleFile:
-                        type: "string"
+                    rules:
+                        type: "object"
+                        properties:
+                            userIds:
+                                type: "object"
+                                properties:
+                                    exempt:
+                                        type: "array"
+                                        items:
+                                            type: "string"
+                                    conflict:
+                                        type: "array"
+                                        items:
+                                            type: "string"
+
                     enableReload:
                         type: "boolean"
                     roomLimit:
                         type: "number"
             passwordEncryptionKeyPath:
                 type: "string"
+            RMAUlimit:
+                type: "integer"
+            userActivity:
+                type: "object"
+                properties:
+                    minUserActiveDays:
+                        type: "number"
+                    inactiveAfterDays:
+                        type: "number"
             matrixHandler:
                 type: "object"
                 properties: