<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Tool

 * @subpackage Framework

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: ArgumentParser.php 22877 2010-08-21 19:53:14Z ramon $

 */

/**

 * @see Zend_Console_GetOpt

 */

require_once 'Zend/Console/Getopt.php';

/**

 * @see Zend_Tool_Framework_Registry_EnabledInterface

 */

require_once 'Zend/Tool/Framework/Registry/EnabledInterface.php';

/**

 * @category   Zend

 * @package    Zend_Tool

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Tool_Framework_Client_Console_ArgumentParser implements Zend_Tool_Framework_Registry_EnabledInterface

{

    /**

     * @var Zend_Tool_Framework_Registry_Interface

     */

    protected $_registry = null;

    /**

     * Holds the manifest repository taken from the registry.

     *

     * @var Zend_Tool_Framework_Manifest_Repository

     */

      protected $_manifestRepository = null;

    /**

     * @var Zend_Tool_Framework_Client_Request

     */

    protected $_request = null;

    /**

     * @var Zend_Tool_Framework_Client_Response

     */

    protected $_response = null;

    /**#@+

     * @var array

     */

    protected $_argumentsOriginal = null;

    protected $_argumentsWorking  = null;

    /**#@-*/

    /**

     * @var bool

     */

    protected $_help = false;

    protected $_helpKnownAction = false;

    protected $_helpKnownProvider = false;

    protected $_helpKnownSpecialty = false;

    /**

     * setArguments

     *

     * @param array $arguments

     * @return Zend_Tool_Framework_Client_Console_ArgumentParser

     */

    public function setArguments(Array $arguments)

    {

        $this->_argumentsOriginal = $this->_argumentsWorking = $arguments;

        return $this;

    }

    /**

     * setRegistry()

     *

     * @param Zend_Tool_Framework_Registry_Interface $registry

     * @return Zend_Tool_Framework_Client_Console_ArgumentParser

     */

    public function setRegistry(Zend_Tool_Framework_Registry_Interface $registry)

    {

        // get the client registry

        $this->_registry = $registry;

        // set manifest repository, request, response for easy access

        $this->_manifestRepository = $this->_registry->getManifestRepository();

        $this->_request  = $this->_registry->getRequest();

        $this->_response = $this->_registry->getResponse();

        return $this;

    }

    /**

     * Parse() - This method does the work of parsing the arguments into the enpooint request,

     * this will also (during help operations) fill the response in with information as needed

     *

     * @return null

     */

    public function parse()

    {

        if ($this->_request == null || $this->_response == null) {

            require_once 'Zend/Tool/Framework/Client/Exception.php';

            throw new Zend_Tool_Framework_Client_Exception('The client registry must have both a request and response registered.');

        }

        // setup the help options

        $helpResponseOptions = array();

        // check to see if the first cli arg is the script name

        if ($this->_argumentsWorking[0] == $_SERVER['SCRIPT_NAME' ]) {

            array_shift($this->_argumentsWorking);

        }

        // process global options

        try {

            $this->_parseGlobalPart();

        } catch (Zend_Tool_Framework_Client_Exception $exception) {

            $this->_createHelpResponse(array('error' => $exception->getMessage()));

            return;

        }

        // ensure there are arguments left

        if (count($this->_argumentsWorking) == 0) {

            $this->_request->setDispatchable(false); // at this point request is not dispatchable

            // check to see if this was a help request

            if ($this->_help) {

                $this->_createHelpResponse();

            } else {

                $this->_createHelpResponse(array('error' => 'An action and provider is required.'));

            }

            return;

        }

        // process the action part of the command line

        try {

            $this->_parseActionPart();

        } catch (Zend_Tool_Framework_Client_Exception $exception) {

            $this->_request->setDispatchable(false);

            $this->_createHelpResponse(array('error' => $exception->getMessage()));

            return;

        }

        if ($this->_helpKnownAction) {

            $helpResponseOptions = array_merge(

                $helpResponseOptions,

                array('actionName' => $this->_request->getActionName())

                );

        }

        /* @TODO Action Parameter Requirements */

        // make sure there are more "words" on the command line

        if (count($this->_argumentsWorking) == 0) {

            $this->_request->setDispatchable(false); // at this point request is not dispatchable

            // check to see if this is a help request

            if ($this->_help) {

                $this->_createHelpResponse($helpResponseOptions);

            } else {

                $this->_createHelpResponse(array_merge($helpResponseOptions, array('error' => 'A provider is required.')));

            }

            return;

        }

        // process the provider part of the command line

        try {

            $this->_parseProviderPart();

        } catch (Zend_Tool_Framework_Client_Exception $exception) {

            $this->_request->setDispatchable(false);

            $this->_createHelpResponse(array('error' => $exception->getMessage()));

            return;

        }

        if ($this->_helpKnownProvider) {

            $helpResponseOptions = array_merge(

                $helpResponseOptions,

                array('providerName' => $this->_request->getProviderName())

                );

        }

        if ($this->_helpKnownSpecialty) {

            $helpResponseOptions = array_merge(

                $helpResponseOptions,

                array('specialtyName' => $this->_request->getSpecialtyName())

                );

        }

        // if there are arguments on the command line, lets process them as provider options

        if (count($this->_argumentsWorking) != 0) {

            $this->_parseProviderOptionsPart();

        }

        // if there is still arguments lingering around, we can assume something is wrong

        if (count($this->_argumentsWorking) != 0) {

            $this->_request->setDispatchable(false); // at this point request is not dispatchable

            if ($this->_help) {

                $this->_createHelpResponse($helpResponseOptions);

            } else {

                $this->_createHelpResponse(array_merge(

                    $helpResponseOptions,

                    array('error' => 'Unknown arguments left on the command line: ' . implode(' ', $this->_argumentsWorking))

                    ));

            }

            return;

        }

        // everything was processed and this is a request for help information

        if ($this->_help) {

            $this->_request->setDispatchable(false); // at this point request is not dispatchable

            $this->_createHelpResponse($helpResponseOptions);

        }

        return;

    }

    /**

     * Internal routine for parsing global options from the command line

     *

     * @return null

     */

    protected function _parseGlobalPart()

    {

        $getoptOptions = array();

        $getoptOptions['help|h']    = 'HELP';

        $getoptOptions['verbose|v'] = 'VERBOSE';

        $getoptOptions['pretend|p'] = 'PRETEND';

        $getoptOptions['debug|d']   = 'DEBUG';

        $getoptParser = new Zend_Console_Getopt($getoptOptions, $this->_argumentsWorking, array('parseAll' => false));

        // @todo catch any exceptions here

        $getoptParser->parse();

        foreach ($getoptParser->getOptions() as $option) {

            if ($option == 'pretend') {

                $this->_request->setPretend(true);

            } elseif ($option == 'debug') {

                $this->_request->setDebug(true);

            } elseif ($option == 'verbose') {

                $this->_request->setVerbose(true);

            } else {

                $property = '_'.$option;

                $this->{$property} = true;

            }

        }

        $this->_argumentsWorking = $getoptParser->getRemainingArgs();

        return;

    }

    /**

     * Internal routine for parsing the action name from the arguments

     *

     * @return null

     */

    protected function _parseActionPart()

    {

        // the next "word" should be the action name

        $consoleActionName = array_shift($this->_argumentsWorking);

        if ($consoleActionName == '?') {

            $this->_help = true;

            return;

        }

        $actionSearchCriteria = array(

            'type'       => 'Tool',

            'name'       => 'actionName',

            'value'      => $consoleActionName,

            'clientName' => 'console'

            );

        // is the action name valid?

        $actionMetadata = $this->_manifestRepository->getMetadata($actionSearchCriteria);

        // check for normalized names as well (all lower, no separators)

        if (!$actionMetadata) {

            $actionSearchCriteria['name']  = 'normalizedActionName';

            $actionSearchCriteria['value'] = strtolower(str_replace(array('-', '_'), '', $consoleActionName));

            $actionSearchCriteria['clientName'] = 'all';

            $actionMetadata = $this->_manifestRepository->getMetadata($actionSearchCriteria);

        }

        // if no action, handle error

        if (!$actionMetadata) {

            require_once 'Zend/Tool/Framework/Client/Exception.php';

            throw new Zend_Tool_Framework_Client_Exception('Action \'' . $consoleActionName . '\' is not a valid action.');

        }

        // prepare action request name

        $this->_helpKnownAction = true;

        $this->_request->setActionName($actionMetadata->getActionName());

        return;

    }

    /**

     * Internal routine for parsing the provider part of the command line arguments

     *

     * @return null

     */

    protected function _parseProviderPart()

    {

        // get the cli "word" as the provider name from command line

        $consoleProviderFull = array_shift($this->_argumentsWorking);

        $consoleSpecialtyName = '_global';

        // if there is notation for specialties? If so, break them up

        if (strstr($consoleProviderFull, '.')) {

            list($consoleProviderName, $consoleSpecialtyName) = explode('.', $consoleProviderFull);

        } else {

            $consoleProviderName = $consoleProviderFull;

        }

        if ($consoleProviderName == '?') {

            $this->_help = true;

            return;

        }

        $providerSearchCriteria = array(

            'type'       => 'Tool',

            'name'       => 'providerName',

            'value'      => $consoleProviderName,

            'clientName' => 'console'

            );

        // get the cli provider names from the manifest

        $providerMetadata = $this->_manifestRepository->getMetadata($providerSearchCriteria);

        // check for normalized names as well (all lower, no separators)

        if (!$providerMetadata) {

            $providerSearchCriteria['name']  = 'normalizedProviderName';

            $providerSearchCriteria['value'] = strtolower(str_replace(array('-', '_'), '', $consoleProviderName));

            $providerSearchCriteria['clientName'] = 'all';

            $providerMetadata = $this->_manifestRepository->getMetadata($providerSearchCriteria);

        }

        if (!$providerMetadata) {

            require_once 'Zend/Tool/Framework/Client/Exception.php';

            throw new Zend_Tool_Framework_Client_Exception(

                'Provider \'' . $consoleProviderFull . '\' is not a valid provider.'

                );

        }

        $this->_helpKnownProvider = true;

        $this->_request->setProviderName($providerMetadata->getProviderName());

        if ($consoleSpecialtyName == '?') {

            $this->_help = true;

            return;

        }

        $providerSpecialtySearchCriteria = array(

            'type'         => 'Tool',

            'name'         => 'specialtyName',

            'value'        => $consoleSpecialtyName,

            'providerName' => $providerMetadata->getProviderName(),

            'clientName'   => 'console'

            );

        $providerSpecialtyMetadata = $this->_manifestRepository->getMetadata($providerSpecialtySearchCriteria);

        if (!$providerSpecialtyMetadata) {

            $providerSpecialtySearchCriteria['name'] = 'normalizedSpecialtyName';

            $providerSpecialtySearchCriteria['value'] = strtolower(str_replace(array('-', '_'), '', $consoleSpecialtyName));

            $providerSpecialtySearchCriteria['clientName'] = 'all';

            $providerSpecialtyMetadata = $this->_manifestRepository->getMetadata($providerSpecialtySearchCriteria);

        }

        if (!$providerSpecialtyMetadata) {

            require_once 'Zend/Tool/Framework/Client/Exception.php';

            throw new Zend_Tool_Framework_Client_Exception(

                'Provider \'' . $consoleSpecialtyName . '\' is not a valid specialty.'

                );

        }

        $this->_helpKnownSpecialty = true;

        $this->_request->setSpecialtyName($providerSpecialtyMetadata->getSpecialtyName());

        return;

    }

    /**

     * Internal routine for parsing the provider options from the command line

     *

     * @return null

     */

    protected function _parseProviderOptionsPart()

    {

        if (current($this->_argumentsWorking) == '?') {

            $this->_help = true;

            return;

        }

        $searchParams = array(

            'type'          => 'Tool',

            'providerName'  => $this->_request->getProviderName(),

            'actionName'    => $this->_request->getActionName(),

            'specialtyName' => $this->_request->getSpecialtyName(),

            'clientName'    => 'console'

            );

        $actionableMethodLongParamsMetadata = $this->_manifestRepository->getMetadata(

            array_merge($searchParams, array('name' => 'actionableMethodLongParams'))

            );

        $actionableMethodShortParamsMetadata = $this->_manifestRepository->getMetadata(

            array_merge($searchParams, array('name' => 'actionableMethodShortParams'))

            );

        $paramNameShortValues = $actionableMethodShortParamsMetadata->getValue();

        $getoptOptions = array();

        $wordArguments = array();

        $longParamCanonicalNames = array();