composer/src/Composer/IO/ConsoleIO.php

<?php

/*
 * This file is part of Composer.
 *
 * (c) Nils Adermann <naderman@naderman.de>
 *     Jordi Boggiano <j.boggiano@seld.be>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Composer\IO;

use Composer\IO\IOInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Formatter\OutputFormatterInterface;
use Symfony\Component\Console\Helper\HelperSet;

/**
 * The Input/Output helper.
 *
 * @author François Pluchino <francois.pluchino@opendisplay.com>
 */
class ConsoleIO implements IOInterface
{
    protected $input;
    protected $output;
    protected $helperSet;
    protected $authentifications;
    protected $lastUsername;
    protected $lastPassword;

    /**
     * Constructor.
     *
     * @param InputInterface         $input     The input instance
     * @param ConsoleOutputInterface $output    The output instance
     * @param HelperSet              $helperSet The helperSet instance
     */
    public function __construct(InputInterface $input, ConsoleOutputInterface $output, HelperSet $helperSet)
    {
        $this->input = $input;
        $this->output = $output;
        $this->helperSet = $helperSet;
    }

    /**
     * {@inheritDoc}
     */
    public function getFirstArgument()
    {
        return $this->input->getFirstArgument();
    }

    /**
     * {@inheritDoc}
     */
    public function hasParameterOption($values)
    {
        return $this->input->hasParameterOption($values);
    }

    /**
     * {@inheritDoc}
     */
    public function getParameterOption($values, $default = false)
    {
        return $this->input->getParameterOption($values, $default);
    }

    /**
     * {@inheritDoc}
     */
    public function bind(InputDefinition $definition)
    {
        $this->input->bind($definition);
    }

    /**
     * {@inheritDoc}
     */
    public function validate()
    {
        $this->input->validate();
    }

    /**
     * {@inheritDoc}
     */
    public function getArguments()
    {
        return $this->input->getArguments();
    }

    /**
     * {@inheritDoc}
     */
    public function getArgument($name)
    {
        return $this->input->getArgument($name);
    }

    /**
     * {@inheritDoc}
     */
    public function getOptions()
    {
        return $this->input->getOptions();
    }

    /**
     * {@inheritDoc}
     */
    public function getOption($name)
    {
        return $this->input->getOption($name);
    }

    /**
     * {@inheritDoc}
     */
    public function isInteractive()
    {
        return $this->input->isInteractive();
    }

    /**
     * {@inheritDoc}
     */
    public function getErrorOutput()
    {
        return $this->output->getErrorOutput();
    }

    /**
     * {@inheritDoc}
     */
    public function setErrorOutput(OutputInterface $error)
    {
        $this->output->setErrorOutput($error);
    }

    /**
     * {@inheritDoc}
     */
    public function write($messages, $newline = false, $type = 0)
    {
        $this->output->write($messages, $newline, $type);
    }

    /**
     * {@inheritDoc}
     */
    public function writeln($messages, $type = 0)
    {
        $this->output->writeln($messages, $type);
    }

    /**
     * {@inheritDoc}
     */
    public function overwrite($messages, $size = 80, $newline = false, $type = 0)
    {
        for ($place = $size; $place > 0; $place--) {
            $this->write("\x08");
        }

        $this->write($messages, false, $type);

        for ($place = ($size - strlen($messages)); $place > 0; $place--) {
            $this->write(' ');
        }

        // clean up the end line
        for ($place = ($size - strlen($messages)); $place > 0; $place--) {
            $this->write("\x08");
        }

        if ($newline) {
            $this->writeln('');
        }
    }

    /**
     * {@inheritDoc}
     */
    public function overwriteln($messages, $size = 80, $type = 0)
    {
        $this->overwrite($messages, $size, true, $type);
    }

    /**
     * {@inheritDoc}
     */
    public function setVerbosity($level)
    {
        $this->output->setVerbosity($level);
    }

    /**
     * {@inheritDoc}
     */
    public function getVerbosity()
    {
        return $this->output->getVerbosity();
    }

    /**
     * {@inheritDoc}
     */
    public function setDecorated($decorated)
    {
        $this->output->setDecorated($decorated);
    }

    /**
     * {@inheritDoc}
     */
    public function isDecorated()
    {
        return $this->output->isDecorated();
    }

    /**
     * {@inheritDoc}
     */
    public function setFormatter(OutputFormatterInterface $formatter)
    {
        $this->output->setFormatter($formatter);
    }

    /**
     * {@inheritDoc}
     */
    public function getFormatter()
    {
        return $this->output->getFormatter();
    }

    /**
     * {@inheritDoc}
     */
    public function ask($question, $default = null)
    {
        return $this->helperSet->get('dialog')->ask($this->output, $question, $default);
    }

    /**
     * {@inheritDoc}
     */
    public function askConfirmation($question, $default = true)
    {
        return $this->helperSet->get('dialog')->askConfirmation($this->output, $question, $default);
    }

    public function askAndValidate($question, $validator, $attempts = false, $default = null)
    {
        return $this->helperSet->get('dialog')->askAndValidate($this->output, $question, $validator, $attempts, $default);
    }

    /**
     * {@inheritDoc}
     */
    public function askAndHideAnswer($question)
    {
        // for windows OS (does not hide the answer in the popup, but it never appears in the STDIN history)
        if (preg_match('/^win/i', PHP_OS)) {
            $vbscript = sys_get_temp_dir() . '/prompt_password.vbs';
            file_put_contents($vbscript,
                    'wscript.echo(Inputbox("' . addslashes($question) . '","'
                            . addslashes($question) . '", ""))');
            $command = "cscript //nologo " . escapeshellarg($vbscript);

            $this->write($question);

            $value = rtrim(shell_exec($command));
            unlink($vbscript);

            for ($i = 0; $i < strlen($value); ++$i) {
                $this->write('*');
            }

            $this->writeln('');

            return $value;
        }

        // for other OS with shell_exec (hide the answer)
        else if (rtrim(shell_exec($command)) === 'OK') {
            $command = "/usr/bin/env bash -c 'echo OK'";

            $this->write($question);

            $command = "/usr/bin/env bash -c 'read -s mypassword && echo \$mypassword'";
            $value = rtrim(shell_exec($command));

            for ($i = 0; $i < strlen($value); ++$i) {
                $this->write('*');
            }

            $this->writeln('');

            return $value;
        }

        // for other OS without shell_exec (does not hide the answer)
        $this->writeln('');

        return $this->ask($question);
    }

    /**
     * {@inheritDoc}
     */
    public function getLastUsername()
    {
        return $this->lastUsername;
    }

    /**
     * {@inheritDoc}
     */
    public function getLastPassword()
    {
        return $this->lastPassword;
    }

    /**
     * {@inheritDoc}
     */
    public function getAuthentifications()
    {
        if (null === $this->authentifications) {
            $this->authentifications = array();
        }

        return $this->authentifications;
    }

    /**
     * {@inheritDoc}
     */
    public function hasAuthentification($repositoryName)
    {
        $auths = $this->getAuthentifications();
        return isset($auths[$repositoryName]) ? true : false;
    }

    /**
     * {@inheritDoc}
     */
    public function getAuthentification($repositoryName)
    {
        $auths = $this->getAuthentifications();
        return isset($auths[$repositoryName]) ? $auths[$repositoryName] : array('username' => null, 'password' => null);
    }

    /**
     * {@inheritDoc}
     */
    public function setAuthentification($repositoryName, $username, $password = null)
    {
        $auths = $this->getAuthentifications();
        $auths[$repositoryName] = array('username' => $username, 'password' => $password);

        $this->authentifications = $auths;
        $this->lastUsername = $username;
        $this->lastPassword = $password;
    }
}