composer/src/Composer/Util/Svn.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\Util;

use Composer\IO\IOInterface;

/**
 * @author Till Klampaeckel <till@php.net>
 */
class Svn
{
    /**
     * @var mixed $credentials
     * @see self::hasAuth()
     */
    protected $credentials;

    /**
     * @var boolean $hasAuth
     */
    protected $hasAuth;

    /**
     * @var \Composer\IO\IOInterface $io
     */
    protected $io;

    /**
     * @var string $url
     */
    protected $url;

    /**
     * @var bool $useCache Cache credentials.
     */
    protected $useCache = false;

    /**
     * __construct
     *
     * @param string                   $url
     * @param \Composer\IO\IOInterface $io
     *
     * @return \Composer\Util\Svn
     */
    public function __construct($url, IOInterface $io)
    {
        $this->url = $url;
        $this->io  = $io;
    }

    /**
     * doAuthDance
     *
     * Repositories requests credentials, let's put them in.
     *
     * @return \Composer\Util\Svn
     * @uses   self::$io
     * @uses   self::$hasAuth
     * @uses   self::$credentials
     * @uses   self::$useCache
     */
    public function doAuthDance()
    {
        $this->io->write("The Subversion server ({$this->url}) requested credentials:");

        $this->hasAuth     = true;
        $this->credentials = new \stdClass();

        $this->credentials->username = $this->io->ask("Username: ");
        $this->credentials->password = $this->io->askAndHideAnswer("Password: ");

        $pleaseCache = $this->io->askConfirmation("Should Subversion cache these credentials? (yes/no) ", false);
        if ($pleaseCache === true) {
            $this->useCache = true;
        }
        return $this;
    }
    /**
     * Return the no-auth-cache switch.
     *
     * @return string
     * @uses   selfg::$useCache
     * @see    self::doAuthDance()
     */
    public function getAuthCache()
    {
        if (!$this->useCache) {
            return '--no-auth-cache ';
        }
        return '';
    }

    /**
     * A method to create the svn commands run.
     *
     * @param string $cmd  Usually 'svn ls' or something like that.
     * @param string $url  Repo URL.
     * @param string $path The path to run this against (e.g. a 'co' into)
     * @param mixed  $pipe Optional pipe for the output.
     *
     * @return string
     */
    public function getCommand($cmd, $url, $path = '', $pipe = null)
    {
        $cmd = sprintf('%s %s%s %s',
            $cmd,
            '--non-interactive ',
            $this->getCredentialString(),
            escapeshellarg($url)
        );
        if (!empty($path)) {
            $cmd .= ' ' . escapeshellarg($path);
        }
        if ($pipe !== null) {
            $cmd .= ' ' . $pipe;
        }
        return $cmd;
    }

    /**
     * Return the credential string for the svn command.
     *
     * Adds --no-auth-cache when credentials are present.
     *
     * @return string
     * @uses   self::$useAuth
     */
    public function getCredentialString()
    {
        if ($this->hasAuth === null) {
            $this->hasAuth();
        }
        if (!$this->hasAuth) {
            return '';
        }
        return sprintf(
            ' %s--username %s --password %s ',
            $this->getAuthCache(),
            escapeshellarg($this->getUsername()),
            escapeshellarg($this->getPassword())
        );
    }

    /**
     * Get the password for the svn command. Can be empty.
     *
     * @return string
     * @throws \LogicException
     */
    public function getPassword()
    {
        if ($this->credentials === null) {
            throw new \LogicException("No auth detected.");
        }
        if (isset($this->credentials->password)) {
            return $this->credentials->password;
        }
        return ''; // could be empty
    }

    /**
     * Get the username for the svn command.
     *
     * @return string
     * @throws \LogicException
     */
    public function getUsername()
    {
        if ($this->credentials === null) {
            throw new \LogicException("No auth detected.");
        }
        return $this->credentials->username;
    }

    /**
     * Detect Svn Auth.
     *
     * @param string $url
     *
     * @return \stdClass
     */
    public function hasAuth()
    {
        if ($this->hasAuth !== null) {
            return $this->hasAuth;
        }

        $uri = parse_url($this->url);
        if (empty($uri['user'])) {
            $this->hasAuth = false;
            return $this->hasAuth;
        }

        $this->hasAuth     = true;
        $this->credentials = new \stdClass();

        $this->credentials->username = $uri['user'];

        if (!empty($uri['pass'])) {
            $this->credentials->password = $uri['pass'];
        }

        return $this->hasAuth;
    }
}