From e623ad041f4937b0e7ed22f3159acfee6c0147b3 Mon Sep 17 00:00:00 2001
From: Azat Khuzhin <a3at.mail@gmail.com>
Date: Thu, 25 Jul 2024 16:44:17 +0200
Subject: [PATCH] Make C-z ignorance configurable (ignore_shell_suspend) in
 clickhouse-client

C-z is extermelly useful for some users (like myself), so provide a way
to configure it in client and avoid it's ignorance in clickhouse-disks
(I hope it is OK since it is not that known utility and it does not have
it's own configuration, while cli option is useless, one should remeber
about it).

Honestly I've never seen any interactive client that forbids C-z, so
ignoring it my default looks strange to me.

Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
---
 programs/client/clickhouse-client.xml   | 3 +++
 programs/disks/DisksApp.cpp             | 1 +
 programs/disks/DisksApp.h               | 2 +-
 programs/disks/DisksClient.cpp          | 1 -
 programs/disks/DisksClient.h            | 3 +--
 programs/keeper-client/KeeperClient.cpp | 1 +
 src/Client/ClientBase.cpp               | 1 +
 src/Client/ReplxxLineReader.cpp         | 4 +++-
 src/Client/ReplxxLineReader.h           | 1 +
 9 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/programs/client/clickhouse-client.xml b/programs/client/clickhouse-client.xml
index 9ce7d1cb223..6eb8976a6ef 100644
--- a/programs/client/clickhouse-client.xml
+++ b/programs/client/clickhouse-client.xml
@@ -53,6 +53,9 @@
     </proto_caps>
     -->
 
+    <!-- Do not send clickhouse-client to background on C-z -->
+    <!-- <ignore_shell_suspend>true</ignore_shell_suspend> -->
+
     <!--
         Settings adjustable via command-line parameters
         can take their defaults from that config file, see examples:
diff --git a/programs/disks/DisksApp.cpp b/programs/disks/DisksApp.cpp
index 59ba45b9451..884550ff2ed 100644
--- a/programs/disks/DisksApp.cpp
+++ b/programs/disks/DisksApp.cpp
@@ -247,6 +247,7 @@ void DisksApp::runInteractiveReplxx()
         suggest,
         history_file,
         /* multiline= */ false,
+        /* ignore_shell_suspend= */ false,
         query_extenders,
         query_delimiters,
         word_break_characters.c_str(),
diff --git a/programs/disks/DisksApp.h b/programs/disks/DisksApp.h
index f8167884c62..5b240648508 100644
--- a/programs/disks/DisksApp.h
+++ b/programs/disks/DisksApp.h
@@ -2,7 +2,7 @@
 
 #include <unordered_map>
 #include <vector>
-#include <Client/ReplxxLineReader.h>
+#include <Client/LineReader.h>
 #include <Loggers/Loggers.h>
 #include "DisksClient.h"
 #include "ICommand_fwd.h"
diff --git a/programs/disks/DisksClient.cpp b/programs/disks/DisksClient.cpp
index 7e36c7911ab..53d7c7f78f6 100644
--- a/programs/disks/DisksClient.cpp
+++ b/programs/disks/DisksClient.cpp
@@ -1,6 +1,5 @@
 #include "DisksClient.h"
 #include <Client/ClientBase.h>
-#include <Client/ReplxxLineReader.h>
 #include <Disks/registerDisks.h>
 #include <Common/Config/ConfigProcessor.h>
 
diff --git a/programs/disks/DisksClient.h b/programs/disks/DisksClient.h
index 8a55d22af93..299631f1afe 100644
--- a/programs/disks/DisksClient.h
+++ b/programs/disks/DisksClient.h
@@ -5,9 +5,8 @@
 #include <string>
 #include <unordered_map>
 #include <vector>
-#include <Client/ReplxxLineReader.h>
 #include <Loggers/Loggers.h>
-#include "Disks/IDisk.h"
+#include <Disks/IDisk.h>
 
 #include <Interpreters/Context.h>
 #include <boost/program_options/options_description.hpp>
diff --git a/programs/keeper-client/KeeperClient.cpp b/programs/keeper-client/KeeperClient.cpp
index a20c1f686f3..ad376d4b88f 100644
--- a/programs/keeper-client/KeeperClient.cpp
+++ b/programs/keeper-client/KeeperClient.cpp
@@ -314,6 +314,7 @@ void KeeperClient::runInteractiveReplxx()
         suggest,
         history_file,
         /* multiline= */ false,
+        /* ignore_shell_suspend= */ false,
         query_extenders,
         query_delimiters,
         word_break_characters,
diff --git a/src/Client/ClientBase.cpp b/src/Client/ClientBase.cpp
index 74357d33f1c..01d03006eec 100644
--- a/src/Client/ClientBase.cpp
+++ b/src/Client/ClientBase.cpp
@@ -2554,6 +2554,7 @@ void ClientBase::runInteractive()
         *suggest,
         history_file,
         getClientConfiguration().has("multiline"),
+        getClientConfiguration().getBool("ignore_shell_suspend", true),
         query_extenders,
         query_delimiters,
         word_break_characters,
diff --git a/src/Client/ReplxxLineReader.cpp b/src/Client/ReplxxLineReader.cpp
index 3b3508d1a58..78ae6c5eb15 100644
--- a/src/Client/ReplxxLineReader.cpp
+++ b/src/Client/ReplxxLineReader.cpp
@@ -294,6 +294,7 @@ ReplxxLineReader::ReplxxLineReader(
     Suggest & suggest,
     const String & history_file_path_,
     bool multiline_,
+    bool ignore_shell_suspend,
     Patterns extenders_,
     Patterns delimiters_,
     const char word_break_characters_[],
@@ -363,7 +364,8 @@ ReplxxLineReader::ReplxxLineReader(
     rx.bind_key(Replxx::KEY::control('P'), [this](char32_t code) { return rx.invoke(Replxx::ACTION::HISTORY_PREVIOUS, code); });
 
     /// We don't want the default, "suspend" behavior, it confuses people.
-    rx.bind_key_internal(replxx::Replxx::KEY::control('Z'), "insert_character");
+    if (ignore_shell_suspend)
+        rx.bind_key_internal(replxx::Replxx::KEY::control('Z'), "insert_character");
 
     auto commit_action = [this](char32_t code)
     {
diff --git a/src/Client/ReplxxLineReader.h b/src/Client/ReplxxLineReader.h
index c46080420ef..1dbad2c70dd 100644
--- a/src/Client/ReplxxLineReader.h
+++ b/src/Client/ReplxxLineReader.h
@@ -15,6 +15,7 @@ public:
         Suggest & suggest,
         const String & history_file_path,
         bool multiline,
+        bool ignore_shell_suspend,
         Patterns extenders_,
         Patterns delimiters_,
         const char word_break_characters_[],