Latest dev sync

2022-06-22 11:32:51 -05:00
parent 39b47554b8
commit 2bbb507f01
180 changed files with 50855 additions and 4416 deletions
@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: mod/speak.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Source: mod/speak.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/* eslint no-param-reassign: 0 */
+
+/**
+  * @author OpSimple ( https://github.com/OpSimple )
+  * @summary Unmuzzle a user
+  * @version 1.0.0
+  * @description Pardon a dumb user to be able to speak again
+  * @module speak
+  */
+
+import {
+  isModerator,
+} from '../utility/_UAC.js';
+
+/**
+  * Automatically executes once after server is ready
+  * @param {Object} core - Reference to core enviroment object
+  * @public
+  * @return {void}
+  */
+export function init(core) {
+  if (typeof core.muzzledHashes === 'undefined') {
+    core.muzzledHashes = {};
+  }
+}
+
+/**
+  * Executes when invoked by a remote client
+  * @param {Object} env - Enviroment object with references to core, server, socket &amp; payload
+  * @public
+  * @return {void}
+  */
+export async function run({
+  core, server, socket, payload,
+}) {
+  // increase rate limit chance and ignore if not admin or mod
+  if (!isModerator(socket.level)) {
+    return server.police.frisk(socket.address, 10);
+  }
+
+  // check user input
+  if (typeof payload.ip !== 'string' &amp;&amp; typeof payload.hash !== 'string') {
+    return server.reply({
+      cmd: 'warn', // @todo Add numeric error code as `id`
+      text: "hash:'targethash' or ip:'1.2.3.4' is required",
+      channel: socket.channel, // @todo Multichannel
+    }, socket);
+  }
+
+  if (typeof payload.ip === 'string') {
+    if (payload.ip === '*') {
+      core.muzzledHashes = {};
+
+      return server.broadcast({
+        cmd: 'info',
+        text: `${socket.nick} unmuzzled all users`,
+        channel: false, // @todo Multichannel, false for global
+      }, { level: isModerator });
+    }
+  } else if (payload.hash === '*') {
+    core.muzzledHashes = {};
+
+    return server.broadcast({
+      cmd: 'info',
+      text: `${socket.nick} unmuzzled all users`,
+      channel: false, // @todo Multichannel, false for global
+    }, { level: isModerator });
+  }
+
+  // find target &amp; remove mute status
+  let target;
+  if (typeof payload.ip === 'string') {
+    target = server.getSocketHash(payload.ip);
+  } else {
+    target = payload.hash;
+  }
+
+  delete core.muzzledHashes[target];
+
+  // notify mods
+  server.broadcast({
+    cmd: 'info',
+    text: `${socket.nick}#${socket.trip} unmuzzled : ${target}`,
+    channel: false, // @todo Multichannel, false for global
+  }, { level: isModerator });
+
+  return true;
+}
+
+/**
+  * Module meta information
+  * @public
+  * @typedef {Object} speak/info
+  * @property {string} name - Module command name
+  * @property {string} category - Module category name
+  * @property {string} description - Information about module
+  * @property {string} usage - Information about module usage
+  */
+export const info = {
+  name: 'speak',
+  category: 'moderators',
+  description: 'Pardon a dumb user to be able to speak again',
+  aliases: ['unmuzzle', 'unmute'],
+  usage: `
+    API: { cmd: 'speak', ip/hash: '&lt;target ip or hash' }`,
+};
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-addmod.html">addmod</a></li><li><a href="module-ban.html">ban</a></li><li><a href="module-changecolor.html">changecolor</a></li><li><a href="module-changenick.html">changenick</a></li><li><a href="module-chat.html">chat</a></li><li><a href="module-disconnect.html">disconnect</a></li><li><a href="module-dumb.html">dumb</a></li><li><a href="module-emote.html">emote</a></li><li><a href="module-forcecolor.html">forcecolor</a></li><li><a href="module-help.html">help</a></li><li><a href="module-invite.html">invite</a></li><li><a href="module-join.html">join</a></li><li><a href="module-kick.html">kick</a></li><li><a href="module-listusers.html">listusers</a></li><li><a href="module-morestats.html">morestats</a></li><li><a href="module-ping.html">ping</a></li><li><a href="module-reload.html">reload</a></li><li><a href="module-removemod.html">removemod</a></li><li><a href="module-saveconfig.html">saveconfig</a></li><li><a href="module-session.html">session</a></li><li><a href="module-shout.html">shout</a></li><li><a href="module-socketreply.html">socketreply</a></li><li><a href="module-speak.html">speak</a></li><li><a href="module-stats.html">stats</a></li><li><a href="module-unban.html">unban</a></li><li><a href="module-unbanall.html">unbanall</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Jun 22 2022 10:04:25 GMT-0500 (Central Daylight Time)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>