chore: remove pty module

Signed-off-by: Innei <i@innei.in>
This commit is contained in:
Innei
2024-08-16 12:26:36 +08:00
parent 3bb1c52e78
commit 1bb4f6a72b
4 changed files with 0 additions and 257 deletions

View File

@@ -1,17 +0,0 @@
import { Get } from '@nestjs/common'
import { ApiController } from '~/common/decorators/api-controller.decorator'
import { Auth } from '~/common/decorators/auth.decorator'
import { PTYService } from './pty.service'
@Auth()
@ApiController({ path: 'pty' })
export class PTYController {
constructor(private readonly service: PTYService) {}
@Get('/record')
async getPtyLoginRecord() {
return this.service.getLoginRecord()
}
}

View File

@@ -1,189 +0,0 @@
// THIS MODULE IS DISABLED
// @ts-nocheck
import { isNil, pick } from 'lodash'
import { spawn } from 'node-pty'
import { Socket } from 'socket.io'
import { nanoid as N } from '@mx-space/external'
import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets'
import { DEMO_MODE } from '~/app.config'
import { BusinessEvents } from '~/constants/business-event.constant'
import { RedisKeys } from '~/constants/cache.constant'
import { DATA_DIR } from '~/constants/path.constant'
import { AuthService } from '~/modules/auth/auth.service'
import { ConfigsService } from '~/modules/configs/configs.service'
import { createAuthGateway } from '~/processors/gateway/shared/auth.gateway'
import { JWTService } from '~/processors/helper/helper.jwt.service'
import { CacheService } from '~/processors/redis/cache.service'
import { getIp, getRedisKey } from '~/utils'
import type { IPty } from 'node-pty'
import type {
GatewayMetadata,
OnGatewayConnection,
OnGatewayDisconnect,
} from '@nestjs/websockets'
const { nanoid } = N
const AuthGateway = createAuthGateway({ namespace: 'pty', authway: 'jwt' })
@WebSocketGateway<GatewayMetadata>({ namespace: 'pty' })
export class PTYGateway
extends AuthGateway
implements OnGatewayConnection, OnGatewayDisconnect
{
constructor(
protected readonly jwtService: JWTService,
protected readonly authService: AuthService,
protected readonly cacheService: CacheService,
protected readonly configService: ConfigsService,
) {
super(jwtService, authService)
}
socket2ptyMap = new WeakMap<Socket, IPty>()
@SubscribeMessage('pty')
async pty(
client: Socket,
data?: { password?: string; cols: number; rows: number },
) {
if (DEMO_MODE) {
client.send(
this.gatewayMessageFormat(
BusinessEvents.PTY_MESSAGE,
'PTY 在演示模式下不可用',
),
)
return
}
const password = data?.password
const terminalOptions = await this.configService.get('terminalOptions')
if (!terminalOptions.enable) {
client.send(
this.gatewayMessageFormat(BusinessEvents.PTY_MESSAGE, 'PTY 已禁用'),
)
return
}
const isValidPassword = isNil(terminalOptions.password)
? true
: password === terminalOptions.password
if (!isValidPassword) {
if (typeof password === 'undefined' || password === '') {
client.send(
this.gatewayMessageFormat(
BusinessEvents.PTY_MESSAGE,
'PTY 验证未通过:需要密码验证',
10000,
),
)
} else {
client.send(
this.gatewayMessageFormat(
BusinessEvents.PTY_MESSAGE,
'PTY 验证未通过:密码错误',
10001,
),
)
}
return
}
const zsh = await $`zsh --version`.quiet().nothrow()
const fish = await $`fish --version`.quiet().nothrow()
const pty = spawn(
os.platform() === 'win32'
? 'powershell.exe'
: zsh.exitCode == 0
? 'zsh'
: fish.exitCode == 0
? 'fish'
: 'bash',
[],
{
cwd: DATA_DIR,
cols: data?.cols || 30,
rows: data?.rows || 80,
env: pick(process.env, [
'PATH',
'EDITOR',
'SHELL',
'USER',
'VISUAL',
'LANG',
'TERM',
'LANGUAGE',
// other
'N_PREFIX',
'N_PRESERVE_NPM',
]) as any,
},
)
const nid = nanoid()
const ip =
client.handshake.headers['x-forwarded-for'] ||
client.handshake.address ||
getIp(client.request) ||
client.conn.remoteAddress
this.cacheService.getClient().hset(
getRedisKey(RedisKeys.PTYSession),
nid,
`${new Date().toISOString()},${ip}`,
)
pty.onExit(async () => {
const hvalue = await this.cacheService
.getClient()
.hget(getRedisKey(RedisKeys.PTYSession), nid)
if (hvalue) {
this.cacheService
.getClient()
.hset(
getRedisKey(RedisKeys.PTYSession),
nid,
`${hvalue},${new Date().toISOString()}`,
)
}
})
if (terminalOptions.script) {
pty.write(terminalOptions.script)
pty.write('\n')
}
pty.onData((data) => {
client.send(this.gatewayMessageFormat(BusinessEvents.PTY, data))
})
this.socket2ptyMap.set(client, pty)
}
@SubscribeMessage('pty-input')
async ptyInput(client: Socket, data: string) {
const pty = this.socket2ptyMap.get(client)
if (pty) {
pty.write(data)
}
}
@SubscribeMessage('pty-exit')
async ptyExit(client: Socket) {
const pty = this.socket2ptyMap.get(client)
if (pty) {
pty.kill()
}
this.socket2ptyMap.delete(client)
}
handleDisconnect(client: Socket) {
this.ptyExit(client)
super.handleDisconnect(client)
}
}

View File

@@ -1,13 +0,0 @@
import { Module } from '@nestjs/common'
import { AuthModule } from '../auth/auth.module'
import { PTYController } from './pty.controller'
import { PTYGateway } from './pty.gateway'
import { PTYService } from './pty.service'
@Module({
imports: [AuthModule],
controllers: [PTYController],
providers: [PTYService, PTYGateway],
})
export class PTYModule {}

View File

@@ -1,38 +0,0 @@
import { Injectable } from '@nestjs/common'
import { RedisKeys } from '~/constants/cache.constant'
import { CacheService } from '~/processors/redis/cache.service'
import { getRedisKey } from '~/utils'
@Injectable()
export class PTYService {
constructor(private readonly cacheService: CacheService) {}
async getLoginRecord() {
const redis = this.cacheService.getClient()
const keys = await redis.hkeys(getRedisKey(RedisKeys.PTYSession))
const values = await Promise.all(
keys.map(async (key) => {
return redis.hget(getRedisKey(RedisKeys.PTYSession), key)
}),
)
return values
.filter(Boolean)
.map((value: string) => {
const [startTime, ip, endTime] = value.split(',') as [
string,
string,
string | undefined,
]
return {
startTime: new Date(startTime),
ip,
endTime: endTime === '' ? null : endTime,
}
})
.sort((a, b) => b.startTime.getTime() - a.startTime.getTime())
}
}