feat: wrap the readline functions

inhere · inhere · commit f45dd11e229e · 2021-08-06T13:38:51.000+08:00
Signed-off-by: inhere &lt;in.798@qq.com&gt;
diff --git a/example/readline/cb_handler.php b/example/readline/cb_handler.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * https://www.php.net/manual/zh/function.readline-callback-handler-install.php
+ */
+
+require dirname(__DIR__) . '/../test/bootstrap.php';
+
+/**
+ * @param int         $count
+ * @param string|null $prompt
+ *
+ * @return string
+ * @link https://www.php.net/manual/zh/function.readline-callback-handler-install.php#123075
+ */
+function handler_read_demo(int $count, string $prompt = null): string
+{
+    $prev = '';
+
+    // 初始化一个 readline 回调接口，然后终端输出提示信息并立即返回
+    // TIP: 第二次调用这个函数不需要移除上一个回调接口，这个函数将自动覆盖旧的接口
+    readline_callback_handler_install($prompt ?? " \e[D", function ($input) use (&$prev) {
+        echo "Input is: $input\n";
+        $prev .= $input . '|';
+    });
+
+    $str = '';
+    do {
+        $r = [STDIN];
+        // 配合 stream_select() 时回调的特性非常有用，它允许在 IO 与用户输入 间交叉进行
+        $n = stream_select($r, $w, $e, null);
+
+        // TIP: 每输入一个字符都会触发这里
+        if ($n && in_array(STDIN, $r, true)) {
+            // 当一个行被接收时读取一个字符并且通知 readline 调用回调函数
+            readline_callback_read_char();
+            // vdump(readline_info());
+            // $str = $prev . readline_info('line_buffer');
+            $str .= readline_info('line_buffer') . '|';
+        }
+    } while (mb_strlen($str) < $count); // use strlen if you need the exact byte count
+
+    // 移除上一个安装的回调函数句柄并且恢复终端设置
+    readline_callback_handler_remove();
+
+    echo "prev: $prev\n";
+    return $str;
+}
+
+$str = handler_read_demo(20, 'TEST > ');
+
+echo "str: $str";
diff --git a/example/readline/cb_handler2.php b/example/readline/cb_handler2.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * https://www.jb51.net/article/212496.htm
+ */
+
+use Toolkit\Cli\Util\Readline;
+
+require dirname(__DIR__) . '/../test/bootstrap.php';
+
+// 输出的内容进入这个回调函数中
+function rl_callback($ret)
+{
+    global $c, $prompting;
+
+    echo "您输入的内容是: $ret\n";
+    $c++;
+
+    readline_add_history($ret);
+
+    // 限制了就调用10次，也可以通过命令行输入的内容来判断，比如上面的 exit 那种进行退出
+    if ($c > 10) {
+        $prompting = false;
+        // 移除上一个安装的回调函数句柄并且恢复终端设置
+        readline_callback_handler_remove();
+    } else {
+        // 继续进行递归回调
+        readline_callback_handler_install("[$c] 输入点什么内容: ", 'rl_callback');
+    }
+}
+
+$c = 1;
+$prompting = true;
+
+// 初始化一个 readline 回调接口，然后终端输出提示信息并立即返回，需要等待 readline_callback_read_char() 函数调用后才会进入到回调函数中
+readline_callback_handler_install("[$c] 输入点什么内容: ", 'rl_callback');
+
+// 当 $prompting 为 ture 时，一直等待输入信息
+while ($prompting) {
+    $w = null;
+    $e = null;
+    $r = [STDIN];
+    $n = stream_select($r, $w, $e, null);
+    if ($n && in_array(STDIN, $r, true)) {
+        // 当一个行被接收时读取一个字符并且通知 readline 调用回调函数
+        readline_callback_read_char();
+    }
+}
+
+echo "结束，完成所有输入！\n";
+// [1] 输入点什么内容: A
+// 您输入的内容是: A
+// [2] 输入点什么内容: B
+// 您输入的内容是: B
+// [3] 输入点什么内容: C
+// 您输入的内容是: C
+// [4] 输入点什么内容: D
+// 您输入的内容是: D
+// [5] 输入点什么内容: E
+// 您输入的内容是: E
+// [6] 输入点什么内容: F
+// 您输入的内容是: F
+// [7] 输入点什么内容: G
+// 您输入的内容是: G
+// [8] 输入点什么内容: H
+// 您输入的内容是: H
+// [9] 输入点什么内容: I
+// 您输入的内容是: I
+// [10] 输入点什么内容: J
+// 您输入的内容是: J
+// 结束，完成所有输入！
+
+// print_r(readline_list_history());
+Readline::setListTmpFile(__DIR__ . '/cb_handler2.txt');
+print_r(Readline::listHistory());
+// Array
+// (
+//     [0] => A
+//     [1] => B
+//     [2] => C
+//     [3] => D
+//     [4] => E
+//     [5] => F
+//     [6] => G
+//     [7] => H
+//     [8] => I
+//     [9] => J
+// )
diff --git a/example/readline/cb_handler2.txt b/example/readline/cb_handler2.txt
@@ -0,0 +1,11 @@
+_HiStOrY_V2_
+a
+b
+c
+
+g
+dfd
+df
+
+sd
+s
diff --git a/example/readline/complete.php b/example/readline/complete.php
@@ -0,0 +1,67 @@
+<?php
+/**
+ * @link https://www.php.net/manual/zh/function.readline-completion-function.php
+ */
+
+require dirname(__DIR__) . '/../test/bootstrap.php';
+
+function your_callback($input, $index): array
+{
+    // Get info about the current buffer
+    /*
+    string(3) "efg" // last words
+    int(4)
+    array(6) {
+      ["line_buffer"]=> string(7) "adb efg" // full line
+      ["point"]=> int(7)
+      ["end"]=> int(7)
+      ["library_version"]=> string(16) "EditLine wrapper"
+      ["readline_name"]=> string(0) ""
+      ["attempted_completion_over"]=> int(0)
+    }
+
+     */
+    $rlInfo = readline_info();
+
+    // Figure out what the entire input is
+    $full_input = substr($rlInfo['line_buffer'], 0, $rlInfo['end']);
+
+    // vdump($input, $index, $full_input, $rlInfo);
+    // vdump($input, $index, $rlInfo);
+
+    $samples = [
+        'abc',
+        'tom',
+        'inhere',
+        'quit',
+        'exit',
+    ];
+    $matches = [];
+    if (!$input) {
+        return $samples;
+    }
+
+    // Get all matches based on the entire input buffer
+    foreach ($samples as $phrase) {
+        // Only add the end of the input (where this word begins)
+        // to the matches array
+        $matches[] = substr($phrase, $index);
+    }
+
+    return $matches;
+}
+
+$ok = readline_completion_function('your_callback');
+
+// 使用 Tab 键测试一下吧
+// $line = \Toolkit\Cli\Cli::readln('please input> ');
+$line = trim(readline("please input> "));
+if (!empty($line)) {
+    readline_add_history($line);
+}
+
+echo $line, PHP_EOL; // 当前输入的命令信息
+// 如果命令是 exit 或者 quit ，就退出程序执行
+if($line === 'exit' || $line === 'quit'){
+    exit('bye');
+}
diff --git a/example/readline/readline.php b/example/readline/readline.php
@@ -0,0 +1,45 @@
+<?php
+
+require dirname(__DIR__) . '/../test/bootstrap.php';
+
+$line = readline("command："); // 读取命令行交互信息
+if (!empty($line)) {
+    readline_add_history($line); // 需要手动加入到命令历史记录中
+}
+echo $line, PHP_EOL; // aaa
+
+$line = readline("command：");
+if (!empty($line)) {
+    readline_add_history($line);
+}
+
+readline_write_history($filename = __DIR__ . '/rl_history.txt');
+
+// 命令历史记录列表
+// TIP: on READLINE_LIB=libedit not support the function.
+// var_dump(readline_list_history());
+var_dump(file_get_contents($filename));
+// Array
+// (
+//     [0] => aaa
+//     [1] => bbb
+// )
+
+// 当前命令行内部的变量信息
+var_dump(readline_info());
+// Array
+// (
+//     [line_buffer] => bbb
+//     [point] => 3
+//     [end] => 3
+//     [mark] => 0
+//     [done] => 1
+//     [pending_input] => 0
+//     [prompt] => 请输入命令：
+//     [terminal_name] => xterm-256color
+//     [completion_append_character] =>
+//     [completion_suppress_append] =>
+//     [library_version] => 7.0
+//     [readline_name] => other
+//     [attempted_completion_over] => 0
+// )
diff --git a/example/readline/rl_history.txt b/example/readline/rl_history.txt
@@ -0,0 +1,3 @@
+_HiStOrY_V2_
+dfd
+faddf
diff --git a/src/Traits/ReadMessageTrait.php b/src/Traits/ReadMessageTrait.php
@@ -9,6 +9,10 @@
 
 namespace Toolkit\Cli\Traits;
 
+use Toolkit\Cli\Cli;
+use Toolkit\Cli\Util\Readline;
+use function fopen;
+use function strip_tags;
 use const STDIN;
 
 /**
@@ -35,7 +39,7 @@ trait ReadMessageTrait
     public static function read($message = null, bool $nl = false, array $opts = []): string
     {
         if ($message) {
-            self::write($message, $nl);
+            Cli::write($message, $nl);
         }
 
         $opts = array_merge([
@@ -61,9 +65,15 @@ public static function read($message = null, bool $nl = false, array $opts = [])
     public static function readln($message = null, bool $nl = false, array $opts = []): string
     {
         if ($message) {
-            self::write($message, $nl);
+            Cli::write($message, $nl);
         }
 
+        // TIP: use readline method, support left and right press.
+        if (Readline::isSupported()) {
+            return Readline::readline();
+        }
+
+        // read from input stream
         $opts = array_merge([
             'length' => 1024,
             'stream' => self::$inputStream,
@@ -97,7 +107,7 @@ public static function readRow($message = null, bool $nl = false): string
     public static function readSafe($message = null, bool $nl = false, array $opts = []): string
     {
         if ($message) {
-            self::write($message, $nl);
+            Cli::write($message, $nl);
         }
 
         $opts = array_merge([
@@ -106,7 +116,9 @@ public static function readSafe($message = null, bool $nl = false, array $opts =
             'allowTags' => null,
         ], $opts);
 
-        return trim(fgetss($opts['stream'], $opts['length'], $opts['allowTags']));
+        // up: fgetss has been DEPRECATED as of PHP 7.3.0
+        // return trim(fgetss($opts['stream'], $opts['length'], $opts['allowTags']));
+        return trim(strip_tags(fgets($opts['stream'], $opts['length']), $opts['allowTags']));
     }
 
     /**
@@ -137,6 +149,33 @@ public static function readFirst(string $message = '', bool $nl = false): string
         return self::readChar($message, $nl);
     }
 
+    /**
+     * Read password text.
+     * NOTICE: only support linux
+     *
+     * @param string $prompt
+     *
+     * @return string
+     * @link https://www.php.net/manual/zh/function.readline.php#120729
+     */
+    public static function readPassword(string $prompt = ''): string
+    {
+        $termDevice = '/dev/tty';
+        if ($prompt) {
+            Cli::write($prompt);
+        }
+
+        $h = fopen($termDevice, 'rb');
+        if ($h === false) {
+            // throw new RuntimeException("Failed to open terminal device");
+            return ''; // probably not running in a terminal.
+        }
+
+        $line = trim((string)fgets($h));
+        fclose($h);
+        return $line;
+    }
+
     /**
      * @return false|resource
      */
diff --git a/src/Util/Readline.php b/src/Util/Readline.php
diff --git a/test/bootstrap.php b/test/bootstrap.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,11 @@ @@
 +_HiStOrY_V2_
 +a
 +b
 +c
++
 +g
 +dfd
 +df
++
 +sd
 +s