Flarum AutoModerator

askvortsov · 2021-05-20T04:17:32+00:00

Auto Moderator A Flarum extension. Core Concept The core idea is as follows: When a user meets criteria X, do Y. When a user no longer meets criteria X, do Z. Let's define some key terms: Criteria Group: The set of all criteria that a user meets. Criteria (singular Criterion): An arbitrary set of conditions. Criteria are paired with triggers and actions, and are composed of: Metrics: A numerical condition. For example, post count or number of likes received. A criterion could require a range/minimum/maximum of metrics. Requirement: An abstract boolean condition. For example, not being suspended, or having an email that matches a certain regex. Action: Something that happens automatically when a criteria is met or lost. This could include anything from adding/removing a group to sending an email to suspending a user. Triggers: A set of events that would cause a user's criteria groups to be reevaluated. These are associated with metrics and Requirements. LoggedIn is automatically a trigger for all criteria. This makes for an extremely powerful extension. Furthermore, since extensions can add their own metrics, requirements, and actions, this extension can automate away a lot of moderation. Beyond the examples listed below, some things that could be possible are: Automating assignment of achievements / badges Sending emails/notifications to users when they reach thresholds (or just when they register) Establishing a system of "trust levels" like Discourse Onboard/offboard users to/from external systems when they receive/lose certain group membership And a bunch more! The possibilities are endless. Evaluation When a trigger event occurs: All metrics will be calculated for the relevant user (what is the numerical value of the metric?) All requirements will be calculated for the relevant user (does the user satisfy each of the requirements?) The user's new criteria group will be computed and diffed against the user's current criteria group. The two sets will be diffed. Only criteria triggered by the event will be adjusted. Actions will be executed for any gained and lost criteria. You can also use the php flarum criteria:recalculate console command to recalculate criteria for all users. Note that this will be quite slow, and shouldn't usually be done. Examples Example 1: Group Management Criteria: Users that receive 50 or more likes and have started at least 10 discussions should placed in the "Active" group. Here, the metrics are "received 50 or more likes" and "have started at least 10 discussions". Unsurprisingly, they come with the triggers (PostWasLiked, PostWasUnliked) and (Discussion\Started) respectively. The actions are: When the criteria is met, add the user to the "Active" group When the criteria is lost, remove the user from the "Active" group Example 2: Suspension Criteria: If a user gets 15 warnings or more and is not an admin, suspend them. Here, the metrics are "gets 15 warnings or more" and the requirements are "is not an admin". The triggers would be a new warning for the metric. The requirement has no triggers. The actions are: When the criteria is met, suspend them When the criteria is lost, unsuspend them Example 3: Auto Activation Criteria: If a user's email matches a regex, activate their email. The requirement is "a user's email matches a regex". The triggers are saving a user. The actions are: When the criteria is met, auto activate the user's email When the criteria are not met, don't Example 4: Default Group Criteria: Add a user to a group There are no metrics or requirements, so this will be applied to all users on login. The actions are: Add all users to a group on login Screenshots Metrics vs Requirements It's clear to see that any metric could be represented as a Requirement. A requirement must be specific. "More than 50 received likes" could be a requirement. However, metrics can allow for any range of values. Metrics can be stored and used for other purposes. For example, a planned feature is combining all metrics to provide a "reputation" score. Settings Requirements and actions can require settings in the admin dashboard. For example: The "add to group" action takes the group ID as a setting The "suspend" action takes the number of days and whether the suspension is indefinite as settings The "email matches regex" requirement takes the regex as a setting Extensibility This extension is extremely flexible. It can be considered a framework for automoderation actions. Extensions can use the Askvortsov\AutoModerator\Extend\AutoModerator extender to add: Action drivers Metric drivers Requirement drivers You should look at the source code of the default drivers for examples. They're fairly exhaustive of what's offered. If your extension adds action or requirement drivers that consume settings, you have 2 options: Provide translation keys for the settings you need in the driver's availableSettings method. This is very easy, but also very restrictive. You can only use strings, and can't add any restrictions or UI. You can declare a settings form component for your driver. See js/src/admin/components/SuspendSelector for an example. The component should take a settings stream as this.attrs.settings. The contents of the stream should be an object that maps setting keys to values. The component is responsible for updating the stream on input. You can register a form component by adding its class to app.autoModeratorForms[DRIVER CATEGORY][TYPE], where DRIVER CATEGORY is "action" or "requirement", and TYPE is the type string you registered your driver with in extend.php. See js/src/admin/index.js for the underlying data structure and examples. TODO: Add support for more metrics: Posts read Time spent on forum Days visited Days since account creation Etc Add support for dated metrics (discussions created in the past X days) Introduce metric "weights", sum together to calculate a reputation. Make that reputation available as a metric. Develop a data collection extension, which could cache things such as like counts, to improve performance on large forums Investigate criterion "listeners": can we generalize stuff like removing links from posts of users without certain groups? Contributions Contributions and PRs are welcome! Any PRs adding new drivers should come with unit tests (like with all existing drivers). Compatibility Compatible starting with Flarum 1.0. Installation composer require askvortsov/flarum-auto-moderator:* if(window.hljsLoader && !document.currentScript.parentNode.hasAttribute('data-s9e-livepreview-onupdate')) { window.hljsLoader.highlightBlocks(document.currentScript.parentNode); } Updating composer update askvortsov/flarum-auto-moderator if(window.hljsLoader && !document.currentScript.parentNode.hasAttribute('data-s9e-livepreview-onupdate')) { window.hljsLoader.highlightBlocks(document.currentScript.parentNode); } Links Packagist Github Discuss

SeguirBlog

GreXXL @askvortsov Hello, I managed to understand more or less what is the configuration that I put for a day of suspension in case the moderator does not come to do an action on the forum?

SeguirBlog

GreXXL @askvortsov
Hi I'm trying to configure here but it's not working....

Can you make an example for me to follow your tips if you can even send a print?

SeguirBlog

GreXXL @askvortsov Is the moderator automatically added according to your action?

GreXXL

SeguirBlog configuration that I put for a day of suspension in case the moderator does not come to do an action on the forum

If I understand you right, I don't think that this is currently possible. You want to suspend a user on certain behaviour automatically. I am uncertain how that behaviour should be defined and how Auto-Moderation (with its current set of actions) could assist.

PS.: Please do not do multi-posts. Read our guidelines to learn more. Especially this is applicable:

Avoid making multiple posts in a row when one would suffice. This is a forum, not a chat room.

Code1990

It's not working for me guys, I've read the entire post several times, and I don't understand why.
I'm sure I've missed something obvious, but I can't find it.

I have successfully installed the mod, but it does not appear in my list of applications.
This is my current configuration:

Flarum 1.4.1
PHP 8.1.8
MySQL 10.3.35-MariaDB

https://ibb.co/nfMPbgw

GreXXL

Code1990 please share your php flarum info output with us. Are you certain that you have been within the right folder before running the composer install command?

Code1990

GreXXL I already solved it, thank you very much, the error was that I was not specifying to composer where to install the mod.

Thanks for your reply, you were right.

SeguirBlog

GreXXL I meant thank you!

So this extension seems to help me with what I want.... I need one that controls the moderator that I see that he is always on the site and performing his actions like promoting the site

SeguirBlog

Hey @askvortsov Its extension is good, I just think I had to put one more option because it recognizes by point for the moderator to disclose by sharing the topics he earns points so this is an advantage to better publicize the forum... What do you think? What did you think of these tips? Who liked it to help spread the word like this discussion..

Chope

Hi,
Wondering if criteria like this is obtainable

if user is a member of certain user group(s)
if thread content contains like or certain words
trigger action like, suspend user and put posts to moderation.

GreXXL

Chope currently not possible with this extension. But there if FoF Filter instead, that you can use for exactly this.

CyberGene

I read about people having problems with spam and I think I may need to implement something proactively before it hits my forum. So, I have this idea: if a user receives more than X flags from at least Y users each of whom has more than Z posts (i.e. is an old and trusted member), then suspend the user. Is it possible through this extension? Also, can I count the total flags across all posts and discussion, not for a single post? And also, once I review the flagged posts and if it turns out they are OK, is it possible to somehow un-flag them, so that the extension doesn't trigger again after I remove the suspension?

GreXXL

Leaving this here - would be awesome if AutoModerator could work with AnonymousPosting: https://discuss.flarum.org/d/31151-anonymous-posting/17

hrvoje_hr

Lately, I noticed that some of my users don't get assigned to any of the Auto Moderator groups.

When the user's name is changed, they lose all Auto Moderator assigned groups
When the user's name is changed, they aren't affected by Auto Moderator anymore
When the user's name is reversed back to the original name, they still aren't affected by Auto Moderator anymore
When I use php flarum criteria:recalculate, those users are still ignored by Auto Moderator

Reported on GitHub.

CyberGene

Is there any other extension that is much simpler and that would assign newly registered users to a group and then move them to another group after certain number of posts? Nothing else, no conditions and stuff. I’ve been considering AutoModerator but seems like it’s overcomplicated and not very stable as of late.

luceos

CyberGene try https://extiverse.com/extension/fof/default-group

CyberGene

luceos thanks. And what extension can reassign them to another group after a certain number of posts?

luceos

CyberGene honestly I don't know. You could make a local extender do that, someone might be able to help you with that.

xa_sharma

hrvoje_hr

You should try php flarum criteria:recalculate .... it worked for me.

hrvoje_hr

xa_sharma I forgot to write that, even when I do that, affected users arent getting into groups either

« Previous Page Next Page »