<?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_DIR.'/owa_lib.php');
require_once(OWA_BASE_DIR.'/owa_controller.php');
require_once(OWA_BASE_DIR.DIRECTORY_SEPARATOR.'ini_db.php');
 
/**
 * Generic Event Processor Controller
 * 
 * @author      Peter Adams <peter@openwebanalytics.com>
 * @copyright   Copyright &copy; 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.0.0
 */
 
class owa_processEventController extends owa_controller {
        
        var $event;
        var $eq;
        
        function __construct($params) {
        
                if (array_key_exists('event', $params) && !empty($params['event'])) {
                        
                        $this->event = $params['event'];
                                
                } else {
                        owa_coreAPI::debug("No event object was passed to controller.");
                        $this->event = owa_coreAPI::supportClassFactory('base', 'event');
                }
                                
                $this->eq = owa_coreAPI::getEventDispatch();
                
                return parent::__construct($params);
        
        }
        
        /**
         * Main Control Logic
         *
         * @return unknown
         */
        function action() {
                        
                return;
                
        }
        
        /**
         * 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' ) ) );
                
                // set referer
                // needed in case javascript logger sets the referer variable but is blank
                if ($this->event->get('referer')) {
                        //TODO: STANDARDIZE NAME to avoid doing this map
                        $referer = $this->event->get('referer');
                } else {
                        owa_coreAPI::debug('ref: '.owa_coreAPI::getServerParam('HTTP_REFERER'));
                        $referer = owa_coreAPI::getServerParam('HTTP_REFERER');
                }
                
                $this->event->set('HTTP_REFERER', $this->eq->filter('http_referer', $referer));
                
                // set host
                if (!$this->event->get('HTTP_HOST')) {
                        $this->event->set('HTTP_HOST', owa_coreAPI::getServerParam('HTTP_HOST'));
                }
                
                // set language
                if (!$this->event->get( 'language' ) ) {
                        $this->event->set( 'language', $this->eq->filter('language', substr(owa_coreAPI::getServerParam( 'HTTP_ACCEPT_LANGUAGE' ),0,5 ) ) );
                }
                
                $this->event->set('HTTP_HOST', $this->eq->filter('http_host', $this->event->get('HTTP_HOST')));
                
                // set page type to unknown if not already set by caller
                if (!$this->event->get('page_type')) {
                        $this->event->set('page_type', '(not set)');
                } 
                
                $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());
                }
                
                $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 internal referer
                if ($this->event->get('HTTP_REFERER')) {
 
                        $referer_parse = 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' ) ) );  
                        } else {
                                
                                $this->event->set('external_referer', true);
                                $this->event->set('referer_id', owa_lib::setStringGuid($this->event->get('HTTP_REFERER' ) ) );
                        
                                if ( ! $this->event->get( 'search_terms' ) ) {
                                        // set query terms
                                        $qt = $this->extractSearchTerms($this->event->get('HTTP_REFERER'));
                                        
                                        if ($qt) {
                                                $this->event->set('search_terms', trim( strtolower( $qt ) ) );  
                                        }
                                }                               
                        }
                }
                
                // set referring search term id         
                if ($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')));
                
                // 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' ) ) );
                                
                $this->event->set( 'host', $this->eq->filter( 'host', $this->event->get( 'full_host' ), $this->event->get( 'ip_address' ) ) );
                // Generate host_id
                $this->event->set( 'host_id',  owa_lib::setStringGuid( $this->event->get( 'full_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') . ' ' .