| <?php | |
| // | |
| // Open Web Analytics - An Open Source Web Analytics Framework | |
| // | |
| // Copyright 2006 Peter Adams. All rights reserved. | |
| // | |
| // Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html | |
| // | |
| // Unless required by applicable law or agreed to in writing, software | |
| // distributed under the License is distributed on an "AS IS" BASIS, | |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| // See the License for the specific language governing permissions and | |
| // limitations under the License. | |
| // | |
| // $Id$ | |
| // | |
| require_once( OWA_BASE_CLASSES_DIR . 'owa_caller.php' ); | |
| /** | |
| * OWA Client Class | |
| * | |
| * Abstract Client Class for use in php based applications | |
| * | |
| * @author Peter Adams <peter@openwebanalytics.com> | |
| * @copyright Copyright © 2006 Peter Adams <peter@openwebanalytics.com> | |
| * @license http://www.gnu.org/copyleft/gpl.html GPL v2.0 | |
| * @category owa | |
| * @package owa | |
| * @version $Revision$ | |
| * @since owa 1.4.0 | |
| */ | |
| class owa_client extends owa_caller { | |
| var $commerce_event; | |
| var $pageview_event; | |
| var $global_event_properties = array(); | |
| var $stateInit; | |
| // set one traffic has been attributed. | |
| var $isTrafficAttributed; | |
| public function __construct($config = null) { | |
| $this->pageview_event = $this->makeEvent(); | |
| $this->pageview_event->setEventType('base.page_request'); | |
| return parent::__construct($config); | |
| } | |
| public function setPageTitle($value) { | |
| $this->pageview_event->set('page_title', $value); | |
| } | |
| public function setPageType($value) { | |
| $this->pageview_event->set('page_type', $value); | |
| } | |
| public function setProperty($name, $value) { | |
| $this->setGlobalEventProperty($name, $value); | |
| } | |
| private function setGlobalEventProperty($name, $value) { | |
| $this->global_event_properties[$name] = $value; | |
| } | |
| private function getGlobalEventProperty($name) { | |
| if ( array_key_exists($name, $this->global_event_properties) ) { | |
| return $this->global_event_properties[$name]; | |
| } | |
| } | |
| private function manageState( &$event ) { | |
| if ( ! $this->stateInit ) { | |
| $this->setVisitorId( $event ); | |
| $this->setFirstSessionTimestamp( $event ); | |
| $this->setLastRequestTime( $event ); | |
| $this->setSessionId( $event ); | |
| $this->setNumberPriorSessions( $event ); | |
| $this->setTrafficAttribution( $event ); | |
| // clear old style session cookie | |
| $session_store_name = sprintf('%s_%s', owa_coreAPI::getSetting('base', 'site_session_param'), $this->site_id); | |
| owa_coreAPI::clearState( $session_store_name ); | |
| $this->stateInit = true; | |
| } | |
| } | |
| private function setVisitorId( &$event ) { | |
| $visitor_id = owa_coreAPI::getStateParam( 'v', 'vid' ); | |
| if ( ! $visitor_id ) { | |
| $visitor_id = owa_coreAPI::getStateParam( 'v' ); | |
| owa_coreAPI::clearState( 'v' ); | |
| owa_coreAPI::setState( 'v', 'vid', $visitor_id, 'cookie', true ); | |
| } | |
| if ( ! $visitor_id ) { | |
| $visitor_id = $event->getSiteSpecificGuid( $this->site_id ); | |
| $this->setGlobalEventProperty( 'is_new_visitor', true ); | |
| owa_coreAPI::setState( 'v', 'vid', $visitor_id, 'cookie', true ); | |
| } | |
| // set property on event object | |
| $this->setGlobalEventProperty( 'visitor_id', $visitor_id ); | |
| } | |
| private function setNumberPriorSessions( &$event ) { | |
| // if check for nps value in vistor cookie. | |
| $nps = owa_coreAPI::getStateParam('v', 'nps'); | |
| // set value to 0 if not found. | |
| if (!$nps) { | |
| $nps = 0; | |
| } | |
| // if new session, increment visit count and persist to state store | |
| if ( $this->getGlobalEventProperty('is_new_session' ) ) { | |
| owa_coreAPI::setState('v', 'nps', $nps + 1, 'cookie', true); | |
| } | |
| // set property on the event object | |
| $this->setGlobalEventProperty('num_prior_sessions', $nps); | |
| } | |
| private function setFirstSessionTimestamp( &$event ) { | |
| $fsts = owa_coreAPI::getStateParam( 'v', 'fsts' ); | |
| if ( ! $fsts ) { | |
| $fsts = $event->get('timestamp'); | |
| owa_coreAPI::setState(owa_coreAPI::getSetting('base', 'visitor_param'), 'fsts', $fsts , 'cookie', true); | |
| } | |
| $this->setGlobalEventProperty( 'fsts', $fsts ); | |
| } | |
| private function setSessionId( &$event ) { | |
| $is_new_session = $this->isNewSession( $event->get( 'timestamp' ), $this->getGlobalEventProperty( 'last_req' ) ); | |
| if ( $is_new_session ) { | |
| //set prior_session_id | |
| $prior_session_id = owa_coreAPI::getStateParam('s', 'sid'); | |
| if ( ! $prior_session_id ) { | |
| $state_store_name = sprintf('%s_%s', owa_coreAPI::getSetting('base', 'site_session_param'), $this->site_id); | |
| $prior_session_id = owa_coreAPI::getStateParam($state_store_name, 's'); | |
| } | |
| if ($prior_session_id) { | |
| $this->setGlobalEventProperty( 'prior_session_id', $prior_session_id ); | |
| } | |
| $session_id = $event->getSiteSpecificGuid( $this->site_id ); | |
| // it's a new session. generate new session ID | |
| $this->setGlobalEventProperty( 'session_id', $session_id ); | |
| //mark new session flag on current request | |
| $this->setGlobalEventProperty( 'is_new_session', true ); | |
| owa_coreAPI::setState( 's', 'sid', $session_id, 'cookie', true ); | |
| } else { | |
| // Must be an active session so just pull the session id from the state store | |
| $session_id = owa_coreAPI::getStateParam('s', 'sid'); | |
| // support for old style cookie | |
| if ( ! $session_id ) { | |
| $state_store_name = sprintf('%s_%s', owa_coreAPI::getSetting('base', 'site_session_param'), $this->site_id); | |
| $session_id = owa_coreAPI::getStateParam($state_store_name, 's'); | |
| owa_coreAPI::setState( 's', 'sid', $session_id, 'cookie', true ); | |
| } | |
| $this->setGlobalEventProperty('session_id', $session_id); | |
| } | |
| // fail-safe just in case there is no session_id | |
| if ( ! $this->getGlobalEventProperty( 'session_id' ) ) { | |
| $session_id = $event->getSiteSpecificGuid( $this->site_id ); | |
| $this->setGlobalEventProperty( 'session_id', $session_id ); | |
| //mark new session flag on current request | |
| $this->setGlobalEventProperty( 'is_new_session', true ); | |
| owa_coreAPI::debug('hello from failsafe'); | |
| owa_coreAPI::setState( 's', 'sid', $session_id, 'cookie', true ); | |
| } | |
| } | |
| private function setLastRequestTime( &$event ) { | |
| $last_req = owa_coreAPI::getStateParam('s', 'last_req'); | |
| // suppport for old style cookie | |
| if ( ! $last_req ) { | |
| $state_store_name = sprintf( '%s_%s', owa_coreAPI::getSetting( 'base', 'site_session_param' ), $this->site_id ); | |
| $last_req = owa_coreAPI::getStateParam( $state_store_name, 'last_req' ); | |
| } | |
| // set property on event object | |
| $this->setGlobalEventProperty( 'last_req', $last_req ); | |
| // store new state value | |
| owa_coreAPI::setState( 's', 'last_req', $event->get( 'timestamp' ), 'cookie', true ); | |
| } | |
| /** | |
| * Check to see if request is a new or active session | |
| * | |
| * @return boolean | |
| */ | |
| private function isNewSession($timestamp = '', $last_req = 0) { | |
| $is_new_session = false; | |
| if ( ! $timestamp ) { | |
| $timestamp = time(); | |
| } | |
| $time_since_lastreq = $timestamp - $last_req; | |
| $len = owa_coreAPI::getSetting( 'base', 'session_length' ); | |
| if ( $time_since_lastreq < $len ) { | |
| owa_coreAPI::debug("This request is part of a active session."); | |
| return false; | |
| } else { | |
| //NEW SESSION. prev session expired, because no requests since some time. | |
| owa_coreAPI::debug("This request is the start of a new session. Prior session expired."); | |
| return true; | |
| } | |
| } | |
| /** | |
| * Logs tracking event from url params taken from request scope. | |
| * Takes event type from url. | |
| * | |
| * @return unknown | |
| */ | |
| function logEventFromUrl($manage_state = false) { | |
| // keeps php executing even if the client closes the connection | |
| ignore_user_abort(true); | |
| $service = &owa_coreAPI::serviceSingleton(); | |
| $service->request->decodeRequestParams(); | |
| $event = owa_coreAPI::supportClassFactory('base', 'event'); | |
| $event->setEventType(owa_coreAPI::getRequestParam('event_type')); | |
| $event->setProperties($service->request->getAllOwaParams()); | |
| // check for third party cookie mode. | |
| $mode = owa_coreAPI::getRequestParam('thirdParty'); | |
| if ( $mode ) { | |
| return $this->trackEvent($event); | |
| } else { | |
| return owa_coreAPI::logEvent($event->getEventType(), $event); | |
| } | |
| } | |
| /** | |
| * Logs tracking event | |
| * | |
| * This function fires a tracking event that will be processed and then dispatched | |
| * | |
| * @param object $event | |
| * @return boolean | |
| */ | |
| public function trackEvent($event) { | |
| // do not track anything if user is in overlay mode | |
| if (owa_coreAPI::getStateParam('overlay')) { | |
| return false; | |
| } | |
| // needed by helper page tags function so it can append to first hit tag url | |
| if (!$this->getSiteId()) { | |
| $this->setSiteId($event->get('site_id')); | |
| } | |
| if (!$this->getSiteId()) { | |
| $this->setSiteId(owa_coreAPI::getRequestParam('site_id')); | |
| } | |
| // set various state properties. | |
| $this->manageState( $event ); | |
| $event = $this->setAllGlobalEventProperties( $event ); | |
| // send event to log API for processing. | |
| return owa_coreAPI::logEvent($event->getEventType(), $event); | |
| } | |
| public function setAllGlobalEventProperties( $event ) { | |
| if ( ! $event->get('site_id') ) { | |
| $event->set( 'site_id', $this->getSiteId() ); | |
| } | |
| // merge global event properties | |
| foreach ($this->global_event_properties as $k => $v) { | |
| $event->set($k, $v); | |
| } | |
| return $event; | |
| } | |
| public function getAllEventProperties( $event ) { | |
| $event = $this->setAllGlobalEventProperties( $event ); | |
| return $event->getProperties(); | |
| } | |
| public function trackPageview($event = '') { | |
| if ($event) { | |
| $event->setEventType('base.page_request'); | |
| $this->pageview_event = $event; | |
| } | |
| return $this->trackEvent($this->pageview_event); | |
| } | |
| public function trackAction($action_group = '', $action_name, $action_label = '', $numeric_value = 0) { | |
| $event = $this->makeEvent(); | |
| $event->setEventType('track.action'); | |
| $event->set('action_group', $action_group); | |
| $event->set('action_name', $action_name); | |
| $event->set('action_label', $action_label); | |
| $event->set('numeric_value', $numeric_value); | |
| $event->set('site_id', $this->getSiteId()); | |
| return $this->trackEvent($event); | |
| } | |
| /** | |
| * Creates a ecommerce Transaction event | |
| * | |
| * Creates a parent commerce.transaction event | |
| */ | |
| public function addTransaction( | |
| $order_id, | |
| $order_source = '', | |
| $total = 0, | |
| $tax = 0, | |
| $shipping = 0, | |
| $gateway = '', | |
| $country = '', | |
| $state = '', | |
| $city = '', | |
| $page_url = '', | |
| $session_id = '' | |
| ) { | |
| $this->commerce_event = $this->makeEvent(); | |
| $this->commerce_event->setEventType( 'ecommerce.transaction' ); | |
| $this->commerce_event->set( 'ct_order_id', $order_id ); | |
| $this->commerce_event->set( 'ct_order_source', $order_source ); | |
| $this->commerce_event->set( 'ct_total', $total ); | |
| $this->commerce_event->set( 'ct_tax', $tax ); | |
| $this->commerce_event->set( 'ct_shipping', $shipping ); | |
| $this->commerce_event->set( 'ct_gateway', $gateway ); | |
| $this->commerce_event->set( 'page_url', $page_url ); | |
| $this->commerce_event->set( 'ct_line_items', array() ); | |
| $this->commerce_event->set( 'country', $page_url ); | |
| $this->commerce_event->set( 'state', $page_url ); | |
| $this->commerce_event->set( 'city', $page_url ); | |
| if ( $session_id ) { | |
| $this->commerce_event->set( 'original_session_id', $session_id ); | |
| // tells the client to NOT manage state properties as we are | |
| // going to look them up from the session later. | |
| $this->commerce_event->set( 'is_state_set', true ); | |
| } | |
| } | |
| /** | |
| * Adds a line item to a commerce transaction | |