Merge branch 'v3'
This commit is contained in:
benji7425
commit
6f007ad8b1
|
|
@ -0,0 +1,79 @@
|
|||
### Discord bots ####
|
||||
guilds.json
|
||||
token.json
|
||||
log
|
||||
|
||||
|
||||
# Created by https://www.gitignore.io/api/node,visualstudiocode
|
||||
|
||||
### Node ###
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# nyc test coverage
|
||||
.nyc_output
|
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# Bower dependency directory (https://bower.io/)
|
||||
bower_components
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
node_cache
|
||||
node_modules/
|
||||
jspm_packages/
|
||||
|
||||
# Typescript v1 declaration files
|
||||
typings/
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional eslint cache
|
||||
.eslintcache
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# dotenv environment variables file
|
||||
.env
|
||||
|
||||
|
||||
### VisualStudioCode ###
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
.history
|
||||
|
||||
# End of https://www.gitignore.io/api/node,visualstudiocode
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
// Use IntelliSense to learn about possible Node.js debug attributes.
|
||||
// Hover to view descriptions of existing attributes.
|
||||
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"name": "Launch Program",
|
||||
"program": "${workspaceRoot}/bootstrap.js"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"files.exclude": {
|
||||
"log": true,
|
||||
".npmrc": true,
|
||||
"node_modules": true,
|
||||
"node_cache": true,
|
||||
"token.json": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Changelog
|
||||
|
||||
## Unreleased
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
//external lib imports
|
||||
const GetUrls = require("get-urls"); //for extracting urls from messages
|
||||
|
||||
//my imports
|
||||
const DiscordUtil = require("discordjs-util");
|
||||
|
||||
//app component imports
|
||||
const GuildData = require("./models/guild-data.js");
|
||||
const FeedData = require("./models/feed-data.js");
|
||||
|
||||
module.exports = {
|
||||
onReady(client, guildsData, config) {
|
||||
return new Promise((resolve, reject) => {
|
||||
parseLinksInGuilds(client.guilds, guildsData)
|
||||
.then(() => checkFeedsInGuilds(client.guilds, guildsData))
|
||||
.then(() => setInterval(() => checkFeedsInGuilds(client.guilds, guildsData), config.feedCheckIntervalSec * 1000)); //set up an interval to check all the feeds
|
||||
});
|
||||
},
|
||||
onCommand(commandObj, commandsObj, params, guildData, message, config, client, botName) {
|
||||
switch (commandObj.command) {
|
||||
case commandsObj.addFeed.command:
|
||||
return addFeed(client, guildData, message, config.maxCacheSize);
|
||||
case commandsObj.removeFeed.command:
|
||||
return removeFeed(guildData, message, botName);
|
||||
case commandsObj.viewFeeds.command:
|
||||
return viewFeeds(guildData);
|
||||
}
|
||||
},
|
||||
onNonCommandMsg(message, guildData) {
|
||||
guildData.feeds.forEach(feedData => {
|
||||
if (message.channel.name === feedData.channelName)
|
||||
feedData.cachedLinks.push(...GetUrls(message.content)); //spread the urlSet returned by GetUrls into the cache array
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
function addFeed(client, guildData, message, maxCacheSize) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const feedUrl = [...GetUrls(message.content)][0];
|
||||
const channel = message.mentions.channels.first();
|
||||
|
||||
if (!feedUrl || !channel)
|
||||
reject("Please provide both a channel and an RSS feed URL. You can optionally @mention a role also.");
|
||||
|
||||
const role = message.mentions.roles.first();
|
||||
|
||||
const feedData = new FeedData({
|
||||
url: feedUrl,
|
||||
channelName: channel.name,
|
||||
roleName: role ? role.name : null,
|
||||
maxCacheSize: maxCacheSize
|
||||
});
|
||||
|
||||
//ask the user if they're happy with the details they set up, save if yes, don't if no
|
||||
DiscordUtil.ask(client, message.channel, message.member, "Are you happy with this?\n" + feedData.toString())
|
||||
.then(responseMessage => {
|
||||
|
||||
//if they responded yes, save the feed and let them know, else tell them to start again
|
||||
if (responseMessage.content.toLowerCase() === "yes") {
|
||||
if (!guildData)
|
||||
guildData = new GuildData({ id: message.guild.id, feeds: [] });
|
||||
|
||||
guildData.feeds.push(feedData);
|
||||
resolve("Your new feed has been saved!");
|
||||
}
|
||||
else
|
||||
reject("Your feed has not been saved, please add it again with the correct details");
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function removeFeed(guildData, message, botName) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const parameters = message.content.split(" ");
|
||||
if (parameters.length !== 3)
|
||||
resolve(`Please use the command as such:\n\`\`\` ${botName} remove-feed feedid\`\`\``);
|
||||
else {
|
||||
const idx = guildData.feeds.findIndex(feed => feed.id === parameters[2]);
|
||||
if (!Number.isInteger(idx))
|
||||
reject("Can't find feed with id " + parameters[2]);
|
||||
else {
|
||||
guildData.feeds.splice(idx, 1);
|
||||
resolve("Feed removed!");
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function viewFeeds(guildData) {
|
||||
if (!guildData)
|
||||
return Promise.reject("Guild not setup");
|
||||
|
||||
return Promise.resolve(guildData.feeds.map(f => f.toString()).join("\n"));
|
||||
}
|
||||
|
||||
function checkFeedsInGuilds(guilds, guildsData) {
|
||||
Object.keys(guildsData).forEach(key => guildsData[key].checkFeeds(guilds));
|
||||
}
|
||||
|
||||
function parseLinksInGuilds(guilds, guildsData) {
|
||||
const promises = [];
|
||||
for (let guildId of guilds.keys()) {
|
||||
const guildData = guildsData[guildId];
|
||||
if (guildData)
|
||||
promises.push(guildData.cachePastPostedLinks(guilds.get(guildId)));
|
||||
}
|
||||
return Promise.all(promises);
|
||||
}
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
{
|
||||
"generic": {
|
||||
"saveFile": "./guilds.json",
|
||||
"saveIntervalSec": 60,
|
||||
"website": "https://benji7425.github.io",
|
||||
"discordInvite": "https://discord.gg/SSkbwSJ",
|
||||
"defaultDMResponse": "This bot does not have any handling for direct messages. To learn more or get help please visit %s, or join my Discord server here: %s"
|
||||
},
|
||||
"maxCacheSize": 100,
|
||||
"feedCheckIntervalSec": 30,
|
||||
"commands": {
|
||||
"version": {
|
||||
"command": "version",
|
||||
"description": "Returns the bot version",
|
||||
"syntax": "version",
|
||||
"admin": false
|
||||
},
|
||||
"help": {
|
||||
"command": "help",
|
||||
"description": "Display information about commands available to you",
|
||||
"syntax": "help",
|
||||
"admin": false
|
||||
},
|
||||
"addFeed": {
|
||||
"command": "add-feed",
|
||||
"description": "Add an RSS feed to be posted in a channel, with an optional role to tag",
|
||||
"syntax": "add-feed <url> <#channel> [@role]",
|
||||
"admin": true
|
||||
},
|
||||
"removeFeed": {
|
||||
"command": "remove-feed",
|
||||
"description": "Remove an RSS feed by it's ID",
|
||||
"syntax": "remove-feed <id>",
|
||||
"admin": true
|
||||
},
|
||||
"viewFeeds": {
|
||||
"command": "view-feeds",
|
||||
"description": "View a list of configured feeds and their associated details",
|
||||
"syntax": "view-feed",
|
||||
"admin": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,123 @@
|
|||
//node imports
|
||||
const FileSystem = require("fs"); //manage files
|
||||
const Util = require("util"); //various node utilities
|
||||
|
||||
//external lib imports
|
||||
const Discord = require("discord.js");
|
||||
const JsonFile = require("jsonfile"); //save/load data to/from json
|
||||
|
||||
//my imports
|
||||
const DiscordUtil = require("discordjs-util"); //some discordjs helper functions of mine
|
||||
|
||||
//app components
|
||||
const GuildData = require("./models/guild-data.js"); //data structure for guilds
|
||||
const PackageJSON = require("../package.json"); //used to provide some info about the bot
|
||||
const Bot = require("./bot.js");
|
||||
|
||||
//global vars
|
||||
let writeFile = null;
|
||||
|
||||
//use module.exports as a psuedo "onready" function
|
||||
module.exports = (client, config = null) => {
|
||||
config = config || require("./config.json"); //load config file
|
||||
const guildsData = FileSystem.existsSync(config.generic.saveFile) ? fromJSON(JsonFile.readFileSync(config.generic.saveFile)) : {}; //read data from file, or generate new one if file doesn't exist
|
||||
|
||||
//create our writeFile function that will allow other functions to save data to json without needing access to the full guildsData or config objects
|
||||
//then set an interval to automatically save data to file
|
||||
writeFile = () => JsonFile.writeFile(config.generic.saveFile, guildsData, err => { if (err) DiscordUtil.dateError("Error writing file", err); });
|
||||
setInterval(() => writeFile(), config.generic.saveIntervalSec * 1000);
|
||||
|
||||
//handle messages
|
||||
client.on("message", message => {
|
||||
if (message.author.id !== client.user.id) { //check the bot isn't triggering itself
|
||||
|
||||
//check whether we need to use DM or text channel handling
|
||||
if (message.channel.type === "dm")
|
||||
HandleMessage.dm(client, config, message);
|
||||
else if (message.channel.type === "text" && message.member)
|
||||
HandleMessage.text(client, config, message, guildsData);
|
||||
}
|
||||
});
|
||||
|
||||
Bot.onReady(client, guildsData, config).then(() => writeFile).catch(err => DiscordUtil.dateError(err));
|
||||
};
|
||||
|
||||
const HandleMessage = {
|
||||
dm: (client, config, message) => {
|
||||
message.reply(Util.format(config.generic.defaultDMResponse, config.generic.website, config.generic.discordInvite));
|
||||
},
|
||||
text: (client, config, message, guildsData) => {
|
||||
const isCommand = message.content.startsWith(message.guild.me.toString());
|
||||
let guildData = guildsData[message.guild.id];
|
||||
|
||||
if (!guildData)
|
||||
guildData = guildsData[message.guild.id] = new GuildData({ id: message.guild.id });
|
||||
|
||||
if (isCommand) {
|
||||
const userIsAdmin = message.member.permissions.has("ADMINISTRATOR");
|
||||
const botName = "@" + (message.guild.me.nickname || client.user.username);
|
||||
|
||||
const split = message.content.toLowerCase().split(/\ +/); //split the message at whitespace
|
||||
const command = split[1]; //extract the command used
|
||||
const commandObj = config.commands[Object.keys(config.commands).find(x => config.commands[x].command.toLowerCase() === command)]; //find the matching command object
|
||||
|
||||
if (!commandObj || (!commandObj.admin && !userIsAdmin))
|
||||
return;
|
||||
|
||||
const params = split.slice(2, split.length); //extract the parameters passed for the command
|
||||
const expectedParamCount = commandObj.syntax.split(/\ +/).length - 1; //calculate the number of expected command params
|
||||
|
||||
let finalisedParams;
|
||||
if (params.length > expectedParamCount) //if we have more params than needed
|
||||
finalisedParams = params.slice(0, expectedParamCount - 1).concat([params.slice(expectedParamCount - 1, params.length).join(" ")]);
|
||||
else //else we either have exactly the right amount, or not enough
|
||||
finalisedParams = params;
|
||||
|
||||
//find which command was used and handle it
|
||||
switch (command) {
|
||||
case config.commands.version.command:
|
||||
message.reply(`${PackageJSON.name} v${PackageJSON.version}`);
|
||||
break;
|
||||
case config.commands.help.command:
|
||||
message.channel.send(createHelpEmbed(botName, config, userIsAdmin));
|
||||
break;
|
||||
default:
|
||||
if (finalisedParams.length >= expectedParamCount)
|
||||
Bot.onCommand(commandObj, config.commands, finalisedParams, guildData, message, config, client, botName)
|
||||
.then(msg => {
|
||||
message.reply(msg);
|
||||
writeFile();
|
||||
})
|
||||
.catch(err => {
|
||||
message.reply(err);
|
||||
DiscordUtil.dateError(err);
|
||||
});
|
||||
else
|
||||
message.reply(`Incorrect syntax!\n**Expected:** *${botName} ${commandObj.syntax}*\n**Need help?** *${botName} ${config.commands.help.command}*`);
|
||||
break;
|
||||
}
|
||||
}
|
||||
else
|
||||
Bot.onNonCommandMsg(message, guildData);
|
||||
}
|
||||
};
|
||||
|
||||
function fromJSON(json) {
|
||||
const guildsData = Object.keys(json);
|
||||
guildsData.forEach(guildID => { json[guildID] = new GuildData(json[guildID]); });
|
||||
return json;
|
||||
}
|
||||
|
||||
function createHelpEmbed(name, config, userIsAdmin) {
|
||||
const commandsArr = Object.keys(config.commands).map(x => config.commands[x]).filter(x => userIsAdmin || !x.admin);
|
||||
|
||||
const embed = new Discord.RichEmbed().setTitle("__Help__");
|
||||
|
||||
commandsArr.forEach(command => {
|
||||
embed.addField(command.command, `${command.description}\n**Usage:** *${name} ${command.syntax}*${userIsAdmin && command.admin ? "\n***Admin only***" : ""}`);
|
||||
});
|
||||
|
||||
embed.addField("__Need more help?__", `[Visit my website](${config.generic.website}) or [Join my Discord](${config.generic.discordInvite})`, true);
|
||||
|
||||
return { embed };
|
||||
}
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
//my imports
|
||||
const DiscordUtil = require("discordjs-util");
|
||||
|
||||
//external lib imports
|
||||
const Dns = require("dns"); //for host resolution checking
|
||||
const Url = require("url"); //for url parsing
|
||||
const FeedRead = require("feed-read"); //for extracing new links from RSS feeds
|
||||
const GetUrls = require("get-urls"); //for extracting urls from messages
|
||||
const ShortID = require("shortid"); //to provide ids for each feed, allowing guilds to remove them
|
||||
|
||||
module.exports = class FeedData {
|
||||
constructor({ id, url, channelName, roleName, cachedLinks, maxCacheSize }) {
|
||||
this.id = id || ShortID.generate();
|
||||
this.url = url;
|
||||
this.channelName = channelName;
|
||||
this.roleName = roleName;
|
||||
this.cachedLinks = cachedLinks || [];
|
||||
this.maxCacheSize = maxCacheSize || 10;
|
||||
|
||||
this.cachedLinks.push = (...elements) => {
|
||||
const unique = elements
|
||||
.map(el => normaliseUrl(el)) //normalise all the urls
|
||||
.filter(el => !this.cachedLinks.includes(el)); //filter out any already cached
|
||||
Array.prototype.push.apply(this.cachedLinks, unique);
|
||||
|
||||
if (this.cachedLinks.length > this.maxCacheSize)
|
||||
this.cachedLinks.splice(0, this.cachedLinks.length - this.maxCacheSize); //remove the # of elements above the max from the beginning
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a promise providing all the links posted in the last 100 messages
|
||||
* @param {Discord.Guild} guild The guild this feed belongs to
|
||||
* @returns {Promise<string[]>} Links posted in last 100 messages
|
||||
*/
|
||||
updatePastPostedLinks(guild) {
|
||||
const channel = guild.channels.find(ch => ch.type === "text" && ch.name === this.channelName);
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
channel.fetchMessages({ limit: 100 })
|
||||
.then(messages => {
|
||||
new Map([...messages].reverse()).forEach(m => this.cachedLinks.push(...GetUrls(m.content))); //push all the links in each message into our links array
|
||||
resolve(this);
|
||||
})
|
||||
.catch(reject);
|
||||
});
|
||||
}
|
||||
|
||||
check(guild) {
|
||||
Dns.resolve(Url.parse(this.url).host || "", err => { //check we can resolve the host, so we can throw an appropriate error if it fails
|
||||
if (err)
|
||||
DiscordUtil.dateError("Connection Error: Can't resolve host", err); //log our error if we can't resolve the host
|
||||
else
|
||||
FeedRead(this.url, (err, articles) => { //check the feed
|
||||
if (err)
|
||||
DiscordUtil.dateError(err);
|
||||
else {
|
||||
let latest = articles[0].link; //extract the latest link
|
||||
latest = normaliseUrl(latest); //standardise it a bit
|
||||
|
||||
//if we don't have it cached already, cache it and callback
|
||||
if (!this.cachedLinks.includes(latest)) {
|
||||
this.cachedLinks.push(latest);
|
||||
|
||||
const channel = guild.channels.find(ch => ch.type === "text" && ch.name.toLowerCase() === this.channelName.toLowerCase());
|
||||
const role = this.roleName ? guild.roles.find(role => role.name.toLowerCase() === this.roleName.toLowerCase()) : null;
|
||||
channel.send((role ? role + " " : "") + latest);
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
toString() {
|
||||
const blacklist = ["cachedLinks", "maxCacheSize"];
|
||||
return `\`\`\`JavaScript\n ${JSON.stringify(this, (k, v) => !blacklist.includes(k) ? v : undefined, "\t")} \`\`\``;
|
||||
}
|
||||
};
|
||||
|
||||
function normaliseUrl(url) {
|
||||
url = url.replace("https://", "http://"); //cheaty way to get around http and https not matching
|
||||
|
||||
if (Url.parse(url).host.includes("youtu")) //detect youtu.be and youtube.com - yes I know it's hacky
|
||||
url = url.split("&")[0]; //quick way to chop off stuff like &feature=youtube
|
||||
|
||||
url = url.replace(/(www.)?youtube.com\/watch\?v=/, "youtu.be/"); //turn full url into share url
|
||||
|
||||
return url;
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
const FeedData = require("./feed-data.js");
|
||||
const Util = require("discordjs-util");
|
||||
|
||||
module.exports = class GuildData {
|
||||
constructor({ id, feeds }) {
|
||||
this.id = id;
|
||||
this.feeds = feeds.map(feed => new FeedData(feed));
|
||||
}
|
||||
|
||||
cachePastPostedLinks(guild) {
|
||||
const promises = [];
|
||||
|
||||
this.feeds.forEach(feed => {
|
||||
promises.push(feed.updatePastPostedLinks(guild).catch(Util.dateError));
|
||||
});
|
||||
|
||||
return Promise.all(promises);
|
||||
}
|
||||
|
||||
checkFeeds(guilds) {
|
||||
this.feeds.forEach(feed => feed.check(guilds.get(this.id)));
|
||||
}
|
||||
};
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
const Discord = require("discord.js");
|
||||
const DiscordUtil = require("discordjs-util");
|
||||
|
||||
const client = new Discord.Client();
|
||||
|
||||
process.on("uncaughtException", (err) => {
|
||||
DiscordUtil.dateError("Uncaught exception!", err);
|
||||
});
|
||||
|
||||
client.login(require("./token.json").token);
|
||||
|
||||
client.on("ready", () => {
|
||||
DiscordUtil.dateLog("Registered bot " + client.user.username);
|
||||
require("./app/index.js")(client);
|
||||
client.user.setPresence({ game: { name: "benji7425.github.io", type: 0 } });
|
||||
});
|
||||
|
||||
client.on("disconnect", eventData => {
|
||||
DiscordUtil.dateError("Bot was disconnected!", eventData.code, eventData.reason);
|
||||
});
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"version": "3.0.0-b1",
|
||||
"main": "app/index.js",
|
||||
"scripts": {
|
||||
"start": "node bootstrap.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"discord.js": "11.1.0",
|
||||
"discordjs-util": "git+https://github.com/benji7425/discordjs-util.git",
|
||||
"feed-read": "0.0.1",
|
||||
"get-urls": "7.0.0",
|
||||
"jsonfile": "3.0.1",
|
||||
"shortid": "2.2.8"
|
||||
},
|
||||
"name": "discord-bot-rss-feed",
|
||||
"devDependencies": {},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/benji7425/discord-bot-rss-feed.git"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/benji7425/discord-bot-rss-feed/issues"
|
||||
},
|
||||
"homepage": "https://github.com/benji7425/discord-bot-rss-feed#readme",
|
||||
"description": ""
|
||||
}
|
||||
Loading…
Reference in New Issue