system/libraries/User_agent.php - code-igniter-v3-giggi - Gitiles

 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 /**
  * CodeIgniter
  *
  * An open source application development framework for PHP 5.1.6 or newer
  *
  * NOTICE OF LICENSE
  *
  * Licensed under the Open Software License version 3.0
  *
  * This source file is subject to the Open Software License (OSL 3.0) that is
  * bundled with this package in the files license.txt / license.rst.  It is
  * also available through the world wide web at this URL:
  * http://opensource.org/licenses/OSL-3.0
  * 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
  * licensing@ellislab.com so we can send you a copy immediately.
  *
  * @package		CodeIgniter
  * @author		EllisLab Dev Team
  * @copyright	Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
  * @license		http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
  * @link		http://codeigniter.com
  * @since		Version 1.0
  * @filesource
  */

 // ------------------------------------------------------------------------

 /**
  * User Agent Class
  *
  * Identifies the platform, browser, robot, or mobile device of the browsing agent
  *
  * @package		CodeIgniter
  * @subpackage	Libraries
  * @category	User Agent
  * @author		EllisLab Dev Team
  * @link		http://codeigniter.com/user_guide/libraries/user_agent.html
  */
 class CI_User_agent {

 	public $agent		= NULL;

 	public $is_browser	= FALSE;
 	public $is_robot	= FALSE;
 	public $is_mobile	= FALSE;

 	public $languages	= array();
 	public $charsets	= array();

 	public $platforms	= array();
 	public $browsers	= array();
 	public $mobiles		= array();
 	public $robots		= array();

 	public $platform	= '';
 	public $browser		= '';
 	public $version		= '';
 	public $mobile		= '';
 	public $robot		= '';

 	/**
 	 * Constructor
 	 *
 	 * Sets the User Agent and runs the compilation routine
 	 *
 	 * @return	void
 	 */
 	public function __construct()
 	{
 		if (isset($_SERVER['HTTP_USER_AGENT']))
 		{
 			$this->agent = trim($_SERVER['HTTP_USER_AGENT']);
 		}

 		if ( ! is_null($this->agent))
 		{
 			if ($this->_load_agent_file())
 			{
 				$this->_compile_data();
 			}
 		}

 		log_message('debug', "User Agent Class Initialized");
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Compile the User Agent Data
 	 *
 	 * @return	bool
 	 */
 	protected function _load_agent_file()
 	{
 		if (defined('ENVIRONMENT') AND is_file(APPPATH.'config/'.ENVIRONMENT.'/user_agents.php'))
 		{
 			include(APPPATH.'config/'.ENVIRONMENT.'/user_agents.php');
 		}
 		elseif (is_file(APPPATH.'config/user_agents.php'))
 		{
 			include(APPPATH.'config/user_agents.php');
 		}
 		else
 		{
 			return FALSE;
 		}

 		$return = FALSE;

 		if (isset($platforms))
 		{
 			$this->platforms = $platforms;
 			unset($platforms);
 			$return = TRUE;
 		}

 		if (isset($browsers))
 		{
 			$this->browsers = $browsers;
 			unset($browsers);
 			$return = TRUE;
 		}

 		if (isset($mobiles))
 		{
 			$this->mobiles = $mobiles;
 			unset($mobiles);
 			$return = TRUE;
 		}

 		if (isset($robots))
 		{
 			$this->robots = $robots;
 			unset($robots);
 			$return = TRUE;
 		}

 		return $return;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Compile the User Agent Data
 	 *
 	 * @return	bool
 	 */
 	protected function _compile_data()
 	{
 		$this->_set_platform();

 		foreach (array('_set_robot', '_set_browser', '_set_mobile') as $function)
 		{
 			if ($this->$function() === TRUE)
 			{
 				break;
 			}
 		}
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the Platform
 	 *
 	 * @return	mixed
 	 */
 	protected function _set_platform()
 	{
 		if (is_array($this->platforms) AND count($this->platforms) > 0)
 		{
 			foreach ($this->platforms as $key => $val)
 			{
 				if (preg_match("|".preg_quote($key)."|i", $this->agent))
 				{
 					$this->platform = $val;
 					return TRUE;
 				}
 			}
 		}
 		$this->platform = 'Unknown Platform';
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the Browser
 	 *
 	 * @return	bool
 	 */
 	protected function _set_browser()
 	{
 		if (is_array($this->browsers) AND count($this->browsers) > 0)
 		{
 			foreach ($this->browsers as $key => $val)
 			{
 				if (preg_match("|".preg_quote($key).".*?([0-9\.]+)|i", $this->agent, $match))
 				{
 					$this->is_browser = TRUE;
 					$this->version = $match[1];
 					$this->browser = $val;
 					$this->_set_mobile();
 					return TRUE;
 				}
 			}
 		}
 		return FALSE;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the Robot
 	 *
 	 * @return	bool
 	 */
 	protected function _set_robot()
 	{
 		if (is_array($this->robots) AND count($this->robots) > 0)
 		{
 			foreach ($this->robots as $key => $val)
 			{
 				if (preg_match("|".preg_quote($key)."|i", $this->agent))
 				{
 					$this->is_robot = TRUE;
 					$this->robot = $val;
 					return TRUE;
 				}
 			}
 		}
 		return FALSE;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the Mobile Device
 	 *
 	 * @return	bool
 	 */
 	protected function _set_mobile()
 	{
 		if (is_array($this->mobiles) AND count($this->mobiles) > 0)
 		{
 			foreach ($this->mobiles as $key => $val)
 			{
 				if (FALSE !== (strpos(strtolower($this->agent), $key)))
 				{
 					$this->is_mobile = TRUE;
 					$this->mobile = $val;
 					return TRUE;
 				}
 			}
 		}
 		return FALSE;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the accepted languages
 	 *
 	 * @return	void
 	 */
 	protected function _set_languages()
 	{
 		if ((count($this->languages) === 0) AND isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) AND $_SERVER['HTTP_ACCEPT_LANGUAGE'] != '')
 		{
 			$this->languages = explode(',', preg_replace('/(;q=[0-9\.]+)/i', '', strtolower(trim($_SERVER['HTTP_ACCEPT_LANGUAGE']))));
 		}

 		if (count($this->languages) === 0)
 		{
 			$this->languages = array('Undefined');
 		}
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Set the accepted character sets
 	 *
 	 * @return	void
 	 */
 	protected function _set_charsets()
 	{
 		if ((count($this->charsets) === 0) AND isset($_SERVER['HTTP_ACCEPT_CHARSET']) AND $_SERVER['HTTP_ACCEPT_CHARSET'] != '')
 		{
 			$this->charsets = explode(',', preg_replace('/(;q=.+)/i', '', strtolower(trim($_SERVER['HTTP_ACCEPT_CHARSET']))));
 		}

 		if (count($this->charsets) === 0)
 		{
 			$this->charsets = array('Undefined');
 		}
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Is Browser
 	 *
 	 * @return	bool
 	 */
 	public function is_browser($key = NULL)
 	{
 		if ( ! $this->is_browser)
 		{
 			return FALSE;
 		}

 		// No need to be specific, it's a browser
 		if ($key === NULL)
 		{
 			return TRUE;
 		}

 		// Check for a specific browser
 		return array_key_exists($key, $this->browsers) AND $this->browser === $this->browsers[$key];
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Is Robot
 	 *
 	 * @return	bool
 	 */
 	public function is_robot($key = NULL)
 	{
 		if ( ! $this->is_robot)
 		{
 			return FALSE;
 		}

 		// No need to be specific, it's a robot
 		if ($key === NULL)
 		{
 			return TRUE;
 		}

 		// Check for a specific robot
 		return array_key_exists($key, $this->robots) AND $this->robot === $this->robots[$key];
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Is Mobile
 	 *
 	 * @return	bool
 	 */
 	public function is_mobile($key = NULL)
 	{
 		if ( ! $this->is_mobile)
 		{
 			return FALSE;
 		}

 		// No need to be specific, it's a mobile
 		if ($key === NULL)
 		{
 			return TRUE;
 		}

 		// Check for a specific robot
 		return array_key_exists($key, $this->mobiles) AND $this->mobile === $this->mobiles[$key];
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Is this a referral from another site?
 	 *
 	 * @return	bool
 	 */
 	public function is_referral()
 	{
 		return ( ! isset($_SERVER['HTTP_REFERER']) OR $_SERVER['HTTP_REFERER'] == '') ? FALSE : TRUE;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Agent String
 	 *
 	 * @return	string
 	 */
 	public function agent_string()
 	{
 		return $this->agent;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get Platform
 	 *
 	 * @return	string
 	 */
 	public function platform()
 	{
 		return $this->platform;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get Browser Name
 	 *
 	 * @return	string
 	 */
 	public function browser()
 	{
 		return $this->browser;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get the Browser Version
 	 *
 	 * @return	string
 	 */
 	public function version()
 	{
 		return $this->version;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get The Robot Name
 	 *
 	 * @return	string
 	 */
 	public function robot()
 	{
 		return $this->robot;
 	}
 	// --------------------------------------------------------------------

 	/**
 	 * Get the Mobile Device
 	 *
 	 * @return	string
 	 */
 	public function mobile()
 	{
 		return $this->mobile;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get the referrer
 	 *
 	 * @return	bool
 	 */
 	public function referrer()
 	{
 		return ( ! isset($_SERVER['HTTP_REFERER']) OR $_SERVER['HTTP_REFERER'] == '') ? '' : trim($_SERVER['HTTP_REFERER']);
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get the accepted languages
 	 *
 	 * @return	array
 	 */
 	public function languages()
 	{
 		if (count($this->languages) === 0)
 		{
 			$this->_set_languages();
 		}

 		return $this->languages;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Get the accepted Character Sets
 	 *
 	 * @return	array
 	 */
 	public function charsets()
 	{
 		if (count($this->charsets) === 0)
 		{
 			$this->_set_charsets();
 		}

 		return $this->charsets;
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Test for a particular language
 	 *
 	 * @return	bool
 	 */
 	public function accept_lang($lang = 'en')
 	{
 		return (in_array(strtolower($lang), $this->languages(), TRUE));
 	}

 	// --------------------------------------------------------------------

 	/**
 	 * Test for a particular character set
 	 *
 	 * @return	bool
 	 */
 	public function accept_charset($charset = 'utf-8')
 	{
 		return (in_array(strtolower($charset), $this->charsets(), TRUE));
 	}

 }

 /* End of file User_agent.php */
 /* Location: ./system/libraries/User_agent.php */
	<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
	/**
	* CodeIgniter
	*
	* An open source application development framework for PHP 5.1.6 or newer
	*
	* NOTICE OF LICENSE
	*
	* Licensed under the Open Software License version 3.0
	*
	* This source file is subject to the Open Software License (OSL 3.0) that is
	* bundled with this package in the files license.txt / license.rst. It is
	* also available through the world wide web at this URL:
	* http://opensource.org/licenses/OSL-3.0
	* 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
	* licensing@ellislab.com so we can send you a copy immediately.
	*
	* @package CodeIgniter
	* @author EllisLab Dev Team
	* @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
	* @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
	* @link http://codeigniter.com
	* @since Version 1.0
	* @filesource
	*/

	// ------------------------------------------------------------------------

	/**
	* User Agent Class
	*
	* Identifies the platform, browser, robot, or mobile device of the browsing agent
	*
	* @package CodeIgniter
	* @subpackage Libraries
	* @category User Agent
	* @author EllisLab Dev Team
	* @link http://codeigniter.com/user_guide/libraries/user_agent.html
	*/
	class CI_User_agent {

	public $agent = NULL;

	public $is_browser = FALSE;
	public $is_robot = FALSE;
	public $is_mobile = FALSE;

	public $languages = array();
	public $charsets = array();

	public $platforms = array();
	public $browsers = array();
	public $mobiles = array();
	public $robots = array();

	public $platform = '';
	public $browser = '';
	public $version = '';
	public $mobile = '';
	public $robot = '';

	/**
	* Constructor
	*
	* Sets the User Agent and runs the compilation routine
	*
	* @return void
	*/
	public function __construct()
	{
	if (isset($_SERVER['HTTP_USER_AGENT']))
	{
	$this->agent = trim($_SERVER['HTTP_USER_AGENT']);
	}

	if ( ! is_null($this->agent))
	{
	if ($this->_load_agent_file())
	{
	$this->_compile_data();
	}
	}

	log_message('debug', "User Agent Class Initialized");
	}

	// --------------------------------------------------------------------

	/**
	* Compile the User Agent Data
	*
	* @return bool
	*/
	protected function _load_agent_file()
	{
	if (defined('ENVIRONMENT') AND is_file(APPPATH.'config/'.ENVIRONMENT.'/user_agents.php'))
	{
	include(APPPATH.'config/'.ENVIRONMENT.'/user_agents.php');
	}
	elseif (is_file(APPPATH.'config/user_agents.php'))
	{
	include(APPPATH.'config/user_agents.php');
	}
	else
	{
	return FALSE;
	}

	$return = FALSE;

	if (isset($platforms))
	{
	$this->platforms = $platforms;
	unset($platforms);
	$return = TRUE;
	}

	if (isset($browsers))
	{
	$this->browsers = $browsers;
	unset($browsers);
	$return = TRUE;
	}

	if (isset($mobiles))
	{
	$this->mobiles = $mobiles;
	unset($mobiles);
	$return = TRUE;
	}

	if (isset($robots))
	{
	$this->robots = $robots;
	unset($robots);
	$return = TRUE;
	}

	return $return;
	}

	// --------------------------------------------------------------------

	/**
	* Compile the User Agent Data
	*
	* @return bool
	*/
	protected function _compile_data()
	{
	$this->_set_platform();

	foreach (array('_set_robot', '_set_browser', '_set_mobile') as $function)
	{
	if ($this->$function() === TRUE)
	{
	break;
	}
	}
	}

	// --------------------------------------------------------------------

	/**
	* Set the Platform
	*
	* @return mixed
	*/
	protected function _set_platform()
	{
	if (is_array($this->platforms) AND count($this->platforms) > 0)
	{
	foreach ($this->platforms as $key => $val)
	{
	if (preg_match("\|".preg_quote($key)."\|i", $this->agent))
	{
	$this->platform = $val;
	return TRUE;
	}
	}
	}
	$this->platform = 'Unknown Platform';
	}

	// --------------------------------------------------------------------

	/**
	* Set the Browser
	*
	* @return bool
	*/
	protected function _set_browser()
	{
	if (is_array($this->browsers) AND count($this->browsers) > 0)
	{
	foreach ($this->browsers as $key => $val)
	{
	if (preg_match("\|".preg_quote($key).".*?([0-9\.]+)\|i", $this->agent, $match))
	{
	$this->is_browser = TRUE;
	$this->version = $match[1];
	$this->browser = $val;
	$this->_set_mobile();
	return TRUE;
	}
	}
	}
	return FALSE;
	}

	// --------------------------------------------------------------------

	/**
	* Set the Robot
	*
	* @return bool
	*/
	protected function _set_robot()
	{
	if (is_array($this->robots) AND count($this->robots) > 0)
	{
	foreach ($this->robots as $key => $val)
	{
	if (preg_match("\|".preg_quote($key)."\|i", $this->agent))
	{
	$this->is_robot = TRUE;
	$this->robot = $val;
	return TRUE;
	}
	}
	}
	return FALSE;
	}

	// --------------------------------------------------------------------

	/**
	* Set the Mobile Device
	*
	* @return bool
	*/
	protected function _set_mobile()
	{
	if (is_array($this->mobiles) AND count($this->mobiles) > 0)
	{
	foreach ($this->mobiles as $key => $val)
	{
	if (FALSE !== (strpos(strtolower($this->agent), $key)))
	{
	$this->is_mobile = TRUE;
	$this->mobile = $val;
	return TRUE;
	}
	}
	}
	return FALSE;
	}

	// --------------------------------------------------------------------

	/**
	* Set the accepted languages
	*
	* @return void
	*/
	protected function _set_languages()
	{
	if ((count($this->languages) === 0) AND isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) AND $_SERVER['HTTP_ACCEPT_LANGUAGE'] != '')
	{
	$this->languages = explode(',', preg_replace('/(;q=[0-9\.]+)/i', '', strtolower(trim($_SERVER['HTTP_ACCEPT_LANGUAGE']))));
	}

	if (count($this->languages) === 0)
	{
	$this->languages = array('Undefined');
	}
	}

	// --------------------------------------------------------------------

	/**
	* Set the accepted character sets
	*
	* @return void
	*/
	protected function _set_charsets()
	{
	if ((count($this->charsets) === 0) AND isset($_SERVER['HTTP_ACCEPT_CHARSET']) AND $_SERVER['HTTP_ACCEPT_CHARSET'] != '')
	{
	$this->charsets = explode(',', preg_replace('/(;q=.+)/i', '', strtolower(trim($_SERVER['HTTP_ACCEPT_CHARSET']))));
	}

	if (count($this->charsets) === 0)
	{
	$this->charsets = array('Undefined');
	}
	}

	// --------------------------------------------------------------------

	/**
	* Is Browser
	*
	* @return bool
	*/
	public function is_browser($key = NULL)
	{
	if ( ! $this->is_browser)
	{
	return FALSE;
	}

	// No need to be specific, it's a browser
	if ($key === NULL)
	{
	return TRUE;
	}

	// Check for a specific browser
	return array_key_exists($key, $this->browsers) AND $this->browser === $this->browsers[$key];
	}

	// --------------------------------------------------------------------

	/**
	* Is Robot
	*
	* @return bool
	*/
	public function is_robot($key = NULL)
	{
	if ( ! $this->is_robot)
	{
	return FALSE;
	}

	// No need to be specific, it's a robot
	if ($key === NULL)
	{
	return TRUE;
	}

	// Check for a specific robot
	return array_key_exists($key, $this->robots) AND $this->robot === $this->robots[$key];
	}

	// --------------------------------------------------------------------

	/**
	* Is Mobile
	*
	* @return bool
	*/
	public function is_mobile($key = NULL)
	{
	if ( ! $this->is_mobile)
	{
	return FALSE;
	}

	// No need to be specific, it's a mobile
	if ($key === NULL)
	{
	return TRUE;
	}

	// Check for a specific robot
	return array_key_exists($key, $this->mobiles) AND $this->mobile === $this->mobiles[$key];
	}

	// --------------------------------------------------------------------

	/**
	* Is this a referral from another site?
	*
	* @return bool
	*/
	public function is_referral()
	{
	return ( ! isset($_SERVER['HTTP_REFERER']) OR $_SERVER['HTTP_REFERER'] == '') ? FALSE : TRUE;
	}

	// --------------------------------------------------------------------

	/**
	* Agent String
	*
	* @return string
	*/
	public function agent_string()
	{
	return $this->agent;
	}

	// --------------------------------------------------------------------

	/**
	* Get Platform
	*
	* @return string
	*/
	public function platform()
	{
	return $this->platform;
	}

	// --------------------------------------------------------------------

	/**
	* Get Browser Name
	*
	* @return string
	*/
	public function browser()
	{
	return $this->browser;
	}

	// --------------------------------------------------------------------

	/**
	* Get the Browser Version
	*
	* @return string
	*/
	public function version()
	{
	return $this->version;
	}

	// --------------------------------------------------------------------

	/**
	* Get The Robot Name
	*
	* @return string
	*/
	public function robot()
	{
	return $this->robot;
	}
	// --------------------------------------------------------------------

	/**
	* Get the Mobile Device
	*
	* @return string
	*/
	public function mobile()
	{
	return $this->mobile;
	}

	// --------------------------------------------------------------------

	/**
	* Get the referrer
	*
	* @return bool
	*/
	public function referrer()
	{
	return ( ! isset($_SERVER['HTTP_REFERER']) OR $_SERVER['HTTP_REFERER'] == '') ? '' : trim($_SERVER['HTTP_REFERER']);
	}

	// --------------------------------------------------------------------

	/**
	* Get the accepted languages
	*
	* @return array
	*/
	public function languages()
	{
	if (count($this->languages) === 0)
	{
	$this->_set_languages();
	}

	return $this->languages;
	}

	// --------------------------------------------------------------------

	/**
	* Get the accepted Character Sets
	*
	* @return array
	*/
	public function charsets()
	{
	if (count($this->charsets) === 0)
	{
	$this->_set_charsets();
	}

	return $this->charsets;
	}

	// --------------------------------------------------------------------

	/**
	* Test for a particular language
	*
	* @return bool
	*/
	public function accept_lang($lang = 'en')
	{
	return (in_array(strtolower($lang), $this->languages(), TRUE));
	}

	// --------------------------------------------------------------------

	/**
	* Test for a particular character set
	*
	* @return bool
	*/
	public function accept_charset($charset = 'utf-8')
	{
	return (in_array(strtolower($charset), $this->charsets(), TRUE));
	}

	}

	/* End of file User_agent.php */
	/* Location: ./system/libraries/User_agent.php */