PrestaShop/classes/Connection.php

<?php
/*
* 2007-2013 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* 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@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
*  @author PrestaShop SA <contact@prestashop.com>
*  @copyright  2007-2013 PrestaShop SA
*  @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
*  International Registered Trademark & Property of PrestaShop SA
*/

class ConnectionCore extends ObjectModel
{
	/** @var integer */
	public $id_guest;

	/** @var integer */
	public $id_page;

	/** @var string */
	public $ip_address;

	/** @var string */
	public $http_referer;

	/** @var int */
	public $id_shop;

	/** @var int */
	public $id_shop_group;

	/** @var string */
	public $date_add;

	/**
	 * @see ObjectModel::$definition
	 */
	public static $definition = array(
		'table' => 'connections',
		'primary' => 'id_connections',
		'fields' => array(
			'id_guest' => 		array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true),
			'id_page' => 		array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true),
			'ip_address' => 	array('type' => self::TYPE_INT, 'validate' => 'isInt'),
			'http_referer' => 	array('type' => self::TYPE_STRING, 'validate' => 'isAbsoluteUrl'),
			'id_shop' => 		array('type' => self::TYPE_INT, 'required' => true),
			'id_shop_group' => 	array('type' => self::TYPE_INT, 'required' => true),
			'date_add' => 		array('type' => self::TYPE_DATE, 'validate' => 'isDate')
		),
	);

	/**
	 * @see ObjectModel::getFields()
	 * @return array
	 */
	public function getFields()
	{
		if (!$this->id_shop_group)
			$this->id_shop_group = Context::getContext()->shop->id_shop_group;

		$fields = parent::getFields();
		return $fields;
	}

	public static function setPageConnection($cookie, $full = true)
	{
		// The connection is created if it does not exist yet and we get the current page id
		if (!isset($cookie->id_connections) || !strstr(isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '', Tools::getHttpHost(false, false)))
			$id_page = Connection::setNewConnection($cookie);
		// If we do not track the pages, no need to get the page id
		if (!Configuration::get('PS_STATSDATA_PAGESVIEWS') && !Configuration::get('PS_STATSDATA_CUSTOMER_PAGESVIEWS'))
			return array();
		if (!isset($id_page) || !$id_page)
			$id_page = Page::getCurrentId();
		// If we do not track the page views by customer, the id_page is the only information needed
		if (!Configuration::get('PS_STATSDATA_CUSTOMER_PAGESVIEWS'))
			return array('id_page' => $id_page);

		// The ending time will be updated by an ajax request when the guest will close the page
		$time_start = date('Y-m-d H:i:s');
		Db::getInstance()->insert('connections_page', array(
			'id_connections' => (int)$cookie->id_connections,
			'id_page' => (int)$id_page,
			'time_start' => $time_start
		), false, true, Db::INSERT_IGNORE);

		// This array is serialized and used by the ajax request to identify the page
		return array(
			'id_connections' => (int)$cookie->id_connections,
			'id_page' => (int)$id_page,
			'time_start' => $time_start);
	}

	public static function setNewConnection($cookie)
	{
		if (isset($_SERVER['HTTP_USER_AGENT'])
			&& preg_match('/BotLink|ahoy|AlkalineBOT|anthill|appie|arale|araneo|AraybOt|ariadne|arks|ATN_Worldwide|Atomz|bbot|Bjaaland|Ukonline|borg\-bot\/0\.9|boxseabot|bspider|calif|christcrawler|CMC\/0\.01|combine|confuzzledbot|CoolBot|cosmos|Internet Cruiser Robot|cusco|cyberspyder|cydralspider|desertrealm, desert realm|digger|DIIbot|grabber|downloadexpress|DragonBot|dwcp|ecollector|ebiness|elfinbot|esculapio|esther|fastcrawler|FDSE|FELIX IDE|ESI|fido|H<>m<EFBFBD>h<EFBFBD>kki|KIT\-Fireball|fouineur|Freecrawl|gammaSpider|gazz|gcreep|golem|googlebot|griffon|Gromit|gulliver|gulper|hambot|havIndex|hotwired|htdig|iajabot|INGRID\/0\.1|Informant|InfoSpiders|inspectorwww|irobot|Iron33|JBot|jcrawler|Teoma|Jeeves|jobo|image\.kapsi\.net|KDD\-Explorer|ko_yappo_robot|label\-grabber|larbin|legs|Linkidator|linkwalker|Lockon|logo_gif_crawler|marvin|mattie|mediafox|MerzScope|NEC\-MeshExplorer|MindCrawler|udmsearch|moget|Motor|msnbot|muncher|muninn|MuscatFerret|MwdSearch|sharp\-info\-agent|WebMechanic|NetScoop|newscan\-online|ObjectsSearch|Occam|Orbsearch\/1\.0|packrat|pageboy|ParaSite|patric|pegasus|perlcrawler|phpdig|piltdownman|Pimptrain|pjspider|PlumtreeWebAccessor|PortalBSpider|psbot|Getterrobo\-Plus|Raven|RHCS|RixBot|roadrunner|Robbie|robi|RoboCrawl|robofox|Scooter|Search\-AU|searchprocess|Senrigan|Shagseeker|sift|SimBot|Site Valet|skymob|SLCrawler\/2\.0|slurp|ESI|snooper|solbot|speedy|spider_monkey|SpiderBot\/1\.0|spiderline|nil|suke|http:\/\/www\.sygol\.com|tach_bw|TechBOT|templeton|titin|topiclink|UdmSearch|urlck|Valkyrie libwww\-perl|verticrawl|Victoria|void\-bot|Voyager|VWbot_K|crawlpaper|wapspider|WebBandit\/1\.0|webcatcher|T\-H\-U\-N\-D\-E\-R\-S\-T\-O\-N\-E|WebMoose|webquest|webreaper|webs|webspider|WebWalker|wget|winona|whowhere|wlm|WOLP|WWWC|none|XGET|Nederland\.zoek/i', $_SERVER['HTTP_USER_AGENT']))
		{
			// This is a bot and we have to retrieve its connection ID
			$sql = 'SELECT `id_connections` FROM `'._DB_PREFIX_.'connections`
					WHERE ip_address = '.ip2long(Tools::getRemoteAddr()).'
						AND `date_add` > \''.pSQL(date('Y-m-d H:i:00'), time() - 1800).'\'
						'.Shop::addSqlRestriction(Shop::SHARE_CUSTOMER).'
					ORDER BY `date_add` DESC';
			if ($id_connections = Db::getInstance()->getValue($sql))
			{
				$cookie->id_connections = (int)$id_connections;
				return Page::getCurrentId();
			}
		}

		// A new connection is created if the guest made no actions during 30 minutes
		$sql = 'SELECT `id_guest`
				FROM `'._DB_PREFIX_.'connections`
				WHERE `id_guest` = '.(int)$cookie->id_guest.'
					AND `date_add` > \''.pSQL(date('Y-m-d H:i:00', time() - 1800)).'\'
					'.Shop::addSqlRestriction(Shop::SHARE_CUSTOMER).'
				ORDER BY `date_add` DESC';
		$result = Db::getInstance()->getRow($sql);
		if (!$result['id_guest'] && (int)$cookie->id_guest)
		{
			// The old connections details are removed from the database in order to spare some memory
			Connection::cleanConnectionsPages();

			$referer = isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '';
			$array_url = parse_url($referer);
			if (!isset($array_url['host']) || preg_replace('/^www./', '', $array_url['host']) == preg_replace('/^www./', '', Tools::getHttpHost(false, false)))
				$referer = '';
			$connection = new Connection();
			$connection->id_guest = (int)$cookie->id_guest;
			$connection->id_page = Page::getCurrentId();
			$connection->ip_address = Tools::getRemoteAddr() ? ip2long(Tools::getRemoteAddr()) : '';
			$connection->id_shop = Context::getContext()->shop->id;
			$connection->id_shop_group = Context::getContext()->shop->id_shop_group;
			$connection->date_add = $cookie->date_add;
			if (Validate::isAbsoluteUrl($referer))
				$connection->http_referer = substr($referer, 0, 254);
			$connection->add();
			$cookie->id_connections = $connection->id;
			return $connection->id_page;
		}
	}

	public static function setPageTime($id_connections, $id_page, $time_start, $time)
	{
		if (!Validate::isUnsignedId($id_connections)
			|| !Validate::isUnsignedId($id_page)
			|| !Validate::isDate($time_start))
			return;

		// Limited to 5 minutes because more than 5 minutes is considered as an error
		if ($time > 300000)
			$time = 300000;
		Db::getInstance()->execute('
		UPDATE `'._DB_PREFIX_.'connections_page`
		SET `time_end` = `time_start` + INTERVAL '.(int)($time / 1000).' SECOND
		WHERE `id_connections` = '.(int)$id_connections.'
		AND `id_page` = '.(int)$id_page.'
		AND `time_start` = \''.pSQL($time_start).'\'');
	}

	public static function cleanConnectionsPages()
	{
		$period = Configuration::get('PS_STATS_OLD_CONNECT_AUTO_CLEAN');

		if ($period === 'week')
			$interval = '1 WEEK';
		else if ($period === 'month')
			$interval = '1 MONTH';
		else if ($period === 'year')
			$interval = '1 YEAR';
		else
			return;

		if ($interval != null)
		{
			// Records of connections details older than the beginning of the  specified interval are deleted
			Db::getInstance()->execute('
			DELETE FROM `'._DB_PREFIX_.'connections_page`
			WHERE time_start < LAST_DAY(DATE_SUB(NOW(), INTERVAL '.$interval.'))');
		}
	}
}