misc_pterodactyl-panel/resources/scripts/components/server/Console.tsx

233 lines
8.5 KiB
TypeScript
Raw Normal View History

2021-03-04 05:04:11 +00:00
import React, { useEffect, useMemo, useRef, useState } from 'react';
import { Terminal, ITerminalOptions } from 'xterm';
import { FitAddon } from 'xterm-addon-fit';
import { SearchAddon } from 'xterm-addon-search';
import { SearchBarAddon } from 'xterm-addon-search-bar';
2020-11-24 21:04:44 +00:00
import { WebLinksAddon } from 'xterm-addon-web-links';
import { ScrollDownHelperAddon } from '@/plugins/XtermScrollDownHelperAddon';
import SpinnerOverlay from '@/components/elements/SpinnerOverlay';
2019-09-06 06:05:24 +00:00
import { ServerContext } from '@/state/server';
2020-07-03 21:19:05 +00:00
import styled from 'styled-components/macro';
import { usePermissions } from '@/plugins/usePermissions';
2020-10-17 20:54:34 +00:00
import tw, { theme as th } from 'twin.macro';
import 'xterm/css/xterm.css';
import useEventListener from '@/plugins/useEventListener';
import { debounce } from 'debounce';
2020-10-26 12:30:30 +00:00
import { usePersistedState } from '@/plugins/usePersistedState';
import { SocketEvent, SocketRequest } from '@/components/server/events';
const theme = {
2020-10-17 20:54:34 +00:00
background: th`colors.black`.toString(),
cursor: 'transparent',
2020-10-17 20:54:34 +00:00
black: th`colors.black`.toString(),
red: '#E54B4B',
green: '#9ECE58',
yellow: '#FAED70',
blue: '#396FE2',
magenta: '#BB80B3',
cyan: '#2DDAFD',
white: '#d0d0d0',
brightBlack: 'rgba(255, 255, 255, 0.2)',
brightRed: '#FF5370',
brightGreen: '#C3E88D',
brightYellow: '#FFCB6B',
brightBlue: '#82AAFF',
brightMagenta: '#C792EA',
brightCyan: '#89DDFF',
brightWhite: '#ffffff',
selection: '#FAF089',
};
const terminalProps: ITerminalOptions = {
2019-09-06 06:05:24 +00:00
disableStdin: true,
cursorStyle: 'underline',
allowTransparency: true,
fontSize: 12,
fontFamily: 'Menlo, Monaco, Consolas, monospace',
rows: 30,
theme: theme,
};
2019-12-22 22:33:08 +00:00
const TerminalDiv = styled.div`
&::-webkit-scrollbar {
width: 8px;
}
&::-webkit-scrollbar-thumb {
${tw`bg-neutral-900`};
}
`;
const CommandInput = styled.input`
${tw`text-sm transition-colors duration-150 px-2 bg-transparent border-0 border-b-2 border-transparent text-neutral-100 p-2 pl-0 w-full focus:ring-0`}
&:focus {
${tw`border-cyan-700`};
}
`;
2019-09-06 06:05:24 +00:00
export default () => {
2020-01-18 23:26:15 +00:00
const TERMINAL_PRELUDE = '\u001b[1m\u001b[33mcontainer@pterodactyl~ \u001b[0m';
const ref = useRef<HTMLDivElement>(null);
const terminal = useMemo(() => new Terminal({ ...terminalProps }), []);
const fitAddon = new FitAddon();
const searchAddon = new SearchAddon();
2020-10-15 20:41:11 +00:00
const searchBar = new SearchBarAddon({ searchAddon });
2020-11-24 21:04:44 +00:00
const webLinksAddon = new WebLinksAddon();
const scrollDownHelperAddon = new ScrollDownHelperAddon();
2019-12-07 20:13:46 +00:00
const { connected, instance } = ServerContext.useStoreState(state => state.socket);
2021-06-12 17:46:10 +00:00
const [ canSendCommands ] = usePermissions([ 'control.console' ]);
2020-10-26 12:30:30 +00:00
const serverId = ServerContext.useStoreState(state => state.server.data!.id);
const isTransferring = ServerContext.useStoreState(state => state.server.data!.isTransferring);
2021-06-12 17:46:10 +00:00
const [ history, setHistory ] = usePersistedState<string[]>(`${serverId}:command_history`, []);
const [ historyIndex, setHistoryIndex ] = useState(-1);
2020-01-18 23:26:15 +00:00
const handleConsoleOutput = (line: string, prelude = false) => terminal.writeln(
(prelude ? TERMINAL_PRELUDE : '') + line.replace(/(?:\r\n|\r|\n)$/im, '') + '\u001b[0m',
2019-09-06 06:05:24 +00:00
);
const handleTransferStatus = (status: string) => {
switch (status) {
// Sent by either the source or target node if a failure occurs.
case 'failure':
terminal.writeln(TERMINAL_PRELUDE + 'Transfer has failed.\u001b[0m');
return;
// Sent by the source node whenever the server was archived successfully.
case 'archive':
terminal.writeln(TERMINAL_PRELUDE + 'Server has been archived successfully, attempting connection to target node..\u001b[0m');
}
};
2019-09-28 20:09:47 +00:00
const handleDaemonErrorOutput = (line: string) => terminal.writeln(
2020-01-18 23:26:15 +00:00
TERMINAL_PRELUDE + '\u001b[1m\u001b[41m' + line.replace(/(?:\r\n|\r|\n)$/im, '') + '\u001b[0m',
2019-09-28 20:09:47 +00:00
);
const handlePowerChangeEvent = (state: string) => terminal.writeln(
2020-01-18 23:26:15 +00:00
TERMINAL_PRELUDE + 'Server marked as ' + state + '...\u001b[0m',
);
const handleCommandKeyDown = (e: React.KeyboardEvent<HTMLInputElement>) => {
2020-10-26 12:30:30 +00:00
if (e.key === 'ArrowUp') {
const newIndex = Math.min(historyIndex + 1, history!.length - 1);
setHistoryIndex(newIndex);
e.currentTarget.value = history![newIndex] || '';
// By default up arrow will also bring the cursor to the start of the line,
// so we'll preventDefault to keep it at the end.
e.preventDefault();
2020-10-26 12:30:30 +00:00
}
if (e.key === 'ArrowDown') {
const newIndex = Math.max(historyIndex - 1, -1);
setHistoryIndex(newIndex);
e.currentTarget.value = history![newIndex] || '';
2019-09-18 05:54:23 +00:00
}
2020-10-26 12:30:30 +00:00
const command = e.currentTarget.value;
if (e.key === 'Enter' && command.length > 0) {
2021-06-12 17:46:10 +00:00
setHistory(prevHistory => [ command, ...prevHistory! ].slice(0, 32));
2020-10-26 12:30:30 +00:00
setHistoryIndex(-1);
instance && instance.send('send command', command);
e.currentTarget.value = '';
}
2019-09-18 05:54:23 +00:00
};
2019-09-06 06:05:24 +00:00
useEffect(() => {
if (connected && ref.current && !terminal.element) {
terminal.loadAddon(fitAddon);
terminal.loadAddon(searchAddon);
2020-10-15 20:41:11 +00:00
terminal.loadAddon(searchBar);
2020-11-24 21:04:44 +00:00
terminal.loadAddon(webLinksAddon);
terminal.loadAddon(scrollDownHelperAddon);
terminal.open(ref.current);
fitAddon.fit();
// Add support for capturing keys
terminal.attachCustomKeyEventHandler((e: KeyboardEvent) => {
if ((e.ctrlKey || e.metaKey) && e.key === 'c') {
document.execCommand('copy');
return false;
} else if ((e.ctrlKey || e.metaKey) && e.key === 'f') {
2021-02-18 05:32:36 +00:00
e.preventDefault();
2020-10-15 20:41:11 +00:00
searchBar.show();
return false;
2021-02-18 05:32:36 +00:00
} else if (e.key === 'Escape') {
2020-10-15 20:41:11 +00:00
searchBar.hidden();
}
return true;
});
}
2021-06-12 17:46:10 +00:00
}, [ terminal, connected ]);
useEventListener('resize', debounce(() => {
if (terminal.element) {
fitAddon.fit();
}
}, 100));
2019-09-06 06:05:24 +00:00
useEffect(() => {
const listeners: Record<string, (s: string) => void> = {
[SocketEvent.STATUS]: handlePowerChangeEvent,
[SocketEvent.CONSOLE_OUTPUT]: handleConsoleOutput,
[SocketEvent.INSTALL_OUTPUT]: handleConsoleOutput,
[SocketEvent.TRANSFER_LOGS]: handleConsoleOutput,
[SocketEvent.TRANSFER_STATUS]: handleTransferStatus,
[SocketEvent.DAEMON_MESSAGE]: line => handleConsoleOutput(line, true),
[SocketEvent.DAEMON_ERROR]: handleDaemonErrorOutput,
};
2019-09-06 06:05:24 +00:00
if (connected && instance) {
// Do not clear the console if the server is being transferred.
if (!isTransferring) {
terminal.clear();
}
Object.keys(listeners).forEach((key: string) => {
instance.addListener(key, listeners[key]);
});
instance.send(SocketRequest.SEND_LOGS);
}
2019-09-06 06:05:24 +00:00
return () => {
if (instance) {
Object.keys(listeners).forEach((key: string) => {
instance.removeListener(key, listeners[key]);
});
}
2019-09-06 06:05:24 +00:00
};
2021-06-12 17:46:10 +00:00
}, [ connected, instance ]);
2019-09-06 06:05:24 +00:00
return (
<div css={tw`text-xs font-mono relative`}>
<SpinnerOverlay visible={!connected} size={'large'} />
2019-09-06 06:05:24 +00:00
<div
css={[
tw`rounded-t p-2 bg-black w-full`,
!canSendCommands && tw`rounded-b`,
]}
style={{ minHeight: '16rem' }}
2019-09-06 06:05:24 +00:00
>
<TerminalDiv id={'terminal'} ref={ref} />
2019-09-06 06:05:24 +00:00
</div>
{canSendCommands &&
<div css={tw`rounded-b bg-neutral-900 text-neutral-100 flex items-baseline`}>
<div css={tw`flex-shrink-0 p-2 font-bold`}>$</div>
<div css={tw`w-full`}>
<CommandInput
type={'text'}
placeholder={'Type a command...'}
aria-label={'Console command input.'}
disabled={!instance || !connected}
onKeyDown={handleCommandKeyDown}
/>
</div>
</div>
}
2019-09-06 06:05:24 +00:00
</div>
);
};