import enum import logging import sys import termios import tty from dataclasses import dataclass, field from getpass import getpass from typing import Any, TypedDict from clan_lib.errors import ClanError log = logging.getLogger(__name__) # This is for simulating user input in tests. MOCK_PROMPT_RESPONSE: None = None # ASCII control character constants CTRL_D_ASCII = 4 # EOF character CTRL_C_ASCII = 3 # Interrupt character DEL_ASCII = 127 # Delete character BACKSPACE_ASCII = 8 # Backspace character class PromptType(enum.Enum): LINE = "line" HIDDEN = "hidden" MULTILINE = "multiline" MULTILINE_HIDDEN = "multiline-hidden" class Display(TypedDict): label: str | None group: str | None helperText: str | None required: bool @dataclass class Prompt: name: str description: str prompt_type: PromptType persist: bool = False previous_value: str | None = None display: Display = field( default_factory=lambda: Display( { "label": None, "group": None, "helperText": None, "required": False, }, ), ) @classmethod def from_nix(cls: type["Prompt"], data: dict[str, Any]) -> "Prompt": return cls( name=data["name"], description=data.get("description", data["name"]), prompt_type=PromptType(data.get("type", "line")), persist=data.get("persist", False), display=data.get("display", {}), ) def get_multiline_hidden_input() -> str: """Get multiline input from the user without echoing the input. This function allows the user to enter multiple lines of text, and it will return the concatenated string of all lines entered. The user can finish the input by pressing Ctrl-D (EOF). """ # Save terminal settings fd = sys.stdin.fileno() old_settings = termios.tcgetattr(fd) lines = [] current_line: list[str] = [] try: # Change terminal settings - disable echo tty.setraw(fd) while True: char = sys.stdin.read(1) # Check for Ctrl-D (ASCII value 4 or EOF) if not char or ord(char) == CTRL_D_ASCII: # Add last line if not empty if current_line: lines.append("".join(current_line)) break # Check for Ctrl-C (KeyboardInterrupt) if ord(char) == CTRL_C_ASCII: raise KeyboardInterrupt # Handle Enter key if char in {"\r", "\n"}: lines.append("".join(current_line)) current_line = [] # Print newline for visual feedback sys.stdout.write("\r\n") sys.stdout.flush() # Handle backspace elif ord(char) == DEL_ASCII or ord(char) == BACKSPACE_ASCII: if current_line: current_line.pop() # Regular character else: current_line.append(char) finally: # Restore terminal settings termios.tcsetattr(fd, termios.TCSADRAIN, old_settings) # Print a final newline for clean display print() return "\n".join(lines) def _get_secret_input_with_confirmation( ident: str, input_type: PromptType, text: str, max_attempts: int = 3 ) -> str: """Get secret input with confirmation, retrying on mismatch.""" for attempt in range(max_attempts): try: first_input, second_input = _prompt_for_confirmation(input_type, text) if first_input == second_input: log.info("Input received and confirmed. Processing...") return first_input remaining = max_attempts - attempt - 1 if remaining > 0: attempts_text = "attempt" if remaining == 1 else "attempts" print( f"Values do not match. {remaining} {attempts_text} remaining.", file=sys.stderr, ) else: msg = f"Failed to confirm value for {ident} after {max_attempts} attempts." raise ClanError(msg) except (KeyboardInterrupt, EOFError) as e: msg = "User cancelled the input." raise ClanError(msg) from e # Should never reach here due to logic above, but keeping for safety msg = f"Failed to get input for {ident}" raise ClanError(msg) def _prompt_for_confirmation(input_type: PromptType, text: str) -> tuple[str, str]: """Prompt user twice for the same input to confirm.""" match input_type: case PromptType.MULTILINE_HIDDEN: print("Enter multiple lines (press Ctrl-D to finish or Ctrl-C to cancel):") first_input = get_multiline_hidden_input() print( "Confirm by entering the same value again (press Ctrl-D to finish or Ctrl-C to cancel):" ) second_input = get_multiline_hidden_input() case PromptType.HIDDEN: first_input = getpass(f"{text} (hidden): ") second_input = getpass(f"Confirm {text} (hidden): ") case _: msg = f"Unsupported input type for confirmation: {input_type}" raise ClanError(msg) return first_input, second_input def _get_regular_input(input_type: PromptType, text: str) -> str: """Get regular (non-secret) input from user.""" try: match input_type: case PromptType.LINE: return input(f"{text}: ") case PromptType.MULTILINE: print(f"{text} (Finish with Ctrl-D): ") content = sys.stdin.read() # Remove final newline if present to match hidden multi-line behavior return content.rstrip("\n") case _: msg = f"Unsupported input type: {input_type}" raise ClanError(msg) except (KeyboardInterrupt, EOFError) as e: msg = "User cancelled the input." raise ClanError(msg) from e def ask( ident: str, input_type: PromptType, label: str | None, ) -> str: """Ask user for input, with confirmation for secret inputs.""" text = label or f"Enter the value for {ident}:" log.info(f"Prompting value for {ident}") if MOCK_PROMPT_RESPONSE: return next(MOCK_PROMPT_RESPONSE) # Secret prompts require confirmation if input_type in (PromptType.HIDDEN, PromptType.MULTILINE_HIDDEN): return _get_secret_input_with_confirmation(ident, input_type, text) # Regular prompts don't need confirmation result = _get_regular_input(input_type, text) log.info("Input received. Processing...") return result