/* * Copyright (c) 2018-2021, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include class TerminalChangeListener : public Config::Listener { public: TerminalChangeListener(VT::TerminalWidget& parent_terminal) : m_parent_terminal(parent_terminal) { } virtual void config_bool_did_change(DeprecatedString const& domain, DeprecatedString const& group, DeprecatedString const& key, bool value) override { VERIFY(domain == "Terminal"); if (group == "Terminal") { if (key == "ShowScrollBar") m_parent_terminal.set_show_scrollbar(value); else if (key == "ConfirmClose" && on_confirm_close_changed) on_confirm_close_changed(value); } else if (group == "Cursor" && key == "Blinking") { m_parent_terminal.set_cursor_blinking(value); } } virtual void config_string_did_change(DeprecatedString const& domain, DeprecatedString const& group, DeprecatedString const& key, DeprecatedString const& value) override { VERIFY(domain == "Terminal"); if (group == "Window" && key == "Bell") { auto bell_mode = VT::TerminalWidget::BellMode::Visible; if (value == "AudibleBeep") bell_mode = VT::TerminalWidget::BellMode::AudibleBeep; if (value == "Visible") bell_mode = VT::TerminalWidget::BellMode::Visible; if (value == "Disabled") bell_mode = VT::TerminalWidget::BellMode::Disabled; m_parent_terminal.set_bell_mode(bell_mode); } else if (group == "Text" && key == "Font") { auto font = Gfx::FontDatabase::the().get_by_name(value); if (font.is_null()) font = Gfx::FontDatabase::default_fixed_width_font(); m_parent_terminal.set_font_and_resize_to_fit(*font); m_parent_terminal.apply_size_increments_to_window(*m_parent_terminal.window()); m_parent_terminal.window()->resize(m_parent_terminal.size()); } else if (group == "Cursor" && key == "Shape") { auto cursor_shape = VT::TerminalWidget::parse_cursor_shape(value).value_or(VT::CursorShape::Block); m_parent_terminal.set_cursor_shape(cursor_shape); } } virtual void config_i32_did_change(DeprecatedString const& domain, DeprecatedString const& group, DeprecatedString const& key, i32 value) override { VERIFY(domain == "Terminal"); if (group == "Terminal" && key == "MaxHistorySize") { m_parent_terminal.set_max_history_size(value); } else if (group == "Window" && key == "Opacity") { m_parent_terminal.set_opacity(value); } } Function on_confirm_close_changed; private: VT::TerminalWidget& m_parent_terminal; }; static void utmp_update(DeprecatedString const& tty, pid_t pid, bool create) { int utmpupdate_pid = fork(); if (utmpupdate_pid < 0) { perror("fork"); return; } if (utmpupdate_pid == 0) { // Be careful here! Because fork() only clones one thread it's // possible that we deadlock on anything involving a mutex, // including the heap! So resort to low-level APIs char pid_str[32]; snprintf(pid_str, sizeof(pid_str), "%d", pid); execl("/bin/utmpupdate", "/bin/utmpupdate", "-f", "Terminal", "-p", pid_str, (create ? "-c" : "-d"), tty.characters(), nullptr); } else { wait_again: int status = 0; if (waitpid(utmpupdate_pid, &status, 0) < 0) { int err = errno; if (err == EINTR) goto wait_again; perror("waitpid"); return; } if (WIFEXITED(status) && WEXITSTATUS(status) != 0) dbgln("Terminal: utmpupdate exited with status {}", WEXITSTATUS(status)); else if (WIFSIGNALED(status)) dbgln("Terminal: utmpupdate exited due to unhandled signal {}", WTERMSIG(status)); } } static ErrorOr run_command(DeprecatedString command, bool keep_open) { DeprecatedString shell = "/bin/Shell"; auto* pw = getpwuid(getuid()); if (pw && pw->pw_shell) { shell = pw->pw_shell; } endpwent(); Vector arguments; arguments.append(shell); if (!command.is_empty()) { if (keep_open) arguments.append("--keep-open"sv); arguments.append("-c"sv); arguments.append(command); } auto env = TRY(FixedArray::try_create({ "TERM=xterm"sv, "PAGER=more"sv, "PATH="sv DEFAULT_PATH_SV })); TRY(Core::System::exec(shell, arguments, Core::System::SearchInPath::No, env.span())); VERIFY_NOT_REACHED(); } static ErrorOr> create_find_window(VT::TerminalWidget& terminal) { auto window = TRY(GUI::Window::try_create(&terminal)); window->set_window_mode(GUI::WindowMode::RenderAbove); window->set_title("Find in Terminal"); window->set_resizable(false); window->resize(300, 90); auto main_widget = TRY(window->try_set_main_widget()); main_widget->set_fill_with_background_color(true); main_widget->set_background_role(ColorRole::Button); (void)TRY(main_widget->try_set_layout()); main_widget->layout()->set_margins(4); auto find = TRY(main_widget->try_add()); (void)TRY(find->try_set_layout()); find->layout()->set_margins(4); find->set_fixed_height(30); auto find_textbox = TRY(find->try_add()); find_textbox->set_fixed_width(230); find_textbox->set_focus(true); if (terminal.has_selection()) find_textbox->set_text(terminal.selected_text().replace("\n"sv, " "sv, ReplaceMode::All)); auto find_backwards = TRY(find->try_add()); find_backwards->set_fixed_width(25); find_backwards->set_icon(TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/upward-triangle.png"sv))); auto find_forwards = TRY(find->try_add()); find_forwards->set_fixed_width(25); find_forwards->set_icon(TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/downward-triangle.png"sv))); find_textbox->on_return_pressed = [find_backwards] { find_backwards->click(); }; find_textbox->on_shift_return_pressed = [find_forwards] { find_forwards->click(); }; auto match_case = TRY(main_widget->try_add("Case sensitive")); auto wrap_around = TRY(main_widget->try_add("Wrap around")); find_backwards->on_click = [&terminal, find_textbox, match_case, wrap_around](auto) { auto needle = find_textbox->text(); if (needle.is_empty()) { return; } auto found_range = terminal.find_previous(needle, terminal.normalized_selection().start(), match_case->is_checked(), wrap_around->is_checked()); if (found_range.is_valid()) { terminal.scroll_to_row(found_range.start().row()); terminal.set_selection(found_range); } }; find_forwards->on_click = [&terminal, find_textbox, match_case, wrap_around](auto) { auto needle = find_textbox->text(); if (needle.is_empty()) { return; } auto found_range = terminal.find_next(needle, terminal.normalized_selection().end(), match_case->is_checked(), wrap_around->is_checked()); if (found_range.is_valid()) { terminal.scroll_to_row(found_range.start().row()); terminal.set_selection(found_range); } }; return window; } ErrorOr serenity_main(Main::Arguments arguments) { TRY(Core::System::pledge("stdio tty rpath cpath wpath recvfd sendfd proc exec unix sigaction")); struct sigaction act; memset(&act, 0, sizeof(act)); act.sa_flags = SA_NOCLDWAIT; act.sa_handler = SIG_IGN; TRY(Core::System::sigaction(SIGCHLD, &act, nullptr)); auto app = TRY(GUI::Application::try_create(arguments)); TRY(Core::System::pledge("stdio tty rpath cpath wpath recvfd sendfd proc exec unix")); Config::pledge_domain("Terminal"); char const* command_to_execute = nullptr; bool keep_open = false; Core::ArgsParser args_parser; args_parser.add_option(command_to_execute, "Execute this command inside the terminal", nullptr, 'e', "command"); args_parser.add_option(keep_open, "Keep the terminal open after the command has finished executing", nullptr, 'k'); args_parser.parse(arguments); if (keep_open && !command_to_execute) { warnln("Option -k can only be used in combination with -e."); return 1; } int ptm_fd; pid_t shell_pid = forkpty(&ptm_fd, nullptr, nullptr, nullptr); if (shell_pid < 0) { perror("forkpty"); return 1; } if (shell_pid == 0) { close(ptm_fd); if (command_to_execute) TRY(run_command(command_to_execute, keep_open)); else TRY(run_command(Config::read_string("Terminal"sv, "Startup"sv, "Command"sv, ""sv), false)); VERIFY_NOT_REACHED(); } auto ptsname = TRY(Core::System::ptsname(ptm_fd)); utmp_update(ptsname, shell_pid, true); auto app_icon = GUI::Icon::default_icon("app-terminal"sv); auto window = TRY(GUI::Window::try_create()); window->set_title("Terminal"); window->set_obey_widget_min_size(false); auto terminal = TRY(window->try_set_main_widget(ptm_fd, true)); terminal->on_command_exit = [&] { app->quit(0); }; terminal->on_title_change = [&](auto title) { window->set_title(title); }; terminal->on_terminal_size_change = [&](auto size) { window->resize(size); }; terminal->apply_size_increments_to_window(*window); window->set_icon(app_icon.bitmap_for_size(16)); Config::monitor_domain("Terminal"); auto should_confirm_close = Config::read_bool("Terminal"sv, "Terminal"sv, "ConfirmClose"sv, true); TerminalChangeListener listener { terminal }; auto bell = Config::read_string("Terminal"sv, "Window"sv, "Bell"sv, "Visible"sv); if (bell == "AudibleBeep") { terminal->set_bell_mode(VT::TerminalWidget::BellMode::AudibleBeep); } else if (bell == "Disabled") { terminal->set_bell_mode(VT::TerminalWidget::BellMode::Disabled); } else { terminal->set_bell_mode(VT::TerminalWidget::BellMode::Visible); } auto cursor_shape = VT::TerminalWidget::parse_cursor_shape(Config::read_string("Terminal"sv, "Cursor"sv, "Shape"sv, "Block"sv)).value_or(VT::CursorShape::Block); terminal->set_cursor_shape(cursor_shape); auto cursor_blinking = Config::read_bool("Terminal"sv, "Cursor"sv, "Blinking"sv, true); terminal->set_cursor_blinking(cursor_blinking); auto find_window = TRY(create_find_window(terminal)); auto new_opacity = Config::read_i32("Terminal"sv, "Window"sv, "Opacity"sv, 255); terminal->set_opacity(new_opacity); window->set_has_alpha_channel(new_opacity < 255); auto new_scrollback_size = Config::read_i32("Terminal"sv, "Terminal"sv, "MaxHistorySize"sv, terminal->max_history_size()); terminal->set_max_history_size(new_scrollback_size); auto show_scroll_bar = Config::read_bool("Terminal"sv, "Terminal"sv, "ShowScrollBar"sv, true); terminal->set_show_scrollbar(show_scroll_bar); auto open_settings_action = GUI::Action::create("Terminal &Settings", TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/settings.png"sv)), [&](auto&) { GUI::Process::spawn_or_show_error(window, "/bin/TerminalSettings"sv); }); TRY(terminal->context_menu().try_add_separator()); TRY(terminal->context_menu().try_add_action(open_settings_action)); auto file_menu = TRY(window->try_add_menu("&File")); TRY(file_menu->try_add_action(GUI::Action::create("Open New &Terminal", { Mod_Ctrl | Mod_Shift, Key_N }, TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/app-terminal.png"sv)), [&](auto&) { GUI::Process::spawn_or_show_error(window, "/bin/Terminal"sv); }))); TRY(file_menu->try_add_action(open_settings_action)); TRY(file_menu->try_add_separator()); auto tty_has_foreground_process = [&] { pid_t fg_pid = tcgetpgrp(ptm_fd); return fg_pid != -1 && fg_pid != shell_pid; }; auto shell_child_process_count = [&] { Core::DirIterator iterator(DeprecatedString::formatted("/proc/{}/children", shell_pid), Core::DirIterator::Flags::SkipParentAndBaseDir); int background_process_count = 0; while (iterator.has_next()) { ++background_process_count; (void)iterator.next_path(); } return background_process_count; }; auto check_terminal_quit = [&]() -> GUI::Dialog::ExecResult { if (!should_confirm_close) return GUI::MessageBox::ExecResult::OK; Optional close_message; if (tty_has_foreground_process()) { close_message = "There is still a process running in this terminal. Closing the terminal will kill it."; } else { auto child_process_count = shell_child_process_count(); if (child_process_count > 1) close_message = DeprecatedString::formatted("There are {} background processes running in this terminal. Closing the terminal may kill them.", child_process_count); else if (child_process_count == 1) close_message = "There is a background process running in this terminal. Closing the terminal may kill it."; } if (close_message.has_value()) return GUI::MessageBox::show(window, *close_message, "Close this terminal?"sv, GUI::MessageBox::Type::Warning, GUI::MessageBox::InputType::OKCancel); return GUI::MessageBox::ExecResult::OK; }; TRY(file_menu->try_add_action(GUI::CommonActions::make_quit_action([&](auto&) { dbgln("Terminal: Quit menu activated!"); if (check_terminal_quit() == GUI::MessageBox::ExecResult::OK) GUI::Application::the()->quit(); }))); auto edit_menu = TRY(window->try_add_menu("&Edit")); TRY(edit_menu->try_add_action(terminal->copy_action())); TRY(edit_menu->try_add_action(terminal->paste_action())); TRY(edit_menu->try_add_separator()); TRY(edit_menu->try_add_action(GUI::Action::create("&Find...", { Mod_Ctrl | Mod_Shift, Key_F }, TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/find.png"sv)), [&](auto&) { find_window->show(); find_window->move_to_front(); }))); auto view_menu = TRY(window->try_add_menu("&View")); TRY(view_menu->try_add_action(GUI::CommonActions::make_fullscreen_action([&](auto&) { window->set_fullscreen(!window->is_fullscreen()); }))); TRY(view_menu->try_add_action(terminal->clear_including_history_action())); auto help_menu = TRY(window->try_add_menu("&Help")); TRY(help_menu->try_add_action(GUI::CommonActions::make_command_palette_action(window))); TRY(help_menu->try_add_action(GUI::CommonActions::make_help_action([](auto&) { Desktop::Launcher::open(URL::create_with_file_scheme("/usr/share/man/man1/Terminal.md"), "/bin/Help"); }))); TRY(help_menu->try_add_action(GUI::CommonActions::make_about_action("Terminal", app_icon, window))); window->on_close_request = [&]() -> GUI::Window::CloseRequestDecision { if (check_terminal_quit() == GUI::MessageBox::ExecResult::OK) return GUI::Window::CloseRequestDecision::Close; return GUI::Window::CloseRequestDecision::StayOpen; }; window->on_input_preemption_change = [&](bool is_preempted) { terminal->set_logical_focus(!is_preempted); }; TRY(Core::System::unveil("/sys/kernel/processes", "r")); TRY(Core::System::unveil("/res", "r")); TRY(Core::System::unveil("/bin", "r")); TRY(Core::System::unveil("/proc", "r")); TRY(Core::System::unveil("/bin/Terminal", "x")); TRY(Core::System::unveil("/bin/TerminalSettings", "x")); TRY(Core::System::unveil("/bin/utmpupdate", "x")); TRY(Core::System::unveil("/etc/FileIconProvider.ini", "r")); TRY(Core::System::unveil("/tmp/session/%sid/portal/launch", "rw")); TRY(Core::System::unveil("/tmp/session/%sid/portal/config", "rw")); TRY(Core::System::unveil(nullptr, nullptr)); auto modified_state_check_timer = Core::Timer::create_repeating(500, [&] { window->set_modified(tty_has_foreground_process() || shell_child_process_count() > 0); }); listener.on_confirm_close_changed = [&](bool confirm_close) { if (confirm_close) { modified_state_check_timer->start(); } else { modified_state_check_timer->stop(); window->set_modified(false); } should_confirm_close = confirm_close; }; window->show(); if (should_confirm_close) modified_state_check_timer->start(); int result = app->exec(); dbgln("Exiting terminal, updating utmp"); utmp_update(ptsname, 0, false); return result; }