LibertyGeo.php

<?php
/**
 * @version $Header$
 * created 2006/08/01
 * @author Will <will@onnyturf.com>
 *
 * @package geo
 */

/**
 * Initialize
 */
require_once( KERNEL_PKG_PATH.'BitBase.php' );

/**
 * @package geo
 */
class LibertyGeo extends LibertyBase {
	var $mContentId;

	function LibertyGeo( $pContentId=NULL ) {
		parent::__construct();
		$this->mContentId = $pContentId;
	}

	/**
	 * Load the data from the database
	 * @param pParamHash be sure to pass by reference in case we need to make modifcations to the hash
	 **/
	function load() {
		if( $this->isValid() ) {
			$query = "SELECT * FROM `".BIT_DB_PREFIX."geo` WHERE `content_id`=?";
			$this->mInfo = $this->mDb->getRow( $query, array( $this->mContentId ) );
		}
		return( count( $this->mInfo ) );
	}

	/**
	 * @param array pParams hash of values that will be used to store the page
	 * @return bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
	 * @access public
	 **/
	function store( &$pParamHash ) {
		if( $this->verify( $pParamHash ) ) {
			if (!empty($pParamHash['geo_store'])) {
				$pParamHash['geo_store']['content_id'] = $this->mContentId;
				$table = BIT_DB_PREFIX."geo";
				$this->mDb->StartTrans();
				if( !empty( $this->mInfo ) ) {
					$result = $this->mDb->associateUpdate( $table, $pParamHash['geo_store'], array( "content_id" => $this->mContentId ) );
				} else {
					$result = $this->mDb->associateInsert( $table, $pParamHash['geo_store'] );
				}

				if (defined('POSTGIS_SUPPORT')) {
					$this->mDb->query("UPDATE ".$table." SET `geom`=GeomFromText( 'POINT(' || lat || ' ' || lng || ')', ".POSTGIS_SRID.")");
				}

				$this->mDb->CompleteTrans();
				$this->load();
			}
			else if (!empty($this->mInfo)) {
				$this->expunge();
			}
		}
		return( count( $this->mErrors )== 0 );
	}

	/**
	 * Make sure the data is safe to store
	 * @param array pParams reference to hash of values that will be used to store the page, they will be modified where necessary
	 * @return bool TRUE on success, FALSE if verify failed. If FALSE, $this->mErrors will have reason why
	 * @access private
	 **/
	function verify( &$pParamHash ) {
		$pParamHash['geo_store'] = array();
		if( $this->isValid() ) {
			$this->load();
			if(!empty( $pParamHash['geo'])){
				if( !empty( $pParamHash['geo']['lat'] ) ) {
					if ( is_numeric( $pParamHash['geo']['lat'] ) ) {
						$pParamHash['geo_store']['lat'] = $pParamHash['geo']['lat'];
					} else {
						$this->mErrors['lat'] = "Latitude must be numeric.";
					}
				} else {
					$pParamHash['geo_store']['lat'] = 0;
				}
				if( !empty( $pParamHash['geo']['lng'] ) ) {
					if ( is_numeric( $pParamHash['geo']['lng'] ) ) {
						$pParamHash['geo_store']['lng'] = $pParamHash['geo']['lng'];
					} else {
						$this->mErrors['lng'] = "Longitude must be numeric.";
					}
				} else {
					$pParamHash['geo_store']['lng'] = 0;
				}
				if( !empty( $pParamHash['geo']['amsl'] ) ) {
					if (is_numeric( $pParamHash['geo']['amsl'] ) ) {
						$pParamHash['geo_store']['amsl'] = $pParamHash['geo']['amsl'];
					} else {
						$this->mErrors['amsl'] = "amsl must be numeric.";
					}
				}
				if( !empty( $pParamHash['geo']['amsl_unit'] )) {
					$pParamHash['geo_store']['amsl_unit'] = $pParamHash['geo']['amsl_unit'];
				}
				if( empty( $pParamHash['geo_store']['lat'] ) && !empty( $pParamHash['geo_store']['lng'] )) {
					$this->mErrors['lat'] = "Latitude is required if Longitude is provided.";
				}
				if( empty( $pParamHash['geo_store']['lng'] ) && !empty( $pParamHash['geo_store']['lat'] )) {
					$this->mErrors['lng'] = "Longitude is required if Latitude is provided.";
				}
				if( !empty( $pParamHash['geo_store']['amsl'] ) && empty( $pParamHash['geo_store']['amsl_unit'] )) {
					$this->mErrors['amsl_unit'] = "amsl_unit required when amsl provided.";
				}
				if( !empty( $pParamHash['geo_store']['amsl_unit'] ) && empty( $pParamHash['geo_store']['amsl'] )) {
					$this->mErrors['amsl'] = "amsl unit is useless without amsl value.";
				}
				if( empty( $pParamHash['geo_store']['lat'] ) && empty( $pParamHash['geo_store']['lng'] ) &&
					( !empty( $pParamHash['geo_store']['amsl'] ) || !empty($pParamHash['geo_store']['amsl_unit'] )))
				{
					$this->mErrors['amsl'] = "amsl and amsl_unit require Latitude and Longitude";
				}
			}
		}
		return( count( $this->mErrors )== 0 );
	}

	/**
	 * check if the mContentId is set and valid
	 */
	function isValid() {
		return( @BitBase::verifyId( $this->mContentId ) );
	}

	/**
	 * This function removes a geo entry
	 **/
	function expunge() {
		$ret = FALSE;
		if( $this->isValid() ) {
			$query = "DELETE FROM `".BIT_DB_PREFIX."geo` WHERE `content_id` = ?";
			$result = $this->mDb->query( $query, array( $this->mContentId ) );
		}
		return $ret;
	}
}

/********* SERVICE FUNCTIONS *********/

function geo_content_load_sql() {
	global $gBitSystem;
	$ret = array();
	$ret['select_sql'] = " , geo.`lat`, geo.`lng`, geo.`amsl`, geo.`amsl_unit`";
	$ret['join_sql'] = " LEFT JOIN `".BIT_DB_PREFIX."geo` geo ON ( lc.`content_id`=geo.`content_id` )";
	return $ret;
}
/**
 * @param $pParamHash['up']['lng'], $pParamHash['up']['lat'], $pParamHash['down']['lng'], $pParamHash['down']['lat']
 **/
function geo_content_list_sql( &$pObject, $pParamHash=NULL ) {
	global $gBitSystem;
	$ret = array();
	$ret['select_sql'] = " , geo.`lat`, geo.`lng`, geo.`amsl`, geo.`amsl_unit`";
	$ret['join_sql'] = " LEFT JOIN `".BIT_DB_PREFIX."geo` geo ON ( lc.`content_id`=geo.`content_id` )";
	$ret['where_sql'] = "";
	if (isset($pParamHash['up_lat']) && isset($pParamHash['right_lng']) && isset($pParamHash['down_lat']) && isset($pParamHash['left_lng']) ) {
		/* when the left is greater than the right
		 * then the international dateline is visible
		 * and we need to get values at an intersection
		 * of two groups, so we use OR
		 */
		if ($pParamHash['left_lng'] < $pParamHash['right_lng']){
			$ret['where_sql'] .= ' AND geo.`lng` >= ? AND geo.`lng` <= ? AND geo.`lat` <= ? AND geo.`lat` >= ? ';
		}else{
			$ret['where_sql'] .= ' AND ( geo.`lng` >= ? OR geo.`lng` <= ? ) AND geo.`lat` <= ? AND geo.`lat` >= ? ';
		}
		$ret['bind_vars'][] = $pParamHash['left_lng'];
		$ret['bind_vars'][] = $pParamHash['right_lng'];
		$ret['bind_vars'][] = $pParamHash['up_lat'];
		$ret['bind_vars'][] = $pParamHash['down_lat'];
	}
	if (isset($pParamHash['geo_notnull'])){
		$ret['where_sql'] .= ' AND geo.`lng` IS NOT NULL AND geo.`lng` IS NOT NULL ';
	}
	return $ret;
}

function geo_content_store( &$pObject, &$pParamHash ) {
	global $gBitSystem;
	$errors = NULL;
	// If a content access system is active and we have geo in our store hash, let's call it
	if( $gBitSystem->isPackageActive( 'geo' ) && !empty( $pParamHash['geo'] ) ) {
		$geo = new LibertyGeo( $pObject->mContentId );

		// if both lat and lng fields are empty then the user is trying to clear geo data
		if( empty( $pParamHash['geo']['lat'] ) && empty( $pParamHash['geo']['lng'] ) ) {
			$geo->expunge();
		// store the geo data
		}elseif ( !$geo->store( $pParamHash ) ) {
			$errors=$geo->mErrors;
		}
	}
	return( $errors );
}

function geo_content_preview( &$pObject) {
	global $gBitSystem;
	if ( $gBitSystem->isPackageActive( 'geo' ) ) {
		if (isset($_REQUEST['geo']['lat'])) {
			$pObject->mInfo['lat'] = $_REQUEST['geo']['lat'];
		}
		if (isset($_REQUEST['geo']['lng'])) {
			$pObject->mInfo['lng'] = $_REQUEST['geo']['lng'];
		}
		if (isset($_REQUEST['geo']['amsl'])) {
			$pObject->mInfo['amsl'] = $_REQUEST['geo']['amsl'];
		}
		if (isset($_REQUEST['geo']['amsl_unit'])) {
			$pObject->mInfo['amsl_unit'] = $_REQUEST['geo']['amsl_unit'];
		}
	}
}

function geo_content_expunge( &$pObject ) {
	$geo = new LibertyGeo( $pObject->mContentId );
	$geo->expunge();
}
?>