<?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$
//

include_once('owa_env.php');
require_once(OWA_BASE_DIR.'/owa_base.php');
require_once(OWA_BASE_DIR.'/owa_requestContainer.php');
require_once(OWA_BASE_DIR.'/owa_auth.php');
require_once(OWA_BASE_DIR.'/owa_coreAPI.php');

/**
 * Abstract Caller class used to build application specific invocation classes
 * 
 * @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_caller extends owa_base {
	
	/**
	 * Request Params from get or post
	 *
	 * @var array
	 */
	var $params;
		
	var $start_time;
	
	var $end_time;
	
	var $update_required;
	
	var $service;
	
	var $site_id;
	
	var $commerce_event;
	
	var $pageview_event;
		
	/**
	 * Constructor
	 *
	 * @param array $config
	 * @return owa_caller
	 */
	function __construct($config = array()) {
		
		if (empty($config)) {
			$config = array();
		}
		
		// Start time
		$this->start_time = owa_lib::microtime_float();
		
		/* SETUP CONFIGURATION AND ERROR LOGGER */
		
		// Parent Constructor. Sets default config entity and error logger
		parent::__construct();
		
		// Log version debug
		$this->e->debug(sprintf('*** Starting Open Web Analytics v%s. Running under PHP v%s (%s) ***', OWA_VERSION, PHP_VERSION, PHP_OS));
		owa_coreAPI::debug('Request URL: '.$_SERVER['REQUEST_URI']);
		owa_coreAPI::debug('User Agent: '.$_SERVER['HTTP_USER_AGENT']);
		
		// Backtrace. handy for debugging who called OWA	
		//$bt = debug_backtrace();
		//$this->e->debug($bt[4]); 		
		
		// load config values from DB
		// Applies config from db or cache
		// check here is needed for installs when the configuration table does not exist.
		
		if (!defined('OWA_INSTALLING')) {
			//if ($this->c->get('base', 'do_not_fetch_config_from_db') != true) {
				if ($this->c->isConfigFilePresent())  {
					$this->c->load($this->c->get('base', 'configuration_id'));
				}
			//}
		}
		 	

		/* APPLY CALLER CONFIGURATION OVERRIDES */
		
		// overrides all default and user config values except defined in the config file
		// must come after user overides are applied 
		// This will apply configuration overirdes that are specified by the calling application.
		// This is usually used by plugins to setup integration specific configuration values.
		
		$this->c->applyModuleOverrides('base', $config);
		
		$this->e->debug('Caller configuration overrides applied.');
		
		/* SET ERROR HANDLER */

		// Sets the correct mode of the error logger now that final config values are in place
		// This will flush buffered msgs that were thrown up untill this point
		$this->e->setHandler($this->c->get('base', 'error_handler'));
		
		/* PHP ERROR LOGGING */
		
		if (defined('OWA_LOG_PHP_ERRORS')) {
			$this->e->logPhpErrors();
		}
		
		/* LOAD SERVICE LAYER */
		$this->service = &owa_coreAPI::serviceSingleton();
		// initialize framework
		$this->service->initializeFramework();	
		// notify handlers of 'init' action
		$dispatch = owa_coreAPI::getEventDispatch();
		$dispatch->notify($dispatch->makeEvent('init'));
		
		/* SET SITE ID */
		// needed in standalone installs where site_id is not set in config file.
		if (!empty($this->params['site_id'])) {
			$this->c->set('base', 'site_id', $this->params['site_id']);
		}
		
		// re-fetch the array now that overrides have been applied.
		// needed for backwards compatability 
		$this->config = $this->c->fetch('base');
		
		/* SETUP REQUEST Params */
		//$this->params = &owa_requestContainer::getInstance();
		$this->params = $this->service->request->getAllOwaParams();
		//print_r($this->params);
		
		// check for required schema updates and sets update flag
		// this is needed if the calling application or plugin needs to check for updates
		//if (!empty($this->api->modules_needing_updates)):
		//	$this->service->setUpdateRequired();
		//endif;
		
		return;
	
	}
	
	function handleRequestFromUrl()  {
		
		//$this->params = owa_lib::getRequestParams();
		return $this->handleRequest();
		
	}
	
	/**
	 * Logs a Page Request
	 *
	 * @param array $app_params	This is an array of application specific request params
	 * @depricated
	 */
	function log($caller_params = '') {
		
		return owa_coreAPI::logEvent('base.page_request', $caller_params);
		
	}
	
	/**
	 * Logs an event to the event queue
	 * 
	 * This function sets the action to be perfromed, santizes, 
	 * and adds all of PHP's $_SERVER vars to the $caller_params.
	 * $_REQUEST vars are already added to $this->params in the constructor.
	 *
	 * @param array $caller_params
	 * @param string $event_type
	 * @return boolean
	 * @depricated
	 */
	function logEvent($event_type, $caller_params = '') {
		
		return owa_coreAPI::logEvent($event_type, $caller_params);
		
	}
	
	/**
	 * Fires a tracking event
	 * 
	 * This function fires a tracking event that will be processed and then dispatched
	 *
	 * @param object $event
	 * @return boolean
	 */
	function trackEvent($event) {
	
		// needed by helperpage tags function so it can append to first hit tag url
		//if (!owa_coreAPI::getRequestParam('site_id')) {	
		//	owa_coreAPI::setRequestParam('site_id', $event->get('site_id'));					
		//}
		
		if (!$this->getSiteId()) {
			$this->setSiteId($event->get('site_id'));
		}
		
		if (!$this->getSiteId()) {
			$this->setSiteId(owa_coreAPI::getRequestParam('site_id'));
		}
		
		if ( ! $event->get('site_id') ) {
			$event->set( 'site_id', $this->getSiteId() );
		}
		
		return owa_coreAPI::logEvent($event->getEventType(), $event);
	}
	
	/**
	 * Logs event params taken from request scope (url, cookies, etc.).
	 * Takes event type from url.
	 *
	 * @return unknown
	 */
	function logEventFromUrl() {
		
		// 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());
		//owa_coreAPI::debug("logeventfromurl event".print_r($event, true));
		return $this->trackEvent($event);
		
	}
	
	function placeHelperPageTags($echo = true, $options = array()) {
		
		if(!owa_coreAPI::getRequestParam('is_robot')) {
				
			$params = array();
			$params['do'] = 'base.helperPageTags';
			$params['site_id'] = $this->getSiteId();
			$params['options'] = $options;
			
			if ($echo == false) {
				//return $this->handleHelperPageTagsRequest();
				return $this->handleRequest($params);
			} else {
				echo $this->handleRequest($params);
				return;
			}
		}
	}
	
	function handleHelperPageTagsRequest() {
	
		$params = array();
		$params['do'] = 'base.helperPageTags';
		return $this->handleRequest($params);
	
	}
	
	/**
	 * Handles OWA internal page/action requests
	 *
	 * @return unknown
	 */
	function handleRequest($caller_params = null, $action = '') {
		
		return owa_coreAPI::handleRequest($caller_params, $action);
						
	}
	
	function handleSpecialActionRequest() {
		
		if(isset($_GET['owa_specialAction'])):
			$this->e->debug("special action received");
			echo $this->handleRequestFromUrl();
			$this->e->debug("special action complete");
			exit;
		elseif(isset($_GET['owa_logAction'])):
			$this->e->debug("log action received");
			$this->config['delay_first_hit'] = false;
			$this->c->set('base', 'delay_first_hit', false);
			echo $this->logEventFromUrl();
			exit;
		elseif(isset($_GET['owa_apiAction'])):
			$this->e->debug("api action received");
			define('OWA_API', true);
			// lookup method class
			echo $this->handleRequest('', 'base.apiRequest');
			exit;
		else:
			owa_coreAPI::debug('hello from special action request method in caller. no action to do.');
			return;
		endif;

	}
	
	function __destruct() {
		
		$this->end_time = owa_lib::microtime_float();
		$total_time = $this->end_time - $this->start_time;
		$this->e->debug(sprintf('Total session time: %s',$total_time));
		$this->e->debug("goodbye from OWA");
		owa_coreAPI::profileDisplay();
		
		return;
	}
	
	function createSiteId($value) {
	
		return md5($value);
	}
	
	function setSetting($module, $name, $value) {
		
		return owa_coreAPI::setSetting($module, $name, $value);
	}
	
	function getSetting($module, $name) {
		
		return owa_coreAPI::getSetting($module, $name);
	}
	
	function setCurrentUser($role, $login_name = '') {
		$cu =&owa_coreAPI::getCurrentUser();
		$cu->setRole($role);
		$cu->setAuthStatus(true);
	}
	
	function makeEvent() {
	
		return owa_coreAPI::supportClassFactory('base', 'event');
	}
	
	function trackPageView($event) {
		
		$event->setEventType('base.page_request');
		$this->pageview_event = $event;
		return $this->trackEvent($event);
	}
	
	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 commerce Transaction event
	 *
	 * Creates a parent commerce.transaction event
	 */
	function addTransaction( $order_id, $order_source = '', $total = 0, $tax = 0, $shipping = 0, $gateway = '', $page_url = '' ) {
		
		$this->commerce_event = $this->makeEvent();
		$this->commerce_event->setEventType( 'commerce.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() );
	}
	
	/** 
	 * Adds a line item to a commerce transaction
	 *
	 * Creates and a commerce.line_item event and adds it to the parent transaction event
	 */
	function addTransactionLineItem($order_id, $sku = '', $product_name = '', $category = '', $unit_price = 0, $quantity = 0) {
		
		if ( empty( $this->commerce_event ) ) {
			$this->addTransaction('none set');
		}
		
		$event = $this->makeEvent();
		$event->setEventType( 'commerce.line_item' );
		$event->set( 'li_order_id', $order_id );
		$event->set( 'li_sku', $sku );
		$event->set( 'li_product_name', $product_name );
		$event->set( 'li_category', $category );
		$event->set( 'li_unit_price', $unit_price );
		$event->set( 'li_quantity', $quantity );
		
		$items = $this->commerce_event->get( 'ct_line_items' );
		$items[] = $event;
		$this->commerce_event->set( 'ct_line_items', $items );
	}
	
	/** 
	 * tracks a commerce events
	 *
	 * Tracks a parent transaction event by sending it to the event queue
	 */
	function trackTransaction() {
		
		if ( ! empty( $this->commerce_event ) ) {
			$this->trackEvent( $this->commerce_event );
			$this->commerce_event = '';
		}
	}
	
	function setSiteId($site_id) {
		
		$this->site_id = $site_id;
	}
	
	function getSiteId() {
		
		return $this->site_id;
	}
	
	function setErrorHandler($mode) {
		$this->e->setHandler($mode);
	}
	
	function isOwaInstalled() {
		
		$version = owa_coreAPI::getSetting('base', 'schema_version');
		if ($version > 0) {
			return true;
		} else {
			return false;
		}
	}
	
}

?>