Skip to content

Admin commands to alter the state of other users #1754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Admin commands to alter the state of other users #1754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 100 additions & 4 deletions src/bridge/AdminRoomHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,17 @@ const COMMANDS: {[command: string]: Command|Heading} = {
summary: "Unlink an IRC channel from a Matrix room. " +
"You need to be a moderator of the Matrix room or an administrator of this bridge.",
},
'!reconnect-other': {
example: "!reconnect-other @user:id [irc.example.net]",
summary: "Forcibly reconnect another user. " +
"You need to be a moderator of the Matrix room or an administrator of this bridge.",
requiresPermission: CommandPermission.Admin,
},
'!force-part': {
example: "!force-part [irc.example.net] @user:id #channel ",
summary: "Force a user to leave a channel. This will NOT remove them from the room. ",
requiresPermission: CommandPermission.Admin,
},
};

class ServerRequiredError extends Error {
Expand Down Expand Up @@ -206,12 +217,18 @@ export class AdminRoomHandler {
case "!bridgeversion":
return this.showBridgeVersion();
case "!plumb":
return await this.handlePlumb(args, event.sender)
return await this.handlePlumb(args, event.sender);
case "!unlink":
case "!unplumb": // alias for convinience
return await this.handleUnlink(args, event.sender)
return await this.handleUnlink(args, event.sender);
case "!reconnect-other": // alias for convinience
return await this.handleReconnectOther(args);
case "!force-part":
return await this.handleForcePart(args);
case "!admin-cmd":
return await this.handleAdminClientCmd(req, args);
case "!help":
return this.showHelp(event.sender);
return await this.showHelp(event.sender);
default: {
return new MatrixAction(ActionType.Notice,
"The command was not recognised. Available commands are listed by !help");
Expand Down Expand Up @@ -415,7 +432,7 @@ export class AdminRoomHandler {
server, sender
);

bridgedClient.sendCommands(...sendArgs);
await bridgedClient.sendCommands(...sendArgs);
}
catch (err) {
return new MatrixAction(ActionType.Notice, `${err}\n` );
Expand Down Expand Up @@ -772,6 +789,85 @@ export class AdminRoomHandler {
return new MatrixAction(ActionType.Notice, null, body + "</ul>");
}

private async handleForcePart(args: string[]) {
const server = this.extractServerFromArgs(args);
const userId = args[0];
const channel = args[1];

if (!userId || !userId.startsWith("@")) {
return new MatrixAction(ActionType.Notice, "The user ID must start with a @");
}

if (!channel || !channel.startsWith("@")) {
return new MatrixAction(ActionType.Notice, "The user ID must start with a #");
}
const client = this.ircBridge.getClientPool().getBridgedClientByUserId(server, userId);
if (!client) {
return new MatrixAction(
ActionType.Notice, `User is not connected to ${server.domain}, not reconnecting`
);
}
// If the bridge doesn't think we're connected, force it anyway.
if (await client.leaveChannel(channel) === false) {
await (await client.assertConnected()).part(channel, "Force parted by bridge");
}
}

private async handleReconnectOther(args: string[]) {
const [userId, serverDomain] = args;
const server = serverDomain ? this.ircBridge.getServer(serverDomain) : this.ircBridge.getServers()[0];
if (!server) {
return new MatrixAction(ActionType.Notice, "The server provided is not configured on this bridge");
}
if (!userId || !userId.startsWith("@")) {
return new MatrixAction(ActionType.Notice, "The user ID must start with a @");
}
const client = this.ircBridge.getClientPool().getBridgedClientByUserId(server, userId);
if (!client) {
return new MatrixAction(
ActionType.Notice, `User is not connected to ${server.domain}, not reconnecting`
);
}
try {
if (client) {
await client.disconnect("iwanttoreconnect", "Reconnecting", false);
return new MatrixAction(
ActionType.Notice, `Reconnecting to network...`
);
}
}
catch (err) {
log.error("Failed to reconnect other", err.stack);
return new MatrixAction(
ActionType.Notice, `Failed to reconnect`
);
}

}

private async handleAdminClientCmd(req: BridgeRequest, args: string[]) {
// Assumes commands have the form
// !cmd [irc.server] @userid:server COMMAND [arg0 [arg1 [...]]]
const server = this.extractServerFromArgs(args);
const [userId, ...cmds] = args[0];

if (!userId || !userId.startsWith("@")) {
return new MatrixAction(ActionType.Notice, "The user ID must start with a @");
}

try {
const bridgedClient = await this.ircBridge.getBridgedClient(
server, userId
);

await bridgedClient.sendCommands(...cmds);
}
catch (err) {
return new MatrixAction(ActionType.Notice, `${err}\n` );
}
return undefined;
}

// will mutate args if sucessful
private extractServerFromArgs(args: string[]): IrcServer {
// Require an IRC server to be specified if there's more than one possible choice
Expand Down
13 changes: 7 additions & 6 deletions src/irc/BridgedClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,12 +455,12 @@ export class BridgedClient extends EventEmitter {
});
}

public async leaveChannel(channel: string, reason = "User left"): Promise<void> {
public async leaveChannel(channel: string, reason = "User left"): Promise<boolean> {
if (this.state.status !== BridgedClientStatus.CONNECTED) {
return undefined; // we were never connected to the network.
return false; // we were never connected to the network.
}
if (!channel.startsWith("#")) {
return undefined; // PM room
return false; // PM room
}
const deferredChannelJoin = this.channelJoinDefers.get(channel);
if (deferredChannelJoin) {
Expand All @@ -474,7 +474,7 @@ export class BridgedClient extends EventEmitter {
}
}
if (!this.inChannel(channel)) {
return undefined; // we were never joined to it.
return false; // we were never joined to it.
}
const defer = promiseutil.defer<void>();
this.log.debug("Leaving channel %s", channel);
Expand All @@ -484,7 +484,8 @@ export class BridgedClient extends EventEmitter {
defer.resolve();
});

return defer.promise;
await defer.promise;
return true;
}

public inChannel(channel: string) {
Expand Down Expand Up @@ -1169,7 +1170,7 @@ export class BridgedClient extends EventEmitter {
return this.connectDefer.promise;
}

private assertConnected(): Client {
public assertConnected(): Client {
if (this.state.status !== BridgedClientStatus.CONNECTED) {
throw Error('Client is not connected');
}
Expand Down