<?php

/**
 * 自定义一个基类 -- 应用中的所有控制器应继承此类
 * (以备业务有所修改而不便故延伸此类)
 * 
 * @name Controller_abstract
 * @version 0.2 (2012-12-17 16:35:28) <fei.hong@yoho.cn>
 * @author xiaoma 
 * @since 0.1 (2012-6-26)
 */
class Controller_Abstract extends Framework_YController
{

    /**
     * 存放网站SEO
     * 
     * @var array
     * @since 0.2
     */
    private $_seo = array();

    /**
     * 存放插件参数
     * 
     * @var array
     */
    private $_pluginParam = array();

    /**
     * 当前应用的ID
     * 
     * @var string
     * @since 5.0
     */
    protected $_appId;

    /**
     * 当前应用的订阅信息
     * 
     * @var string
     * @since 5.0
     */
    protected $_appScope;

    /**
     * 初始化父类
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * 将继承类中的execute方法覆盖
     * 
     * 方便以后对此应用单独进行配置或修改,避免直接操作基础类
     * 
     * @param string $action 操作名称
     * @param array $args 预留参数
     */
    public function execute($action, array $args = array())
    {
        // 执行Action之前的操作
        $this->beforeExecute();

        // 初始化并执行Action操作
        $response = $this->init();
        if (null === $response)
        {
            $action = $this->formatAction($action);
            $response = call_user_func_array(array($this, $action), $args);
        }

        // 执行Action之后的操作
        $this->afterExecute($response);

        // 如果无返回值，则渲染视图页面.
        if (null === $response && is_array($this->_view))
        {
            // 渲染视图之前的操作
            $this->beforeRender($response);

            // 渲染视图操作
            $response = $this->render($this->_viewname, $this->_view);
        }

        return $response;
    }

    /**
     * 设置插件的参数
     *
     * @param mixed $pluginValue (插件参数值)
     * @param string $pluginName (插件参数名)
     * @return void
     */
    public function setPluginParam($pluginValue, $pluginName)
    {
        $this->_pluginParam[$pluginName] = $pluginValue;
    }

    /**
     * 获取插件的参数
     *
     * @param string $pluginName (插件的参数名)
     * @return mixed
     */
    public function getPluginParam($pluginName = null)
    {
        if (null === $pluginName)
        {
            return $this->_pluginParam;
        }
        elseif (isset($this->_pluginParam[$pluginName]))
        {
            return $this->_pluginParam[$pluginName];
        }
        else
        {
            return null;
        }
    }

    /**
     * 创建统一JSON格式
     *
     * @param string $code 自定义Code码
     * @param mixed $data  自定义返回数据
     * @param string $message 提示信息
     * @return json
     */
    protected function returnJson($code = 0, $data = '', $message = '')
    {
// 		if ($this->_request->isAjax())
// 		{
// 			header('Content-Type: application/json; charset=utf-8;');
// 		}

        return json_encode(array('code' => $code, 'data' => $data, 'message' => $message));
    }

    /**
     * 错误提示页
     *
     * @param string $caption	标题
     * @param string $message	提示信息
     * @param string $url		跳转链接
     * @param integer $delay	停留时间时间
     * @param string $script	JS脚本
     * @param string $viewname	使用的视图
     * @return string 错误提示页面HTML内容
     * @since 0.2
     */
    protected function _error($caption, $message, $url, $delay = 5, $script = '', $viewname = 'redirect_message')
    {
        return $this->render($viewname, array(
                    'message_caption' => $caption,
                    'message_body' => $message,
                    'redirect_url' => $url,
                    'redirect_delay' => $delay,
                    'hidden_script' => $script
        ));
    }

    /**
     * 创建Session
     *
     * @param string $namespace  命名空间
     * @param string $key  键名
     * @param mixed $value  键值
     * @return void
     * @since 0.2
     */
    protected function setSession($namespace, $key, $value)
    {
        isset($_SESSION) || session_start();

        $_SESSION[$namespace][$key] = $value;
    }

    /**
     * 获取Session
     *
     * @param string $namespace  命名空间
     * @param string $name  session名称: 默认为null, 表示所有
     * @param mixed $default  默认返回值
     * @return mixed
     * @since 0.2
     */
    protected function getSession($namespace, $name = null, $default = null)
    {
        isset($_SESSION) || session_start();

        if (null === $name)
        {
            return $_SESSION[$namespace];
        }

        return isset($_SESSION[$namespace][$name]) ? $_SESSION[$namespace][$name] : $default;
    }

    /**
     * 删除Session
     *
     * @param string $namespace  命名空间
     * @param string $name  session名称: 默认为null, 表示所有
     * @return void
     * @since 0.2
     */
    protected function delSession($namespace, $name = null)
    {
        isset($_SESSION) || session_start();

        if (null === $name)
        {
            $_SESSION[$namespace] = array();

            unset($_SESSION[$namespace]);
        }
        elseif (isset($_SESSION[$namespace][$name]))
        {
            $_SESSION[$namespace][$name] = null;

            unset($_SESSION[$namespace][$name]);
        }
    }

    /**
     * 设置cookie
     * 
     * @param string $name  cookie名称
     * @param mixed $value  cookie值
     * @param integer $expire  cookie有效期
     * @param mixed $domain  cookie作用域
     * @param mixed $path  cookie有效路径
     * @return void
     * @since 0.2
     */
    protected function setCookie($name, $value, $expire = 0, $domain = '.yoho.cn', $path = '/')
    {
        setcookie($name, $value, $expire, $path, $domain, null, null);
    }

    /**
     * 获取cookie
     * 
     * @param string $name  cookie名称
     * @param mixed $default  默认返回值
     * @return mixed null:  表示cookie不存在
     * @since 0.2
     */
    protected function getCookie($name, $default = null)
    {
        if (null === $name)
        {
            return $_COOKIE;
        }

        return isset($_COOKIE[$name]) ? $_COOKIE[$name] : $default;
    }

    /**
     * 删除cookie
     * 
     * @param string $name  cookie名称
     * @return void
     * @since 0.2
     */
    protected function delCookie($name)
    {
        setcookie($name, null);
    }

    /**
     * 设置SEO标题
     *
     * @param string $title  SEO标题
     * @since 0.2
     */
    protected function setTitle($title)
    {
        $this->_seo['title'] = $this->stripTags($title);
    }

    /**
     * 设置SEO关键字
     *
     * @param string $keywords  SEO关键字
     * @since 0.2
     */
    protected function setKeywords($keywords)
    {
        $this->_seo['keywords'] = $this->stripTags($keywords);
    }

    /**
     * 设置SEO简单描述
     *
     * @param string $description  SEO简单描述
     * @since 0.2
     */
    protected function setDescription($description)
    {
        $this->_seo['description'] = $this->stripTags($description);
    }

    /**
     * 调用组件
     *
     * @param string $alias (组件路径)
     * @param array $params (组件参数)
     * @access protected
     * @since 4.0
     */
    protected function component($alias, $params = array(), $id = '')
    {
        $component = new Framework_YComponent($id);
        $component->execute($alias, $params);
    }

    /**
     * 过滤字符内容
     *
     * @param string $html
     * @return string
     */
    protected function stripTags($html)
    {
        $search = array(
            '&nbsp;',
            "'<script[^>]*?>.*?</script>'si",
            "'<[\/\!]*?[^<>]*?>'si",
            "'([\r\n])[\s]+'",
            "'&(quot|#34|#034|#x22);'i",
            "'&(amp|#38|#038|#x26);'i",
            "'&(lt|#60|#060|#x3c);'i",
            "'&(gt|#62|#062|#x3e);'i",
            "'&(nbsp|#160|#xa0);'i",
            "'&(iexcl|#161);'i",
            "'&(cent|#162);'i",
            "'&(pound|#163);'i",
            "'&(copy|#169);'i",
            "'&(reg|#174);'i",
            "'&(deg|#176);'i",
            "'&(#39|#039|#x27);'",
            "'&(euro|#8364);'i",
            "'&a(uml|UML);'",
            "'&o(uml|UML);'",
            "'&u(uml|UML);'",
            "'&A(uml|UML);'",
            "'&O(uml|UML);'",
            "'&U(uml|UML);'",
            "'&szlig;'i",
            "\n",
            "\r",
            "\t",
            "\0",
        );
        return trim(str_replace($search, '', strip_tags($html)));
    }

    /**
     * 判断访问设备类型
     * @return string
     */
    protected function isMobileAgent()
    {
        if (strstr($_SERVER['HTTP_USER_AGENT'], 'Android')) //Android
        {
            return 'Android';
        }
        elseif (strstr($_SERVER['HTTP_USER_AGENT'], 'iPhone')) //iphone
        {
            return 'iPhone';
        }
        elseif (strstr($_SERVER['HTTP_USER_AGENT'], 'Windows Phone'))
        {
            return 'wp';
        }
        else
        {
            return 'desktop';
        }
    }

    /**
     * 执行Action前的操作
     * 在此设置此方法为最终方法，不允许action中进行继承
     * 例如: 此处可放置如日志系统之类的代码
     */
    final protected function beforeExecute()
    {
        
    }

    /**
     * 执行Action后的操作
     * 在此设置此方法为最终方法，不允许action中进行继承
     * 例如: 此处可放置如日志系统之类的代码
     */
    final protected function afterExecute(&$response)
    {
        Framework_YPlugin::execute('afterAction', array(
            'param' => $this->getPluginParam(), // 插件参数
            'view' => $this->_view, // 视图参数
            'req' => $this->_request, // 请求对象
            'res' => $response // 响应结果
        ));
    }

    /**
     * 执行渲染视图前的操作
     *
     * 在此设置此方法为最终方法，不允许action中进行继承
     * 例如: 此处可放置初始化设置网站SEO
     *
     * @see Framework_YController::beforeRender()
     * @since 0.2
     */
    final protected function beforeRender($response)
    {
        
    }

    /**
     * 生成签名
     *
     * @param string $secret  私有密钥
     * @param array $params  请求的参数
     * @return string
     * @since 5.0
     */
    protected function makeSign($secret, $params)
    {
        $params = $temp = (array) $params;
        //过滤带"/"的参数,因服务器的环境问题，会将controller/action作为传递的参数，故需过滤
        foreach ($temp as $k => $v)
        {
        	if (strstr($k,'/') !== false)
        	{
                    unset($params[$k]);
        	}
        }
        // 添加密钥
        $params['private_key'] = $secret;

        // 排序
        ksort($params);
        reset($params);

        $str = '';
        foreach ($params as $key => $val)
        {
            $str .= $key . '=' . trim($val) . '&';
        }
        $str = substr($str, 0, -1);

        return md5($str);
    }

    /**
     * 初始化操作
     * 
     * 验证应用身份, 获取并暂存应用的订阅信息
     * 
     * @since 5.0
     */
    protected function init()
    {
        if ($this->_request->isPost())
        {
            $key = $this->_request->post('key', '');
            $sign = $this->_request->post('sign', '');
            if ($key != '' && $sign != '')
            {
                $appInfo = Facade_Subscribe::get($key);
                if ($appInfo && isset($appInfo['scope']) && $appInfo['state'])
                {
                    $params = $this->_request->post();
                    unset($params['sign']);
                    if ($sign === $this->makeSign($appInfo['secret'], $params))
                    {
                        $this->_appId = $appInfo['key'];
                        $this->_appScope = $appInfo['scope'];
                        return null;
                    }
                }
            }
        }
        else
        {
            $key = $this->_request->get('key', '');
            $sign = $this->_request->get('sign', '');
            if ($key != '' && $sign != '')
            {
                $appInfo = Facade_Subscribe::get($key);
                if ($appInfo && isset($appInfo['scope']) && $appInfo['state'])
                {
                    $params = $this->_request->get();
                    unset($params['sign']);

                    // 过滤掉不需要的参数
                    $filter = array('controller' => '', 'action' => '', 'module' => '', 'namespace' => '');
                    $params = array_diff_key($params, $filter);
                    if ($sign === $this->makeSign($appInfo['secret'], $params))
                    {
                        $this->_appId = $appInfo['key'];
                        $this->_appScope = $appInfo['scope'];
                        return null;
                    }
                }
            }
        }

        return $this->returnJson(Config_Code::$error['system']['code'], null, '认证失败');
    }

    /**
     * 页面回调方法
     * @param string $callback 地址
     * @param string $method 方法(post|get)
     * @param array $data 数据
     */
    protected function _callback($callback, $method, $data)
    {
        $method = strtolower($method);
        $method = ($method == 'get') ? 'get' : 'post';
        if ($method == 'get')
        {
            $data = http_build_query($data);
            if (strstr($callback, '?') !== false)
            {
                $callback .= '&' . $data;
            }
            else
            {
                $callback .= '?' . $data;
            }
            return <<<EOT
<html>
	<head>
		<meta http-equiv="refresh" content="0;URL=$callback" />
	</head>
</html>
EOT;
        }
        else
        {
            //POST提交
            $postString = '';
            foreach ($data as $k => $v)
            {
                $postString .= '<input type="hidden" name="' . $k . '" value="' . $v . '">';
            }
            return <<<EOT
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	</head>
	<body onload="document.yohoSubmit.submit();">
		<form method="POST" action="$callback"  name="yohoSubmit" id="yohoSubmit" >
		$postString
		</form>
	</body>
</html>
EOT;
        }
    }

}

?>