Merge pull request #29 from TheDevs-Network/develop

better custom commands and overall improvements

Author: poeti8

.eslintrc.json

@@ -39,7 +39,7 @@
 		"consistent-return": "error",
 		"curly": [
 			"error",
-			"all"
+			"multi-line"
 		],
 		"default-case": "error",
 		"dot-location": [

README.md

@@ -20,25 +20,29 @@ You need [Node.js](https://nodejs.org/) (> 8.1) to run this bot.
 Now you can add the bot as **administrator** to your groups.
 
 ## Commands
-Command  | Role   | Description
--------- | ------ | -----------
-`/admin` | _Master_ | Makes the user admin.
-`/unadmin` | _Master_ | Demotes the user from admin list.
-`/leave` | _Master_ | Makes the bot leave the group cleanly.
-`/warn <reason>` | _Admin_ | Warns the user.
-`/unwarn` | _Admin_ | Removes the last warn from the user.
-`/nowarns` | _Admin_ | Clears warns for the user.
-`/getwarns` | _Admin_ | Shows a list of warns for the user.
-`/ban <reason>` | _Admin_ | Bans the user from groups.
-`/unban` | _Admin_ | Removes the user from ban list.
-`/staff` | _All_ | Shows a list of admins.
-`/link` | _All_ | Show the current group's link.
-`/groups` | _All_ | Show a list of groups which the bot is admin in.
-`/report` | _All_ | Reports the replied-to message to admins.
+Command                 | Role       | Available at | Description
+----------------------- | ---------- | ------------ | -----------------
+`/admin`                | _Master_   | _Everywhere_ | Makes the user admin.
+`/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.
+`/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.
+`/link`                 | _Everyone_ | _Everywhere_ | Shows the current group's link.
+`/groups`               | _Everyone_ | _Everywhere_ | Shows a list of groups which the bot is admin in.
+`/report`               | _Everyone_ | _Everywhere_ | Reports the replied-to message to admins.
+`/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.
 
-If used by reply, `/ban` and `/warn` remove the replied-to message.
+If used by reply, `/ban` and `/warn` would remove the replied-to message.
 
 The bot is still in alpha phase so feel free to open issues and ask for a _feature_.
 

bot/index.js

@@ -1,8 +1,7 @@
 'use strict';
 
 const Telegraf = require('telegraf');
-const { loadJSON } = require('../utils/json');
-const config = loadJSON('config.json');
+const config = require('../config.json');
 
 const bot = new Telegraf(config.token);
 

handlers/commands/addCommand.js

@@ -1,24 +1,23 @@
 'use strict';
 
 // DB
-const { isAdmin } = require('../../stores/user');
 const { addCommand } = require('../../stores/command');
 
 // Bot
 const { replyOptions } = require('../../bot/options');
 
-const addCommandHandler = async ({ chat, message, reply }) => {
-	const user = message.from;
-	if (chat.type !== 'private') {
-		return null;
-	}
-	if (!await isAdmin(user)) {
+const addCommandHandler = async ({ chat, reply, state }) => {
+	const { isAdmin, user } = state;
+	if (chat.type !== 'private') return null;
+
+	if (!isAdmin) {
 		return reply('ℹ️ <b>Sorry, only admins access this command.</b>',
 			replyOptions);
 	}
 	await addCommand({ id: user.id });
-	return reply('Enter a name for the command.\n\nFor example: <b>rules</b>',
-		replyOptions);
+	return reply('Enter a name for the command without forward slash "/".' +
+		'\n\nFor example: <b>rules</b>',
+	replyOptions);
 };
 
 module.exports = addCommandHandler;

handlers/commands/admin.js

@@ -1,13 +1,9 @@
 'use strict';
 
 // Utils
-const { loadJSON } = require('../../utils/json');
 const { link } = require('../../utils/tg');
 const { logError } = require('../../utils/log');
 
-// Config
-const { masterID } = loadJSON('config.json');
-
 // Bot
 const { replyOptions } = require('../../bot/options');
 
@@ -20,16 +16,15 @@ const {
 	nowarns
 } = require('../../stores/user');
 
-const adminHandler = async ({ message, reply }) => {
-	if (message.from.id !== masterID) {
-		return null;
-	}
+const adminHandler = async ({ message, reply, state }) => {
+	const { isMaster, user } = state;
+	if (!isMaster) return null;
 
 	const userToAdmin = message.reply_to_message
 		? message.reply_to_message.from
 		: message.commandMention
 			? message.commandMention
-			: message.from;
+			: user;
 
 	if (await isBanned(userToAdmin)) {
 		return reply('ℹ️ <b>Can\'t admin banned user.</b>', replyOptions);

handlers/commands/ban.js

@@ -12,10 +12,8 @@ const { replyOptions } = require('../../bot/options');
 const { listGroups } = require('../../stores/group');
 const { isAdmin, isBanned, ban } = require('../../stores/user');
 
-const banHandler = async ({ chat, message, reply, telegram, me }) => {
-	if (!await isAdmin(message.from)) {
-		return null;
-	}
+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
@@ -69,7 +67,7 @@ const banHandler = async ({ chat, message, reply, telegram, me }) => {
 		logError(err);
 	}
 
-	return reply(`🚫 ${link(message.from)} <b>banned</b> ${link(userToBan)} ` +
+	return reply(`🚫 ${link(state.user)} <b>banned</b> ${link(userToBan)} ` +
 		`<b>for:</b>\n\n${reason}`, replyOptions);
 };
 

handlers/commands/commands.js

@@ -29,16 +29,15 @@ const actions = `\n
 /removecommand <code>&lt;name&gt;</code> - to remove a custom command.`;
 
 const commandReferenceHandler = async ({ chat, replyWithHTML }) => {
-	if (chat.type !== 'private') {
-		return null;
-	}
+	if (chat.type !== 'private') return null;
+
 	const customCommands = await listCommands();
 	const customCommandsText = customCommands.length
 		? '\n<b>Custom commands:</b>\n' +
 		customCommands
 			.filter(command => command.isActive)
 			.sort((a, b) => a.role < b.role)
-			.map(command => `[${command.role}] <code>/${command.name}</code>`)
+			.map(command => `[${command.role}] <code>!${command.name}</code>`)
 			.join('\n')
 		: '';
 

handlers/commands/getwarns.js

@@ -7,12 +7,12 @@ const { link } = require('../../utils/tg');
 const { replyOptions } = require('../../bot/options');
 
 // DB
-const { isAdmin, getWarns } = require('../../stores/user');
+const { getWarns } = require('../../stores/user');
+
+const getWarnsHandler = async ({ message, reply, state }) => {
+	const { isAdmin } = state;
+	if (!isAdmin) return null;
 
-const getWarnsHandler = async ({ message, reply }) => {
-	if (!await isAdmin(message.from)) {
-		return null;
-	}
 	const theUser = message.reply_to_message
 		? message.reply_to_message.from
 		: message.commandMention

handlers/commands/help.js

@@ -19,9 +19,8 @@ and @mattatabot might be better choices for you.
 `;
 
 const helpHandler = ({ chat, replyWithHTML }) => {
-	if (chat.type !== 'private') {
-		return null;
-	}
+	if (chat.type !== 'private') return null;
+
 	return replyWithHTML(
 		message,
 		Markup.inlineKeyboard(

handlers/commands/leave.js

@@ -1,15 +1,36 @@
 'use strict';
 
-const { masterID } = require('../../config.json');
-
-const { removeGroup } = require('../../stores/group');
+const { managesGroup, removeGroup } = require('../../stores/group');
 
 const leaveCommandHandler = async ctx => {
-	if (ctx.from.id !== masterID) {
-		return null;
+	const { chat, message, telegram, state, replyWithHTML } = ctx;
+	const { isMaster } = state;
+	if (!isMaster) return null;
+
+	const groupName = message.text.split(' ').slice(1).join(' ');
+
+	if (groupName) {
+		const group = /^-?\d+/.test(groupName)
+			? { id: Number(groupName) }
+			:	{ title: groupName };
+		console.log(group);
+		const isGroup = await managesGroup(group);
+		if (!isGroup) {
+			return replyWithHTML(
+				'ℹ️ <b>Couldn\'t find a group with that ID/name.</b>'
+			);
+		}
+		await Promise.all([
+			removeGroup(isGroup),
+			telegram.leaveChat(isGroup.id)
+		]);
+		return replyWithHTML(
+			'✅ <b>I no longer manage that group.</b>'
+		);
 	}
-	await removeGroup(ctx.chat);
-	return ctx.telegram.leaveChat(ctx.chat.id);
+
+	await removeGroup(chat);
+	return telegram.leaveChat(chat.id);
 };
 
 module.exports = leaveCommandHandler;