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

 * @subpackage UserAgent

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

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

 */

require_once 'Zend/Http/UserAgent/Device.php';

/**

 * Abstract Class to define a browser device.

 *

 * @category   Zend

 * @package    Zend_Http

 * @subpackage UserAgent

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

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

 */

abstract class Zend_Http_UserAgent_AbstractDevice

    implements Zend_Http_UserAgent_Device

{

    /**

     * Browser signature

     *

     * @var string

     */

    protected $_browser = '';

    /**

     * Browser version

     *

     * @var string

     */

    protected $_browserVersion = '';

    /**

     * Configuration

     * 

     * @var array

     */

    protected $_config;

    /**

     * User Agent chain

     *

     * @var string

     */

    protected $_userAgent;

    /**

     * Server variable

     * 

     * @var array

     */

    protected $_server;

    /**

     * Image types

     * 

     * @var array

     */

    protected $_images = array(

        'jpeg', 

        'gif', 

        'png', 

        'pjpeg', 

        'x-png', 

        'bmp',

    );

    /**

     * Browser/Device features

     *

     * @var array

     */

    protected $_aFeatures = array();

    /**

     * Browser/Device features groups

     *

     * @var array

     */

    protected $_aGroup = array();

    /**

     * Constructor

     *

     * @param  null|string|array $userAgent If array, restores from serialized version

     * @param  array $server 

     * @param  array $config 

     * @return void

     */

    public function __construct($userAgent = null, array $server = array(), array $config = array())

    {

        if (is_array($userAgent)) {

            // Restoring from serialized array

            $this->_restoreFromArray($userAgent);

        } else {

            // Constructing new object

            $this->setUserAgent($userAgent);

            $this->_server    = $server;

            $this->_config    = $config;

            $this->_getDefaultFeatures();

            $this->_defineFeatures();

        }

    }

    /**

     * Serialize object

     * 

     * @return string

     */

    public function serialize()

    {

        $spec = array(

            '_aFeatures'      => $this->_aFeatures,

            '_aGroup'         => $this->_aGroup,

            '_browser'        => $this->_browser,

            '_browserVersion' => $this->_browserVersion,

            '_userAgent'      => $this->_userAgent,

            '_images'         => $this->_images,

        );

        return serialize($spec);

    }

    /**

     * Unserialize

     * 

     * @param  string $serialized 

     * @return void

     */

    public function unserialize($serialized)

    {

        $spec = unserialize($serialized);

        $this->_restoreFromArray($spec);

    }

    /**

     * Restore object state from array

     * 

     * @param  array $spec 

     * @return void

     */

    protected function _restoreFromArray(array $spec)

    {

        foreach ($spec as $key => $value) {

            if (property_exists($this, $key)) {

                $this->{$key} = $value;

            }

        }

    }

    /**

     * Look for features

     *

     * @return array|null

     */

    protected function _defineFeatures()

    {

        $features = $this->_loadFeaturesAdapter();

        if (is_array($features)) {

            $this->_aFeatures = array_merge($this->_aFeatures, $features);

        }

        return $this->_aFeatures;

    }

    /**

     * Gets the browser type identifier

     *

     * @return string

     */

    abstract public function getType();

    /**

     * Check a feature for the current browser/device.

     *

     * @param  string $feature The feature to check.

     * @return bool

     */

    public function hasFeature($feature)

    {

        return (!empty($this->_aFeatures[$feature]));

    }

    /**

     * Gets the value of the current browser/device feature

     *

     * @param  string $feature Feature to search

     * @return string|null

     */

    public function getFeature($feature)

    {

        if ($this->hasFeature($feature)) {

            return $this->_aFeatures[$feature];

        }

    }

    /**

     * Set a feature for the current browser/device.

     *

     * @param  string $feature The feature to set.

     * @param  string $value (option) feature value.

     * @param  string $group (option) Group to associate with the feature

     * @return Zend_Http_UserAgent_AbstractDevice

     */

    public function setFeature($feature, $value = false, $group = '')

    {

        $this->_aFeatures[$feature] = $value;

        if (!empty($group)) {

            $this->setGroup($group, $feature);

        }

        return $this;

    }

    /**

     * Affects a feature to a group

     *

     * @param  string $group Group name

     * @param  string $feature Feature name

     * @return Zend_Http_UserAgent_AbstractDevice

     */

    public function setGroup($group, $feature)

    {

        if (!isset($this->_aGroup[$group])) {

            $this->_aGroup[$group] = array();

        }

        if (!in_array($feature, $this->_aGroup[$group])) {

            $this->_aGroup[$group][] = $feature;

        }

        return $this;

    }

    /**

     * Gets an array of features associated to a group

     *

     * @param  string $group Group param

     * @return array

     */

    public function getGroup($group)

    {

        return $this->_aGroup[$group];

    }

    /**

     * Gets all the browser/device features

     *

     * @return array

     */

    public function getAllFeatures()

    {

        return $this->_aFeatures;

    }

    /**

     * Gets all the browser/device features' groups

     *

     * @return array

     */

    public function getAllGroups()

    {

        return $this->_aGroup;

    }

    /**

     * Sets all the standard features extracted from the User Agent chain and $this->_server

     * vars

     *

     * @return void

     */

    protected function _getDefaultFeatures()

    {

        $server = array();

        // gets info from user agent chain 

        $uaExtract = $this->extractFromUserAgent($this->getUserAgent());

        if (is_array($uaExtract)) {

            foreach ($uaExtract as $key => $info) {

                $this->setFeature($key, $info, 'product_info');

            }

        }

        if (isset($uaExtract['browser_name'])) {

            $this->_browser = $uaExtract['browser_name'];

        }

        if (isset($uaExtract['browser_version'])) {

            $this->_browserVersion = $uaExtract['browser_version'];

        }

        if (isset($uaExtract['device_os'])) {

            $this->device_os = $uaExtract['device_os_name'];

        }

        /* browser & device info */

        $this->setFeature('is_wireless_device', false, 'product_info');

        $this->setFeature('is_mobile', false, 'product_info');

        $this->setFeature('is_desktop', false, 'product_info');

        $this->setFeature('is_tablet', false, 'product_info');

        $this->setFeature('is_bot', false, 'product_info');

        $this->setFeature('is_email', false, 'product_info');

        $this->setFeature('is_text', false, 'product_info');

        $this->setFeature('device_claims_web_support', false, 'product_info');

        $this->setFeature('is_' . strtolower($this->getType()), true, 'product_info');

        /* sets the browser name */

        if (isset($this->list) && empty($this->_browser)) {

            $lowerUserAgent = strtolower($this->getUserAgent());

            foreach ($this->list as $browser_signature) {

                if (strpos($lowerUserAgent, $browser_signature) !== false) {

                    $this->_browser = strtolower($browser_signature);

                    $this->setFeature('browser_name', $this->_browser, 'product_info');

                }

            }

        }

        /* sets the client IP */

        if (isset($this->_server['remote_addr'])) {

            $this->setFeature('client_ip', $this->_server['remote_addr'], 'product_info');

        } elseif (isset($this->_server['http_x_forwarded_for'])) {

            $this->setFeature('client_ip', $this->_server['http_x_forwarded_for'], 'product_info');

        } elseif (isset($this->_server['http_client_ip'])) {

            $this->setFeature('client_ip', $this->_server['http_client_ip'], 'product_info');

        }

        /* sets the server infos */

        if (isset($this->_server['server_software'])) {

            if (strpos($this->_server['server_software'], 'Apache') !== false || strpos($this->_server['server_software'], 'LiteSpeed') !== false) {

                $server['version'] = 1;

                if (strpos($this->_server['server_software'], 'Apache/2') !== false) {

                    $server['version'] = 2;

                }

                $server['server'] = 'apache';

            }

            if (strpos($this->_server['server_software'], 'Microsoft-IIS') !== false) {

                $server['server'] = 'iis';

            }

            if (strpos($this->_server['server_software'], 'Unix') !== false) {

                $server['os'] = 'unix';

                if (isset($_ENV['MACHTYPE'])) {

                    if (strpos($_ENV['MACHTYPE'], 'linux') !== false) {

                        $server['os'] = 'linux';

                    }

                }

            } elseif (strpos($this->_server['server_software'], 'Win') !== false) {

                $server['os'] = 'windows';

            }

            if (preg_match('/Apache\/([0-9\.]*)/', $this->_server['server_software'], $arr)) {

                if ($arr[1]) {

                    $server['version'] = $arr[1];

                    $server['server']  = 'apache';

                }

            }

        }

        $this->setFeature('php_version', phpversion(), 'server_info');

        if (isset($server['server'])) {

            $this->setFeature('server_os', $server['server'], 'server_info');

        }

        if (isset($server['version'])) {

            $this->setFeature('server_os_version', $server['version'], 'server_info');

        }

        if (isset($this->_server['http_accept'])) {

            $this->setFeature('server_http_accept', $this->_server['http_accept'], 'server_info');

        }

        if (isset($this->_server['http_accept_language'])) {

            $this->setFeature('server_http_accept_language', $this->_server['http_accept_language'], 'server_info');

        }

        if (isset($this->_server['server_addr'])) {

            $this->setFeature('server_ip', $this->_server['server_addr'], 'server_info');

        }

        if (isset($this->_server['server_name'])) {

            $this->setFeature('server_name', $this->_server['server_name'], 'server_info');

        }

    }

    /**

     * Extract and sets informations from the User Agent chain

     *

     * @param  string $userAgent User Agent chain

     * @return array

     */

    public static function extractFromUserAgent($userAgent)

    {

        $userAgent = trim($userAgent);

        /**

         * @see http://www.texsoft.it/index.php?c=software&m=sw.php.useragent&l=it

         */

        $pattern =  "(([^/\s]*)(/(\S*))?)(\s*\[[a-zA-Z][a-zA-Z]\])?\s*(\\((([^()]|(\\([^()]*\\)))*)\\))?\s*";

        preg_match("#^$pattern#", $userAgent, $match);

        $comment = array();

        if (isset($match[7])) {

            $comment = explode(';', $match[7]);

        }

        // second part if exists

        $end = substr($userAgent, strlen($match[0]));

        if (!empty($end)) {

            $result['others']['full'] = $end;

        }

        $match2 = array();

        if (isset($result['others'])) {

            preg_match_all('/(([^\/\s]*)(\/)?([^\/\(\)\s]*)?)(\s\((([^\)]*)*)\))?/i', $result['others']['full'], $match2);

        }

        $result['user_agent']   = trim($match[1]);

        $result['product_name'] = isset($match[2]) ? trim($match[2]) : '';

        $result['browser_name'] = $result['product_name'];