static function utfEncodeProperty($string, $event)
{
return owa_lib::utf8Encode(trim($string));
}
/**
* Must be called before all other event property setting functions
*/
function pre()
{
// ENVIRONMENTAL PARAMS
// check for no value
// clean
// apply default if necessary
// filter
// these should really be pulled from the service layer
$this->event->set('timestamp', owa_coreAPI::getRequestTimestamp());
$this->event->set('microtime', microtime());
//set user agent
if (!$this->event->get('HTTP_USER_AGENT')) {
$this->event->set('HTTP_USER_AGENT', owa_coreAPI::getServerParam('HTTP_USER_AGENT'));
}
// filter user agent
$this->event->set('HTTP_USER_AGENT', $this->eq->filter('user_agent', $this->event->get('HTTP_USER_AGENT')));
// set http_host
if (!$this->event->get('HTTP_HOST')) {
$this->event->set('HTTP_HOST', owa_coreAPI::getServerParam('HTTP_HOST'));
}
//filter http_host
$this->event->set('HTTP_HOST', $this->eq->filter('HTTP_HOST', $this->event->get('HTTP_HOST')));
// set language
if (!$this->event->get('language')) {
$this->event->set('language', substr(owa_coreAPI::getServerParam('HTTP_ACCEPT_LANGUAGE'), 0, 5));
}
// filter language
$this->event->set('language', $this->eq->filter('language', $this->event->get('language')));
// Set Ip Address
if (!$this->event->get('ip_address')) {
$this->event->set('ip_address', owa_coreAPI::getServerParam('REMOTE_ADDR'));
}
$this->event->set('ip_address', $this->eq->filter('ip_address', $this->event->get('ip_address')));
// Set host related properties
if (!$this->event->get('REMOTE_HOST')) {
$this->event->set('REMOTE_HOST', owa_coreAPI::getServerParam('REMOTE_HOST'));
}
//$teh = owa_trackingEventHelpers::getInstance();
//$teh->setEnvironmentals( $this->event );
/// REQUIRED PARAMS
// check for value
// clean based on type
// filter
// apply default value if necessary
// set page type
// moved
if (!$this->event->get('page_type')) {
$this->event->set('page_type', '(not set)');
}
//filter page type
//moved
$this->event->set('page_type', $this->eq->filter('page_type', $this->event->get('page_type')));
// filter page_url
//moved
$this->event->set('page_url', $this->eq->filter('page_url', $this->event->get('page_url'), $this->event->get('site_id')));
// Page title
// moved
if ($this->event->get('page_title')) {
$page_title = owa_lib::utf8Encode(trim($this->event->get('page_title')));
} else {
$page_title = '(not set)';
}
$this->event->set('page_title', $this->eq->filter('page_title', $page_title));
// needs key translation
// translated,
$this->event->set('days_since_first_session', $this->event->get('dsfs'));
$this->event->set('days_since_prior_session', $this->event->get('dsps'));
$this->event->set('num_prior_sessions', $this->event->get('nps'));
// OPTIONAL PARAMS
// filter http referer
/* moved */
if ($this->event->get('HTTP_REFERER')) {
$this->event->set('HTTP_REFERER', $this->eq->filter('HTTP_REFERER', $this->event->get('HTTP_REFERER')));
}
// Filter the target url of clicks
/* moved */
if ($this->event->get('target_url')) {
$this->event->set('target_url', $this->eq->filter('target_url', $this->event->get('target_url'), $this->event->get('site_id')));
}
/* moved */
if ($this->event->get('source')) {
$this->event->set('source', $this->eq->filter('source', trim(strtolower($this->event->get('source')))));
}
/* moved */
if ($this->event->get('medium')) {
$this->event->set('medium', $this->eq->filter('medium', trim(strtolower($this->event->get('medium')))));
}
// set session referer (the site that originally referer the visit)
/* moved */
if ($this->event->get('session_referer')) {
$this->event->set('session_referer', $this->eq->filter('session_referer', $this->event->get('session_referer')));
}
$this->setCustomVariables();
// DEPENDANT SETS
// evaluate
// produce value
// filter
// add default if required
// Set all time related properties
// depends on 'timestamp'
/* moved */
$this->setTimeProperties($this->event);
/* moved */
// set repeat visitor type flag visitor is not new.
if (!$this->event->get('is_new_visitor')) {
$this->event->set('is_repeat_visitor', true);
} else {
// properly cast this to a bool.
$this->event->set('is_new_visitor', true);
}
/* moved */
if (!$this->event->get('page_uri')) {
$page_uri = $this->derivePageUri($this->event->get('page_url'));
}
$this->event->set('page_uri', $this->eq->filter('page_uri', $page_uri));
// host properties
/* mooved */
$this->event->set('full_host', $this->eq->filter('full_host', $this->event->get('REMOTE_HOST'), $this->event->get('ip_address')));
// required
if (!$this->event->get('full_host')) {
$this->event->set('full_host', '(not set)');
}
/* moved */
$this->event->set('host', $this->eq->filter('host', $this->event->get('full_host'), $this->event->get('ip_address')));
//required
if (!$this->event->get('host')) {
$this->event->set('host', '(not set)');
}
// Browser related properties
// required
$service = owa_coreAPI::serviceSingleton();
$bcap = $service->getBrowscap();
// Assume browser untill told otherwise
/* moved */
$this->event->set('is_browser', true);
/* moved */
$this->event->set('browser_type', $this->eq->filter('browser_type', $bcap->getUaFamily()));
/* moved */
if ($bcap->getUaVersion()) {
$this->event->set('browser', $this->eq->filter('browser', $bcap->getUaVersion()));
} else {
$this->event->set('browser', $this->eq->filter('browser', '(unknown)'));
}
//Check for what kind of page request this is
/* moved */
if ($bcap->isRobot()) {
$this->event->set('is_robot', true);
$this->event->set('is_browser', false);
}
/* moved */
$this->event->set('os', $this->eq->filter('operating_system', $bcap->getOsFamily(), $this->event->get('HTTP_USER_AGENT')));
/*moved */
if ($this->event->get('is_new_session')) {
//mark entry page flag on current request
$this->event->set('is_entry_page', true);
}
/* moved */
$this->setGeolocation();
// set prior page properties
/* moved */
if ($this->event->get('HTTP_REFERER')) {
$referer_parse = owa_lib::parse_url($this->event->get('HTTP_REFERER'));
if ($referer_parse['host'] === $page_parse['host']) {
$this->event->set('prior_page', $this->eq->filter('prior_page', $this->event->get('HTTP_REFERER'), $this->event->get('site_id')));
}
}
// set search terms
/* moved */
$search_terms = $this->event->get('search_terms');
if ($search_terms && $search_terms != '(not set)') {
$this->event->set('search_terms', $this->eq->filter('search_terms', trim(strtolower($this->event->get('search_terms')))));
}
// ID GENERATION
//set user agent id
/* moved */
$this->event->set('ua_id', owa_lib::setStringGuid($this->event->get('HTTP_USER_AGENT')));
// set document/page id
/* moved */
if ($this->event->get('page_url')) {
$this->event->set('document_id', owa_lib::setStringGuid($this->event->get('page_url')));
}
// Generate host_id
/* moved */
$this->event->set('host_id', owa_lib::setStringGuid($this->event->get('host')));
// generate os_id
/* moved */
$this->event->set('os_id', owa_lib::setStringGuid($this->event->get('os')));
/* moved */
if ($this->event->get('campaign')) {
$this->event->set('campaign_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('campaign')))));
}
/* moved */
if ($this->event->get('ad')) {
$this->event->set('ad_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('ad')))));
}
/* moved */
if ($this->event->get('source')) {
$this->event->set('source_id', owa_lib::setStringGuid($this->event->get('source')));
}
// set session referer (the site that originally referer the visit)
/* moved */
if ($this->event->get('session_referer')) {
// generate referer_id for downstream handlers
$this->event->set('referer_id', owa_lib::setStringGuid($this->event->get('session_referer')));
}
/* moved */
if ($this->event->get('search_terms')) {
$this->event->set('referring_search_term_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('search_terms')))));
}
// SHOULD BE A FILTER
// record and filter personally identifiable info (PII)
if (owa_coreAPI::getSetting('base', 'log_visitor_pii')) {
// set user name if one does not already exist on event
/* moved */
if (!$this->event->get('user_name') && owa_coreAPI::getSetting('base', 'log_owa_user_names')) {
$cu = owa_coreAPI::getCurrentUser();
$this->event->set('user_name', $cu->user->get('user_id'));
}
$this->event->set('user_name', $this->eq->filter('user_name', $this->event->get('user_name')));
// set email_address if one does not already exist on event
/* moved */
if (!$this->event->get('email_address')) {
$cu = owa_coreAPI::getCurrentUser();
$this->event->set('email_address', $cu->user->get('email_address'));
}
$this->event->set('user_email', $this->eq->filter('user_email', $this->event->get('email_address')));
}
// anonymize Ip address
if (owa_coreAPI::getSetting('base', 'anonymize_ips')) {
$this->event->set('ip_address', $this->anonymizeIpAddress($this->event->get('ip_address')));
$this->event->set('full_host', '(not set)');
}
}
/**
* Notify Event Handler
*
* @param unknown_type $event
* @access public
*/
function notify($event)
{
$medium = $event->get('medium');
// if there is no session referer then return
if (!$event->get('session_referer')) {
return OWA_EHS_EVENT_HANDLED;
}
// Make entity
$r = owa_coreAPI::entityFactory('base.referer');
$r->load($event->get('referer_id'));
if (!$r->wasPersisted()) {
// Set id
if ($event->get('referer_id')) {
$r->set('id', $event->get('referer_id'));
} else {
$r->set('id', $r->generateId($event->get('session_referer')));
}
// set referer url
$r->set('url', $event->get('session_referer'));
// Set site
$url = owa_lib::parse_url($event->get('session_referer'));
$r->set('site', $url['host']);
if ($medium === 'organic-search') {
$r->set('is_searchengine', true);
}
// set title. this will be updated later by the crawler.
$r->set('page_title', '(not set)');
// Crawl and analyze refering page
if (owa_coreAPI::getSetting('base', 'fetch_refering_page_info') && $medium != 'organic-search') {
//owa_coreAPI::debug('hello from logReferer');
$crawler = new owa_http();
//$crawler->fetch($this->params['HTTP_REFERER']);
$res = $crawler->getRequest($event->get('session_referer'));
owa_coreAPI::debug('http request response: ' . print_r($res, true));
//Extract Title
$title = trim($crawler->extract_title());
if ($title) {
$r->set('page_title', owa_lib::utf8Encode($title));
}
$se = $r->get('is_searchengine');
//Extract anchortext and page snippet but not if it's a search engine...
if ($se != true) {
$snippet = $crawler->extract_anchor_snippet($event->get('inbound_page_url'));
if ($snippet) {
if (function_exists('iconv')) {
$snippet = iconv('UTF-8', 'UTF-8//TRANSLIT', $snippet);
}
$r->set('snippet', $snippet);
}
$anchortext = $crawler->anchor_info['anchor_text'];
if ($anchortext) {
$r->set('refering_anchortext', owa_lib::utf8Encode($anchortext));
}
}
}
// Persist to database
$ret = $r->create();
if ($ret) {
return OWA_EHS_EVENT_HANDLED;
} else {
return OWA_EHS_EVENT_FAILED;
}
} else {
owa_coreAPI::debug('Not Persisting. Referrer already exists.');
return OWA_EHS_EVENT_HANDLED;
}
}
/**
* Must be called before all other event property setting functions
*/
function pre()
{
// Set all time related properties
$this->event->setTime();
// set repeat visitor type flag visitor is not new.
if (!$this->event->get('is_new_visitor')) {
$this->event->set('is_repeat_visitor', true);
} else {
// properly cast this to a bool.
$this->event->set('is_new_visitor', true);
}
//set user agent
if (!$this->event->get('HTTP_USER_AGENT')) {
$this->event->set('HTTP_USER_AGENT', owa_coreAPI::getServerParam('HTTP_USER_AGENT'));
}
$this->event->set('HTTP_USER_AGENT', $this->eq->filter('user_agent', $this->event->get('HTTP_USER_AGENT')));
//set user agent id
$this->event->set('ua_id', owa_lib::setStringGuid($this->event->get('HTTP_USER_AGENT')));
// filter http referer
if ($this->event->get('HTTP_REFERER')) {
$this->event->set('HTTP_REFERER', $this->eq->filter('HTTP_REFERER', $this->event->get('HTTP_REFERER')));
}
// set http_host
if (!$this->event->get('HTTP_HOST')) {
$this->event->set('HTTP_HOST', owa_coreAPI::getServerParam('HTTP_HOST'));
}
//filter http_host
$this->event->set('HTTP_HOST', $this->eq->filter('HTTP_HOST', $this->event->get('HTTP_HOST')));
// set language
if (!$this->event->get('language')) {
$this->event->set('language', substr(owa_coreAPI::getServerParam('HTTP_ACCEPT_LANGUAGE'), 0, 5));
}
// filter language
$this->event->set('language', $this->eq->filter('language', $this->event->get('language')));
// set page type to unknown if not already set by caller
if (!$this->event->get('page_type')) {
$this->event->set('page_type', '(not set)');
}
//filter page_type
$this->event->set('page_type', $this->eq->filter('page_type', $this->event->get('page_type')));
// Set the page url or else construct it from environmental vars
if (!$this->event->get('page_url')) {
$this->event->set('page_url', owa_lib::get_current_url());
}
// filter page_url
$this->event->set('page_url', $this->eq->filter('page_url', $this->event->get('page_url'), $this->event->get('site_id')));
// set document/page id
$this->event->set('document_id', owa_lib::setStringGuid($this->event->get('page_url')));
// needed?
$this->event->set('inbound_page_url', $this->event->get('page_url'));
// Page title
if ($this->event->get('page_title')) {
$page_title = owa_lib::utf8Encode(trim($this->event->get('page_title')));
} else {
$page_title = '(not set)';
}
$this->event->set('page_title', $this->eq->filter('page_title', $page_title));
$page_parse = parse_url($this->event->get('page_url'));
if (!array_key_exists('path', $page_parse) || empty($page_parse['path'])) {
$page_parse['path'] = '/';
}
if (!$this->event->get('page_uri')) {
if (array_key_exists('query', $page_parse) || !empty($page_parse['query'])) {
$this->event->set('page_uri', $this->eq->filter('page_uri', sprintf('%s?%s', $page_parse['path'], $page_parse['query'])));
} else {
$this->event->set('page_uri', $this->eq->filter('page_uri', $page_parse['path']));
}
}
// set session referer (the site that originally referer the visit)
if ($this->event->get('session_referer')) {
//filter session_referer
$this->event->set('session_referer', $this->eq->filter('session_referer', $this->event->get('session_referer')));
// generate referer_id for downstream handlers
$this->event->set('referer_id', owa_lib::setStringGuid($this->event->get('session_referer')));
}
// set prior page properties
if ($this->event->get('HTTP_REFERER')) {
$referer_parse = owa_lib::parse_url($this->event->get('HTTP_REFERER'));
if ($referer_parse['host'] === $page_parse['host']) {
$this->event->set('prior_page', $this->eq->filter('prior_page', $this->event->get('HTTP_REFERER'), $this->event->get('site_id')));
}
}
// set search terms and id
$search_terms = $this->event->get('search_terms');
if ($search_terms && $search_terms != '(not set)') {
$this->event->set('search_terms', $this->eq->filter('search_terms', trim(strtolower($this->event->get('search_terms')))));
$this->event->set('referring_search_term_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('search_terms')))));
}
// Filter the target url of clicks
if ($this->event->get('target_url')) {
$this->event->set('target_url', $this->eq->filter('target_url', $this->event->get('target_url'), $this->event->get('site_id')));
}
// Set Ip Address
if (!$this->event->get('ip_address')) {
$this->event->set('ip_address', owa_coreAPI::getServerParam('REMOTE_ADDR'));
}
$this->event->set('ip_address', $this->eq->filter('ip_address', $this->event->get('ip_address')));
// check to see if IP should be excluded
if ($this->isIpAddressExcluded($this->event->get('ip_address'))) {
$this->event->set('do_not_log', true);
return;
}
// Set host related properties
if (!$this->event->get('REMOTE_HOST')) {
$this->event->set('REMOTE_HOST', owa_coreAPI::getServerParam('REMOTE_HOST'));
}
// host properties
$this->event->set('full_host', $this->eq->filter('full_host', $this->event->get('REMOTE_HOST'), $this->event->get('ip_address')));
if (!$this->event->get('full_host')) {
$this->event->set('full_host', '(not set)');
}
$this->event->set('host', $this->eq->filter('host', $this->event->get('full_host'), $this->event->get('ip_address')));
if (!$this->event->get('host')) {
$this->event->set('host', '(not set)');
}
// Generate host_id
$this->event->set('host_id', owa_lib::setStringGuid($this->event->get('host')));
// Browser related properties
$service = owa_coreAPI::serviceSingleton();
$bcap = $service->getBrowscap();
// Assume browser untill told otherwise
$this->event->set('is_browser', true);
$this->event->set('browser_type', $this->eq->filter('browser_type', $bcap->get('Browser')));
if ($bcap->get('Version')) {
$this->event->set('browser', $this->eq->filter('browser', $bcap->get('Browser') . ' ' . $bcap->get('Version')));
} else {
$this->event->set('browser', $this->eq->filter('browser', $bcap->get('Browser')));
}
// Set Operating System
$this->event->set('os', $this->eq->filter('operating_system', $bcap->get('Platform'), $this->event->get('HTTP_USER_AGENT')));
$this->event->set('os_id', owa_lib::setStringGuid($this->event->get('os')));
//Check for what kind of page request this is
if ($bcap->get('Crawler')) {
$this->event->set('is_robot', true);
$this->event->set('is_browser', false);
}
// feed request properties
$et = $this->event->getEventType();
if ($et === 'base.feed_request') {
// Feed subscription tracking code
if (!$this->event->get('feed_subscription_id')) {
$this->event->set('feed_subscription_id', $this->getParam(owa_coreAPI::getSetting('base', 'feed_subscription_param')));
}
// needed??
$this->event->set('feed_reader_guid', $this->event->setEnvGUID());
// set feedreader flag to true, browser flag to false
$this->event->set('is_feedreader', true);
$this->event->set('is_browser', false);
}
// record and filter personally identifiable info (PII)
if (owa_coreAPI::getSetting('base', 'log_visitor_pii')) {
// set user name if one does not already exist on event
if (!$this->event->get('user_name') && owa_coreAPI::getSetting('base', 'log_owa_user_names')) {
$cu = owa_coreAPI::getCurrentUser();
$this->event->set('user_name', $cu->user->get('user_id'));
}
$this->event->set('user_name', $this->eq->filter('user_name', $this->event->get('user_name')));
// set email_address if one does not already exist on event
if (!$this->event->get('email_address')) {
$cu = owa_coreAPI::getCurrentUser();
$this->event->set('email_address', $cu->user->get('email_address'));
}
$this->event->set('user_email', $this->eq->filter('user_email', $this->event->get('email_address')));
}
$this->event->set('days_since_first_session', $this->event->get('dsfs'));
$this->event->set('days_since_prior_session', $this->event->get('dsps'));
$this->event->set('num_prior_sessions', $this->event->get('nps'));
if ($this->event->get('is_new_session')) {
//mark entry page flag on current request
$this->event->set('is_entry_page', true);
}
if ($this->event->get('medium')) {
$this->event->set('medium', $this->eq->filter('medium', trim(strtolower($this->event->get('medium')))));
}
if ($this->event->get('source')) {
$this->event->set('source', $this->eq->filter('source', trim(strtolower($this->event->get('source')))));
$this->event->set('source_id', owa_lib::setStringGuid($this->event->get('source')));
}
if ($this->event->get('campaign')) {
$this->event->set('campaign_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('campaign')))));
}
if ($this->event->get('ad')) {
$this->event->set('ad_id', owa_lib::setStringGuid(trim(strtolower($this->event->get('ad')))));
}
$this->setCustomVariables();
$this->setGeolocation();
// anonymize Ip address
if (owa_coreAPI::getSetting('base', 'anonymize_ips')) {
$this->event->set('ip_address', $this->anonymizeIpAddress($this->event->get('ip_address')));
$this->event->set('full_host', '(not set)');
}
}
