Log in | Back to darenet.org
Share

Extended Bans

m (→Text Bans)
(Add note about regarding +s/p channels for extban 'j' at tyil's request)
 
(13 intermediate revisions not shown)
Line 1: Line 1:
-
We have recently added support for extended bans to ircd-darenet, our server software. Extended bans gives channel operators more flexibility and control over their channel's ban list. The proper syntax for extended bans is as follows:
+
Extended bans allow different checks than the usual nick!user@host (hostmask) match to determine whether someone should be banned from the channel, allowing channel operators more flexibility and control over their channel's ban list. On DareNET, extended bans are of the form '''<code>$[~]<type>:<data></code>'''. Where <type> is one character (case sensitive) and determines the type of match that is to be used. If the tilde (~) is used, the result of the check will be negated.
-
 
+
-
'''<code>/mode #channel +b $type:mask</code>'''  
+
The following types of extended bans are currently supported:
The following types of extended bans are currently supported:
-
{| class="wikitable" width="100%" style="font-size: 85%;"
+
{| class="simpletable" width="100%"
! style="text-align: center;" | Type
! style="text-align: center;" | Type
! style="text-align: center;" | Name
! style="text-align: center;" | Name
Line 21: Line 19:
| style="text-align: center;" | Shared Bans
| style="text-align: center;" | Shared Bans
| If a user matches a ban on the channel who's ban list is being shared, (s)he will be unable to join.
| If a user matches a ban on the channel who's ban list is being shared, (s)he will be unable to join.
-
|-
 
-
| style="text-align: center;" | $n
 
-
| style="text-align: center;" | Nick Change
 
-
| If a user matches this ban, (s)he will be unable to change their nickname while in the channel.
 
-
|-
 
-
| style="text-align: center;" | $q
 
-
| style="text-align: center;" | Quiet
 
-
| If a user matches this ban, (s)he will be unable to send messages to the channel.
 
|-
|-
| style="text-align: center;" | $r
| style="text-align: center;" | $r
Line 36: Line 26:
| style="text-align: center;" | $t
| style="text-align: center;" | $t
| style="text-align: center;" | Text
| style="text-align: center;" | Text
-
| Allows you to specify text that will be blocked if a user's privmsg or notice to the channel contains it. * and ? wildcards supported.
+
| Allows you to specify text that will be blocked if a user's privmsg or notice to the channel contains it.
|-
|-
-
|}
+
|}<br />
-
== Quiet and Nick Change ==
+
== Account ==
-
$q (quiet) and $n (nick change) are similar to normal bans, except that they allow you to control what a user can do without preventing them from joining the channel. $q prevents users matching the ban from sending messages/notices to the channel, while $n prevents them from changing their nickname.
+
The $a (account) type allows you to ban authed users who's account name matches the specified account mask.
-
'''Syntax:'''
+
{| class="simpletable" width="10%"
 +
! style="text-align: left;" | Syntax
 +
|-
 +
| $a:<mask>
 +
|-
 +
|}
-
<code>/mode #channel +b $q:nick!ident@host<br>
+
If we wanted to ban all users who's account name contained the word ''joe'', we could set the following $a type extended ban:
-
/mode #channel +b $n:nick!ident@host</code>
+
-
'''Examples:'''
+
<code>/mode #ourchannel +b $a:*joe*</code>
-
Let's say that we wanted to allow AOL users to join the channel, but prevent them from speaking. This could be achieved by setting the following $q (quiet) extended ban:
+
== Channel ==
-
<code>/mode #channel +b $q:*!*@*.aol.com</code>
+
The $c (channel) type prevents users who are in a matching channel from joining your channel.
-
If we wanted to also prevent AOL users from changing their nickname while their in our channel, we could also set the following #n (nick change) extended ban to achieve that:
+
{| class="simpletable" width="10%"
 +
! style="text-align: left;" | Syntax
 +
|-
 +
| $c:<#channel>
 +
|-
 +
|}
-
<code>/mode #channel +b $n:*!*@*.aol.com</code>
+
If we wanted to prevent users who are in channels with the word ''lame'' in its name from joining our channel, we could set the following $c type extended ban.
-
== Channel and Realname ==
+
<code>/mode #ourchannel +b $c:#*lame*</code>
-
$c and $r are channel and realname (gecos) bans, respectively.
+
== Realname ==
-
When $c is used, it will prevent users who are currently in the channel specified from joining your channel. When $r is used, it will prevent users who's realname (gecos) matches the ban from joining your channel. Note, $r treats '_' as both the underscore character and a space.
+
The $r (realname/gecos) type prevents users with a matching realname from joining your channel.
-
'''Syntax:'''
+
{| class="simpletable" width="10%"
 +
! style="text-align: left;" | Syntax
 +
|-
 +
| $r:<mask>
 +
|-
 +
|}
-
<code>/mode #channel +b $c:#channel<br>
+
If we wanted to prevent users who had the word ''bot'' in their realname (gecos) from the joining our channel, we could set the following $r type extended ban:
-
/mode #channel +b $r:realname</code>
+
-
'''Examples:'''
+
<code>/mode #ourchannel +b $r:*bot*</code>
-
Let's say we wanted to prevent all users who are inchannels with the word ''warez'' in their name from joining our channel. We could achieve this by setting the following $c (channel) extended ban:
+
== Shared bans ==
-
<code>/mode #channel +b $c:#*warez*</code>
+
The $j type allows sharing channel ban lists.
-
Let's say we also want to prevent all users with the word ''bot'' in their realname (gecos) from joining the channel, as well. To do this, we could set the following $r (realname) extended ban:
+
{| class="simpletable" width="10%"
 +
! style="text-align: left;" | Syntax
 +
|-
 +
| $j:<#channel>
 +
|-
 +
|}
-
<code>/mode #channel +b $r:*bot*</code>
+
For this example, the name of our channel is ''#ourchannel'' and we want to use ''#shared''<nowiki>'</nowiki>s channel ban list with our own. So, to do this we could set the following $j type extended ban:
-
== Account Bans ==
+
<code>/mode #ourchannel +b $j:#shared</code>
-
The $a (account) extended ban type allows you to ban (logged in) users who's account matches the specified ban mask. Note, these types of bans can only ever match users logged into their NickServ account.
+
Now, whenever a user tries to join our channel, ''#ourchannel'', they'll be checked against ''#shared''<nowiki>'</nowiki>s ban list in addition to our own ban list. If a match is found in either ban list, the user will be prevented from joining.
-
'''Syntax:'''  
+
'''NOTE:''' The shared channel must not be in +p or +s for this to work
-
<code>/mode #channel +b $a:mask</code>
+
== Text bans ==
-
'''Examples:'''
+
The $t (text) type allows channel operators to specify words (wildcards supported) that will be blocked if the user's message or notice to the channel matches it.
-
If we wanted to ban all users who's account names contained the word ''joe'' in them, we could set the following $a (account) extended ban to achieve this:
+
{| class="simpletable" width="10%"
-
 
+
! style="text-align: left;" | Syntax
-
<code>/mode #channel +b $a:*joe*</code>
+
|-
-
 
+
| $t:<#mask>
-
NOTE: Extended account bans act identical to the previous method of banning user's based on their account name (e.g. <code>/mode #channel +b *!*@accountname.*</code>); however, the reverse logic function can also be used with extended account bans, which cannot presently do with the old method. We discuss the reverse logic function a little later in this guide.
+
|-
-
 
+
|}
-
== Shared Bans ==
+
-
 
+
-
The $j (shared bans) extended ban type allows you to use another channel's ban list.
+
-
 
+
-
'''Syntax:'''
+
-
 
+
-
<code>/mode #channel +b $j:mask</code>
+
-
 
+
-
'''Examples:'''
+
-
 
+
-
Okay, for this example, our channel is ''#channel'' and we want to use ''#shared''<nowiki>'</nowiki>s channel ban list along with our own. To do this, we would set the following $c (shared bans) extended ban on ''#channel'':
+
-
 
+
-
<code>/mode #channel +b $j:#shared</code>
+
-
 
+
-
Now, whenever a user tries to join ''#channel'', they will be checked against ''#shared''<nowiki>'</nowiki>s channel ban list, in addition to ''#channel''<nowiki>'</nowiki>s channel ban list. If a match is found in either ban list, they will be prevented from joining.
+
-
 
+
-
== Text Bans ==
+
-
 
+
-
The $t (text ban) extended ban type allows channel operators to specify text that will blocked if a user's message or notice to the channel contains it. The * and ? wildcards are supported. Note, this currently affects channel operators, half operators and voices as well.
+
-
 
+
-
'''Syntax:'''
+
-
 
+
-
<code>/mode #channel +b $t:mask</code>
+
-
 
+
-
'''Examples:'''
+
-
 
+
-
Let's say we wanted to block all channel messages and notices that contained the word ''damn''. To do this, we would set the following:
+
-
 
+
-
<code>/mode #channel +b $t:damn</code>
+
-
 
+
-
== Reverse Logic ==
+
-
 
+
-
If "!" is specified in an extended ban, then it will have a reverse effect. Please note this does not work with quiets. Instead, use excepts.
+
-
'''Syntax:'''  
+
Let's say we wanted to block all channel messages and notices that contained the word ''damn'', regardless of the user sending it. To do this we could set the following $t type extended ban:
-
<code>/mode #channel +b $!<type>:mask</code>
+
<code>/mode #ourchannel +b $t:*damn*</code>
-
'''Example:'''
+
== Negation / Reverse logic ==
-
Let's say we wanted to an extended channel ban on #darenet with the "!" (reverse) flag, we'd use:
+
If "~" is prepended to the type of an extended ban, then the result of the comparison is negated. In other words, it will have a reversed effect.
-
<code>/mode #channel +b $!c:#darenet</code>
+
Let's say we wanted to allow users to join our channel ONLY if they're already present in #darenet. To do this, we would set a $c type extended ban, by prepending "~" to the type flag:
-
This would prevent anyone from joining #channel if they are not already in #darenet as well.
+
<code>/mode #ourchannel +b $~c:#darenet</code>
== Assistance ==
== Assistance ==
-
Should you need assistance using the new extended bans feature, feel free to stop by #Support
+
Should you need assistance using the extended bans feature, feel free to stop by #help.
-
[[Category:Documentation]]
+
[[Category:All]] [[Category:Documentation]]

Current revision as of 22:33, 21 October 2015

Extended bans allow different checks than the usual nick!user@host (hostmask) match to determine whether someone should be banned from the channel, allowing channel operators more flexibility and control over their channel's ban list. On DareNET, extended bans are of the form $[~]<type>:<data>. Where <type> is one character (case sensitive) and determines the type of match that is to be used. If the tilde (~) is used, the result of the check will be negated.

The following types of extended bans are currently supported:

Type Name Purpose
$a Account If a user's account name matches this ban, (s)he will be unable to join.
$c Channel If a user is in a channel that matches this ban, (s)he will be unable to join.
$j Shared Bans If a user matches a ban on the channel who's ban list is being shared, (s)he will be unable to join.
$r Realname If a user's realname (gecos) matches this ban, (s)he will be unable to join.
$t Text Allows you to specify text that will be blocked if a user's privmsg or notice to the channel contains it.

In This Guide:

Account

The $a (account) type allows you to ban authed users who's account name matches the specified account mask.

Syntax
$a:<mask>

If we wanted to ban all users who's account name contained the word joe, we could set the following $a type extended ban:

/mode #ourchannel +b $a:*joe*

Channel

The $c (channel) type prevents users who are in a matching channel from joining your channel.

Syntax
$c:<#channel>

If we wanted to prevent users who are in channels with the word lame in its name from joining our channel, we could set the following $c type extended ban.

/mode #ourchannel +b $c:#*lame*

Realname

The $r (realname/gecos) type prevents users with a matching realname from joining your channel.

Syntax
$r:<mask>

If we wanted to prevent users who had the word bot in their realname (gecos) from the joining our channel, we could set the following $r type extended ban:

/mode #ourchannel +b $r:*bot*

Shared bans

The $j type allows sharing channel ban lists.

Syntax
$j:<#channel>

For this example, the name of our channel is #ourchannel and we want to use #shared's channel ban list with our own. So, to do this we could set the following $j type extended ban:

/mode #ourchannel +b $j:#shared

Now, whenever a user tries to join our channel, #ourchannel, they'll be checked against #shared's ban list in addition to our own ban list. If a match is found in either ban list, the user will be prevented from joining.

NOTE: The shared channel must not be in +p or +s for this to work

Text bans

The $t (text) type allows channel operators to specify words (wildcards supported) that will be blocked if the user's message or notice to the channel matches it.

Syntax
$t:<#mask>

Let's say we wanted to block all channel messages and notices that contained the word damn, regardless of the user sending it. To do this we could set the following $t type extended ban:

/mode #ourchannel +b $t:*damn*

Negation / Reverse logic

If "~" is prepended to the type of an extended ban, then the result of the comparison is negated. In other words, it will have a reversed effect.

Let's say we wanted to allow users to join our channel ONLY if they're already present in #darenet. To do this, we would set a $c type extended ban, by prepending "~" to the type flag:

/mode #ourchannel +b $~c:#darenet

Assistance

Should you need assistance using the extended bans feature, feel free to stop by #help.

Retrieved from "http://wiki.darenet.org/Extended_Bans"