File size: 15,884 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
"""Terminal management for exposing terminals to a web interface using Tornado.
"""
# Copyright (c) Jupyter Development Team
# Copyright (c) 2014, Ramalingam Saravanan <[email protected]>
# Distributed under the terms of the Simplified BSD License.
from __future__ import annotations
import asyncio
import codecs
import itertools
import logging
import os
import select
import signal
import warnings
from collections import deque
from concurrent import futures
from typing import TYPE_CHECKING, Any, Coroutine
if TYPE_CHECKING:
from terminado.websocket import TermSocket
try:
from ptyprocess import PtyProcessUnicode # type:ignore[import-untyped]
def preexec_fn() -> None:
"""A prexec function to set up a signal handler."""
signal.signal(signal.SIGPIPE, signal.SIG_DFL)
except ImportError:
try:
from winpty import PtyProcess as PtyProcessUnicode # type:ignore[import-not-found]
except ImportError:
PtyProcessUnicode = object
preexec_fn = None # type:ignore[assignment]
from tornado.ioloop import IOLoop
ENV_PREFIX = "PYXTERM_" # Environment variable prefix
# TERM is set according to xterm.js capabilities
DEFAULT_TERM_TYPE = "xterm-256color"
class PtyWithClients:
"""A pty object with associated clients."""
term_name: str | None
def __init__(self, argv: Any, env: dict[str, str] | None = None, cwd: str | None = None):
"""Initialize the pty."""
self.clients: list[Any] = []
# Use read_buffer to store historical messages for reconnection
self.read_buffer: deque[str] = deque([], maxlen=1000)
kwargs = {"argv": argv, "env": env or [], "cwd": cwd}
if preexec_fn is not None:
kwargs["preexec_fn"] = preexec_fn
self.ptyproc = PtyProcessUnicode.spawn(**kwargs)
# The output might not be strictly UTF-8 encoded, so
# we replace the inner decoder of PtyProcessUnicode
# to allow non-strict decode.
self.ptyproc.decoder = codecs.getincrementaldecoder("utf-8")(errors="replace")
def resize_to_smallest(self) -> None:
"""Set the terminal size to that of the smallest client dimensions.
A terminal not using the full space available is much nicer than a
terminal trying to use more than the available space, so we keep it
sized to the smallest client.
"""
minrows = mincols = 10001
for client in self.clients:
rows, cols = client.size
if rows is not None and rows < minrows:
minrows = rows
if cols is not None and cols < mincols:
mincols = cols
if minrows == 10001 or mincols == 10001:
return
rows, cols = self.ptyproc.getwinsize()
if (rows, cols) != (minrows, mincols):
self.ptyproc.setwinsize(minrows, mincols)
def kill(self, sig: int = signal.SIGTERM) -> None:
"""Send a signal to the process in the pty"""
self.ptyproc.kill(sig)
def killpg(self, sig: int = signal.SIGTERM) -> Any:
"""Send a signal to the process group of the process in the pty"""
if os.name == "nt":
return self.ptyproc.kill(sig)
pgid = os.getpgid(self.ptyproc.pid)
os.killpg(pgid, sig)
return None
async def terminate(self, force: bool = False) -> bool:
"""This forces a child process to terminate. It starts nicely with
SIGHUP and SIGINT. If "force" is True then moves onto SIGKILL. This
returns True if the child was terminated. This returns False if the
child could not be terminated."""
if os.name == "nt":
signals = [signal.SIGINT, signal.SIGTERM]
else:
signals = [signal.SIGHUP, signal.SIGCONT, signal.SIGINT, signal.SIGTERM]
_ = IOLoop.current()
def sleep() -> Coroutine[Any, Any, None]:
"""Sleep to allow the terminal to exit gracefully."""
return asyncio.sleep(self.ptyproc.delayafterterminate)
if not self.ptyproc.isalive():
return True
try:
for sig in signals:
self.kill(sig)
await sleep()
if not self.ptyproc.isalive():
return True
if force:
self.kill(signal.SIGKILL)
await sleep()
return bool(not self.ptyproc.isalive())
return False
except OSError:
# I think there are kernel timing issues that sometimes cause
# this to happen. I think isalive() reports True, but the
# process is dead to the kernel.
# Make one last attempt to see if the kernel is up to date.
await sleep()
return bool(not self.ptyproc.isalive())
def _update_removing(target: Any, changes: Any) -> None:
"""Like dict.update(), but remove keys where the value is None."""
for k, v in changes.items():
if v is None:
target.pop(k, None)
else:
target[k] = v
def _poll(fd: int, timeout: float = 0.1) -> list[tuple[int, int]]:
"""Poll using poll() on posix systems and select() elsewhere (e.g., Windows)"""
if os.name == "posix":
poller = select.poll()
poller.register(
fd, select.POLLIN | select.POLLPRI | select.POLLHUP | select.POLLERR
) # read-only
return poller.poll(timeout * 1000) # milliseconds
# poll() not supported on Windows
r, _, _ = select.select([fd], [], [], timeout)
return r
class TermManagerBase:
"""Base class for a terminal manager."""
def __init__(
self,
shell_command: str,
server_url: str = "",
term_settings: Any = None,
extra_env: Any = None,
ioloop: Any = None,
blocking_io_executor: Any = None,
):
"""Initialize the manager."""
self.shell_command = shell_command
self.server_url = server_url
self.term_settings = term_settings or {}
self.extra_env = extra_env
self.log = logging.getLogger(__name__)
self.ptys_by_fd: dict[int, PtyWithClients] = {}
if blocking_io_executor is None:
self._blocking_io_executor_is_external = False
self.blocking_io_executor = futures.ThreadPoolExecutor(max_workers=1)
else:
self._blocking_io_executor_is_external = True
self.blocking_io_executor = blocking_io_executor
if ioloop is not None:
warnings.warn(
f"Setting {self.__class__.__name__}.ioloop is deprecated and ignored",
DeprecationWarning,
stacklevel=2,
)
def make_term_env(
self,
height: int = 25,
width: int = 80,
winheight: int = 0,
winwidth: int = 0,
**kwargs: Any,
) -> dict[str, str]:
"""Build the environment variables for the process in the terminal."""
env = os.environ.copy()
# ignore any previously set TERM
# TERM is set according to xterm.js capabilities
env["TERM"] = self.term_settings.get("type", DEFAULT_TERM_TYPE)
dimensions = "%dx%d" % (width, height)
if winwidth and winheight:
dimensions += ";%dx%d" % (winwidth, winheight)
env[ENV_PREFIX + "DIMENSIONS"] = dimensions
env["COLUMNS"] = str(width)
env["LINES"] = str(height)
if self.server_url:
env[ENV_PREFIX + "URL"] = self.server_url
if self.extra_env:
_update_removing(env, self.extra_env)
term_env = kwargs.get("extra_env", {})
if term_env and isinstance(term_env, dict):
_update_removing(env, term_env)
return env
def new_terminal(self, **kwargs: Any) -> PtyWithClients:
"""Make a new terminal, return a :class:`PtyWithClients` instance."""
options = self.term_settings.copy()
options["shell_command"] = self.shell_command
options.update(kwargs)
argv = options["shell_command"]
env = self.make_term_env(**options)
cwd = options.get("cwd", None)
return PtyWithClients(argv, env, cwd)
def start_reading(self, ptywclients: PtyWithClients) -> None:
"""Connect a terminal to the tornado event loop to read data from it."""
fd = ptywclients.ptyproc.fd
self.ptys_by_fd[fd] = ptywclients
loop = IOLoop.current()
loop.add_handler(fd, self.pty_read, loop.READ)
def on_eof(self, ptywclients: PtyWithClients) -> None:
"""Called when the pty has closed."""
# Stop trying to read from that terminal
fd = ptywclients.ptyproc.fd
self.log.info("EOF on FD %d; stopping reading", fd)
del self.ptys_by_fd[fd]
IOLoop.current().remove_handler(fd)
# This closes the fd, and should result in the process being reaped.
ptywclients.ptyproc.close()
def pty_read(self, fd: int, events: Any = None) -> None:
"""Called by the event loop when there is pty data ready to read."""
# prevent blocking on fd
if not _poll(fd, timeout=0.1): # 100ms
self.log.debug("Spurious pty_read() on fd %s", fd)
return
ptywclients = self.ptys_by_fd[fd]
try:
self.pre_pty_read_hook(ptywclients)
s = ptywclients.ptyproc.read(65536)
ptywclients.read_buffer.append(s)
for client in ptywclients.clients:
client.on_pty_read(s)
except EOFError:
self.on_eof(ptywclients)
for client in ptywclients.clients:
client.on_pty_died()
def pre_pty_read_hook(self, ptywclients: PtyWithClients) -> None:
"""Hook before pty read, subclass can patch something into ptywclients when pty_read"""
def get_terminal(self, url_component: Any = None) -> PtyWithClients:
"""Override in a subclass to give a terminal to a new websocket connection
The :class:`TermSocket` handler works with zero or one URL components
(capturing groups in the URL spec regex). If it receives one, it is
passed as the ``url_component`` parameter; otherwise, this is None.
"""
raise NotImplementedError
def client_disconnected(self, websocket: Any) -> None:
"""Override this to e.g. kill terminals on client disconnection."""
async def shutdown(self) -> None:
"""Shutdown the manager."""
await self.kill_all()
if not self._blocking_io_executor_is_external:
self.blocking_io_executor.shutdown(wait=False, cancel_futures=True) # type:ignore[call-arg]
async def kill_all(self) -> None:
"""Kill all terminals."""
futures = []
for term in self.ptys_by_fd.values():
futures.append(term.terminate(force=True))
# wait for futures to finish
if futures:
await asyncio.gather(*futures)
class SingleTermManager(TermManagerBase):
"""All connections to the websocket share a common terminal."""
def __init__(self, **kwargs: Any) -> None:
"""Initialize the manager."""
super().__init__(**kwargs)
self.terminal: PtyWithClients | None = None
def get_terminal(self, url_component: Any = None) -> PtyWithClients:
""" "Get the singleton terminal."""
if self.terminal is None:
self.terminal = self.new_terminal()
self.start_reading(self.terminal)
return self.terminal
async def kill_all(self) -> None:
"""Kill the singletone terminal."""
await super().kill_all()
self.terminal = None
class MaxTerminalsReached(Exception):
"""An error raised when we exceed the max number of terminals."""
def __init__(self, max_terminals: int) -> None:
"""Initialize the error."""
self.max_terminals = max_terminals
def __str__(self) -> str:
"""The string representation of the error."""
return "Cannot create more than %d terminals" % self.max_terminals
class UniqueTermManager(TermManagerBase):
"""Give each websocket a unique terminal to use."""
def __init__(self, max_terminals: int | None = None, **kwargs: Any) -> None:
"""Initialize the manager."""
super().__init__(**kwargs)
self.max_terminals = max_terminals
def get_terminal(self, url_component: Any = None) -> PtyWithClients:
"""Get a terminal from the manager."""
if self.max_terminals and len(self.ptys_by_fd) >= self.max_terminals:
raise MaxTerminalsReached(self.max_terminals)
term = self.new_terminal()
self.start_reading(term)
return term
def client_disconnected(self, websocket: TermSocket) -> None:
"""Send terminal SIGHUP when client disconnects."""
self.log.info("Websocket closed, sending SIGHUP to terminal.")
if websocket.terminal:
if os.name == "nt":
websocket.terminal.kill()
# Immediately call the pty reader to process
# the eof and free up space
self.pty_read(websocket.terminal.ptyproc.fd)
return
websocket.terminal.killpg(signal.SIGHUP)
class NamedTermManager(TermManagerBase):
"""Share terminals between websockets connected to the same endpoint."""
def __init__(self, max_terminals: Any = None, **kwargs: Any) -> None:
"""Initialize the manager."""
super().__init__(**kwargs)
self.max_terminals = max_terminals
self.terminals: dict[str, PtyWithClients] = {}
def get_terminal(self, term_name: str) -> PtyWithClients: # type:ignore[override]
"""Get or create a terminal by name."""
assert term_name is not None
if term_name in self.terminals:
return self.terminals[term_name]
if self.max_terminals and len(self.terminals) >= self.max_terminals:
raise MaxTerminalsReached(self.max_terminals)
# Create new terminal
self.log.info("New terminal with specified name: %s", term_name)
term = self.new_terminal()
term.term_name = term_name
self.terminals[term_name] = term
self.start_reading(term)
return term
name_template = "%d"
def _next_available_name(self) -> str | None:
for n in itertools.count(start=1):
name = self.name_template % n
if name not in self.terminals:
return name
return None
def new_named_terminal(self, **kwargs: Any) -> tuple[str, PtyWithClients]:
"""Create a new named terminal with an automatic name."""
name = kwargs["name"] if "name" in kwargs else self._next_available_name()
term = self.new_terminal(**kwargs)
self.log.info("New terminal with automatic name: %s", name)
term.term_name = name
self.terminals[name] = term
self.start_reading(term)
return name, term
def kill(self, name: str, sig: int = signal.SIGTERM) -> None:
"""Kill a terminal by name."""
term = self.terminals[name]
term.kill(sig) # This should lead to an EOF
async def terminate(self, name: str, force: bool = False) -> None:
"""Terminate a terminal by name."""
term = self.terminals[name]
await term.terminate(force=force)
def on_eof(self, ptywclients: PtyWithClients) -> None:
"""Handle end of file for a pty with clients."""
super().on_eof(ptywclients)
name = ptywclients.term_name
self.log.info("Terminal %s closed", name)
assert name is not None
self.terminals.pop(name, None)
async def kill_all(self) -> None:
"""Kill all terminals."""
await super().kill_all()
self.terminals = {}
|