AppserverIo\Psr\Naming\InitialContext

Complexity

Total Complexity

33

Size/Duplication

Total Lines	389
Duplicated Lines	4.11 %

Coupling/Cohesion

Components	1
Dependencies	12

Test Coverage

Coverage

49.06%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	33	3
A	injectProperties()	0	4	1
A	injectLexer()	0	4	1
A	injectApplication()	0	4	1
A	injectServletRequest()	0	4	1
A	getProperties()	0	4	1
A	getLexer()	0	4	1
A	getApplication()	0	4	1
A	getServletRequest()	0	4	1
A	lookup()	0	30	5
B	prepareResourceIdentifier()	0	34	6
A	doRemoteLookup()	11	28	4
A	doLocalLookup()	5	17	3
A	doLookup()	0	37	4

<?php

/**
 * \AppserverIo\Psr\Naming\InitialContext
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <tw@appserver.io>
 * @copyright  2015 TechDivision GmbH <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       https://github.com/appserver-io-psr/naming
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Psr\Naming;

use Phlexy\Lexer;
use Phlexy\LexerDataGenerator;
use Phlexy\LexerFactory\Stateless\UsingPregReplace;
use AppserverIo\Properties\Properties;
use AppserverIo\Properties\PropertiesInterface;
use AppserverIo\Psr\Servlet\SessionUtils;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Application\ApplicationInterface;
use AppserverIo\RemoteMethodInvocation\ConnectionInterface;
use AppserverIo\RemoteMethodInvocation\LocalConnectionFactory;
use AppserverIo\RemoteMethodInvocation\RemoteConnectionFactory;

/**
 * Initial context implementation to lookup enterprise beans.
 *
 * @author     Tim Wagner <tw@appserver.io>
 * @copyright  2015 TechDivision GmbH <info@appserver.io>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       https://github.com/appserver-io-psr/naming
 * @link       http://www.appserver.io
 */
class InitialContext
{

    /**
     * Lexer constants.
     *
     * @var integer
     */
    const T_CLASS = 0;
    const T_COLON = 1;
    const T_SCHEME = 2;
    const T_APPLICATION_SCOPE = 3;
    const T_GLOBAL_SCOPE = 4;
    const T_SEPARATOR = 5;
    const T_INTERFACE = 6;

    /**
     * The configuration properties for this context.
     *
     * @var \AppserverIo\Properties\PropertiesInterface
     */
    protected $properties;

    /**
     * The lexer used to parse the JNDI style bean names.
     *
     * @param \Phlexy\Lexer $lexer the lexer instance
     */
    protected $lexer;

    /**
     * The application instance the context is bound to.
     *
     * @var \AppserverIo\Psr\Application\ApplicationInterface
     */
    protected $application;

    /**
     * The servlet request instance the context is bound to.
     *
     * @var \AppserverIo\Psr\Servlet\ServletRequestInterface
     */
    protected $servletRequest;

    /**
     * The default properties for the context configuration.
     *
     * @var array
     */
    protected $defaultProperties = array(
        'transport' => 'http',
        'scheme'    => 'php',
        'user'      => 'appserver',
        'pass'      => 'appserver.i0',
        'host'      => '127.0.0.1',
        'port'      => '8585',
        'scope'     => 'app',
        'indexFile' => 'index.pc',
        'interface' => EnterpriseBeanResourceIdentifier::LOCAL_INTERFACE
    );

    /**
     * Initialize the initial context with the values of the passed properties.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The configuration properties
     */
    public function __construct(PropertiesInterface $properties = null)
    {

        // initialize the default properties if no ones has been passed
        if ($properties == null) {
            // initialize the default properties
            $properties = new Properties();
            foreach ($this->defaultProperties as $key => $value) {
                $properties->setProperty($key, $value);
            }
        }

        // inject the properties
        $this->injectProperties($properties);

        // create a factory for the lexer we use to parse the JNDI style bean names
        $factory = new UsingPregReplace(new LexerDataGenerator);

        // create the lexer instance and inject it
        $this->injectLexer(
            $factory->createLexer(
                array(
                    'php'                      => InitialContext::T_SCHEME,
                    'global\/([a-zA-Z0-9_-]+)' => InitialContext::T_GLOBAL_SCOPE,
                    'app'                      => InitialContext::T_APPLICATION_SCOPE,
                    '\:'                       => InitialContext::T_COLON,
                    '\/'                       => InitialContext::T_SEPARATOR,
                    'local|remote'             => InitialContext::T_INTERFACE,
                    '\w+'                      => InitialContext::T_CLASS
                )
            )
        );
    }

    /**
     * The configuration properties for this context.
     *
     * @param \AppserverIo\Properties\PropertiesInterface $properties The configuration properties
     *
     * @return void
     */
    public function injectProperties(PropertiesInterface $properties)
    {
        $this->properties = $properties;
    }

    /**
     * The lexer used to parse the JNDI style bean names.
     *
     * @param \Phlexy\Lexer $lexer the lexer instance
     *
     * @return void
     */
    public function injectLexer(Lexer $lexer)
    {
        $this->lexer = $lexer;
    }

    /**
     * The application instance this context is bound to.
     *
     * @param \AppserverIo\Psr\Application\ApplicationInterface $application The application instance
     *
     * @return void
     */
    public function injectApplication(ApplicationInterface $application)
    {
        $this->application = $application;
    }

    /**
     * The servlet request instance for binding stateful session beans to.
     *
     * @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The servlet request instance
     *
     * @return void
     */
    public function injectServletRequest(ServletRequestInterface $servletRequest)
    {
        $this->servletRequest = $servletRequest;
    }

    /**
     * Returns the initial context configuration properties.
     *
     * @return \AppserverIo\Properties\PropertiesInterface The configuration properties
     */
    public function getProperties()
    {
        return $this->properties;
    }

    /**
     * Returns the lexer used to parse the JNDI style bean names.
     *
     * @return \Phlexy\Lexer The lexer instance
     */
    public function getLexer()
    {
        return $this->lexer;
    }

    /**
     * Returns the application instance this context is bound to.
     *
     * @return \AppserverIo\Psr\Application\ApplicationInterface The application instance
     */
    public function getApplication()
    {
        return $this->application;
    }

    /**
     * Returns the servlet request instance for binding stateful session beans to.
     *
     * @return \AppserverIo\Psr\Servlet\ServletRequestInterface The servlet request instance
     */
    public function getServletRequest()
    {
        return $this->servletRequest;
    }

    /**
     * Returns the requested enterprise bean instance remote/local.
     *
     * Example URL for loading a local instance of the UserProcessor session bean:
     *
     * php:app/UserProcessor/local
     *
     * @param string $name      The name of the requested enterprise bean
     * @param string $sessionId The session-ID, necessary for lookup stateful session beans
     *
     * @return object The requested enterprise bean instance
     *
     * @throws \AppserverIo\Psr\Naming\NamingException Is thrown if we can't lookup the enterprise bean with the passed identifier
     */
    public function lookup($name, $sessionId = null)
    {

        // at least we need a resource identifier
        if ($name == null) {
            throw new NamingException(sprintf('%s expects a valid resource identifier as parameter', __METHOD__));
        }

        // a valid resource identifier always has to be string
        if (is_string($name) === false) {
            throw new NamingException(sprintf('Invalid value %s for parameter \'name\' has been found, value MUST be a string', $name));
        }

        // prepare the resource identifier for the requested enterprise bean
        $resourceIdentifier = $this->prepareResourceIdentifier($name);

        // This MUST be a remote lookup to another application and the passed name MUST be a complete URL!
        if ($resourceIdentifier->isRemote()) {
            return $this->doRemoteLookup($resourceIdentifier, $sessionId);
        }

        // This MUST be a local lookup to this application, the passed name CAN either be the bean class name
        // only or the complete path including application name and script file name => index.pc for example!
        if ($resourceIdentifier->isLocal()) {
            return $this->doLocalLookup($resourceIdentifier, $sessionId);
        }

        // throw an exception if we can't lookup the bean
        throw new NamingException(sprintf('Can\'t lookup enterprise bean with passed identifier %s', $name));
    }

    /**
     * Prepares a new resource identifier instance from the passed resource name, that has to be
     * a valid URL.
     *
     * @param string $resourceName The URL with the resource information
     *
     * @return \AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier The initialized resource identifier
     *
     * @throws \AppserverIo\Psr\Naming\NamingException Is thrown if we can't find the necessary application context
     */
    public function prepareResourceIdentifier($resourceName)
    {

        // load the URL properties
        $properties = clone $this->getProperties();

        // lex the passed resource name
        foreach ($this->getLexer()->lex($resourceName) as $token) {
            switch ($token[0]) { // check the found type

                case InitialContext::T_SCHEME: // we found a scheme, e. g. php
                    $properties->setProperty('scheme', $token[2]);
                    break;

                case InitialContext::T_INTERFACE: // we found a interface, e. g. local
                    $properties->setProperty('interface', $token[2]);
                    break;

                case InitialContext::T_CLASS: // we found the class name, e. g. MyProcessor
                    $properties->setProperty('className', $token[2]);
                    break;

                case InitialContext::T_GLOBAL_SCOPE: // we found the scope, e. g. app or global
                    $properties->setProperty('contextName', current($token[3]));
                    break;

                default: // do nothing with the other tokens : and /
                    break;
            }
        }

        // initialize the resource identifier from the passed resource
        return EnterpriseBeanResourceIdentifier::createFromProperties($properties);
    }

    /**
     * Makes a remote lookup for the URL containing the information of the requested bean.
     *
     * @param \AppserverIo\Psr\Naming\ResourceIdentifier $resourceIdentifier The resource identifier with the requested bean information
     * @param string                                     $sessionId          The session-ID, necessary for lookup stateful session beans
     *
     * @return object The been proxy instance
     */
    protected function doRemoteLookup(ResourceIdentifier $resourceIdentifier, $sessionId = null)
    {

        // initialize the connection
        $connection = RemoteConnectionFactory::createContextConnection();
        $connection->injectPort($resourceIdentifier->getPort());
        $connection->injectAddress($resourceIdentifier->getHost());
        $connection->injectTransport($resourceIdentifier->getTransport());

It seems like you code against a specific sub-type and not the parent class AppserverIo\Psr\Naming\ResourceIdentifier as the method getTransport() does only exist in the following sub-classes of AppserverIo\Psr\Naming\ResourceIdentifier: AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier. Maybe you want to instanceof check for one of these explicitly?

        // query if we've a context name defined in the resource identifier
        if ($contextName = $resourceIdentifier->getContextName()) {
            // if yes, use it as application name
            $connection->injectAppName($contextName);
        } else {

This code seems to be duplicated across your project.

            // use the application context from the servlet request
            if ($this->getServletRequest() && $this->getServletRequest()->getContext()) {

The method getContext() does not seem to exist on object<AppserverIo\Psr\Servlet\ServletRequestInterface>.

                $application = $this->getServletRequest()->getContext();

The method getContext() does not seem to exist on object<AppserverIo\Psr\Servlet\ServletRequestInterface>.

            } else {
                $application = $this->getApplication();
            }

            // use the application name
            $connection->injectAppName($application->getName());
        }

        // finally try to lookup the bean
        return $this->doLookup($resourceIdentifier, $connection, $sessionId);
    }

    /**
     * Makes a local lookup for the bean with the passed class name.
     *
     * @param \AppserverIo\Psr\Naming\ResourceIdentifier $resourceIdentifier The resource identifier with the requested bean information
     * @param string                                     $sessionId          The session-ID, necessary for lookup stateful session beans
     *
     * @return object The bean proxy instance
     */
    protected function doLocalLookup(ResourceIdentifier $resourceIdentifier, $sessionId = null)
    {

        // use the application context from the servlet request
        if ($this->getServletRequest() && $this->getServletRequest()->getContext()) {

The method getContext() does not seem to exist on object<AppserverIo\Psr\Servlet\ServletRequestInterface>.

This code seems to be duplicated across your project.

            $application = $this->getServletRequest()->getContext();

The method getContext() does not seem to exist on object<AppserverIo\Psr\Servlet\ServletRequestInterface>.

        } else {
            $application = $this->getApplication();
        }

        // initialize the connection
        $connection = LocalConnectionFactory::createContextConnection();
        $connection->injectApplication($application);

        // finally try to lookup the bean
        return $this->doLookup($resourceIdentifier, $connection, $sessionId);
    }

    /**
     * Finally this method does the lookup for the passed resource identifier
     * using the also passed connection.
     *
     * @param \AppserverIo\Psr\Naming\ResourceIdentifier              $resourceIdentifier The identifier for the requested bean
     * @param \AppserverIo\RemoteMethodInvocation\ConnectionInterface $connection         The connection we use for loading the bean
     * @param string                                                  $sessionId          The session-ID, necessary for lookup stateful session beans
     *
     * @return object The been proxy instance
     */
    protected function doLookup(ResourceIdentifier $resourceIdentifier, ConnectionInterface $connection, $sessionId = null)
    {

        try {
            // initialize the context session
            $session = $connection->createContextSession();

            // check if we've a HTTP session ID passed
            if ($sessionId == null) {

It seems like you are loosely comparing $sessionId of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

                // simulate a unique session ID
                $session->setSessionId(SessionUtils::generateRandomString());
            } else {
                // else, set the passed session ID
                $session->setSessionId($sessionId);
            }

            // check if we've a HTTP servlet request that may contain a session
            if ($servletRequest = $this->getServletRequest()) {
                $session->injectServletRequest($servletRequest);
            }

            // load the proxy class name from the resource identifier => that is the path information
            $proxyClass = $this->getApplication()->search(sprintf('%s/proxy', $className = $resourceIdentifier->getClassName()), array($sessionId));

It seems like you code against a specific sub-type and not the parent class AppserverIo\Psr\Naming\ResourceIdentifier as the method getClassName() does only exist in the following sub-classes of AppserverIo\Psr\Naming\ResourceIdentifier: AppserverIo\Psr\Naming\EnterpriseBeanResourceIdentifier. Maybe you want to instanceof check for one of these explicitly?

The method search() does not seem to exist on object<AppserverIo\Psr\Application\ApplicationInterface>.

            // instanciate the proxy
            $proxyInstance = new $proxyClass($className);
            $proxyInstance->__setSession($session);

            // return the initialized proxy instance
            return $proxyInstance;

Blank line found at end of control structure

        } catch (\Exception $e) {
            // log and re-throw the exception
            $this->getApplication()->getNamingDirectory()->search('php:global/log/System')->error($e->__toString());

The method getNamingDirectory() does not seem to exist on object<AppserverIo\Psr\Application\ApplicationInterface>.

            throw $e;
        }
    }
}