Merge pull request #3471 from MiniDigger/feature/plugin-messages

Add message type for plugins
This commit is contained in:
Pavel Djundik 2019-11-01 16:41:41 +02:00 committed by GitHub
commit 959ec5b598
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 52 additions and 9 deletions

View File

@ -40,6 +40,13 @@
<span class="only-copy">&gt; </span>
</template>
</span>
<span v-else-if="message.type === 'plugin'" class="from">
<template v-if="message.from && message.from.nick">
<span class="only-copy">[</span>
{{ message.from.nick }}
<span class="only-copy">] </span>
</template>
</span>
<span v-else class="from">
<template v-if="message.from && message.from.nick">
<span class="only-copy">-</span>

View File

@ -264,6 +264,7 @@ kbd {
#chat .whois .from::before,
#chat .nick .from::before,
#chat .action .from::before,
#chat .plugin .from::before,
#chat .raw .from::before,
#chat .toggle-button::after,
#chat .toggle-content .more-caret::before,
@ -426,6 +427,13 @@ kbd {
content: "\f005"; /* http://fontawesome.io/icon/star/ */
}
#chat .plugin .from::before {
content: "\f1e6"; /* http://fontawesome.io/icon/plug/ */
transform: rotate(45deg);
display: inline-block;
padding: 1px;
}
#chat .toggle-button {
display: inline-block;
transition: opacity 0.2s, transform 0.2s;

View File

@ -388,7 +388,7 @@ Client.prototype.inputLine = function(data) {
if (typeof plugin.input === "function" && (connected || plugin.allowDisconnected)) {
connected = true;
plugin.input(
new PublicClient(client),
new PublicClient(client, plugin.packageInfo),
{network: target.network, chan: target.chan},
cmd,
args

View File

@ -48,7 +48,8 @@ class Msg {
this.type !== Msg.Type.TOPIC_SET_BY &&
this.type !== Msg.Type.MODE_CHANNEL &&
this.type !== Msg.Type.RAW &&
this.type !== Msg.Type.WHOIS
this.type !== Msg.Type.WHOIS &&
this.type !== Msg.Type.PLUGIN
);
}
}
@ -77,6 +78,7 @@ Msg.Type = {
TOPIC_SET_BY: "topic_set_by",
WHOIS: "whois",
RAW: "raw",
PLUGIN: "plugin",
};
module.exports = Msg;

View File

@ -51,7 +51,10 @@ const getCommands = () =>
.concat(passThroughCommands)
.sort();
const addPluginCommand = (command, func) => pluginCommands.set(command, func);
const addPluginCommand = (packageInfo, command, func) => {
func.packageInfo = packageInfo;
pluginCommands.set(command, func);
};
module.exports = {
addPluginCommand,

View File

@ -27,16 +27,16 @@ module.exports = {
outdated,
};
const packageApis = function(packageName) {
const packageApis = function(packageInfo) {
return {
Stylesheets: {
addFile: addStylesheet.bind(this, packageName),
addFile: addStylesheet.bind(this, packageInfo.packageName),
},
PublicFiles: {
add: addFile.bind(this, packageName),
add: addFile.bind(this, packageInfo.packageName),
},
Commands: {
add: inputs.addPluginCommand,
add: inputs.addPluginCommand.bind(this, packageInfo),
runAsUser: (command, targetId, client) =>
client.inputLine({target: targetId, text: command}),
},
@ -98,6 +98,7 @@ function loadPackages() {
}
packageInfo = packageInfo.thelounge;
packageInfo.packageName = packageName;
packageMap.set(packageName, packageFile);
@ -112,7 +113,7 @@ function loadPackages() {
}
if (packageFile.onServerStart) {
packageFile.onServerStart(packageApis(packageName));
packageFile.onServerStart(packageApis(packageInfo));
}
log.info(`Package ${colors.bold(packageName)} loaded`);

View File

@ -1,6 +1,9 @@
const Msg = require("../../models/msg");
module.exports = class PublicClient {
constructor(client) {
constructor(client, packageInfo) {
this.client = client;
this.packageInfo = packageInfo;
}
/**
@ -37,4 +40,23 @@ module.exports = class PublicClient {
getChannel(chanId) {
return this.client.find(chanId);
}
/**
* Sends a message to this client, displayed in the given channel.
*
* @param {String} text the message to send
* @param {Chan} chan the channel to send the message to
*/
sendMessage(text, chan) {
chan.pushMessage(
this.client,
new Msg({
type: Msg.Type.PLUGIN,
text: text,
from: {
nick: this.packageInfo.name || this.packageInfo.packageName,
},
})
);
}
};