2022-06-23 00:32:51 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: core/invite.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: core/invite.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
|
|
|
* @author Marzavec ( https://github.com/marzavec )
|
|
|
|
|
* @summary Send an invite
|
|
|
|
|
* @version 1.0.0
|
|
|
|
|
* @description Sends an invite to the target client with the provided channel, or a random channel
|
|
|
|
|
* @module invite
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
findUser,
|
|
|
|
|
} from '../utility/_Channels.js';
|
|
|
|
|
import {
|
|
|
|
|
Errors,
|
|
|
|
|
} from '../utility/_Constants.js';
|
|
|
|
|
import {
|
|
|
|
|
legacyInviteOut,
|
|
|
|
|
legacyInviteReply,
|
|
|
|
|
} from '../utility/_LegacyFunctions.js';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the channel that should be invited to.
|
|
|
|
|
* @param {any} channel
|
|
|
|
|
* @private
|
|
|
|
|
* @return {string}
|
|
|
|
|
*/
|
|
|
|
|
export function getChannel(channel = undefined) {
|
|
|
|
|
if (typeof channel === 'string') {
|
|
|
|
|
return channel;
|
|
|
|
|
}
|
|
|
|
|
return Math.random().toString(36).substr(2, 8);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes when invoked by a remote client
|
channel ownership base, part 1
Fleshing out the new channel ownership feature, along with a typo fix and small syntax updates.
A claim can now be staked with /claimchannel, a channel owner may change a trip's level using /setlevel
To do: unclaimchannel, setmotd, makeprivate, makepublic, renewclaim, garbage keeping, update mod commands to accept channelOwner and channelModerator, etc
2024-01-05 16:30:28 +08:00
|
|
|
* @param {Object} env - Environment object with references to core, server, socket & payload
|
2022-06-23 00:32:51 +08:00
|
|
|
* @public
|
|
|
|
|
* @return {void}
|
|
|
|
|
*/
|
|
|
|
|
export async function run({
|
|
|
|
|
core, server, socket, payload,
|
|
|
|
|
}) {
|
|
|
|
|
// check for spam
|
2023-12-27 16:26:49 +08:00
|
|
|
if (server.police.frisk(socket, 2)) {
|
2022-06-23 00:32:51 +08:00
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'You are sending invites too fast. Wait a moment before trying again.',
|
|
|
|
|
id: Errors.Invite.RATELIMIT,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// verify user input
|
|
|
|
|
// if this is a legacy client add missing params to payload
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
if (typeof socket.channel === 'undefined' || typeof payload.nick !== 'string') {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
payload.channel = socket.channel; // eslint-disable-line no-param-reassign
|
|
|
|
|
} else if (typeof payload.userid !== 'number' || typeof payload.channel !== 'string') {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// @todo Verify this socket is part of payload.channel - multichannel patch
|
|
|
|
|
// find target user
|
|
|
|
|
const targetUser = findUser(server, payload);
|
|
|
|
|
if (!targetUser) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Could not find user in that channel',
|
|
|
|
|
id: Errors.Global.UNKNOWN_USER,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// generate common channel
|
|
|
|
|
const channel = getChannel(payload.to);
|
|
|
|
|
|
|
|
|
|
// build invite
|
|
|
|
|
const outgoingPayload = {
|
|
|
|
|
cmd: 'invite',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
from: socket.userid,
|
|
|
|
|
to: targetUser.userid,
|
|
|
|
|
inviteChannel: channel,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// send invite notice to target client
|
|
|
|
|
if (targetUser.hcProtocol === 1) {
|
|
|
|
|
server.reply(legacyInviteOut(outgoingPayload, socket.nick), targetUser);
|
|
|
|
|
} else {
|
|
|
|
|
server.reply(outgoingPayload, targetUser);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// send invite notice to this client
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
server.reply(legacyInviteReply(outgoingPayload, targetUser.nick), socket);
|
|
|
|
|
} else {
|
|
|
|
|
server.reply(outgoingPayload, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// stats are fun
|
|
|
|
|
core.stats.increment('invites-sent');
|
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Module meta information
|
|
|
|
|
* @public
|
|
|
|
|
* @typedef {Object} invite/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: 'invite',
|
|
|
|
|
category: 'core',
|
|
|
|
|
description: 'Sends an invite to the target client with the provided channel, or a random channel.',
|
|
|
|
|
usage: `
|
|
|
|
|
API: { cmd: 'invite', nick: '<target nickname>', to: '<optional destination channel>' }`,
|
|
|
|
|
};
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2023-12-30 15:24:12 +08:00
|
|
|
<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-disablecaptcha.html">disablecaptcha</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-enablecaptcha.html">enablecaptcha</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-lockroom.html">lockroom</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-unlockroom.html">unlockroom</a></li><li><a href="module-updateMessage.html">updateMessage</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
|
2022-06-23 00:32:51 +08:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2023-12-30 15:24:12 +08:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Dec 29 2023 23:22:35 GMT-0800 (Pacific Standard Time)
|
2022-06-23 00:32:51 +08:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
