Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\Readline;
Chris@13: 
Chris@13: /**
Chris@13:  * A Readline interface implementation for GNU Readline.
Chris@13:  *
Chris@13:  * This is by far the coolest way to do it, but it doesn't work with new PHP.
Chris@13:  *
Chris@13:  * Oh well.
Chris@13:  */
Chris@13: class GNUReadline implements Readline
Chris@13: {
Chris@13:     /** @var string|false */
Chris@13:     protected $historyFile;
Chris@13:     /** @var int */
Chris@13:     protected $historySize;
Chris@13:     /** @var bool */
Chris@13:     protected $eraseDups;
Chris@13: 
Chris@13:     /**
Chris@13:      * GNU Readline is supported iff `readline_list_history` is defined. PHP
Chris@13:      * decided it would be awesome to swap out GNU Readline for Libedit, but
Chris@13:      * they ended up shipping an incomplete implementation. So we've got this.
Chris@13:      *
Chris@13:      * @return bool
Chris@13:      */
Chris@13:     public static function isSupported()
Chris@13:     {
Chris@17:         return \function_exists('readline_list_history');
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * GNU Readline constructor.
Chris@13:      *
Chris@13:      * @param string|false $historyFile
Chris@13:      * @param int          $historySize
Chris@13:      * @param bool         $eraseDups
Chris@13:      */
Chris@13:     public function __construct($historyFile = null, $historySize = 0, $eraseDups = false)
Chris@13:     {
Chris@13:         $this->historyFile = ($historyFile !== null) ? $historyFile : false;
Chris@13:         $this->historySize = $historySize;
Chris@13:         $this->eraseDups   = $eraseDups;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function addHistory($line)
Chris@13:     {
Chris@17:         if ($res = \readline_add_history($line)) {
Chris@13:             $this->writeHistory();
Chris@13:         }
Chris@13: 
Chris@13:         return $res;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function clearHistory()
Chris@13:     {
Chris@17:         if ($res = \readline_clear_history()) {
Chris@13:             $this->writeHistory();
Chris@13:         }
Chris@13: 
Chris@13:         return $res;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function listHistory()
Chris@13:     {
Chris@13:         return readline_list_history();
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function readHistory()
Chris@13:     {
Chris@13:         // Workaround PHP bug #69054
Chris@13:         //
Chris@13:         // If open_basedir is set, readline_read_history() segfaults. This was fixed in 5.6.7:
Chris@13:         //
Chris@13:         //     https://github.com/php/php-src/blob/423a057023ef3c00d2ffc16a6b43ba01d0f71796/NEWS#L19-L21
Chris@13:         //
Chris@17:         if (\version_compare(PHP_VERSION, '5.6.7', '>=') || !\ini_get('open_basedir')) {
Chris@17:             \readline_read_history();
Chris@13:         }
Chris@17:         \readline_clear_history();
Chris@13: 
Chris@17:         return \readline_read_history($this->historyFile);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function readline($prompt = null)
Chris@13:     {
Chris@17:         return \readline($prompt);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function redisplay()
Chris@13:     {
Chris@17:         \readline_redisplay();
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * {@inheritdoc}
Chris@13:      */
Chris@13:     public function writeHistory()
Chris@13:     {
Chris@13:         // We have to write history first, since it is used
Chris@13:         // by Libedit to list history
Chris@13:         if ($this->historyFile !== false) {
Chris@17:             $res = \readline_write_history($this->historyFile);
Chris@13:         } else {
Chris@13:             $res = true;
Chris@13:         }
Chris@13: 
Chris@13:         if (!$res || !$this->eraseDups && !$this->historySize > 0) {
Chris@13:             return $res;
Chris@13:         }
Chris@13: 
Chris@13:         $hist = $this->listHistory();
Chris@13:         if (!$hist) {
Chris@13:             return true;
Chris@13:         }
Chris@13: 
Chris@13:         if ($this->eraseDups) {
Chris@13:             // flip-flip technique: removes duplicates, latest entries win.
Chris@17:             $hist = \array_flip(\array_flip($hist));
Chris@13:             // sort on keys to get the order back
Chris@17:             \ksort($hist);
Chris@13:         }
Chris@13: 
Chris@13:         if ($this->historySize > 0) {
Chris@17:             $histsize = \count($hist);
Chris@13:             if ($histsize > $this->historySize) {
Chris@17:                 $hist = \array_slice($hist, $histsize - $this->historySize);
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@17:         \readline_clear_history();
Chris@13:         foreach ($hist as $line) {
Chris@17:             \readline_add_history($line);
Chris@13:         }
Chris@13: 
Chris@13:         if ($this->historyFile !== false) {
Chris@17:             return \readline_write_history($this->historyFile);
Chris@13:         }
Chris@13: 
Chris@13:         return true;
Chris@13:     }
Chris@13: }