Merge branch 'develop'

Author: wojpawlik

.eslintignore

@@ -0,0 +1,4 @@
+# Don't lint plugins
+plugins/*
+# ...but do lint plugin loader
+!plugins/index.js

.eslintrc.json

@@ -26,7 +26,7 @@
 			"error",
 			"always"
 		],
-		"no-console": "off",
+		"no-console": [ "error", { "allow": [ "assert" ] } ],
 		"for-direction": "error",
 		"no-await-in-loop": "error",
 		"no-extra-parens": "error",
@@ -153,6 +153,7 @@
 				"allowArrowFunctions": true
 			}
 		],
+		"function-paren-newline": ["error", "multiline"],
 		"key-spacing": "error",
 		"keyword-spacing": "error",
 		"lines-around-comment": "error",
@@ -278,4 +279,4 @@
 		"symbol-description": "error",
 		"template-curly-spacing": "error"
 	}
-}
+}

README.md

@@ -19,18 +19,31 @@ You need [Node.js](https://nodejs.org/) (> 8.1) to run this bot.
 
 Now you can add the bot as **administrator** to your groups.
 
+## Features
+* Synchronized database accross multiple groups.
+* Adding admins to the bot.
+* Auto-remove and warn channels and groups ads.
+* Kick bots added by users.
+* Warn and ban users to controll the group.
+* Commands work with replying, mentioning and ID.
+* Removes commands and temporary bot messages.
+* Ability to create custom commands.
+* Supports plugins.
+
+Overally, keeps the groups clean and healthy to use.
+
 ## Commands
 Command                 | Role       | Available at | Description
 ----------------------- | ---------- | ------------ | -----------------
-`/admin`                | _Master_   | _Everywhere_ | Makes the user admin.
+`/admin`                | _Master_   | _Everywhere_ | Makes the user admin in the bot and groups.
 `/unadmin`              | _Master_   | _Everywhere_ | Demotes the user from admin list.
 `/leave <name\|id>`     | _Master_   | _Everywhere_ | Make the bot to leave the group cleanly.
 `/warn <reason>`        | _Admin_    | _Groups_     | Warns the user.
 `/unwarn`               | _Admin_    | _Everywhere_ | Removes the last warn from the user.
 `/nowarns`              | _Admin_    | _Everywhere_ | Clears warns for the user.
-`/getwarns`             | _Admin_    | _Everywhere_ | Shows a list of warns for the user.
 `/ban <reason>`         | _Admin_    | _Groups_     | Bans the user from groups.
 `/unban`                | _Admin_    | _Everywhere_ | Removes the user from ban list.
+`/user`                 | _Admin_    | _Everywhere_ | Shows the status of the user.
 `/addcommand`           | _Admin_    | _In-Bot_     | Create a custom command.
 `/removecommand <name>` | _Admin_    | _In-Bot_     | Remove a custom command.
 `/staff`                | _Everyone_ | _Everywhere_ | Shows a list of admins.
@@ -40,7 +53,7 @@ Command                 | Role       | Available at | Description
 `/commands`             | _Everyone_ | _In-Bot_     | Shows a list of available commands.
 `/help` \| `/start`     | _Everyone_ | _In-Bot_     | How to use the bot.
 
-All commands and actions are synchronized across all of the groups managed by the owner and they work with both **replying** and **mentioning** a user.
+All commands and actions are synchronized across all of the groups managed by the owner and they work with **replying**, **mentioning** or **ID** of a user.
 
 If used by reply, `/ban` and `/warn` would remove the replied-to message.
 

bot/index.js

@@ -5,6 +5,10 @@ const config = require('../config.json');
 
 const bot = new Telegraf(config.token);
 
+if (process.env.NODE_ENV === 'development') {
+	bot.state.offset = -1;
+}
+
 module.exports = bot;
 
 

config.example.json

@@ -1,8 +1,17 @@
 {
 	"master": 123456789, // master admin ID as a number or username as astring.
 	"token": "", // bot token.
+	"plugins": [], // list of plugin names to be loaded
+
+	"deleteCommands": "own", // which messages with commands should be deleted?
+		// valid options: "all", "own" (leave commands meant for other bots, this is the default), "none".
+
 	"numberOfWarnsToBan": 3, // Number of warns that will get someone banned.
 	"groupsInlineKeyboard": [], // [[inlineButton]] -> inline keyboard to be added to reply to /groups
-	"excludedChannels": [], // [String] -> list of channels usernames to be excluded from warnings, use "*" to disable this feature.
-	"excludedGroups": [] // [String] -> list of groups links to be excluded from warnings, use "*" to disable this feature.
+	"warnInlineKeyboard": [], // [[inlineButton]] -> inline keyboard to be added to warn message
+
+	// [String] -> list of channels or groups links/usernames that you want to be excluded from warnings
+	//  use "*" to disable this feature.
+	"excludedChannels": [],
+	"excludedGroups": []
 }

handlers/commands/addCommand.js

@@ -11,13 +11,17 @@ const addCommandHandler = async ({ chat, reply, state }) => {
 	if (chat.type !== 'private') return null;
 
 	if (!isAdmin) {
-		return reply('ℹ️ <b>Sorry, only admins access this command.</b>',
-			replyOptions);
+		return reply(
+			'ℹ️ <b>Sorry, only admins access this command.</b>',
+			replyOptions
+		);
 	}
 	await addCommand({ id: user.id });
-	return reply('Enter a name for the command without forward slash "/".' +
+	return reply(
+		'Enter a name for the command without forward slash "/".' +
 		'\n\nFor example: <b>rules</b>',
-	replyOptions);
+		replyOptions
+	);
 };
 
 module.exports = addCommandHandler;

handlers/commands/admin.js

@@ -31,8 +31,10 @@ const adminHandler = async ({ message, reply, state }) => {
 	}
 
 	if (await isAdmin(userToAdmin)) {
-		return reply(`⭐️ ${link(userToAdmin)} <b>is already admin.</b>`,
-			replyOptions);
+		return reply(
+			`⭐️ ${link(userToAdmin)} <b>is already admin.</b>`,
+			replyOptions
+		);
 	}
 
 	if (await getWarns(userToAdmin)) {

handlers/commands/ban.js

@@ -1,7 +1,7 @@
 'use strict';
 
 // Utils
-const { link } = require('../../utils/tg');
+const { link, scheduleDeletion } = require('../../utils/tg');
 const { logError } = require('../../utils/log');
 
 // Bot
@@ -13,41 +13,50 @@ const { listGroups } = require('../../stores/group');
 const { isAdmin, isBanned, ban } = require('../../stores/user');
 
 const banHandler = async ({ chat, message, reply, telegram, me, state }) => {
-	if (!state.isAdmin) return null;
-
 	const userToBan = message.reply_to_message
 		? message.reply_to_message.from
 		: message.commandMention
 			? message.commandMention
 			: null;
 	const reason = message.text.split(' ').slice(1).join(' ').trim();
 
-	if (!userToBan) {
-		return reply('ℹ️ <b>Reply to a message or mention a user.</b>',
-			replyOptions);
+	if (!state.isAdmin || userToBan.username === me) return null;
+
+	if (message.chat.type === 'private') {
+		return reply(
+			'ℹ️ <b>This command is only available in groups.</b>',
+			replyOptions
+		);
 	}
 
-	if (message.chat.type === 'private' || userToBan.username === me) {
-		return null;
+	if (!userToBan) {
+		return reply(
+			'ℹ️ <b>Reply to a message or mention a user.</b>',
+			replyOptions
+		).then(scheduleDeletion);
 	}
 
 	if (await isAdmin(userToBan)) {
 		return reply('ℹ️ <b>Can\'t ban other admins.</b>', replyOptions);
 	}
 
 	if (reason.length === 0) {
-		return reply('ℹ️ <b>Need a reason to ban.</b>', replyOptions);
+		return reply('ℹ️ <b>Need a reason to ban.</b>', replyOptions)
+			.then(scheduleDeletion);
 	}
 
 	if (message.reply_to_message) {
 		bot.telegram.deleteMessage(
 			chat.id,
-			message.reply_to_message.message_id);
+			message.reply_to_message.message_id
+		);
 	}
 
 	if (await isBanned(userToBan)) {
-		return reply(`🚫 ${link(userToBan)} <b>is already banned.</b>`,
-			replyOptions);
+		return reply(
+			`🚫 ${link(userToBan)} <b>is already banned.</b>`,
+			replyOptions
+		);
 	}
 
 	try {

handlers/commands/commands.js

@@ -13,9 +13,9 @@ const commandReference = `\
 <code>/warn &lt;reason&gt;</code> - Warns the user.
 <code>/unwarn</code> - Removes the last warn from the user.
 <code>/nowarns</code> - Clears warns for the user.
-<code>/getwarns</code> - Shows a list of warns for the user.
 <code>/ban &lt;reason&gt;</code> - Bans the user from groups.
 <code>/unban</code> - Removes the user from ban list.
+<code>/user</code> - Shows user's status and warns.
 
 <b>Commands for everyone</b>:
 <code>/staff</code> - Shows a list of admins.
@@ -25,8 +25,8 @@ const commandReference = `\
 `;
 
 const actions = `\n
-/addcommand - to create custom commands.
-/removecommand <code>&lt;name&gt;</code> - to remove a custom command.`;
+<code>/addcommand</code> - to create custom commands.
+<code>/removecommand &lt;name&gt;</code> - to remove a custom command.`;
 
 const commandReferenceHandler = async ({ chat, replyWithHTML }) => {
 	if (chat.type !== 'private') return null;