clean this up when home

1 files changed, 357 insertions, 0 deletions

diff --git a/src/utils.js b/src/utils.js
new file mode 100644
index 0000000..3e475ab
--- /dev/null
+++ b/src/utils.js
@@ -0,0 +1,357 @@
+const Eris = require('eris');
+const bot = require('./bot');
+const moment = require('moment');
+const humanizeDuration = require('humanize-duration');
+const publicIp = require('public-ip');
+const config = require('./config');
+
+class BotError extends Error {}
+
+const userMentionRegex = /^<@!?([0-9]+?)>$/;
+
+let inboxGuild = null;
+let mainGuilds = [];
+let logChannel = null;
+
+/**
+ * @returns {Eris~Guild}
+ */
+function getInboxGuild() {
+  if (! inboxGuild) inboxGuild = bot.guilds.find(g => g.id === config.mailGuildId);
+  if (! inboxGuild) throw new BotError('The bot is not on the modmail (inbox) server!');
+  return inboxGuild;
+}
+
+/**
+ * @returns {Eris~Guild[]}
+ */
+function getMainGuilds() {
+  if (mainGuilds.length === 0) {
+    mainGuilds = bot.guilds.filter(g => config.mainGuildId.includes(g.id));
+  }
+
+  if (mainGuilds.length !== config.mainGuildId.length) {
+    if (config.mainGuildId.length === 1) {
+      console.warn(`[WARN] The bot hasn't joined the main guild!`);
+    } else {
+      console.warn(`[WARN] The bot hasn't joined one or more main guilds!`);
+    }
+  }
+
+  return mainGuilds;
+}
+
+/**
+ * Returns the designated log channel, or the default channel if none is set
+ * @returns {Eris~TextChannel}
+ */
+function getLogChannel() {
+  const inboxGuild = getInboxGuild();
+  const logChannel = inboxGuild.channels.get(config.logChannelId);
+
+  if (! logChannel) {
+    throw new BotError('Log channel (logChannelId) not found!');
+  }
+
+  if (! (logChannel instanceof Eris.TextChannel)) {
+    throw new BotError('Make sure the logChannelId option is set to a text channel!');
+  }
+
+  return logChannel;
+}
+
+function postLog(...args) {
+  getLogChannel().createMessage(...args);
+}
+
+function postError(channel, str, opts = {}) {
+  return channel.createMessage({
+    ...opts,
+    content: `⚠ ${str}`
+  });
+}
+
+/**
+ * Returns whether the given member has permission to use modmail commands
+ * @param member
+ * @returns {boolean}
+ */
+function isStaff(member) {
+  if (! member) return false;
+  if (config.inboxServerPermission.length === 0) return true;
+
+  return config.inboxServerPermission.some(perm => {
+    if (isSnowflake(perm)) {
+      // If perm is a snowflake, check it against the member's user id and roles
+      if (member.id === perm) return true;
+      if (member.roles.includes(perm)) return true;
+    } else {
+      // Otherwise assume perm is the name of a permission
+      return member.permission.has(perm);
+    }
+
+    return false;
+  });
+}
+
+/**
+ * Returns whether the given message is on the inbox server
+ * @param msg
+ * @returns {boolean}
+ */
+function messageIsOnInboxServer(msg) {
+  if (! msg.channel.guild) return false;
+  if (msg.channel.guild.id !== getInboxGuild().id) return false;
+  return true;
+}
+
+/**
+ * Returns whether the given message is on the main server
+ * @param msg
+ * @returns {boolean}
+ */
+function messageIsOnMainServer(msg) {
+  if (! msg.channel.guild) return false;
+
+  return getMainGuilds()
+    .some(g => msg.channel.guild.id === g.id);
+}
+
+/**
+ * @param attachment
+ * @returns {Promise<string>}
+ */
+async function formatAttachment(attachment, attachmentUrl) {
+  let filesize = attachment.size || 0;
+  filesize /= 1024;
+
+  return `**Attachment:** ${attachment.filename} (${filesize.toFixed(1)}KB)\n${attachmentUrl}`;
+}
+
+/**
+ * Returns the user ID of the user mentioned in str, if any
+ * @param {String} str
+ * @returns {String|null}
+ */
+function getUserMention(str) {
+  if (! str) return null;
+
+  str = str.trim();
+
+  if (isSnowflake(str)) {
+    // User ID
+    return str;
+  } else {
+    let mentionMatch = str.match(userMentionRegex);
+    if (mentionMatch) return mentionMatch[1];
+  }
+
+  return null;
+}
+
+/**
+ * Returns the current timestamp in an easily readable form
+ * @returns {String}
+ */
+function getTimestamp(...momentArgs) {
+  return moment.utc(...momentArgs).format('HH:mm');
+}
+
+/**
+ * Disables link previews in the given string by wrapping links in < >
+ * @param {String} str
+ * @returns {String}
+ */
+function disableLinkPreviews(str) {
+  return str.replace(/(^|[^<])(https?:\/\/\S+)/ig, '$1<$2>');
+}
+
+/**
+ * Returns a URL to the bot's web server
+ * @param {String} path
+ * @returns {Promise<String>}
+ */
+async function getSelfUrl(path = '') {
+  if (config.url) {
+    return `${config.url}/${path}`;
+  } else {
+    const port = config.port || 8890;
+    const ip = await publicIp.v4();
+    return `http://${ip}:${port}/${path}`;
+  }
+}
+
+/**
+ * Returns the highest hoisted role of the given member
+ * @param {Eris~Member} member
+ * @returns {Eris~Role}
+ */
+function getMainRole(member) {
+  const roles = member.roles.map(id => member.guild.roles.get(id));
+  roles.sort((a, b) => a.position > b.position ? -1 : 1);
+  return roles.find(r => r.hoist);
+}
+
+/**
+ * Splits array items into chunks of the specified size
+ * @param {Array|String} items
+ * @param {Number} chunkSize
+ * @returns {Array}
+ */
+function chunk(items, chunkSize) {
+  const result = [];
+
+  for (let i = 0; i < items.length; i += chunkSize) {
+    result.push(items.slice(i, i + chunkSize));
+  }
+
+  return result;
+}
+
+/**
+ * Trims every line in the string
+ * @param {String} str
+ * @returns {String}
+ */
+function trimAll(str) {
+  return str
+    .split('\n')
+    .map(str => str.trim())
+    .join('\n');
+}
+
+const delayStringRegex = /^([0-9]+)(?:([dhms])[a-z]*)?/i;
+
+/**
+ * Turns a "delay string" such as "1h30m" to milliseconds
+ * @param {String} str
+ * @returns {Number|null}
+ */
+function convertDelayStringToMS(str) {
+  let match;
+  let ms = 0;
+
+  str = str.trim();
+
+  while (str !== '' && (match = str.match(delayStringRegex)) !== null) {
+    if (match[2] === 'd') ms += match[1] * 1000 * 60 * 60 * 24;
+    else if (match[2] === 'h') ms += match[1] * 1000 * 60 * 60;
+    else if (match[2] === 's') ms += match[1] * 1000;
+    else if (match[2] === 'm' || ! match[2]) ms += match[1] * 1000 * 60;
+
+    str = str.slice(match[0].length);
+  }
+
+  // Invalid delay string
+  if (str !== '') {
+    return null;
+  }
+
+  return ms;
+}
+
+function getInboxMention() {
+  const mentionRoles = Array.isArray(config.mentionRole) ? config.mentionRole : [config.mentionRole];
+  const mentions = [];
+  for (const role of mentionRoles) {
+    if (role == null) continue;
+    else if (role === 'here') mentions.push('@here');
+    else if (role === 'everyone') mentions.push('@everyone');
+    else mentions.push(`<@&${role}>`);
+  }
+  return mentions.join(' ') + ' ';
+}
+
+function postSystemMessageWithFallback(channel, thread, text) {
+  if (thread) {
+    thread.postSystemMessage(text);
+  } else {
+    channel.createMessage(text);
+  }
+}
+
+/**
+ * A normalized way to set props in data models, fixing some inconsistencies between different DB drivers in knex
+ * @param {Object} target
+ * @param {Object} props
+ */
+function setDataModelProps(target, props) {
+  for (const prop in props) {
+    if (! props.hasOwnProperty(prop)) continue;
+    // DATETIME fields are always returned as Date objects in MySQL/MariaDB
+    if (props[prop] instanceof Date) {
+      // ...even when NULL, in which case the date's set to unix epoch
+      if (props[prop].getUTCFullYear() === 1970) {
+        target[prop] = null;
+      } else {
+        // Set the value as a string in the same format it's returned in SQLite
+        target[prop] = moment.utc(props[prop]).format('YYYY-MM-DD HH:mm:ss');
+      }
+    } else {
+      target[prop] = props[prop];
+    }
+  }
+}
+
+const snowflakeRegex = /^[0-9]{17,}$/;
+function isSnowflake(str) {
+  return str && snowflakeRegex.test(str);
+}
+
+const humanizeDelay = (delay, opts = {}) => humanizeDuration(delay, Object.assign({conjunction: ' and '}, opts));
+
+const markdownCharsRegex = /([\\_*|`~])/g;
+function escapeMarkdown(str) {
+  return str.replace(markdownCharsRegex, '\\$1');
+}
+
+function disableCodeBlocks(str) {
+  return str.replace(/`/g, "`\u200b");
+}
+
+/**
+ *
+ */
+function readMultilineConfigValue(str) {
+  return Array.isArray(str) ? str.join('\n') : str;
+}
+
+module.exports = {
+  BotError,
+
+  getInboxGuild,
+  getMainGuilds,
+  getLogChannel,
+  postError,
+  postLog,
+
+  isStaff,
+  messageIsOnInboxServer,
+  messageIsOnMainServer,
+
+  formatAttachment,
+
+  getUserMention,
+  getTimestamp,
+  disableLinkPreviews,
+  getSelfUrl,
+  getMainRole,
+  delayStringRegex,
+  convertDelayStringToMS,
+  getInboxMention,
+  postSystemMessageWithFallback,
+
+  chunk,
+  trimAll,
+
+  setDataModelProps,
+
+  isSnowflake,
+
+  humanizeDelay,
+
+  escapeMarkdown,
+  disableCodeBlocks,
+
+  readMultilineConfigValue,
+};