<?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_Amf

 * @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: Server.php 23256 2010-10-26 12:51:54Z alexander $

 */

/** @see Zend_Server_Interface */

require_once 'Zend/Server/Interface.php';

/** @see Zend_Server_Reflection */

require_once 'Zend/Server/Reflection.php';

/** @see Zend_Amf_Constants */

require_once 'Zend/Amf/Constants.php';

/** @see Zend_Amf_Value_MessageBody */

require_once 'Zend/Amf/Value/MessageBody.php';

/** @see Zend_Amf_Value_MessageHeader */

require_once 'Zend/Amf/Value/MessageHeader.php';

/** @see Zend_Amf_Value_Messaging_CommandMessage */

require_once 'Zend/Amf/Value/Messaging/CommandMessage.php';

/** @see Zend_Loader_PluginLoader */

require_once 'Zend/Loader/PluginLoader.php';

/** @see Zend_Amf_Parse_TypeLoader */

require_once 'Zend/Amf/Parse/TypeLoader.php';

/** @see Zend_Auth */

require_once 'Zend/Auth.php';

/**

 * An AMF gateway server implementation to allow the connection of the Adobe Flash Player to

 * Zend Framework

 *

 * @todo       Make the reflection methods cache and autoload.

 * @package    Zend_Amf

 * @subpackage Server

 * @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_Amf_Server implements Zend_Server_Interface

{

    /**

     * Array of dispatchables

     * @var array

     */

    protected $_methods = array();

    /**

     * Array of classes that can be called without being explicitly loaded

     *

     * Keys are class names.

     *

     * @var array

     */

    protected $_classAllowed = array();

    /**

     * Loader for classes in added directories

     * @var Zend_Loader_PluginLoader

     */

    protected $_loader;

    /**

     * @var bool Production flag; whether or not to return exception messages

     */

    protected $_production = true;

    /**

     * Request processed

     * @var null|Zend_Amf_Request

     */

    protected $_request = null;

    /**

     * Class to use for responses

     * @var null|Zend_Amf_Response

     */

    protected $_response;

    /**

     * Dispatch table of name => method pairs

     * @var array

     */

    protected $_table = array();

    /**

     *

     * @var bool session flag; whether or not to add a session to each response.

     */

    protected $_session = false;

    /**

     * Namespace allows all AMF calls to not clobber other PHP session variables

     * @var Zend_Session_NameSpace default session namespace zend_amf

     */

    protected $_sesionNamespace = 'zend_amf';

    /**

     * Set the default session.name if php_

     * @var string

     */

    protected $_sessionName = 'PHPSESSID';

    /**

     * Authentication handler object

     *

     * @var Zend_Amf_Auth_Abstract

     */

    protected $_auth;

    /**

     * ACL handler object

     *

     * @var Zend_Acl

     */

    protected $_acl;

    /**

     * The server constructor

     */

    public function __construct()

    {

        Zend_Amf_Parse_TypeLoader::setResourceLoader(new Zend_Loader_PluginLoader(array("Zend_Amf_Parse_Resource" => "Zend/Amf/Parse/Resource")));

    }

    /**

     * Set authentication adapter

     *

     * @param  Zend_Amf_Auth_Abstract $auth

     * @return Zend_Amf_Server

     */

    public function setAuth(Zend_Amf_Auth_Abstract $auth)

    {

        $this->_auth = $auth;

        return $this;

    }

   /**

     * Get authentication adapter

     *

     * @return Zend_Amf_Auth_Abstract

     */

    public function getAuth()

    {

        return $this->_auth;

    }

    /**

     * Set ACL adapter

     *

     * @param  Zend_Acl $acl

     * @return Zend_Amf_Server

     */

    public function setAcl(Zend_Acl $acl)

    {

        $this->_acl = $acl;

        return $this;

    }

   /**

     * Get ACL adapter

     *

     * @return Zend_Acl

     */

    public function getAcl()

    {

        return $this->_acl;

    }

    /**

     * Set production flag

     *

     * @param  bool $flag

     * @return Zend_Amf_Server

     */

    public function setProduction($flag)

    {

        $this->_production = (bool) $flag;

        return $this;

    }

    /**

     * Whether or not the server is in production

     *

     * @return bool

     */

    public function isProduction()

    {

        return $this->_production;

    }

    /**

     * @param namespace of all incoming sessions defaults to Zend_Amf

     * @return Zend_Amf_Server

     */

    public function setSession($namespace = 'Zend_Amf')

    {

        require_once 'Zend/Session.php';

        $this->_session = true;

        $this->_sesionNamespace = new Zend_Session_Namespace($namespace);

        return $this;

    }

    /**

     * Whether of not the server is using sessions

     * @return bool

     */

    public function isSession()

    {

        return $this->_session;

    }

    /**

     * Check if the ACL allows accessing the function or method

     *

     * @param string|object $object Object or class being accessed

     * @param string $function Function or method being accessed

     * @return unknown_type

     */

    protected function _checkAcl($object, $function)

    {

        if(!$this->_acl) {

            return true;

        }

        if($object) {

            $class = is_object($object)?get_class($object):$object;

            if(!$this->_acl->has($class)) {

                require_once 'Zend/Acl/Resource.php';

                $this->_acl->add(new Zend_Acl_Resource($class));

            }

            $call = array($object, "initAcl");

            if(is_callable($call) && !call_user_func($call, $this->_acl)) {

                // if initAcl returns false, no ACL check

                return true;

            }

        } else {

            $class = null;

        }

        $auth = Zend_Auth::getInstance();

        if($auth->hasIdentity()) {

            $role = $auth->getIdentity()->role;

        } else {

            if($this->_acl->hasRole(Zend_Amf_Constants::GUEST_ROLE)) {

                $role = Zend_Amf_Constants::GUEST_ROLE;

            } else {

                require_once 'Zend/Amf/Server/Exception.php';

                throw new Zend_Amf_Server_Exception("Unauthenticated access not allowed");

            }

        }

        if($this->_acl->isAllowed($role, $class, $function)) {

            return true;

        } else {

            require_once 'Zend/Amf/Server/Exception.php';

            throw new Zend_Amf_Server_Exception("Access not allowed");

        }

    }

    /**

     * Get PluginLoader for the Server

     *

     * @return Zend_Loader_PluginLoader

     */

    protected function getLoader()

    {

        if(empty($this->_loader)) {

            require_once 'Zend/Loader/PluginLoader.php';

            $this->_loader = new Zend_Loader_PluginLoader();

        }

        return $this->_loader;

    }

    /**

     * Loads a remote class or method and executes the function and returns

     * the result

     *

     * @param  string $method Is the method to execute

     * @param  mixed $param values for the method

     * @return mixed $response the result of executing the method

     * @throws Zend_Amf_Server_Exception

     */

    protected function _dispatch($method, $params = null, $source = null)

    {

        if($source) {

            if(($mapped = Zend_Amf_Parse_TypeLoader::getMappedClassName($source)) !== false) {

                $source = $mapped;

            }

        }

        $qualifiedName = empty($source) ? $method : $source . '.' . $method;

        if (!isset($this->_table[$qualifiedName])) {

            // if source is null a method that was not defined was called.

            if ($source) {

                $className = str_replace('.', '_', $source);

                if(class_exists($className, false) && !isset($this->_classAllowed[$className])) {

                    require_once 'Zend/Amf/Server/Exception.php';

                    throw new Zend_Amf_Server_Exception('Can not call "' . $className . '" - use setClass()');

                }

                try {

                    $this->getLoader()->load($className);

                } catch (Exception $e) {

                    require_once 'Zend/Amf/Server/Exception.php';

                    throw new Zend_Amf_Server_Exception('Class "' . $className . '" does not exist: '.$e->getMessage(), 0, $e);

                }

                // Add the new loaded class to the server.

                $this->setClass($className, $source);

            }

            if (!isset($this->_table[$qualifiedName])) {

                // Source is null or doesn't contain specified method

                require_once 'Zend/Amf/Server/Exception.php';

                throw new Zend_Amf_Server_Exception('Method "' . $method . '" does not exist');

            }

        }

        $info = $this->_table[$qualifiedName];

        $argv = $info->getInvokeArguments();

        if (0 < count($argv)) {

            $params = array_merge($params, $argv);

        }

        if ($info instanceof Zend_Server_Reflection_Function) {

            $func = $info->getName();

            $this->_checkAcl(null, $func);

            $return = call_user_func_array($func, $params);

        } elseif ($info instanceof Zend_Server_Reflection_Method) {

            // Get class

            $class = $info->getDeclaringClass()->getName();

            if ('static' == $info->isStatic()) {

                // for some reason, invokeArgs() does not work the same as

                // invoke(), and expects the first argument to be an object.

                // So, using a callback if the method is static.

                $this->_checkAcl($class, $info->getName());

                $return = call_user_func_array(array($class, $info->getName()), $params);

            } else {

                // Object methods

                try {

                    $object = $info->getDeclaringClass()->newInstance();

                } catch (Exception $e) {

                    require_once 'Zend/Amf/Server/Exception.php';

                    throw new Zend_Amf_Server_Exception('Error instantiating class ' . $class . ' to invoke method ' . $info->getName() . ': '.$e->getMessage(), 621, $e);

                }

                $this->_checkAcl($object, $info->getName());

                $return = $info->invokeArgs($object, $params);

            }

        } else {

            require_once 'Zend/Amf/Server/Exception.php';

            throw new Zend_Amf_Server_Exception('Method missing implementation ' . get_class($info));

        }

        return $return;

    }

    /**

     * Handles each of the 11 different command message types.

     *

     * A command message is a flex.messaging.messages.CommandMessage

     *

     * @see    Zend_Amf_Value_Messaging_CommandMessage

     * @param  Zend_Amf_Value_Messaging_CommandMessage $message

     * @return Zend_Amf_Value_Messaging_AcknowledgeMessage

     */

    protected function _loadCommandMessage(Zend_Amf_Value_Messaging_CommandMessage $message)

    {

        require_once 'Zend/Amf/Value/Messaging/AcknowledgeMessage.php';

        switch($message->operation) {

            case Zend_Amf_Value_Messaging_CommandMessage::DISCONNECT_OPERATION :

            case Zend_Amf_Value_Messaging_CommandMessage::CLIENT_PING_OPERATION :

                $return = new Zend_Amf_Value_Messaging_AcknowledgeMessage($message);

                break;

            case Zend_Amf_Value_Messaging_CommandMessage::LOGIN_OPERATION :

                $data = explode(':', base64_decode($message->body));

                $userid = $data[0];

                $password = isset($data[1])?$data[1]:"";

                if(empty($userid)) {

                    require_once 'Zend/Amf/Server/Exception.php';

                    throw new Zend_Amf_Server_Exception('Login failed: username not supplied');

                }

                if(!$this->_handleAuth($userid, $password)) {

                    require_once 'Zend/Amf/Server/Exception.php';

                    throw new Zend_Amf_Server_Exception('Authentication failed');

                }

                $return = new Zend_Amf_Value_Messaging_AcknowledgeMessage($message);

                break;

           case Zend_Amf_Value_Messaging_CommandMessage::LOGOUT_OPERATION :

                if($this->_auth) {

                    Zend_Auth::getInstance()->clearIdentity();

                }

                $return = new Zend_Amf_Value_Messaging_AcknowledgeMessage($message);

                break;

            default :

                require_once 'Zend/Amf/Server/Exception.php';

                throw new Zend_Amf_Server_Exception('CommandMessage::' . $message->operation . ' not implemented');

                break;

        }

        return $return;

    }

    /**

     * Create appropriate error message

     *

     * @param int $objectEncoding Current AMF encoding

     * @param string $message Message that was being processed when error happened

     * @param string $description Error description

     * @param mixed $detail Detailed data about the error

     * @param int $code Error code

     * @param int $line Error line

     * @return Zend_Amf_Value_Messaging_ErrorMessage|array

     */

    protected function _errorMessage($objectEncoding, $message, $description, $detail, $code, $line)

    {

        $return = null;

        switch ($objectEncoding) {

            case Zend_Amf_Constants::AMF0_OBJECT_ENCODING :

                return array (

                        'description' => ($this->isProduction ()) ? '' : $description,

                        'detail' => ($this->isProduction ()) ? '' : $detail,

                        'line' => ($this->isProduction ()) ? 0 : $line,

                        'code' => $code

                );

            case Zend_Amf_Constants::AMF3_OBJECT_ENCODING :

                require_once 'Zend/Amf/Value/Messaging/ErrorMessage.php';

                $return = new Zend_Amf_Value_Messaging_ErrorMessage ( $message );

                $return->faultString = $this->isProduction () ? '' : $description;

                $return->faultCode = $code;