Maiden-Blocker

About

This agent provides a facility to allow blocking and excluding channels, clients, users, or other parts from event or command processing. This is useful in case of spammers, or if some functionality does not provide an explicit kill switch, but must be turned off for a specific environment.

How To

Blocking happens over rules, which are a composition of clauses. The syntax is as most easily explained through some examples:

(channel "foo")
(or (user "dios") (user "gott"))
(and (prefix "::") (user "no-commands-user"))

Logical combinations can be made via and, or, and not. Tests can be made with channel, client, user, regex, and prefix. You can also define additional clauses for these rules using define-clause.

Rules can also be defined and managed over the interface.

Copyright

maiden-blocker is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shinmera/maiden.

Package Index

MAIDEN-BLOCKER (ORG.SHIRAKUMO.MAIDEN.AGENTS.BLOCKER)

class
ADD-RULE
```
 
```
class
BLOCK-CHANNEL
```
 
```
class
BLOCK-PREFIX
```
 
```
class
BLOCK-REGEX
```
 
```
class
BLOCK-USER
```
 
```

class

`BLOCKER`

This agent handles the blocking of users, channels, or commands based on flexible rules.

class
REMOVE-RULE
```
 
```
class
UPDATE-RULE
```
 
```
class
VIEW-RULE
```
 
```
class
VIEW-RULES
```
 
```

accessor (

`CLAUSE`

NAME)

Accessor to set or retrieve clause resolution functions.

See *CLAUSES*

accessor (

`RULE`

NAME BLOCKER)

Accessor to the rule instances that the blocker keeps.

See RULES
See BLOCKER

function (

`ADD-RULE`

NAME RULE BLOCKER)

Add a new rule to the blocker.

If a rule of the same name already exists, an
error is signalled.

See RULE

function (

`BLOCKED-P`

EVENT BLOCKER)

Returns whether the given event is blocked by the blocker.

See RULES
See MATCH-RULE

function (

`ENSURE-RULE`

RULE)

Attempt to coerce the object into a proper rule form.

This will also make sure that the rule form is
a proper one, as it will simulate a matching
against a dummy event.

See ENSURE-RULE
See MATCH-RULE

function (

`MATCH-RULE`

RULE EVENT)

Attempt to match the event against the rule.

The rule must be a properly parsed rule in list
form. If it contains an invalid clause, an error
is signalled.

function (

`REMOVE-CLAUSE`

NAME)

Remove a clause so that it is no longer recognised.

See *CLAUSES*

function (

`REMOVE-RULE`

NAME BLOCKER)

Remove a rule instance from the blocker.

See RULES
See BLOCKER

macro (

`DEFINE-CLAUSE`

&REST ARGS)

Define a new clause resolution function.

The function should analyse the event and its
arguments and return whether the event passes
the clause or not.

command (

`block`

NAME RULE)

Add a new blocking rule. The rule syntax allows AND/OR/NOT logical combinations and CHANNEL/CLIENT/USER/REGEX/PREFIX matchers. Use s-expression style syntax. Eg: (and (channel foo) (not (user bar)))

command (

`block channel`

CHANNEL &KEY CLIENT NAME)

Block a specific channel from all commands. The name of the rule will be the same as the channel.

command (

`block prefix`

PREFIX &KEY CLIENT NAME)

Block all commands that match a certain prefix. The name of the rule will be the same as the prefix string.

command (

`block regex`

REGEX &KEY CLIENT NAME)

Block all commands that match a certain regex. The name of the rule will be the same as the regex.

command (

`block user`

USER &KEY CLIENT NAME)

Block a specific user from all commands. The name of the rule will be the same as the user name.

command (

`unblock`

NAME)

Remove a rule definition that was previously defined.

command (
update block rule
NAME RULE)
```
Update an existing rule definition.
```
command (
view block rule
NAME)
```
View the actual rule definition.
```

command

`view block rules`

Show a listing of names of all the known block rules.

maiden-blocker

About

How To

Copyright

Package Index

MAIDEN-BLOCKER (ORG.SHIRAKUMO.MAIDEN.AGENTS.BLOCKER)

`ADD-RULE`

`BLOCK-CHANNEL`

`BLOCK-PREFIX`

`BLOCK-REGEX`

`BLOCK-USER`

`BLOCKER`

`REMOVE-RULE`

`UPDATE-RULE`

`VIEW-RULE`

`VIEW-RULES`

`CLAUSE`

`RULE`

`ADD-RULE`

`BLOCKED-P`

`ENSURE-RULE`

`MATCH-RULE`

`REMOVE-CLAUSE`

`REMOVE-RULE`

`DEFINE-CLAUSE`

`block`

`block channel`

`block prefix`

`block regex`

`block user`

`unblock`

`update block rule`

`view block rule`

`view block rules`