UnrealIRCd RPC for Node.js

This allows a Node.js bot like irc-framework to control UnrealIRCd via the JSON-RPC interface.

Installation

1. Install: npm i unrealircd-rpc-node
2. Code a little by integrating it with IRC-framework or another library.

Manual installation

1. Download https://github.com/Madriix/unrealircd-rpc-node.git
2. Rename the folder unrealircd-rpc-node-main to unrealircd-rpc-node
3. Add unrealircd-rpc-node to the same folder as your node bot
4. Install ws: npm install ws
5. Code a little by integrating it with IRC-framework or another library.

Bot setup (with IRC-framework)

UnrealIRCd 6.0.6 or later is needed and you need to enable JSON-RPC in it. After doing that, be sure to rehash the IRCd.

Usage

Here is an example with IRC-framework

/*
	Manual installation
	const UnrealIRCdRpc = require('./unrealircd-rpc-node/UnrealIRCdRpc');
*/
const UnrealIRCdRpc = require('unrealircd-rpc-node');
UnrealIRCdRpc.address = "wss://ApiUser:[email protected]:8600/"; // Set the correct address and port for your UnrealIRCd RPC.

// ...

bot.on('message', async function (event) {
    console.log('<' + event.nick + '>', event.message);
    console.log(event);

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_1$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}

        await urpc.connection.serverban().add("~account:test", "gline", "60", "no reason");

        // urpc.close();
    }

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_2$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}
        
        const bans = await urpc.connection.serverban().getAll();
        for (const ban of bans) {
            bot.raw(`PRIVMSG ${event.nick} :There's a ${ban.type} on ${ban.name}`);
        }

        // urpc.close();
    }

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_3$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}

        await urpc.connection.message().send_privmsg("TestNick", "Test message");

        // urpc.close();
    }

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_4$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}

        await urpc.connection.message().send_numeric("TestNick", 318, "End of /WHOIS list.");

        // urpc.close();
    }

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_5$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}

		const securitygrps = await urpc.connection.securitygroup().getAll();
		for (const group of securitygrps) {
			bot.raw(`PRIVMSG ${event.nick} :Security-Group : ${group.name}`);
		}

        // urpc.close();
    }

    if (!/^#/.test(event.target) && /^!test_unrealircd_rpc_6$/.test(event.message)) {
        const urpc = await UnrealIRCdRpc.getInstance();

		if (!urpc) {
			console.log("Unable to connect to the UnrealIRCd RPC.");
			return;
		}

		const securitygrps = await urpc.connection.securitygroup().get('unknown-users');

		if (securitygrps) {
			bot.raw(`PRIVMSG ${event.nick} Security-Group ${securitygrps.name}`);
			for (const [key, value] of Object.entries(securitygrps)) {
				bot.raw(`PRIVMSG ${event.nick} :${key} = ${value}`);
			}
		}

        // urpc.close();
    }

});

Just go to the bot's private account and type "!test_unrealircd_rpc_1", it will answer you and add a gline to ~account:test.

When testing the command "!test_unrealircd_rpc_2", you will see the list of bans.

By testing "!test_unrealircd_rpc_3", you will receive a message from the IRC server if you replace the nick TestNick with your own nick.

You can also test "!test_unrealircd_rpc_4" and others.

If the example does not work, then make sure you have configured your UnrealIRCd correctly, with the same API username and password you use here, with an allowed IP, and changing the wss://127.0.0.1:8600/ too if needed.

I was inspired by the code unrealircd-rpc-php by copying. I use it on an irc-framework bot, it works well for ServerBan (add/del/list) and Message (send_privmsg, send_notice, send_numeric).

Commmands available (not all tested)

// let rpc = await urpc.connection;

// serverban : The server_ban.* JSON RPC calls can add, remove and list server bans such as KLINE, GLINE, etc. 
await rpc.serverban().add("~account:test", "gline", "60", "no reason");
await rpc.serverban().delete("~account:test", "gline");
await rpc.serverban().getAll();
await rpc.serverban().get("~account:test", "gline");

// serverbanexception : The server_ban_exception.* JSON RPC calls can add, remove and list server ban exceptions (ELINEs). 
await rpc.serverbanexception().add(name, types, reason, set_by = null, duration = null)
await rpc.serverbanexception().delete(name)
await rpc.serverbanexception().getAll()
await rpc.serverbanexception().get(name)

// user : The user.* JSON RPC calls can list and retrieve information about users. 
await rpc.user().getAll(object_detail_level = 2)
await rpc.user().get(nick, object_detail_level = 4)
await rpc.user().set_nick(nick, newnick)
await rpc.user().set_username(nick, username)
await rpc.user().set_realname(nick, realname)
await rpc.user().set_vhost(nick, vhost)
await rpc.user().set_mode(nick, mode, hidden = false)
await rpc.user().set_snomask(nick, snomask, hidden = false)
await rpc.user().set_oper(nick, oper_account, oper_class, classVal = null, modes = null, snomask = null, vhost = null)
await rpc.user().join(nick, channel, key = null, force = false)
await rpc.user().part(nick, channel, force = false)
await rpc.user().quit(nick, reason)
await rpc.user().kill(nick, reason)

// channel : The channel.* JSON RPC calls can list and retrieve information about channels. 
await rpc.channel().getAll(object_detail_level = 1)
await rpc.channel().get(channel, object_detail_level = 3)
await rpc.channel().set_mode(channel, modes, parameters)
await rpc.channel().set_topic(channel, topic, set_by = null, set_at = null)
await rpc.channel().kick(channel, nick, reason)

// spamfilter : The spamfilter.* JSON RPC calls can add, remove and list spamfilters. 
await rpc.spamfilter().add(name, match_type, spamfilter_targets, ban_action, ban_duration, reason)
await rpc.spamfilter().delete(name, match_type, spamfilter_targets, ban_action)
await rpc.spamfilter().getAll()
await rpc.spamfilter().get(name, match_type, spamfilter_targets, ban_action)

// nameban : The name_ban.* JSON RPC calls can add, remove and list banned nicks and channels (q-lines).
await rpc.nameban().add(name, reason, duration = null, set_by = null)
await rpc.nameban().delete(name)
await rpc.nameban().getAll()
await rpc.nameban().get(name)

// stats : Get some quick basic statistics. This is for example used by the admin panel for the 'Overview' page. 
await rpc.stats().get(object_detail_level = 1)

// whowas : The whowas.* JSON RPC calls retrieve whowas history of users. 
await rpc.whowas().get(nick = null, ip = null, object_detail_level = 2)

// log : The log.* JSON RPC calls allow you to subscribe and unsubscribe to log events (real-time streaming of JSON logs).  
await rpc.log().subscribe(sources)
await rpc.log().unsubscribe()
await rpc.log().getAll(sources = null)

// message : The message.* JSON RPC calls can send_privmsg, send_notice, send_numeric, send_standard_reply. 
await rpc.message().send_privmsg("nick", "Test message");
await rpc.message().send_notice("nick", "Test notice");
await rpc.message().send_numeric(nick, numeric, message);
await rpc.message().send_standard_reply(nick, type, code, context, description);

// securitygroup : The security_group.* JSON RPC calls can list security groups
await rpc.securitygroup().getAll();
await rpc.securitygroup().get("unknown-users");