Issues writing a bot plugin

Dave Jensen

I'm trying to write a bot plugin for NodeBB.

The idea is that you type a command and the bot responds as a reply to the post.

I'm running into a few issues.

The bot is a user account but this user account is running into rate limits. No more than 1 post per 10 seconds, etc. Can I bypass this somehow? Is there a permission I can set on the user?
I'm using the action:post.save hook and them I'm calling Topics.reply but when the user posts a reply with a bot command, the page does not refresh with the new message from the bot. Is there a way I can force a refresh?

pichalite

@djensen47 posting limits are setup in ACP. They are under ACP -> Settings -> Post

They are setup specifically to stop flooding. It's not per user though.

Dave Jensen

Where do I find ACP?

pichalite

@djensen47 it's admin control panel. Clock the cogs icon in the header after you login as admin or you can go to http://mydomain.com/admin

Dave Jensen

@pichalite Ah, okay, I just didn't recognize the acronym.

I thought it might've meant access control something.

Dave Jensen

@pichalite said:

They are setup specifically to stop flooding. It's not per user though.

Yeah, the problem is that I need to turn it off for just one user.

Is there a way I can force the reply to go through no matter what?

Also, why isn't there an error callback in the Topics.reply function?

pichalite

@djensen47 don't think you can turn it off for just one user. I think you will have to modify core to force the reply to bypass the restrictions

julian

@djensen47 said:

but when the user posts a reply with a bot command, the page does not refresh with the new message from the bot. Is there a way I can force a refresh?

Ah, the socket call to emit the event is not in Topics.reply... you'll need to manually call it:

NodeBB/src/socket.io/posts.js at master · NodeBB/NodeBB

Node.js based forum software built for the modern web - NodeBB/src/socket.io/posts.js at master · NodeBB/NodeBB

GitHub (github.com)

Make sure to structure result in the format as it is shown several lines above

Dave Jensen

@julian Thanks for the tip!

What if I want to bypass all of the checks that Topics.reply makes? Particularly the rate limiting. The code says not to use Post.create but that would bypass all checks, no?

Dave Jensen

From where can I get a handle to the current socket?

Dave Jensen

I have this working with the following …

var result = {
  posts: [postData],
  privileges: { 'topics:reply': true },
  'reputation:disabled': parseInt(Meta.config['reputation:disabled'], 10) === 1,
  'downvote:disabled': parseInt(Meta.config['downvote:disabled'], 10) === 1
};
Sockets.in('uid_'+uid).emit('event:new_post', result);

So, it appears to refresh the page with the new post but only if I scroll up or down, which is standard behavior?

Next, I'm not seeing alerts when the bot posts a message. I think this is due to the fact that I've switched to using Posts.create instead of Topics.reply

<baris>

Hmm, you could still use Topics.reply and after the post is made set the lastposttime property of the bot user to Date.now() - tenSeconds so it won't be rate limited.

Dave Jensen

@baris said:

Hmm, you could still use Topics.reply and after the post is made set the lastposttime property of the bot user to Date.now() - tenSeconds so it won't be rate limited.

That and using SocketHelpers instead of Socket.in worked like a charm. The bot response is basically instant.

Schamper

GitHub - Schamper/nodebb-plugin-botler: The Botler NodeBB plugin

The Botler NodeBB plugin. Contribute to Schamper/nodebb-plugin-botler development by creating an account on GitHub.

GitHub (github.com)

Working bot, just needs some love and a configuration page and extra handlers/events added.

Dave Jensen

@Schamper It hasn't been updated in a year. For what version does this work?

Anyway, mine seems to be working now. It's a purpose specific bot anyway (dice rolling).

Schamper

@djensen47 yep I noticed that after reading your OP more carefully. The intention of my bot was a 100% configurable bot that would be able to perform actions based on certain events happening and possibly having filters applied to it. It would be waaaay overkill for your use case.

It works in theory but I lost motivation and no one seemed interested in it at the time. If it was actually finished it could easily perform tasks like what you're writing a separate plugin for.