Auto Response Based on Keyword

Liberdy

Hey all,

Is there an extension - that I'm possibly missing through my searches - that allows for an auto response based on a keyword such as #Info?

luceos

Liberdy you can put the following in the extend.php in your installation path. Put it between the [ and ].

    (new Extend\Event())
        ->listen(\Flarum\Post\Event\Posted::class, function (\Flarum\Post\Event\Posted $event) {
            if ($event->post->type === 'comment' && str_contains($event->post->content, '#Info')) {
                \Flarum\Post\CommentPost::reply(
                    $event->post->discussion_id,
                    <<<EOM
### Hi there,

You can find more information on this page: https://flarum.org!
EOM,
                    1
                );
            }
        }),

Modify the text (between <<<EOM and EOM) and the user id (1) as which to post. This should work (untested).

Liberdy

luceos

You're awesome, thank you!

Liberdy

luceos

I changed the script a little bit to organize the multitude of responses for various keywords. But for some reason, despite everything working as it should - I cannot seem to get my designated User to auto respond. Here's what my adjusted script looks like:

Some additional information:

I've verified that the appropriate permissions have been set on the new sub-directory.
I took out my public-facing IP address in the script below, but I can ensure you that it's provided in the one I'm trying to utilize.

return [
    (new Extend\Event())
        ->listen(\Flarum\Post\Event\Posted::class, function (\Flarum\Post\Event\Posted $event) {
            if ($event->post->type === 'comment') {
                $keywords = ['!keyword0', '!keyword1'; // List of keywords to listen for, add more as necessary.

                foreach ($keywords as $keyword) {
                    if (str_contains($event->post->content, $keyword)) {

                        $filesystem = new Filesystem();
                        $responsePath = base_path('./auto_responses'); // The local path where the "auto response" files exist.
                        $responseFile = $responsePath . '/' . substr($keyword, 1) . '.txt';

                        if ($filesystem->exists($responseFile)) {
                            $response = $filesystem->get($responseFile);

                            \Flarum\Post\CommentPost::reply($event->post->discussion_id, $response, 2, 'my.ip.address', $event->actor); //Posts a comment, using the corresponding "auto response" file.

                        }

                        break;
                    }
                }
            }
        }),
];

Liberdy

After troubleshooting my code for several hours - PHP is definitely not my forte by any means. I finally have a working "AutoMod". Basically this script can be copy and pasted directly within your Extend.php file located within the root directory of your Flarum instance.

How it works:

Create a sub-directory in the root directory of Flarum called "auto_responses" (make sure you assign the appropriate permissions to the sub-directory).
Within the "auto-responses" sub-directory, place standard ".txt" files with your pre-canned responses you want the AutoMod to utilize. You'll need to keep these files and the keywords you want to utilize to activate the bot the same. So for example, if you have "!keyword0" to activate the bot, you'll need a corresponding "keyword0.txt" file within the auto_responses sub-directory.
The only change you should have to make inside the script, is ensuring that you setup your keywords in the keyword library section of the script (everything is commented out, so it should be easy enough to find and edit).

<?php

use Flarum\Extend;
use Illuminate\Filesystem\Filesystem;
use Carbon\Carbon;
use Flarum\Discussion\Event\Started;
use Flarum\Foundation\DispatchEventsTrait;
use Flarum\Post\CommentPost;
use Flarum\Settings\SettingsRepositoryInterface;
use Flarum\User\Exception\PermissionDeniedException;
use Flarum\User\User;
use Illuminate\Contracts\Events\Dispatcher;


return [
    (new Extend\Event())
        ->listen(\Flarum\Post\Event\Posted::class, function (\Flarum\Post\Event\Posted $event) {
            if ($event->post->type === 'comment') {
                $keywords = ['!keyword0', '!keyword1']; // Keyword Library, this is where you'll put all of your keywords the AutoMod will listen for. These are Case-SeNsItIvE so be diligent.

				// This portion of the script references the "auto_responses" sub-folder located in the root directory of your Flarum instance.
                foreach ($keywords as $keyword) {
                    if (str_contains($event->post->content, $keyword)) {
						$filesystem = new Filesystem();
						$responsePath = base_path('./auto_responses'); //You'll need to edit the "base_path" if you decide to place your auto_responses directory anywhere else, or decide to re-name it.
						$responseFile = $responsePath . '/' . substr($keyword, 1) . '.txt';
					
						$userId = 3; //Change this to the userId of your "AutoMod", basically this is any user that you've already created within Flarum.
						$user = User::find($userId); //Primary method for finding the userId.
						$discussion = $event->post->discussion; //Primary method for finding the discussionId.
						$actor = $event->post->actor; //Fall-back method, in the event the userId fails for some reason.
						$userPromptId = $user ? $user->id : $actor->id; //This will utilize three different methods to ensure that the "AutoMod" user actually appears as the reply entity.

						
						if ($filesystem->exists($responseFile)) {
							$response = $filesystem->get($responseFile);
							
							// This portion of the script posts a reply to the discussion that called the Keyword from your Keyword Library.
							$post = CommentPost::reply(
							$discussion->id,
							$response,
							$userPromptId,
							null,
							);

						$post->created_at = Carbon::now();

						$post->save();
					}
				}
			}
		}
	}),	
];