Remove readline library

Readline library is not compatible with PHP license-wise and shouldn't
be compiled into the executable. This can be simplified by using the
libedit library with pkgconf determining its availability.

This is a continuation of #3823
and other discussions in the past.

Author: petk

.circleci/config.yml

@@ -59,7 +59,7 @@ jobs:
               libxml2-dev \
               libxslt1-dev \
               libpq-dev \
-              libreadline-dev \
+              libedit-dev \
               libldap2-dev \
               libsodium-dev \
               libargon2-0-dev \

.github/actions/apt-x32/action.yml

@@ -30,7 +30,7 @@ runs:
           libonig-dev:i386 \
           libpng-dev:i386 \
           libpq-dev:i386 \
-          libreadline-dev:i386 \
+          libedit-dev:i386 \
           libsasl2-dev:i386 \
           libsodium-dev:i386 \
           libsqlite3-dev:i386 \

.github/actions/apt-x64/action.yml

@@ -45,7 +45,7 @@ runs:
           libxml2-dev \
           libxslt1-dev \
           libpq-dev \
-          libreadline-dev \
+          libedit-dev \
           libldap2-dev \
           libsodium-dev \
           libargon2-0-dev \

.github/actions/configure-macos/action.yml

@@ -45,7 +45,7 @@ runs:
           --enable-sysvshm \
           --enable-shmop \
           --enable-pcntl \
-          --with-readline=/usr/local/opt/readline \
+          --with-readline \
           --enable-mbstring \
           --with-curl \
           --with-gettext=/usr/local/opt/gettext \

UPGRADING.INTERNALS

@@ -47,8 +47,12 @@ PHP 8.4 INTERNALS UPGRADE NOTES
  b. Unix build system changes
    - The configure option --with-zlib-dir has been removed.
    - The configure option --enable-phpdbg-readline has been removed. Readline
-     support in sapi/phpdbg is determined automatically whether ext/readline is
-     enabled and built statically.
+     support in sapi/phpdbg is determined automatically whether ext/readline has
+     been enabled during the build.
+   - The configure option --with-libedit has been removed (use --with-readline).
+   - The configure option --with-readline now requires libedit library instead
+     of Readline library and doesn't accept directory argument anymore. To
+     customize libedit, use Pkgconf's EDIT_CFLAGS and EDIT_LIBS variables.
    - COOKIE_IO_FUNCTIONS_T symbol has been removed (use cookie_io_functions_t).
    - HAVE_SOCKADDR_UN_SUN_LEN symbol renamed to HAVE_STRUCT_SOCKADDR_UN_SUN_LEN.
    - PHP_CHECK_IN_ADDR_T M4 macro and 'in_addr_t' fallback definition to 'u_int'

build/php.m4

@@ -2023,6 +2023,25 @@ AC_DEFUN([PHP_SETUP_EXPAT], [
   AC_DEFINE(HAVE_LIBEXPAT, 1, [ ])
 ])
 
+dnl
+dnl
+dnl PHP_SETUP_EDIT([shared-add],[action-if-found],[action-if-not-found])
+dnl
+dnl Common setup macro for linking libedit library.
+dnl
+AC_DEFUN([PHP_SETUP_EDIT], [
+  found_libedit=no
+
+  PKG_CHECK_MODULES([EDIT],[libedit],[found_libedit=yes],[found_libedit=no])
+
+  if test "$found_libedit" = "yes"; then
+    PHP_EVAL_LIBLINE($EDIT_LIBS, $1)
+    PHP_EVAL_INCLINE($EDIT_CFLAGS)
+ifelse([$2],[],:,[$2])
+ifelse([$3],[],,[else $3])
+  fi
+])
+
 dnl ----------------------------------------------------------------------------
 dnl Misc. macros
 dnl ----------------------------------------------------------------------------

ext/readline/config.m4

@@ -1,91 +1,14 @@
-PHP_ARG_WITH([libedit],
-  [for libedit readline replacement],
-  [AS_HELP_STRING([--with-libedit],
-    [Include libedit readline replacement (CLI/CGI only)])])
-
-if test "$PHP_LIBEDIT" = "no"; then
-  PHP_ARG_WITH([readline],
-    [for readline support],
-    [AS_HELP_STRING([[--with-readline[=DIR]]],
-      [Include readline support (CLI/CGI only)])])
-else
-  dnl "register" the --with-readline option to prevent invalid "unknown
-  dnl configure option" warning
-  php_with_readline=no
-fi
+PHP_ARG_WITH([readline],
+  [for readline support with libedit],
+  [AS_HELP_STRING([[--with-readline]],
+    [Include readline support using libedit (CLI/CGI only)])])
 
 if test "$PHP_READLINE" && test "$PHP_READLINE" != "no"; then
-  for i in $PHP_READLINE /usr/local /usr; do
-    test -f $i/include/readline/readline.h && READLINE_DIR=$i && break
-  done
-
-  if test -z "$READLINE_DIR"; then
-    AC_MSG_ERROR(Please reinstall readline - I cannot find readline.h)
+  if test "$PHP_READLINE" != "yes"; then
+    AC_MSG_WARN([Library directory ignored, rely on pkg-config])
   fi
 
-  PHP_ADD_INCLUDE($READLINE_DIR/include)
-
-  PHP_READLINE_LIBS=""
-  AC_CHECK_LIB(ncurses, tgetent,
-  [
-    PHP_ADD_LIBRARY(ncurses,,READLINE_SHARED_LIBADD)
-    PHP_READLINE_LIBS="$PHP_READLINE_LIBS -lncurses"
-  ],[
-    AC_CHECK_LIB(termcap, tgetent,
-    [
-      PHP_ADD_LIBRARY(termcap,,READLINE_SHARED_LIBADD)
-      PHP_READLINE_LIBS="$PHP_READLINE_LIBS -ltermcap"
-    ])
-  ])
-
-  PHP_CHECK_LIBRARY(readline, readline,
-  [
-    PHP_ADD_LIBRARY_WITH_PATH(readline, $READLINE_DIR/$PHP_LIBDIR, READLINE_SHARED_LIBADD)
-  ], [
-    AC_MSG_ERROR(readline library not found)
-  ], [
-    -L$READLINE_DIR/$PHP_LIBDIR $PHP_READLINE_LIBS
-  ])
-
-  PHP_CHECK_LIBRARY(readline, rl_pending_input,
-  [], [
-    AC_MSG_ERROR([invalid readline installation detected. Try --with-libedit instead.])
-  ], [
-    -L$READLINE_DIR/$PHP_LIBDIR $PHP_READLINE_LIBS
-  ])
-
-  PHP_CHECK_LIBRARY(readline, rl_callback_read_char,
-  [
-    AC_DEFINE(HAVE_RL_CALLBACK_READ_CHAR, 1, [ ])
-  ],[],[
-    -L$READLINE_DIR/$PHP_LIBDIR $PHP_READLINE_LIBS
-  ])
-
-  PHP_CHECK_LIBRARY(readline, rl_on_new_line,
-  [
-    AC_DEFINE(HAVE_RL_ON_NEW_LINE, 1, [ ])
-  ],[],[
-    -L$READLINE_DIR/$PHP_LIBDIR $PHP_READLINE_LIBS
-  ])
-
-  PHP_CHECK_LIBRARY(readline, rl_completion_matches,
-  [
-    AC_DEFINE(HAVE_RL_COMPLETION_MATCHES, 1, [ ])
-  ],[],[
-    -L$READLINE_DIR/$PHP_LIBDIR $PHP_READLINE_LIBS
-  ])
-
-  AC_DEFINE(HAVE_HISTORY_LIST, 1, [ ])
-  AC_DEFINE(HAVE_LIBREADLINE, 1, [ ])
-
-elif test "$PHP_LIBEDIT" != "no"; then
-  if test "$PHP_LIBEDIT" != "yes"; then
-    AC_MSG_WARN([libedit directory ignored, rely on pkg-config])
-  fi
-
-  PKG_CHECK_MODULES([EDIT], [libedit])
-  PHP_EVAL_LIBLINE($EDIT_LIBS, READLINE_SHARED_LIBADD)
-  PHP_EVAL_INCLINE($EDIT_CFLAGS)
+  PHP_SETUP_EDIT(READLINE_SHARED_LIBADD)
 
   AC_CHECK_LIB(ncurses, tgetent,
   [
@@ -133,11 +56,10 @@ elif test "$PHP_LIBEDIT" != "no"; then
     $READLINE_SHARED_LIBADD
   ])
 
-  AC_DEFINE(HAVE_LIBEDIT, 1, [ ])
-fi
+  AC_DEFINE(HAVE_LIBEDIT,[1],[Whether libedit is available])
 
-if test "$PHP_READLINE" != "no" || test "$PHP_LIBEDIT" != "no"; then
-  dnl Add -Wno-strict-prototypes as depends on user libs
+  dnl Add -Wno-strict-prototypes for Clang because of upstream library issues.
+  # TODO: Libedit on macos seems to be working fine on current versions.
   PHP_NEW_EXTENSION(readline, readline.c readline_cli.c, $ext_shared, cli, "-Wno-strict-prototypes")
   PHP_SUBST(READLINE_SHARED_LIBADD)
 fi

ext/readline/php_readline.h

@@ -17,13 +17,8 @@
 #ifndef PHP_READLINE_H
 #define PHP_READLINE_H
 
-#if HAVE_LIBEDIT
+#ifdef HAVE_LIBEDIT
 #define READLINE_LIB "libedit"
-#else
-#define READLINE_LIB "readline"
-#endif
-
-#if HAVE_LIBREADLINE || HAVE_LIBEDIT
 
 extern zend_module_entry readline_module_entry;
 #define phpext_readline_ptr &readline_module_entry
@@ -35,6 +30,6 @@ extern zend_module_entry readline_module_entry;
 
 #define phpext_readline_ptr NULL
 
-#endif /* HAVE_LIBREADLINE */
+#endif /* HAVE_LIBEDIT */
 
 #endif /* PHP_READLINE_H */

ext/readline/readline.c

@@ -25,18 +25,13 @@
 #include "readline_cli.h"
 #include "readline_arginfo.h"
 
-#if HAVE_LIBREADLINE || HAVE_LIBEDIT
+#ifdef HAVE_LIBEDIT
 
 #ifndef HAVE_RL_COMPLETION_MATCHES
 #define rl_completion_matches completion_matches
 #endif
 
-#ifdef HAVE_LIBEDIT
 #include <editline/readline.h>
-#else
-#include <readline/readline.h>
-#include <readline/history.h>
-#endif
 
 #if HAVE_RL_CALLBACK_READ_CHAR
 
@@ -74,10 +69,6 @@ ZEND_GET_MODULE(readline)
 
 PHP_MINIT_FUNCTION(readline)
 {
-#if HAVE_LIBREADLINE
-		/* libedit don't need this call which set the tty in cooked mode */
-	using_history();
-#endif
 	ZVAL_UNDEF(&_readline_completion);
 #if HAVE_RL_CALLBACK_READ_CHAR
 	ZVAL_UNDEF(&_prepped_callback);
@@ -158,23 +149,6 @@ PHP_FUNCTION(readline_info)
 		add_assoc_long(return_value,"point",rl_point);
 #ifndef PHP_WIN32
 		add_assoc_long(return_value,"end",rl_end);
-#endif
-#ifdef HAVE_LIBREADLINE
-		add_assoc_long(return_value,"mark",rl_mark);
-		add_assoc_long(return_value,"done",rl_done);
-		add_assoc_long(return_value,"pending_input",rl_pending_input);
-		add_assoc_string(return_value,"prompt",SAFE_STRING(rl_prompt));
-		add_assoc_string(return_value,"terminal_name",(char *)SAFE_STRING(rl_terminal_name));
-		add_assoc_str(return_value, "completion_append_character",
-			rl_completion_append_character == 0
-				? ZSTR_EMPTY_ALLOC()
-				: ZSTR_CHAR(rl_completion_append_character));
-		add_assoc_bool(return_value,"completion_suppress_append",rl_completion_suppress_append);
-#endif
-#if HAVE_ERASE_EMPTY_LINE
-		add_assoc_long(return_value,"erase_empty_line",rl_erase_empty_line);
-#endif
-#ifndef PHP_WIN32
 		add_assoc_string(return_value,"library_version",(char *)SAFE_STRING(rl_library_version));
 #endif
 		add_assoc_string(return_value,"readline_name",(char *)SAFE_STRING(rl_readline_name));
@@ -195,55 +169,6 @@ PHP_FUNCTION(readline_info)
 #ifndef PHP_WIN32
 		} else if (zend_string_equals_literal_ci(what, "end")) {
 			RETVAL_LONG(rl_end);
-#endif
-#ifdef HAVE_LIBREADLINE
-		} else if (zend_string_equals_literal_ci(what, "mark")) {
-			RETVAL_LONG(rl_mark);
-		} else if (zend_string_equals_literal_ci(what, "done")) {
-			oldval = rl_done;
-			if (value) {
-				rl_done = zval_get_long(value);
-			}
-			RETVAL_LONG(oldval);
-		} else if (zend_string_equals_literal_ci(what, "pending_input")) {
-			oldval = rl_pending_input;
-			if (value) {
-				if (!try_convert_to_string(value)) {
-					RETURN_THROWS();
-				}
-				rl_pending_input = Z_STRVAL_P(value)[0];
-			}
-			RETVAL_LONG(oldval);
-		} else if (zend_string_equals_literal_ci(what, "prompt")) {
-			RETVAL_STRING(SAFE_STRING(rl_prompt));
-		} else if (zend_string_equals_literal_ci(what, "terminal_name")) {
-			RETVAL_STRING((char *)SAFE_STRING(rl_terminal_name));
-		} else if (zend_string_equals_literal_ci(what, "completion_suppress_append")) {
-			oldval = rl_completion_suppress_append;
-			if (value) {
-				rl_completion_suppress_append = zend_is_true(value);
-			}
-			RETVAL_BOOL(oldval);
-		} else if (zend_string_equals_literal_ci(what, "completion_append_character")) {
-			oldval = rl_completion_append_character;
-			if (value) {
-				if (!try_convert_to_string(value)) {
-					RETURN_THROWS();
-				}
-				rl_completion_append_character = (int)Z_STRVAL_P(value)[0];
-			}
-			RETVAL_INTERNED_STR(
-				oldval == 0 ? ZSTR_EMPTY_ALLOC() : ZSTR_CHAR(oldval));
-#endif
-#if HAVE_ERASE_EMPTY_LINE
-		} else if (zend_string_equals_literal_ci(what, "erase_empty_line")) {
-			oldval = rl_erase_empty_line;
-			if (value) {
-				rl_erase_empty_line = zval_get_long(value);
-			}
-			RETVAL_LONG(oldval);
-#endif
-#ifndef PHP_WIN32
 		} else if (zend_string_equals_literal_ci(what,"library_version")) {
 			RETVAL_STRING((char *)SAFE_STRING(rl_library_version));
 #endif
@@ -291,11 +216,9 @@ PHP_FUNCTION(readline_clear_history)
 		RETURN_THROWS();
 	}
 
-#if HAVE_LIBEDIT
 	/* clear_history is the only function where rl_initialize
 	   is not call to ensure correct allocation */
 	using_history();
-#endif
 	clear_history();
 
 	RETURN_TRUE;
@@ -315,7 +238,7 @@ PHP_FUNCTION(readline_list_history)
 
 	array_init(return_value);
 
-#if defined(HAVE_LIBEDIT) && defined(PHP_WIN32) /* Winedit on Windows */
+#ifdef PHP_WIN32 /* Winedit on Windows */
 	history = history_list();
 
 	if (history) {
@@ -325,7 +248,7 @@ PHP_FUNCTION(readline_list_history)
 		}
 	}
 
-#elif defined(HAVE_LIBEDIT) /* libedit */
+#else
 	{
 		HISTORY_STATE *hs;
 		int i;
@@ -342,16 +265,6 @@ PHP_FUNCTION(readline_list_history)
 		}
 		free(hs);
 	}
-
-#else /* readline */
-	history = history_list();
-
-	if (history) {
-		int i;
-		for (i = 0; history[i]; i++) {
-			add_next_index_string(return_value, history[i]->line);
-		}
-	}
 #endif
 }
 /* }}} */
@@ -572,11 +485,9 @@ PHP_FUNCTION(readline_redisplay)
 		RETURN_THROWS();
 	}
 
-#if HAVE_LIBEDIT
 	/* seems libedit doesn't take care of rl_initialize in rl_redisplay
 	 * see bug #72538 */
 	using_history();
-#endif
 	rl_redisplay();
 }
 /* }}} */
@@ -598,4 +509,4 @@ PHP_FUNCTION(readline_on_new_line)
 #endif
 
 
-#endif /* HAVE_LIBREADLINE */
+#endif /* HAVE_LIBEDIT */