/system/expressionengine/third_party/freeform/addon_builder/addon_builder.php

<?php if ( ! defined('EXT')) exit('No direct script access allowed');

/**
 * Solspace - Add-On Builder Framework
 *
 * @package		Add-On Builder Framework
 * @author		Solspace DevTeam
 * @copyright	Copyright (c) 2008-2011, Solspace, Inc.
 * @link		http://solspace.com/docs/
 * @version		1.2.4
 */

/**
 * Add-On Builder - Base Class
 *
 * A class that helps with the building of ExpressionEngine Add-Ons by allowing the automating of certain
 * tasks.
 *
 * @package 	Add-On Builder Framework
 * @subpackage	Solspace:Add-On Builder
 * @author		Solspace DevTeam
 * @link		http://solspace.com/docs/
 */

//--------------------------------------------
//	Alias to get_instance()
//--------------------------------------------

if ( ! function_exists('ee') )
{
	function ee()
	{
		return get_instance();
	}
}

//--------------------------------------------
//	need the bridge adaptor in 1.x
//--------------------------------------------

if (APP_VER < 2.0)
{
	require_once PATH . "bridge/codeigniter/ci_bridge_adaptor.php";
}

class Addon_builder_freeform {

	static $bridge_version		= '1.2.4';

	public $cache				= array(); // Internal cache

	public $ob_level			= 0;
	public $cached_vars			= array();
	public $switches			= array();

	// The general class name (ucfirst with underscores), used in database and class instantiation
	public $class_name			= '';

	// The lowercased class name, used for referencing module files and in URLs
	public $lower_name			= '';

	// The name that we put into the Extensions DB table, different for 2.x and 1.x
	public $extension_name		= '';

	// Module disabled? Typically used when an update is in progress.
	public $disabled			= FALSE;

	public $addon_path			= '';
	public $theme				= 'default';
	public $version				= '';

	public $crumbs				= array();

	public $document			= FALSE;
	public $data				= FALSE;
	public $actions				= FALSE;

	public $module_preferences	= array();
	public $remote_data			= '';	// For remote file retrieving and storage

	public $sc;

	//this will house items that might not always be set when called.
	public $constants;

	//holder for the json object if ever
	public $json;
	public $json_array;

	//for upper right link building
	public $right_links			= array();

	// Member Fields array
	public $mfields				= array();

	public $updater;

	public $aob_path			= '';

	public $auto_paginate 		= FALSE;

	// --------------------------------------------------------------------

	/**
	 * Constructor
	 *
	 * @access	public
	 * @return	null
	 */

	public function Addon_builder_freeform ($name='')
	{
		//path to this folder
		$this->aob_path = rtrim(realpath(dirname(__FILE__)), '/') . '/';

		$this->EE =& get_instance();

		if ( APP_VER < 2.0)
		{
			ee()->localize = $GLOBALS['LOC'];
			ee()->stats	= ( ! isset($GLOBALS['STAT'])) ? FALSE : $GLOBALS['STAT'];

			//need a symbolic link to extension->last_call and end_script
			if ( isset($GLOBALS['EXT']) AND is_object($GLOBALS['EXT']))
			{
				ee()->extensions->last_call 	=& $GLOBALS['EXT']->last_call;
				ee()->extensions->end_script 	=& $GLOBALS['EXT']->end_script;
			}
		}

		// --------------------------------------------
		//  Session Global
		//	- Add-On Builder might be called for an Extension using the 'session_' hooks,
		//	- so we need to check for that object first.
		// --------------------------------------------

		if ( ! isset(ee()->session) OR ! is_object(ee()->session))
		{
			if ( APP_VER < 2.0)
			{
				//Have to check for ->userdata too because a REAL session instance has it always
				//Some other addon devs are creating $SESS->cache even when $SESS is null
				//That autocreates the session object before the real one clobbers it,
				//that in turn fools addons into thinking that $SESSION has already fired :/

				//assume its still not there
				ee()->session = FALSE;

				//if it is, lets grab it changed to pass by reference
				if ( isset($GLOBALS['SESS']) AND isset($GLOBALS['SESS']->userdata))
				{
					ee()->session =& $GLOBALS['SESS'];
				}
			}
			elseif (file_exists(APPPATH.'libraries/Session.php'))
			{
				ee()->load->library('session');
			}
		}

		// --------------------------------------------
		//  PAGE Request?  Check for $TMPL global
		// --------------------------------------------

		if (APP_VER < 2.0 AND
			( ! isset(ee()->TMPL) OR ! is_object(ee()->TMPL)) AND
			isset($GLOBALS['TMPL']) AND
			is_object($GLOBALS['TMPL']))
		{
			ee()->TMPL =& $GLOBALS['TMPL'];
		}

		//--------------------------------------------
		//  CP Request?  Check for $DSP global
		//--------------------------------------------

		if (APP_VER < 2.0 AND
			REQ == 'CP' AND
			isset($GLOBALS['DSP']) AND
			is_object($GLOBALS['DSP']))
		{
			ee()->cp =& $GLOBALS['DSP'];
		}

		//--------------------------------------------
		// Required CONSTANTs
		//--------------------------------------------

		if ( ! defined('QUERY_MARKER'))
		{
			define('QUERY_MARKER', (ee()->config->item('force_query_string') == 'y') ? '' : '?');
		}

		if ( ! defined('SLASH'))
		{
			define('SLASH', '&#47;');  // Seems this constant is the same for both EE 1.x and EE 2.x
		}

		if ( ! defined('T_SLASH')) // Template Parsing Slash
		{
			define('T_SLASH', (APP_VER < '2.0') ? '&#47;' : "/");
		}

		if ( ! defined('NL'))
		{
			define('NL', "\n");
		}

		if (APP_VER < 2.0 AND ! defined('PATH_THIRD') AND defined('PATH_MOD'))
		{
			define('PATH_THIRD', PATH_MOD);
		}

		if ( ! defined('PATH_CP_IMG') AND defined('PATH_CP_GBL_IMG'))
		{
			define('PATH_CP_IMG', PATH_CP_GBL_IMG);
		}

		//just in case we need them early
		if ( ! defined('AMP'))
		{
			define('AMP', '&amp;');
		}

		if ( ! defined('BR'))
		{
			define('BR',  '<br />');
		}

		if ( ! defined('NBS'))
		{
			define('NBS', "&nbsp;");
		}

		// EE 1.x does not have this constant,
		// but it adds it to every form automatically.
		// EE 2.x sets it all the time now.

		$constants = array(
			'XID_SECURE_HASH' 	=> (APP_VER < 2.0 OR ! defined('XID_SECURE_HASH')) ?
											'' : XID_SECURE_HASH,
		);

		$this->constants = (object) $constants;

		//--------------------------------------------
		// Auto-Detect Name
		//--------------------------------------------

		if ($name == '')
		{
			$name = get_class($this);

			$ends = array(
				'_cp_base',
				'_mcp',
				'_CP',
				'_ext',
				'_extension',
				'_extension_base',
				'_updater_base',
				'_updater',
				'_upd',
				'_actions',
				'_data',
				'_ft',
				'_acc'
			);

			foreach($ends as $remove)
			{
				if (substr($name, -strlen($remove)) == $remove)
				{
					$name = substr($name, 0, -strlen($remove));
					break;
				}
			}
		}

		//--------------------------------------------
		// Important Class Vars
		//--------------------------------------------

		//this should always be loaded after EE 2.1.4
		if ( ! isset(ee()->security) OR
			 ! is_object(ee()->security))
		{
			ee()->load->library('security');
		}

		$this->lower_name		= strtolower(ee()->security->sanitize_filename($name));
		$this->class_name		= ucfirst($this->lower_name);

		$this->extension_name	= $this->class_name . ((APP_VER < 2.0) ? '_extension' : '_ext');

		// -------------------------------------
		//	set short cuts (must be done after lowername)
		// -------------------------------------

		$this->sc = $this->generate_shortcuts();

		//--------------------------------------------
		// Prepare Caching
		//--------------------------------------------

		//no sessions? lets use global until we get here again
		if ( ! isset(ee()->session) OR ! is_object(ee()->session))
		{
			if ( ! isset($GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name]))
			{
				$GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name] = array();
			}

			$this->cache 		=& $GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name];

			if ( ! isset($GLOBALS['solspace']['cache']['addon_builder']['global']) )
			{
				$GLOBALS['solspace']['cache']['addon_builder']['global'] = array();
			}

			$this->global_cache =& $GLOBALS['solspace']['cache']['addon_builder']['global'];
		}
		//sessions?
		else
		{
			//been here before?
			if ( ! isset(ee()->session->cache['solspace']['addon_builder']['addon'][$this->lower_name]))
			{
				//grab pre-session globals, and only unset the ones for this addon
				if ( isset($GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name]))
				{
					ee()->session->cache['solspace']['addon_builder']['addon'][$this->lower_name] = $GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name];

					//cleanup, isle 5
					unset($GLOBALS['solspace']['cache']['addon_builder']['addon'][$this->lower_name]);
				}
				else
				{
					ee()->session->cache['solspace']['addon_builder']['addon'][$this->lower_name] = array();
				}
			}

			//check for solspace-wide globals
			if ( ! isset(ee()->session->cache['solspace']['addon_builder']['global']) )
			{
				if (isset($GLOBALS['solspace']['cache']['addon_builder']['global']))
				{
					ee()->session->cache['solspace']['addon_builder']['global'] = $GLOBALS['solspace']['cache']['addon_builder']['global'];

					unset($GLOBALS['solspace']['cache']['addon_builder']['global']);
				}
				else
				{
					ee()->session->cache['solspace']['addon_builder']['global'] = array();
				}
			}

			$this->global_cache =& ee()->session->cache['solspace']['addon_builder']['global'];
			$this->cache 		=& ee()->session->cache['solspace']['addon_builder']['addon'][$this->lower_name];
		}

		//--------------------------------------------
		// Add-On Path
		//--------------------------------------------

		if (APP_VER < 2.0)
		{
			// Because of Bridge Magic with eval() and parents, we might have to go one or two levels up
			$parent_class		= get_parent_class($this);
			$super_parent_class = get_parent_class($parent_class);

			if (($parent_class == 'Extension_builder_freeform' OR
				 $super_parent_class == 'Extension_builder_freeform') AND
				 is_dir(PATH_EXT.$this->lower_name.'/'))
			{
				$this->extension_name	= $this->class_name;
				$this->addon_path		= PATH_EXT . $this->lower_name.'/';
			}
			else
			{
				$this->addon_path = PATH_MOD . $this->lower_name . '/';
			}
		}
		else
		{
			$this->addon_path = PATH_THIRD . $this->lower_name . '/';
		}

		//--------------------------------------------
		// Language Override
		//--------------------------------------------

		if (isset(ee()->lang) AND is_object(ee()->lang))
		{
			ee()->lang->loadfile($this->lower_name);
		}

		//--------------------------------------------
		// Module Constants
		//--------------------------------------------

		if ( defined(strtoupper($this->lower_name).'_VERSION') == FALSE AND
			 file_exists($this->addon_path.'constants.'.$this->lower_name.'.php'))
		{
			require_once $this->addon_path.'constants.'.$this->lower_name.'.php';
		}

		if (defined(strtoupper($this->lower_name).'_VERSION') !== FALSE)
		{
			$this->version = constant(strtoupper($this->lower_name).'_VERSION');
		}

		//--------------------------------------------
		// Data Object - Used Cached Version, if Available
		//--------------------------------------------

		if ( isset($this->cache['objects']['data']) AND
			 is_object($this->cache['objects']['data']))
		{
			$this->data =& $this->cache['objects']['data'];
		}
		else
		{
			if ( file_exists($this->addon_path . 'data.' . $this->lower_name.'.php'))
			{
				$name = $this->class_name . '_data';

				if ( ! class_exists($name))
				{
					require_once $this->addon_path . 'data.' . $this->lower_name.'.php';
				}

				$this->data = new $name($this);

				$this->data->sc	= $this->sc;
			}
			else
			{
				if ( ! class_exists('Addon_builder_data_freeform'))
				{
					require_once $this->aob_path . 'data.addon_builder.php';
				}

				$this->data = new Addon_builder_data_freeform($this);
			}

			$this->cache['objects']['data'] =& $this->data;
		}

		$this->data->parent_aob_instance =& $this;

		//--------------------------------------------
		// documentDOM_freeform instantiated, might move this.
		//--------------------------------------------

		if (REQ == 'CP' AND file_exists($this->aob_path . 'document_dom.php'))
		{
			if ( ! class_exists('documentDOM_freeform'))
			{
				require_once $this->aob_path . 'document_dom.php';
			}

			$this->document = new documentDOM_freeform();
		}

		//--------------------------------------------
		// Important Cached Vars - Used in Both Extensions and Modules
		//--------------------------------------------

		$this->cached_vars['XID_SECURE_HASH'] 	= $this->constants->XID_SECURE_HASH;
		$this->cached_vars['page_crumb']	 	= '';
		$this->cached_vars['page_title']	 	= '';
		$this->cached_vars['text_direction'] 	= 'ltr';
		$this->cached_vars['onload_events']  	= '';
		$this->cached_vars['message']		 	= '';

		$this->cached_vars['caller'] 		 	=& $this;
		$this->cached_vars['theme_url']			= $this->sc->addon_theme_url;
		$this->cached_vars['addon_theme_url']	= $this->sc->addon_theme_url;

		//--------------------------------------------
		// Determine View Path for Add-On
		//--------------------------------------------

		if ( isset($this->cache['view_path']))
		{
			$this->view_path = $this->cache['view_path'];
		}
		else
		{
			$possible_paths = array();

			$this->theme = ee()->security->sanitize_filename($this->theme);

			if (APP_VER < 2.0)
			{
				if (trim($this->theme, '/') != '')
				{
					$possible_paths[] = $this->addon_path.'views/1.x/'.trim($this->theme, '/').'/';
				}

				$possible_paths[] = $this->addon_path.'views/1.x/default/';
				$possible_paths[] = $this->addon_path.'views/1.x/';
			}
			else
			{
				if (trim($this->theme, '/') != '')
				{
					$possible_paths[] = $this->addon_path.'views/2.x/'.trim($this->theme, '/').'/';
				}

				$possible_paths[] = $this->addon_path.'views/2.x/default/';
				$possible_paths[] = $this->addon_path.'views/2.x/';
			}

			if (trim($this->theme, '/') != '')
			{
				$possible_paths[] = $this->addon_path.'views/'.trim($this->theme, '/').'/';
			}

			$possible_paths[] = $this->addon_path.'views/default/';
			$possible_paths[] = $this->addon_path.'views/';

			foreach(array_unique($possible_paths) as $path)
			{
				if ( is_dir($path))
				{
					$this->view_path = $path;
					break;
				}
			}
		}
	}
	// END Addon_builder_freeform()


	// --------------------------------------------------------------------

	/**
	 * Creates shortcuts for common changed items between versions.
	 *
	 * @access	public
	 * @return	object
	 */

	public function generate_shortcuts ()
	{
		$is2 = ! (APP_VER < 2.0);

		if (defined('URL_THIRD_THEMES'))
		{
			$theme_url = URL_THIRD_THEMES;
		}
		else
		{
			$theme_url = (
				rtrim(ee()->config->item('theme_folder_url'), '/') .
				'/' . ($is2 ? 'third_party/' : '')
			);
		}

		if (defined('PATH_THIRD_THEMES'))
		{
			$theme_path = PATH_THIRD_THEMES;
		}
		else
		{
			$theme_path = (
				rtrim(ee()->config->item('theme_folder_path'), '/') .
				'/' . ($is2 ? 'third_party/' : '')
			);
		}

		return (object) array(
			'db'	=> (object) array(
				'channel_name'			=> $is2 ? 'channel_name'              	: 'blog_name',
				'channel_url'			=> $is2 ? 'channel_url'              	: 'blog_url',
				'channel_title'			=> $is2 ? 'channel_title'             	: 'blog_title',
				'channels'				=> $is2 ? 'exp_channels'              	: 'exp_weblogs',
				'data'					=> $is2 ? 'exp_channel_data'          	: 'exp_weblog_data',
				'channel_data'			=> $is2 ? 'exp_channel_data'          	: 'exp_weblog_data',
				'fields'				=> $is2 ? 'exp_channel_fields'        	: 'exp_weblog_fields',
				'channel_fields'		=> $is2 ? 'exp_channel_fields'        	: 'exp_weblog_fields',
				'id'					=> $is2 ? 'channel_id'                	: 'weblog_id',
				'channel_id'			=> $is2 ? 'channel_id'                	: 'weblog_id',
				'member_groups'			=> $is2 ? 'exp_channel_member_groups' 	: 'exp_weblog_member_groups',
				'channel_member_groups'	=> $is2 ? 'exp_channel_member_groups' 	: 'exp_weblog_member_groups',
				'titles'				=> $is2 ? 'exp_channel_titles'        	: 'exp_weblog_titles',
				'channel_titles'		=> $is2 ? 'exp_channel_titles'        	: 'exp_weblog_titles'
			),
			'channel'					=> $is2 ? 'channel'        				: 'weblog',
			'channels'					=> $is2 ? 'channels'        			: 'weblogs',
			'theme_url'					=> $theme_url,
			'theme_path'				=> $theme_path,
			'addon_theme_url' 			=> $theme_url . $this->lower_name . '/',
			'addon_theme_path' 			=> $theme_path . $this->lower_name . '/',
		);
	}
	/* END generate_shortcuts() */


	// --------------------------------------------------------------------

	/**
	 * Instantiates an Object and Returns It
	 *
	 * Tired of having the same code duplicate everywhere for calling Typography, Email, Et Cetera.
	 *
	 * @access	public
	 * @return	object|NULL
	 */

	public function instantiate ( $name , $variables = array())
	{
		$lower_name = strtolower($name);
		$class_name = ucfirst($lower_name);

		// I am embarrassed by this exception -Paul
		if ($lower_name == 'email')
		{
			$class_name == 'EEmail';
		}

		if ( ! class_exists($class_name))
		{
			// We only load classes from the CP or CORE directories

			if (file_exists(PATH_CP.'core.'.$lower_name.EXT))
			{
				$location = PATH_CP.'core.'.$lower_name.EXT;
			}
			elseif (file_exists(PATH_CORE.'cp.'.$lower_name.EXT))
			{
				$location = PATH_CORE.'cp.'.$lower_name.EXT;
			}
			else
			{
				return NULL;
			}

			require_once $location;
		}

		$NEW = new $class_name();

		foreach($variables AS $key => $value)
		{
			$NEW->$key = $value;
		}

		return $NEW;
	}
	/* END instantiate() */


	// --------------------------------------------------------------------

	/**
	 * Module's Action Object
	 *
	 * intantiates the actions object and sticks it to $this->actions
	 *
	 * @access	public
	 * @return	object
	 */

	public function actions ()
	{
		if ( ! is_object($this->actions))
		{
			$name = $this->class_name.'_actions';

			if ( ! class_exists($name))
			{
				require_once $this->addon_path . 'act.'.$this->lower_name.'.php';
			}

			$this->actions = new $name();
			$this->actions->data =& $this->data;
		}

		return $this->actions;
	}
	// END actions()


	// --------------------------------------------------------------------

	/**
	 * Database Version
	 *
	 * Returns the version of the module in the database
	 *
	 * @access	public
	 * @param 	bool 	ignore all caches and get version from database
	 * @return	string
	 */

	public function database_version ($ignore_cache = FALSE)
	{
		if ( ! $ignore_cache AND
			 isset($this->cache['database_version']))
		{
			return $this->cache['database_version'];
		}

		//	----------------------------------------
		//	 Use Template object variable, if available
		// ----------------------------------------

		//EE1
		if ( ! $ignore_cache AND
			 APP_VER < 2.0 AND
			 isset($GLOBALS['TMPL']) AND
			 is_object($GLOBALS['TMPL']) AND
			 count($GLOBALS['TMPL']->module_data) > 0)
		{
			if ( ! isset($GLOBALS['TMPL']->module_data[$this->class_name]))
			{
				$this->cache['database_version'] = FALSE;
			}
			else
			{
				$this->cache['database_version'] = $GLOBALS['TMPL']->module_data[$this->class_name]['version'];
			}
		}
		//EE2
		elseif ( ! $ignore_cache AND
			 APP_VER >= 2.0 AND
			 isset(ee()->TMPL) AND
			 is_object(ee()->TMPL) AND
			 count(ee()->TMPL->module_data) > 0)
		{
			if ( ! isset(ee()->TMPL->module_data[$this->class_name]))
			{
				$this->cache['database_version'] = FALSE;
			}
			else
			{
				$this->cache['database_version'] = ee()->TMPL->module_data[$this->class_name]['version'];
			}
		}
		//global cache
		elseif ( ! $ignore_cache AND
			isset($this->global_cache['module_data']) AND
			isset($this->global_cache['module_data'][$this->lower_name]['database_version']))
		{
			$this->cache['database_version'] = $this->global_cache['module_data'][$this->lower_name]['database_version'];
		}
		//fill global with last resort
		else
		{
			//	----------------------------------------
			//	 Retrieve all Module Versions from the Database
			//	  - By retrieving all of them at once,
			//   we can limit it to a max of one query per
			//   page load for all Bridge Add-Ons
			// ----------------------------------------

			$query = $this->cacheless_query(
				"SELECT module_version, module_name
				 FROM 	exp_modules"
			);

			foreach($query->result_array() as $row)
			{
				if ( isset(ee()->session) AND is_object(ee()->session))
				{
					$this->global_cache['module_data'][strtolower($row['module_name'])]['database_version'] = $row['module_version'];
				}

				if ($this->class_name == $row['module_name'])
				{
					$this->cache['database_version'] = $row['module_version'];
				}
			}
		}

		//did get anything?
		return isset($this->cache['database_version']) ? $this->cache['database_version'] : FALSE;
	}
	// END database_version()


	// --------------------------------------------------------------------

	/**
	 * Find and return preference
	 *
	 * Any number of possible arguments, although typically I expect there will be only one or two
	 *
	 * @access	public
	 * @param	string			Preference to retrieve
	 * @return	null|string		If preference does not exist, NULL is returned, else the value
	 */

	public function preference ()
	{
		$s = func_num_args();

		if ($s == 0)
		{
			return NULL;
		}

		//--------------------------------------------
		// Fetch Module Preferences
		//--------------------------------------------

		if (count($this->module_preferences) == 0 AND $this->database_version() !== FALSE)
		{
			if ( method_exists($this->actions(), 'module_preferences'))
			{
				$this->module_preferences = $this->actions()->module_preferences();
			}
			elseif ( method_exists($this->data, 'get_module_preferences'))
			{
				$this->module_preferences = $this->data->get_module_preferences();
			}
			else
			{
				return NULL;
			}
		}

		//--------------------------------------------
		// Find Our Value, If It Exists
		//--------------------------------------------

		$value = (isset($this->module_preferences[func_get_arg(0)])) ?
					$this->module_preferences[func_get_arg(0)] : NULL;

		for($i = 1; $i < $s; ++$i)
		{
			if ( ! isset($value[func_get_arg($i)]))
			{
				return NULL;
			}

			$value = $value[func_get_arg($i)];
		}

		return $value;
	}
	// END preference()


	// --------------------------------------------------------------------

	/**
	 * Checks to see if extensions are allowed
	 *
	 *
	 * @access	public
	 * @return	bool	Whether the extensions are allowed
	 */

	public function extensions_allowed ()
	{
		return $this->check_yes(ee()->config->item('allow_extensions'));
	}
	//END extensions_allowed


	// --------------------------------------------------------------------

	/**
	 * Homegrown Version of Version Compare
	 *
	 * Compared two versions in the form of 1.1.1.d12 <= 1.2.3.f0
	 *
	 * @access	public
	 * @param	string	First Version
	 * @param	string	Operator for Comparison
	 * @param	string	Second Version
	 * @return	bool	Whether the comparison is TRUE or FALSE
	 */

	public function version_compare ($v1, $operator, $v2)
	{
		// Allowed operators
		if ( ! in_array($operator, array('>', '<', '>=', '<=', '==', '!=')))
		{
			trigger_error("Invalid Operator in Add-On Library - Version Compare", E_USER_WARNING);
			return FALSE;
		}

		// Normalize and Fix Invalid Values
		foreach(array('v1', 'v2') as $var)
		{
			$x = array_slice(preg_split("/\./", trim($$var), -1, PREG_SPLIT_NO_EMPTY), 0, 4);

			for($i=0; $i < 4; $i++)
			{
				if ( ! isset($x[$i]))
				{
					$x[$i] = ($i == 3) ? 'f0' : '0';
				}
				elseif ($i < 3 AND ctype_digit($x[$i]) == FALSE)
				{
					$x[$i] = '0';
				}
				elseif($i == 3 AND ! preg_match("/^[abdf]{1}[0-9]+$/", $x[$i]))
				{
					$x[$i] = 'f0';
				}

				// Set up for PHP's version_compare
				if ($i == 3)
				{
					$letter 	 = substr($x[3], 0, 1);
					$sans_letter = substr($x[3], 1);

					if ($letter == 'd')
					{
						$letter = 'dev';
					}
					elseif($letter == 'f')
					{
						$letter = 'RC';
					}

					$x[3] = $letter.'.'.$sans_letter;
				}
			}

			$$var = implode('.', $x);
		}

		// echo $v1.' - '.$v2;

		//this is a php built in function,
		//self::version_compare is just prep work
		return version_compare($v1, $v2, $operator);
	}
	// END version_compare()


	// --------------------------------------------------------------------

	/**
	 * ExpressionEngine CP View Request
	 *
	 * Just like a typical view request but we do a few EE CP related things too
	 *
	 * @access	public
	 * @param	array
	 * @return	void
	 */
	public function ee_cp_view ($view)
	{
		//--------------------------------------------
		// Build Crumbs!
		//--------------------------------------------

		$this->build_crumbs();
		$this->build_right_links();

		//--------------------------------------------
		// EE 1.x Code for Calling Certain CP Hooks
		//--------------------------------------------

		if (APP_VER < 2.0)
		{
			// -------------------------------------------
			// 'show_full_control_panel_start' hook.
			//  - Full Control over CP
			//  - Modify any $DSP class variable (JS, headers, etc.)
			//  - Override any $DSP method and use their own
			//
				$edata = ee()->extensions->call('show_full_control_panel_start');
				if (ee()->extensions->end_script === TRUE) return;
			//
			// -------------------------------------------
		}

		//--------------------------------------------
		// Load View Path, Call View File
		//--------------------------------------------

		$output = $this->view($view, array(), TRUE);

		//--------------------------------------------
		// EE 1.x Code for Calling Certain CP Hooks
		//--------------------------------------------

		if (APP_VER < 2.0)
		{
			// -------------------------------------------
			// 'show_full_control_panel_end' hook.
			//  - Rewrite CP's HTML
			//	- Find/Replace Stuff, etc.
			//
				if (ee()->extensions->active_hook('show_full_control_panel_end') === TRUE)
				{
					$output = ee()->extensions->call('show_full_control_panel_end', $output);
					if (ee()->extensions->end_script === TRUE) return;
				}
			//
			// -------------------------------------------
		}

		//--------------------------------------------
		// EE 1.x, We Add Secure Form Hashes and Output Content to Browser
		//--------------------------------------------

		if (APP_VER < 2.0)
		{
			if (stristr($output, '{XID_HASH}'))
			{
				$output = ee()->functions->add_form_security_hash($output);
			}

			ee()->output->_display(ee()->cp->secure_hash($output));
			exit;
		}

		//--------------------------------------------
		// In EE 2.x, we return the Output and Let EE Continue Building the CP
		//--------------------------------------------

		return $output;
	}
	// END ee_cp_view()


	// --------------------------------------------------------------------

	/**
	 * Javascript/CSS File View Request
	 *
	 * Outputs a View file as if it were a Javascript file
	 *
	 * @access	public
	 * @param	array
	 * @return	void
	 */
	public function file_view ($view, $modification_time = '')
	{
		//--------------------------------------------
		// Auto-detect the Type
		//--------------------------------------------

		if (preg_match("/\.([cjs]{2,3})$/i", $view, $match) AND
			in_array($match[1], array('css', 'js')))
		{
			switch($match[1])
			{
				case 'css'	:
					$type = 'css';
				break;
				case 'js'	:
					$type = 'javascript';
				break;
			}
		}
		else
		{
			exit;
		}

		//--------------------------------------------
		// Load View Path, Call View File
		//--------------------------------------------

		$output = $this->view($view, array(), TRUE);

		//--------------------------------------------
		// EE 1.x, We Add Secure Form Hashes and Output Content to Browser
		//--------------------------------------------

		if ($type == 'javascript' AND stristr($output, '{XID_SECURE_HASH}'))
		{
			$output = str_replace('{XID_SECURE_HASH}', '{XID_HASH}', $output);
		}

		if ($type == 'javascript')
		{
			$output = ee()->functions->add_form_security_hash($output);
		}

		//----------------------------------------
		// Generate HTTP headers
		//----------------------------------------

		if (ee()->config->item('send_headers') == 'y')
		{
			$ext = pathinfo($view, PATHINFO_EXTENSION);
			$file = ($ext == '') ? $view.EXT : $view;
			$path = $this->view_path.$file;

			$max_age			= 5184000;
			$modification_time	= ($modification_time != '') ? $modification_time : filemtime($path);
			$modified_since		= ee()->input->server('HTTP_IF_MODIFIED_SINCE');

			if ( ! ctype_digit($modification_time))
			{
				$modification_time	= filemtime($path);
			}

			// Remove anything after the semicolon

			if ($pos = strrpos($modified_since, ';') !== FALSE)
			{
				$modified_since = substr($modified_since, 0, $pos);
			}

			// Send a custom ETag to maintain a useful cache in
			// load-balanced environments

			header("ETag: ".md5($modification_time.$path));

			// If the file is in the client cache, we'll
			// send a 304 and be done with it.

			if ($modified_since AND (strtotime($modified_since) == $modification_time))
			{
				ee()->output->set_status_header(304);
				exit;
			}

			ee()->output->set_status_header(200);
			@header("Cache-Control: max-age={$max_age}, must-revalidate");
			@header('Vary: Accept-Encoding');
			@header('Last-Modified: '.gmdate('D, d M Y H:i:s', $modification_time).' GMT');
			@header('Expires: '.gmdate('D, d M Y H:i:s', time() + $max_age).' GMT');
			@header('Content-Length: '.strlen($output));
		}

		//----------------------------------------
		// Send JavaScript/CSS Header and Output
		//----------------------------------------

		@header("Content-type: text/".$type);

		exit($output);
	}
	// END ee_cp_view()


	// --------------------------------------------------------------------

	/**
	 * View File Loader
	 *
	 * Takes a file from the filesystem and loads it so that we can parse PHP within it just
	 *
	 *
	 * @access		public
	 * @param		string		$view - The view file to be located
	 * @param		array		$vars - Array of data variables to be parsed in the file system
	 * @param		bool		$return - Return file as string or put into buffer
	 * @param		string		$path - Override path for the file rather than using $this->view_path
	 * @return		string
	 */

	public function view ($view, $vars = array(), $return = FALSE, $path='')
	{
		//have to keep this for legacy footers
		global $DSP, $LANG, $PREFS;

		//--------------------------------------------
		// Determine File Name and Extension for Requested File
		//--------------------------------------------

		if ($path == '')
		{
			$ext = pathinfo($view, PATHINFO_EXTENSION);
			$file = ($ext == '') ? $view.EXT : $view;
			$path = $this->view_path.$file;
		}
		else
		{
			$x = explode('/', $path);
			$file = end($x);
		}

		//--------------------------------------------
		// Make Sure the File Actually Exists
		//--------------------------------------------

		if ( ! file_exists($path))
		{
			trigger_error("Invalid View File Request of '".$path."'");
			return FALSE;
		}

		// All variables sent to the function are cached, which allows us to use them
		// within embedded view files within this file.

		if (is_array($vars))
		{
			$this->cached_vars = array_merge($this->cached_vars, $vars);
		}
		extract($this->cached_vars, EXTR_PREFIX_SAME, 'var_');

		//print_r($this->cached_vars);

		//--------------------------------------------
		// Buffer Output
		// - Increases Speed
		// - Allows Views to be Nested Within Views
		//--------------------------------------------

		ob_start();

		//--------------------------------------------
		// Load File and Rewrite Short Tags
		//--------------------------------------------

		$rewrite_short_tags = TRUE; // Hard coded setting for now...

		if ((bool) @ini_get('short_open_tag') === FALSE AND $rewrite_short_tags == TRUE)
		{
			echo eval('?'.'>'.preg_replace("/;*\s*\?".">/", "; ?".">",
					  str_replace('<'.'?=', '<?php echo ',
					 file_get_contents($path))).'<'.'?php ');
		}
		else
		{
			include($path);
		}

		//--------------------------------------------
		// Return Parsed File as String
		//--------------------------------------------

		if ($return === TRUE)
		{
			$buffer = ob_get_contents();
			@ob_end_clean();
			return $buffer;
		}

		//--------------------------------------------
		// Flush Buffer
		//--------------------------------------------

		if (ob_get_level() > $this->ob_level + 1)
		{
			ob_end_flush();
		}
		else
		{
			$buffer = ob_get_contents();
			@ob_end_clean();
			return $buffer;
		}
	}
	// END view()


	// --------------------------------------------------------------------

	/**
	 * Fetch the CP Stylesheet
	 *
	 * Had to build this because it was not abstracted well enough for us to simply call EE methods
	 *
	 * @access	public
	 * @param	array		An array of find/replace values to perform in the stylesheet
	 * @return	string
	 */

	public function fetch_stylesheet ()
	{
		// Change CSS on the click so it works like the hover until they unclick?

		$ptb = ee()->config->item('publish_tab_behavior');
		$stb = ee()->config->item('sites_tab_behavior');

		$tab_behaviors = array(
			'publish_tab_selector'		=> ($ptb == 'hover') 	? 'hover' : 'active',
			'publish_tab_display'		=> ($ptb == 'none') 	? '' : 'display:block; visibility: visible;',
			'publish_tab_ul_display'	=> ($ptb == 'none') 	? '' : 'display:none;',
			'sites_tab_selector'		=> ($stb == 'hover') 	? 'hover' : 'active',
			'sites_tab_display'			=> ($stb == 'none') 	? '' : 'display:block; visibility: visible;',
			'sites_tab_ul_display'		=> ($stb == 'none') 	? '' : 'display:none;'
		);

		$stylesheet = $GLOBALS['DSP']->fetch_stylesheet();

		foreach ($tab_behaviors as $key => $val)
		{
			$stylesheet = str_replace(LD.$key.RD, $val, $stylesheet);
		}

		return $stylesheet;
	}
	 // END fetch_stylesheet()


	// --------------------------------------------------------------------

	/**
	 * Add Array of Breadcrumbs for a Page
	 *
	 * @access	public
	 * @param	array
	 * @return	null
	 */

	public function add_crumbs ($array)
	{
		if ( is_array($array))
		{
			foreach($array as $value)
			{
				if ( is_array($value))
				{
					$this->add_crumb($value[0], $value[1]);
				}
				else
				{
					$this->add_crumb($value);
				}
			}
		}
	}
	/* END add_crumbs */

	// --------------------------------------------------------------------

	/**
	 * Add Single Crumb to List of Breadcrumbs
	 *
	 * @access	public
	 * @param	string		Text of breacrumb
	 * @param	string		Link, if any for breadcrumb
	 * @return	null
	 */

	public function add_crumb ($text, $link='')
	{
		$this->crumbs[] = ($link == '') ? array($text) : array($text, $link);
	}
	/* END add_crumb() */


	// --------------------------------------------------------------------

	/**
	 * Takes Our Crumbs and Builds them into the Breadcrumb List
	 *
	 * @access	public
	 * @return	null
	 */

	public function build_crumbs ()
	{
		global $DSP, $OUT;

		if ( is_string($this->crumbs))
		{
			if (APP_VER < 2.0) $DSP->title	= $this->crumbs;

			$this->cached_vars['page_crumb'] = $this->crumbs;
			$this->cached_vars['page_title'] = $this->crumbs;
			return;
		}

		if (APP_VER < 2.0) $DSP->crumb = '';
		$this->cached_vars['page_crumb'] = '';
		$this->cached_vars['page_title'] = '';

		$item = (count($this->crumbs) == 1) ? TRUE : FALSE;

		ee()->load->helper('url');

		foreach($this->crumbs as $key => $value)
		{
			if (is_array($value))
			{
				$name = $value[0];

				if (isset($value[1]))
				{
					$name = "<a href='{$value[1]}'>{$value[0]}</a>";
				}

				$this->cached_vars['page_title'] = $value[0];
			}
			else
			{
				$name = $value;
				$this->cached_vars['page_title'] = $value;
			}

			if (APP_VER < 2.0)
			{
				if ($item === FALSE)
				{
					$this->cached_vars['page_crumb'] .= $name;
					$item = TRUE;
				}
				else
				{
					$this->cached_vars['page_crumb'] .= $DSP->crumb_item($name);
				}
			}
			else
			{
				if (is_array($value) AND isset($value[1]))
				{
					ee()->cp->set_breadcrumb($value[1], $value[0]);
				}
			}
		}

		/** --------------------------------------------
		/**  2.0 Specific Code
		/** --------------------------------------------*/

		$this->cached_vars['cp_page_title'] = $this->cached_vars['page_title'];

		if (APP_VER >= 2.0)
		{
			ee()->cp->set_variable('cp_page_title', $this->cached_vars['cp_page_title'] );
		}

		/** --------------------------------------------
		/**  1.x Breadcrumb View Variable
		/** --------------------------------------------*/

		if (APP_VER < 2.0) $DSP->crumb = $this->cached_vars['page_crumb'];
	}
	/* END build_crumbs() */


	// --------------------------------------------------------------------

	/**
	 * Field Output Prep for arrays and strings
	 *
	 *
	 * @access	public
	 * @param	string|array	The item that needs to be prepped for output
	 * @return	string|array
	 */

	function output ($item)
	{
		if (is_array($item))
		{
			$array = array();

			foreach($item as $key => $value)
			{
				$array[$this->output($key)] = $this->output($value);
			}

			return $array;
		}
		elseif(is_string($item))
		{
			return htmlspecialchars($item, ENT_QUOTES);
		}
		else
		{
			return $item;
		}
	}
	/* END output() */

	// --------------------------------------------------------------------

	/**
	 * Cycles Between Values
	 *
	 * Takes a list of arguments and cycles through them on each call
	 *
	 * @access	public
	 * @param	string|array	The items that need to be cycled through
	 * @return	string|array
	 */

	function cycle ($items)
	{
		if ( ! is_array($items))
		{
			$items = func_get_args();
		}

		$hash = md5(implode('|', $items));

		if ( ! isset($this->switches[$hash]) OR ! isset($items[$this->switches[$hash] + 1]))
		{
			$this->switches[$hash] = 0;
		}
		else
		{
			$this->switches[$hash]++;
		}

		return $items[$this->switches[$hash]];
	}
	/* END cycle() */


	// --------------------------------------------------------------------

	/**
	 * Order Array
	 *
	 * Takes an array and reorders it based on the value of a key
	 *
	 * @access	public
	 * @param	array	$array		The array needing to be reordered
	 * @param	string	$key		The key being used to reorder
	 * @param	string	$order		The order for the values asc/desc
	 * @return	array
	 */

	function order_array ($array, $key, $order = 'desc')
	{
		// http://us2.php.net/manual/en/function.array-multisort.php
	}
	/* END order_array() */

	// --------------------------------------------------------------------

	/**
	 * Column Exists in DB Table
	 *
	 * @access	public
	 * @param	string	$column		The column whose existence we are looking for
	 * @param	string	$table		In which table?
	 * @return	array
	 */

	public function column_exists ( $column, $table, $cache = TRUE )
	{
		if ($cache === TRUE AND isset($this->cache['column_exists'][$table][$column]))
		{
			return $this->cache['column_exists'][$table][$column];
		}

		/**	----------------------------------------
		/**	Check for columns in tags table
		/** ----------------------------------------*/

		$query	= ee()->db->query( "DESCRIBE `".ee()->db->escape_str( $table )."` `".ee()->db->escape_str( $column )."`" );

		if ( $query->num_rows > 0 )
		{
			return $this->cache['column_exists'][$table][$column] = TRUE;
		}

		return $this->cache['column_exists'][$table][$column] = FALSE;
	}
	/* END column_exists() */


	// --------------------------------------------------------------------

	/**
	 * Retrieve Remote File and Cache It
	 *
	 * @access	public
	 * @param	string		$url - URL to be retrieved
	 * @param	integer		$cache_length - How long to cache the result, if successful retrieval
	 * @return	bool		Success or failure.  Data result stored in $this->remote_data
	 */

	public function retrieve_remote_file ($url, $cache_length = 24, $path='', $file='')
	{
		global $FNS;

		$path		= ($path == '') ? PATH_CACHE.'addon_builder/' : rtrim($path, '/').'/';
		$file		= ($file == '') ? md5($url).'.txt' : $file;
		$file_path	= $path.$file;

		/** --------------------------------------------
		/**  Check for Cached File
		/** --------------------------------------------*/

		if ( ! file_exists($file_path) OR (time() - filemtime($file_path)) > (60 * 60 * round($cache_length)))
		{
			@unlink($file_path);
		}
		elseif (($this->remote_data = file_get_contents($file_path)) === FALSE)
		{
			@unlink($file_path);
		}
		else
		{
			return TRUE;
		}

		/** --------------------------------------------
		/**  Validate and Create Cache Directory
		/** --------------------------------------------*/

		if ( ! is_dir($path))
		{
			$dirs = explode('/', trim(ee()->functions->remove_double_slashes($path), '/'));

			$path = '/';

			foreach ($dirs as $dir)
			{
				if ( ! @is_dir($path.$dir))
				{
					if ( ! @mkdir($path.$dir, 0777))
					{
						$this->errors[] = 'Unable to Create Directory: '.$path.$dir;
						return;
					}

					@chmod($path.$dir, 0777);
				}

				$path .= $dir.'/';
			}
		}

		if ($this->is_really_writable($path) === FALSE)
		{
			$this->errors[] = 'Cache Directory is Not Writable: '.$path;
			return FALSE;
		}

		/** --------------------------------------------
		/**  Retrieve Our URL
		/** --------------------------------------------*/

		$this->remote_data = $this->fetch_url($url);

		if ($this->remote_data == '')
		{
			$this->errors[] = 'Unable to Retrieve URL: '.$url;
			return FALSE;
		}

		/** --------------------------------------------
		/**  Write Cache File
		/** --------------------------------------------*/

		if ( ! $this->write_file($file_path, $this->remote_data))
		{
			$this->errors[] = 'Unable to Write File to Cache';
			return FALSE;
		}

		return TRUE;
	}
	/* END retrieve_remote_file() */


	// --------------------------------------------------------------------

	/**
	 * Fetch the Data for a URL
	 *
	 * @access	public
	 * @param	string			$url - The URI that we are fetching
	 * @param	array			$post - The POST array we are sending
	 * @param	string|bool		$username - Possible username required
	 * @param	string|bool		$password - Password to go with the username
	 * @return	string
	 */

	public function fetch_url ($url, $post = array(), $username = FALSE, $password = FALSE)
	{
		$data = '';

		$user_agent = ini_get('user_agent');

		if ( empty($user_agent))
		{
			$user_agent = $this->class_name.'/1.0';
		}

		/** --------------------------------------------
		/**  file_get_contents()
		/** --------------------------------------------*/

		if ((bool) @ini_get('allow_url_fopen') !== FALSE && empty($post) && $username == FALSE)
		{
			$opts = array('http'	=> array('header' => "User-Agent:".$user_agent."\r\n"),
						  'https'	=> array('header' => "User-Agent:".$user_agent."\r\n"));

			$context = stream_context_create($opts);

			if ($data = @file_get_contents($url, FALSE, $context))
			{
				return $data;
			}
		}

		/** --------------------------------------------
		/**  cURL
		/** --------------------------------------------*/

		if (function_exists('curl_init') === TRUE AND ($ch = @curl_init()) !== FALSE)
		{
			curl_setopt($ch, CURLOPT_URL, $url);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
			curl_setopt($ch, CURLOPT_USERAGENT, $user_agent);

			// prevent a PHP warning on certain servers
			if (! ini_get('safe_mode') AND ! ini_get('open_basedir'))
			{
				curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
			}

			//	Are we posting?
			if ( ! empty( $post ) )
			{
				$str	= '';

				foreach ( $post as $key => $val )
				{
					$str	.= urlencode( $key ) . "=" . urlencode( $val ) . "&";
				}

				$str	= substr( $str, 0, -1 );

				curl_setopt( $ch, CURLOPT_POST, TRUE );
				curl_setopt( $ch, CURLOPT_POSTFIELDS, $str );
			}

			curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
			curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
			curl_setopt($ch, CURLOPT_TIMEOUT, 15);
			curl_setopt($ch, CURLOPT_HEADER, FALSE);
			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);

			if ($username != FALSE)
			{
				curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
				if (defined('CURLOPT_HTTPAUTH')) curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC | CURLAUTH_DIGEST);
			}

			$data = curl_exec($ch);
			curl_close($ch);

			if ($data !== FALSE)
			{
				return $data;
			}
		}

		// --------------------------------------------
		//  fsockopen() - Last but only slightly least...
		// --------------------------------------------

		$parts	= parse_url($url);
		$host	= $parts['host'];
		$path	= (!isset($parts['path'])) ? '/' : $parts['path'];
		$port	= ($parts['scheme'] == "https") ? '443' : '80';
		$ssl	= ($parts['scheme'] == "https") ? 'ssl://' : '';

		if (isset($parts['query']) AND $parts['query'] != '')
		{
			$path .= '?'.$parts['query'];
		}

		$data = '';

		$fp = @fsockopen($ssl.$host, $port, $error_num, $error_str, 7);

		if (is_resource($fp))
		{
			$getpost	= ( ! empty( $post ) ) ? 'POST ': 'GET ';

			fputs($fp, $getpost.$path." HTTP/1.0\r\n" );
			fputs($fp, "Host: ".$host . "\r\n" );

			if ( ! empty( $post ) )
			{
				$str	= '';

				foreach ( $post as $key => $val )
				{
					$str	.= urlencode( $key ) . "=" . urlencode( $val ) . "&";
				}

				$str	= substr( $str, 0, -1 );

				fputs($fp, "Content-type: application/x-www-form-urlencoded\r\n");
				fputs($fp, "Content-length: " . strlen( $str ) . "\r\n");
			}

			fputs($fp,  "User-Agent: ".$user_agent."r\n");

			if ($username != FALSE)
			{
				fputs ($fp, "Authorization: Basic ".base64_encode($username.':'.$password)."\r\n");
			}

			fputs($fp, "Connection: close\r\n\r\n");

			if ( ! empty( $post ) )
			{
				fputs($fp, $str . "\r\n\r\n");
			}

			/* ------------------------------
			/*  This error suppression has to do with a PHP bug involving
			/*  SSL connections: http://bugs.php.net/bug.php?id=23220
			/* ------------------------------*/

			$old_level = error_reporting(0);

			$headers = '';

			while ( ! feof($fp))
			{
				$bit = fgets($fp, 128);

				$headers .= $bit;

				if(preg_match("/^\r?\n$/", $bit)) break;
			}

			while ( ! feof($fp))
			{
				$data .= fgets($fp, 128);
			}

			error_reporting($old_level);

			fclose($fp);
		}

		return trim($data);
	}
	/* END fetch_url() */


	// --------------------------------------------------------------------

	/**
	 * Write File
	 *
	 * @access	public
	 * @param	$file	Full location of final file
	 * @param	$data	Data to put into file
	 * @return	bool
	 */

	function write_file ($file, $data)
	{
		$temp_file = $file.'.tmp';

		if ( ! file_exists($temp_file))
		{
			// Remove old cache file, prevents rename problem on Windows
			// http://bugs.php.net/bug.php?id=44805

			@unlink($file);

			if (file_exists($file))
			{
				$this->errors[] = "Unable to Delete Old Cache File: ".$file;
				return FALSE;
			}

			if ( ! $fp = @fopen($temp_file, 'wb'))
			{
				$this->errors[] = "Unable to Write Temporary Cache File: ".$temp_file;
				return FALSE;
			}

			if ( ! flock($fp, LOCK_EX | LOCK_NB))
			{
				$this->errors[] = "Locking Error when Writing Cache File";
				return FALSE;
			}

			fwrite($fp, $data);
			flock($fp, LOCK_UN);
			fclose($fp);

			// Write, then rename...
			@rename($temp_file, $file);

			// Double check permissions
			@chmod($file, 0777);

			// Just in case the rename did not work
			@unlink($temp_file);
		}

		return TRUE;
	}
	/* END write_file() */


	// --------------------------------------------------------------------

	/**
	 * Check that File is Really Writable, Even on Windows
	 *
	 * is_writable() returns TRUE on Windows servers when you really cannot write to the file
	 * as the OS reports to PHP as FALSE only if the read-only attribute is marked.  Ugh!
	 *
	 * Oh, and there is some silly thing with
	 *
	 * @access	public
	 * @param	string		$path	- Path to be written to.
	 * @param	bool		$remove	- If writing a file, remove it after testing?
	 * @return	bool
	 */


	public function is_really_writable ($file, $remove = FALSE)
	{
		// is_writable() returns TRUE on Windows servers
		// when you really can't write to the file
		// as the OS reports to PHP as FALSE only if the
		// read-only attribute is marked.  Ugh?

		if (substr($file, -1) == '/' OR is_dir($file))
		{
			return self::is_really_writable(rtrim($file, '/').'/'.uniqid(mt_rand()), TRUE);
		}

		if (($fp = @fopen($file, 'ab')) === FALSE)
		{
			return FALSE;
		}
		else
		{
			if ($remove === TRUE)
			{
				@unlink($file);
			}

			fclose($fp);
			return TRUE;
		}
	}
	/* END is_really_writable() */


	// --------------------------------------------------------------------

	/**
	 *	Check Captcha
	 *
	 *	If Captcha is required by a module, we simply do all the work
	 *
	 *	@access		public
	 *	@return		bool
	 */

	public function check_captcha ()
	{
		if ( ee()->config->item('captcha_require_members') == 'y'  OR
			(ee()->config->item('captcha_require_members') == 'n' AND
			 ee()->session->userdata['member_id'] == 0))
		{
			if ( empty($_POST['captcha']))
			{
				return FALSE;
			}
			else
			{
				$res = ee()->db->query(
					"SELECT COUNT(*) AS count
					 FROM 	exp_captcha
					 WHERE  word = '" . ee()->db->escape_str($_POST['captcha']) . "'
					 AND 	ip_address = '" . ee()->db->escape_str(ee()->input->ip_address()) . "'
					 AND 	date > UNIX_TIMESTAMP()-7200"
				);

				if ($res->row('count') == 0)
				{
					return FALSE;
				}

				ee()->db->query(
					"DELETE FROM exp_captcha
					 WHERE 		(
						word = '" . ee()->db->escape_str($_POST['captcha']) . "'
						AND ip_address = '" . ee()->db->escape_str(ee()->input->ip_address()) . "'
					 )
					 OR 	date < UNIX_TIMESTAMP()-7200"
				);
			}
		}

		return TRUE;
	}
	// END check_captcha()


	// --------------------------------------------------------------------

	/**
	 *	Check Secure Forms
	 *
	 *	Checks to see if Secure Forms is enabled, and if so sees if the submitted hash is valid
	 *
	 *	@access		public
	 *	@return		bool
	 */

	public function check_secure_forms ()
	{
		//	----------------------------------------
		//	 Secure forms?
		//	----------------------------------------

		if ( ee()->config->item('secure_forms') == 'y' )
		{
			if ( ! isset($_POST['XID']) AND ! isset($_GET['XID']))
			{
				return FALSE;
			}

			$hash = (isset($_POST['XID'])) ? $_POST['XID'] : $_GET['XID'];

			$query = ee()->db->query(
				"SELECT COUNT(*) AS count
				 FROM 	exp_security_hashes
				 WHERE  hash = '" . ee()->db->escape_str($hash) . "'
				 AND 	ip_address = '" . ee()->db->escape_str(ee()->input->ip_address()) . "'
				 AND 	date > UNIX_TIMESTAMP()-7200"
			);

			if ($query->row('count') == 0)
			{
				return FALSE;
			}

			ee()->db->query(
				"DELETE FROM exp_security_hashes
				 WHERE (
					hash = '" . ee()->db->escape_str($hash) . "'
					AND ip_address = '" . ee()->db->escape_str(ee()->input->ip_address()) . "'
				 )
				 OR date < UNIX_TIMESTAMP()-7200"
			);
		}

		//	----------------------------------------
		//	 Return
		//	----------------------------------------

		return TRUE;
	}
	// END check_secure_forms()


	// --------------------------------------------------------------------

	//depricated. please instead include in your view headers.
	//uncompressed is available in svn
	//this is due to be moved into addon view folders

	/**
	 * A Slightly More Flexible Magic Checkbox
	 *
	 * Toggles the checkbox based on clicking anywhere in the table row that contains the checkbox
	 * Also allows multiple master toggle checkboxes at the top and bottom of a table to de/select all checkboxes
	 *		- give them a name="toggle_all_checkboxes" attribute
	 *		- No longer need to add onclick="toggle(this);" attribute
	 * No longer do you have to give your <form> tag an id="target" attrbiute, you can specify your own ID:
	 *		- <script type="text/javascript">create_magic_checkboxes('delete_cached_uris_form');</script>
	 *		- Or, if you specify no ID, it will find every <table> in the document with a class of
	 *		'magic_checkbox_table' and create the magic checkboxes automatically
	 * Also, it fixes that annoying problem where it was very difficult to easily select text in a row.
	 *
	 *
	 * @access	public
	 * @return	string
	 */

	function js_magic_checkboxes ()
	{
		return <<< EOT
<script type="text/javascript">
var lastCheckedBox="";
function create_magic_checkboxes(d){if(typeof d=="undefined"){var k=document.getElementsByTagName("table");for(d=0;d<k.length;d++)if(k[d].className.indexOf("magic_checkbox_table")>-1||k[d].className.indexOf("magicCheckboxTable")>-1)create_magic_checkboxes(k[d])}else{if(typeof d=="object")var l=d;else if(typeof d=="string"){if(!document.getElementById(d))return;l=document.getElementById(d)}else return;k=l.getElementsByTagName("tr");for(d=0;d<k.length;d++)for(var c=0;c<2;c++)for(var g=c==1?"th":"td",
h=k[d].getElementsByTagName(g),m=0;m<h.length;m++)h[m].onclick=function(e){e=e?e:window.event?window.event:"";var a=e.target||e.srcElement,i=a.tagName?a.tagName.toLowerCase():null;if(i==null){a=a.parentNode;i=a.tagName?a.tagName.toLowerCase():null}if(i!="a"&&i!=null){for(;a.tagName.toLowerCase()!="tr";){a=a.parentNode;if(a.tagName.toLowerCase()=="a")return}for(var f=a.getElementsByTagName(g),b=a.getElementsByTagName("input"),n=false,o=false,j=0;j<b.length;j++)if(b[j].type=="checkbox"){if(b[j].name==
"toggle_all_checkboxes")o=true;else n=b[j].id;break}if(!(n==false&&o==false))if(o==true){if(i=="input"){selectAllVal=b[j].checked?true:false;e=l.getElementsByTagName("tr");b=l.getElementsByTagName("input");for(j=0;j<b.length;j++)if(b[j].type=="checkbox")b[j].checked=selectAllVal;for(a=1;a<e.length;a++){f=e[a].getElementsByTagName(g);for(b=0;b<f.length;b++)f[b].className=selectAllVal==true?f[b].className.indexOf("tableCellOne")>-1?"tableCellOneHover":"tableCellTwoHover":f[b].className.indexOf("tableCellTwo")>
-1?"tableCellTwo":"tableCellOne"}}}else{if(i!="input")document.getElementById(n).checked=document.getElementById(n).checked?false:true;if(window.getSelection||document.selection&&document.selection.createRange){b=window.getSelection?window.getSelection().toString():document.selection.createRange().text;if(b!=""&&b.replace(/<\/?[^>]+(>|$)/g,"").replace(/\s*/g,"")=="")if(document.getSelection)window.getSelection().removeAllRanges();else document.selection?document.selection.empty():document.getElementById(n).focus()}for(b=
0;b<f.length;b++)f[b].className=document.getElementById(n).checked==true?f[b].className.indexOf("tableCellTwo")>-1?"tableCellTwoHover":"tableCellOneHover":f[b].className.indexOf("tableCellOne")>-1?"tableCellOne":"tableCellTwo";e.shiftKey&&lastCheckedBox!=""&&shift_magic_checkbox(document.getElementById(n).checked,lastCheckedBox,a);lastCheckedBox=a}}}}}
function shift_magic_checkbox(d,k,l){var c=l.parentNode,g=c.tagName?c.tagName.toLowerCase():null;if(g==null){c=c.parentNode;g=c.tagName?c.tagName.toLowerCase():null}if(g!=null){for(;c.tagName.toLowerCase()!="table";)c=c.parentNode;c=c.getElementsByTagName("tr");g=false;for(var h=1;h<c.length;h++)if(!(g==false&&c[h]!=k&&c[h]!=l))for(var m=0;m<2;m++){var e=m==1?"th":"td";e=c[h].getElementsByTagName(e);for(var a=c[h].getElementsByTagName("input"),i=false,f=0;f<a.length;f++)if(a[f].type=="checkbox")i=
a[f].id;if(i==false||i=="")return;document.getElementById(i).checked=d;for(a=0;a<e.length;a++)e[a].className=d==true?e[a].className.indexOf("tableCellTwo")>-1?"tableCellTwoHover":"tableCellOneHover":e[a].className.indexOf("tableCellOne")>-1?"tableCellOne":"tableCellTwo";if(c[h]==k||c[h]==l){if(g==true)break;if(g==false)g=true}}}};
</script>
EOT;
	}
	/* END js_magic_checkboxes() */



	// --------------------------------------------------------------------

	/**
	 * Balance a URI
	 *
	 * @access	public
	 * @param	string	$uri
	 * @return	array
	 */

	public function balance_uri ( $uri )
	{
		$uri = '/'.trim($uri, '/').'/';

		if ($uri == '//' OR $uri == '')
		{
			$uri = '/';
		}

		return $uri;
	}
	/* END balance_uri() */


	// --------------------------------------------------------------------

	/**
	 * Fetch Themes for a path
	 *
	 * @access	public
	 * @param	string		$path - Absolute server path to theme directory
	 * @return	array
	 */

	public function fetch_themes ($path)
	{
		$themes = array();

		if ($fp = @opendir($path))
		{
			while (false !== ($file = readdir($fp)))
			{
				if (is_dir($path.$file) AND substr($file, 0, 1) != '.')
				{
					$themes[] = $file;
				}
			}

			closedir($fp);
		}

		sort($themes);

		return $themes;
	}
	/* END fetch_themes() */


	// --------------------------------------------------------------------

	/**
	 * Allowed Group
	 *
	 * Member access validation
	 *
	 * @access	public
	 * @param	string
	 * @return	bool
	 */
	public function allowed_group ($which = '')
	{
		if ( is_object(ee()->cp))
		{
			return ee()->cp->allowed_group($which);
		}
		else
		{
			return ee()->display->allowed_group($which);
		}
	}
	/* END allowed_group() */


	// --------------------------------------------------------------------

	/**
	 * Global Error Message Routine
	 *
	 * @access	public
	 * @param	string
	 * @return	bool
	 */
	public function show_error ($which = '')
	{
		if ( function_exists('show_error'))
		{
			show_error($which);
		}
		else
		{
			ee()->display->error_message($which);
		}
	}
	/* END error_message() */

	// --------------------------------------------------------------------

	/**
	 *	Check if Submitted String is a Yes value
	 *
	 *	If the value is 'y', 'yes', 'true', or 'on', then returns TRUE, otherwise FALSE
	 *
	 *	@access		public
	 *	@param		string
	 *	@return		bool
	 */

	function check_yes ($which)
	{
		if (is_string($which))
		{
			$which = strtolower(trim($which));
		}

		return in_array($which, array('yes', 'y', 'true', 'on'), TRUE);
	}
	/* END check_yes() */

	// --------------------------------------------------------------------

	/**
	 *	Check if Submitted String is a No value
	 *
	 *	If the value is 'n', 'no', 'false', or 'off', then returns TRUE, otherwise FALSE
	 *
	 *	@access		public
	 *	@param		string
	 *	@return		bool
	 */

	function check_no ($which)
	{
		if (is_string($which))
		{
			$which = strtolower(trim($which));
		}

		return in_array($which, array('no', 'n', 'false', 'off'), TRUE);
	}
	/* END check_yes() */


	// --------------------------------------------------------------------

	/**
	 *	json_encode
	 *
	 *	@access		public
	 *	@param		object
	 *	@return		string
	 */

	public function json_encode ($data)
	{
		if (function_exists('json_encode'))
		{
			return json_encode($data);
		}

		if ( ! class_exists('Services_JSON'))
		{
			require_once $this->aob_path . 'json.php';
		}

		if ( ! is_object($this->json))
		{
			$this->json = new Services_JSON();
		}

		return $this->json->encode($data);
	}
	/* END json_encode() */


	// --------------------------------------------------------------------

	/**
	 *	json_decode
	 *
	 *	@access		public
	 *	@param		string
	 *	@param		bool		$associative - By default JSON decode returns object, this forces an array
	 *	@return		object
	 */

	public function json_decode ($data, $associative = FALSE)
	{
		if (function_exists('json_decode'))
		{
			return json_decode($data, $associative);
		}

		if ( ! class_exists('Services_JSON'))
		{
			require_once $this->aob_path . 'json.php';
		}

		if ( $associative == TRUE)
		{
			if ( ! is_object($this->json_array))
			{
				$this->json_array = new Services_JSON(SERVICES_JSON_LOOSE_TYPE);
			}

			return $this->json_array->decode($data);
		}
		else
		{
			if ( ! is_object($this->json))
			{
				$this->json = new Services_JSON();
			}

			return $this->json->decode($data);
		}
	}
	// END json_decode()


	// --------------------------------------------------------------------

	/**
	 *	Pagination for all versions front-end and back
	 *
	 *	* = optional
	 *	$input_data = array(
	 *		'sql'					=> '',
	 *		'total_results'			=> '',
	 *		*'url_suffix' 			=> '',
	 *		'tagdata'				=> ee()->TMPL->tagdata,
	 *		'limit'					=> '',
	 *		*'offset'				=> ee()->TMPL->fetch_param('offset'),
	 *		*'query_string_segment'	=> 'P',
	 *		'uri_string'			=> ee()->uri->uri_string,
	 *		*'current_page'			=> 0
	 *		*'pagination_config'	=> array()
	 *	);
	 *
	 *	@access		public
	 *	@param		array
	 *	@return		array
	 */

	public function universal_pagination ( $input_data )
	{
		// -------------------------------------
		//	prep input data
		// -------------------------------------

		//set defaults for optional items
		$input_defaults	= array(
			'url_suffix' 			=> '',
			'query_string_segment' 	=> 'P',
			'offset'				=> 0,
			'pagination_page'		=> 0,
			'pagination_config'		=> array(),
			'sql'					=> '',
			'tagdata'				=> '',
			'uri_string'			=> '',
			'paginate_prefix'		=> '',
			'prefix'				=> '',
			'total_results'			=> 0,
			'request'				=> REQ,
			'auto_paginate'			=> FALSE
		);

		//array2 overwrites any duplicate key from array1
		$input_data 					= array_merge($input_defaults, $input_data);

		// -------------------------------------
		//	using the prefix? well, lets use it like the old. Stupid legacy
		// -------------------------------------

		if (trim($input_data['prefix']) !== '')
		{
			//allowing ':' in a prefix
			if (substr($input_data['prefix'], -1, 1) !== ':')
			{
				$input_data['prefix'] = rtrim($input_data['prefix'], '_') . '_';
			}

			$input_data['paginate_prefix'] = $input_data['prefix'];
		}

		//using query strings?
		//technically, ACT is the same here, but ACT is not for templates :p
		$use_query_strings 				= (
			REQ == 'CP' OR
			$input_data['request'] == 'CP' OR
			ee()->config->item('enable_query_strings')
		);

		//make sure there is are surrounding slashes.
		$input_data['uri_string']		= '/' . trim($input_data['uri_string'], '/') . '/';

		//shortcuts
		$config							= $input_data['pagination_config'];
		$p								= $input_data['query_string_segment'];
		$config['query_string_segment'] = $input_data['query_string_segment'];
		$config['page_query_string']	= $use_query_strings;

		//need the prefix so our segments are like /segment/segment/P10
		//instead of like /segment/segment/10
		//this only works in EE 2.x because CI 1.x didn't have the prefix
		//a hack later in the code makes this work for EE 1.x
		if (REQ == 'PAGE')
		{
			$config['prefix'] = $config['query_string_segment'];
		}

		//current page
		if ( ! $use_query_strings AND preg_match("/$p(\d+)/s", $input_data['uri_string'], $match) )
		{
			if ( $input_data['pagination_page'] == 0 AND is_numeric($match[1]) )
			{
				$input_data['pagination_page'] 	= $match[1];

				//remove page from uri string, query_string, and uri_segments
				$input_data['uri_string'] 		= ee()->functions->remove_double_slashes(
					str_replace($p . $match[1] , '', $input_data['uri_string'] )
				);
			}
		}
		else if ( $use_query_strings === FALSE)
		{
			if ( ! is_numeric($input_data['pagination_page']) )
			{
				$input_data['pagination_page'] = 0;
			}
		}
		else if ( ! in_array(
			ee()->input->get_post($input_data['query_string_segment']),
			array(FALSE, '')
		))
		{
			$input_data['pagination_page'] = ee()->input->get_post($input_data['query_string_segment']);
		}

		// --------------------------------------------
		//  Automatic Total Results
		// --------------------------------------------

		if ( empty($input_data['total_results']) AND
			 ! empty($input_data['sql'])
		)
		{
			$query = ee()->db->query(
				preg_replace(
					"/SELECT(.*?)\s+FROM\s+/is",
					'SELECT COUNT(*) AS count FROM ',
					$input_data['sql'],
					1
				)
			);

			$input_data['total_results'] = $query->row('count');
		}

		//this prevents the CI pagination class from
		//trying to find the number itself...
		$config['uri_segment'] = 0;

		// -------------------------------------
		//	prep return data
		// -------------------------------------

		$return_data 	= array(
			'paginate'				=> FALSE,
			'paginate_tagpair_data'	=> '',
			'current_page'			=> 0,
			'total_pages'			=> 0,
			'total_results'			=> $input_data['total_results'],
			'page_count'			=> '',
			'pagination_links'		=> '',
			'pagination_array'		=> '', //2.3.0+
			'base_url'				=> '',
			'page_next'				=> '',
			'page_previous'			=> '',
			'pagination_page'		=> $input_data['pagination_page'],
			'tagdata'				=> $input_data['tagdata'],
			'sql'					=> $input_data['sql'],
		);

		// -------------------------------------
		//	Begin pagination check
		// -------------------------------------

		if (REQ == 'CP' OR
			$input_data['request'] == 'CP' OR
			(
				strpos(
					$return_data['tagdata'],
					LD . $input_data['paginate_prefix'] . 'paginate'
				) !== FALSE
				OR
				strpos(
					$return_data['tagdata'],
					LD . 'paginate'
				) !== FALSE
			)
		)
		{
			$return_data['paginate'] = TRUE;

			// -------------------------------------
			//	If we have prefixed pagination tags,
			//	lets do those first
			// -------------------------------------

			if ($input_data['paginate_prefix'] != '' AND preg_match(
					"/" . LD . $input_data['paginate_prefix'] . "paginate" . RD .
						"(.+?)" .
					LD . preg_quote(T_SLASH, '/') .
						$input_data['paginate_prefix'] . "paginate" .
					RD . "/s",
					$return_data['tagdata'],
					$match
				))
			{
				$return_data['paginate_tagpair_data']	= $match[1];
				$return_data['tagdata'] 				= str_replace(
					$match[0],
					'',
					$return_data['tagdata']
				);
			}
			//else lets check for normal pagination tags
			else if (preg_match(
					"/" . LD . "paginate" . RD .
						"(.+?)" .
					LD . preg_quote(T_SLASH, '/') . "paginate" . RD . "/s",
					$return_data['tagdata'],
					$match
				))
			{
				$return_data['paginate_tagpair_data']	= $match[1];
				$return_data['tagdata'] 				= str_replace(
					$match[0],
					'',
					$return_data['tagdata']
				);
			}

			// ----------------------------------------
			//  Calculate total number of pages
			// ----------------------------------------

			$return_data['current_page'] 	= floor(
				$input_data['pagination_page'] / $input_data['limit']
			) + 1;

			$return_data['total_pages']		= ceil(
				($input_data['total_results'] - $input_data['offset']) / $input_data['limit']
			);

			$return_data['page_count'] 		= lang('page') 		. ' ' .
											  $return_data['current_page'] 	. ' ' .
											  lang('of') 		. ' ' .
											  $return_data['total_pages'];

			// ----------------------------------------
			//  Do we need pagination?
			// ----------------------------------------

			if ( ($input_data['total_results'] - $input_data['offset']) > $input_data['limit'] )
			{
				if ( ! isset( $config['base_url'] )  )
				{
					$config['base_url']			= ee()->functions->create_url(
						$input_data['uri_string'] . $input_data['url_suffix'],
						FALSE,
						0
					);
				}

				$config['total_rows'] 	= ($input_data['total_results'] - $input_data['offset']);
				$config['per_page']		= $input_data['limit'];
				$config['cur_page']		= $input_data['pagination_page'];

				if (APP_VER >= '2.3.0')
				{
					$config['first_link'] 	= lang('pag_first_link');
					$config['last_link'] 	= lang('pag_last_link');
				}

				ee()->load->library('pagination');

				ee()->pagination->initialize($config);

				$return_data['pagination_links'] = ee()->pagination->create_links();

				//2.3.0+ supports pagination array
				//create_link_array must be called second after create_links
				//or weird things happen
				if (APP_VER >= '2.3.0')
				{
					$return_data['pagination_array'] = ee()->pagination->create_link_array();
				}

				$return_data['base_url'] = ee()->pagination->base_url;

				//CI 1.x pagination does not have the
				//prefix variable so we have to use this hack
				//to turn /segment/segment/10/ into /segment/segment/P10/
				//where P is $p
				if (APP_VER < 2.0 AND ! $use_query_strings )
				{
					$return_data['pagination_links']		= preg_replace(
						"/" . preg_quote($return_data['base_url'], '/') .
										"([0-9]+)(?:" . preg_quote(T_SLASH, '/') . ")?/s",
						rtrim( $return_data['base_url'] . $p . "$1", '/') . '/',
						$return_data['pagination_links']
					);
				}

				// ----------------------------------------
				//  Prepare next_page and previous_page variables
				// ----------------------------------------

				//next page?
				if ( (($return_data['total_pages'] * $input_data['limit']) - $input_data['limit']) >
					 $return_data['pagination_page'])
				{
					$return_data['page_next'] = $return_data['base_url'] .
						($use_query_strings ? '' : $p) .
						($input_data['pagination_page'] + $input_data['limit']) . '/';
				}

				//previous page?
				if (($return_data['pagination_page'] - $input_data['limit'] ) >= 0)
				{
					$return_data['page_previous'] = $return_data['base_url'] .
						($use_query_strings ? '' : $p) .
						($input_data['pagination_page'] - $input_data['limit']) . '/';
				}
			}
		}

		//move current page to offset
		//$return_data['current_page'] += $input_data['offset'];

		//add limit to passed in sql
		$return_data['sql'] .= 	' LIMIT ' .
			($return_data['pagination_page'] + $input_data['offset']) .
			', ' . $input_data['limit'];

		//if we are automatically making magic, lets add all of the class vars
		if ($input_data['auto_paginate'] === TRUE)
		{
			$this->auto_paginate	= TRUE;
			$this->paginate			= $return_data['paginate'];
			$this->page_next		= $return_data['page_next'];
			$this->page_previous	= $return_data['page_previous'];
			$this->p_page			= $return_data['pagination_page'];
			$this->current_page  	= $return_data['current_page'];
			$this->pagination_links	= $return_data['pagination_links'];
			$this->pagination_array	= $return_data['pagination_array'];
			$this->basepath			= $return_data['base_url'];
			$this->total_pages		= $return_data['total_pages'];
			$this->paginate_data	= $return_data['paginate_tagpair_data'];
			$this->page_count		= $return_data['page_count'];
			//ee()->TMPL->tagdata	= $return_data['tagdata'];
		}

		return $return_data;
	}
	//	End universal_pagination


	// --------------------------------------------------------------------

	/**
	 * Universal Parse Pagination
	 *
	 * This creates a new XID hash in the DB for usage.
	 *
	 * @access	public
	 * @param 	array
	 * @return	tagdata
	 */

	public function parse_pagination ($options = array())
	{
		// -------------------------------------
		//	prep input data
		// -------------------------------------

		//set defaults for optional items
		$defaults	= array(
			'prefix' 			=> '',
			'tagdata' 			=> ((isset(ee()->TMPL) and is_object(ee()->TMPL)) ?
									ee()->TMPL->tagdata : ''),
			'paginate'  		=> FALSE,
			'page_next' 		=> '',
			'page_previous' 	=> '',
			'p_page' 			=> 0,
			'current_page' 		=> 0,
			'pagination_links' 	=> '',
			'pagination_array'	=> '',
			'basepath' 			=> '',
			'total_pages' 		=> '',
			'paginate_data' 	=> '',
			'page_count' 		=> '',
			'auto_paginate' 	=> $this->auto_paginate
		);

		//array2 overwrites any duplicate key from array1
		$options = array_merge($defaults, $options);

		// -------------------------------------
		//	auto paginate?
		// -------------------------------------

		if ($options['auto_paginate'])
		{
			$options = array_merge($options, array(
				'paginate'  		=> $this->paginate,
				'page_next' 		=> $this->page_next,
				'page_previous' 	=> $this->page_previous,
				'p_page' 			=> $this->p_page,
				'current_page' 		=> $this->current_page,
				'pagination_links' 	=> $this->pagination_links,
				'pagination_array'	=> $this->pagination_array,
				'basepath' 			=> $this->basepath,
				'total_pages' 		=> $this->total_pages,
				'paginate_data' 	=> $this->paginate_data,
				'page_count' 		=> $this->page_count,
			));
		}

		// -------------------------------------
		//	prefixed items?
		// -------------------------------------

		$prefix = '';

		if (trim($options['prefix']) != '')
		{
			//allowing ':' in a prefix
			if (substr($options['prefix'], -1, 1) !== ':')
			{
				$options['prefix'] = rtrim($options['prefix'], '_') . '_';
			}

			$prefix = $options['prefix'];
		}

		$tag_paginate			= $prefix . 'paginate';
		$tag_pagination_links	= $prefix . 'pagination_links';
		$tag_current_page		= $prefix . 'current_page';
		$tag_total_pages		= $prefix . 'total_pages';
		$tag_page_count			= $prefix . 'page_count';
		$tag_previous_page		= $prefix . 'previous_page';
		$tag_next_page			= $prefix . 'next_page';
		$tag_auto_path			= $prefix . 'auto_path';
		$tag_path				= $prefix . 'path';

		// -------------------------------------
		//	TO VARIABLES!
		// -------------------------------------

		extract($options);

		// ----------------------------------------
		//	no paginate? :(
		// ----------------------------------------

		if ( $paginate === FALSE )
		{
			return ee()->functions->prep_conditionals(
				$tagdata,
				array($tag_paginate => FALSE)
			);
		}

		// -------------------------------------
		//	replace {if (prefix_)paginate} blocks
		// -------------------------------------

		$tagdata = ee()->functions->prep_conditionals(
			$tagdata,
			array($tag_paginate => TRUE)
		);

		// -------------------------------------
		//	count and link conditionals
		// -------------------------------------

		$pagination_items = array(
			$tag_pagination_links	=> $pagination_links,
			$tag_current_page		=> $current_page,
			$tag_total_pages		=> $total_pages,
			$tag_page_count			=> $page_count
		);

		// -------------------------------------
		//	ee 2.3 pagination array?
		// -------------------------------------

		if (APP_VER >= '2.3.0' AND $pagination_array)
		{
			// Check to see if pagination_links is being used as a single
			// variable or as a variable pair
			if (preg_match_all(
					"/" . LD . $tag_pagination_links . RD .
						"(.+?)" .
					LD . '\/' . $tag_pagination_links . RD . "/s",
					$paginate_data,
					$matches
				))
			{
				// Parse current_page and total_pages
				$paginate_data = ee()->TMPL->parse_variables(
					$paginate_data,
					array(array($tag_pagination_links => array($pagination_array)))
				);
			}
		}

		// -------------------------------------
		//	parse everything left
		// -------------------------------------

		$paginate_data	= ee()->functions->prep_conditionals(
			$paginate_data,
			$pagination_items
		);

		// -------------------------------------
		//	if this is EE 2.3+, we need to parse the pagination
		//	tag pair before we str_replace
		// -------------------------------------

		foreach ( $pagination_items as $key => $val )
		{
			$paginate_data	= str_replace(
				LD . $key . RD,
				$val,
				$paginate_data
			);
		}

		// ----------------------------------------
		//	Previous link
		// ----------------------------------------

		if (preg_match(
				"/" . LD . "if " . $tag_previous_page . RD .
					"(.+?)" .
				 LD . preg_quote(T_SLASH, '/') . "if" . RD . "/s",
				 $paginate_data,
				 $match
			))
		{
			if ($page_previous == '')
			{
				 $paginate_data = preg_replace(
					"/" . LD . "if " . $tag_previous_page . RD .
						".+?" .
					LD . preg_quote(T_SLASH, '/') . "if" . RD . "/s",
					'',
					$paginate_data
				);
			}
			else
			{
				$match['1'] 	= preg_replace(
					"/" . LD . $tag_path . '.*?' . RD . "/",
					$page_previous,
					$match['1']
				);

				$match['1'] 	= preg_replace(
					"/" . LD . $tag_auto_path . RD . "/",
					$page_previous,
					$match['1']
				);

				$paginate_data 	= str_replace(
					$match['0'],
					$match['1'],
					$paginate_data
				);
			}
		}

		// ----------------------------------------
		//	Next link
		// ----------------------------------------

		if (preg_match(
				"/" . LD . "if " . $tag_next_page . RD .
					"(.+?)" .
				LD . preg_quote(T_SLASH, '/') . "if" . RD . "/s",
				$paginate_data,
				$match
			))
		{
			if ($page_next == '')
			{
				$paginate_data = preg_replace(
					"/" . LD . "if " . $tag_next_page . RD .
						".+?" .
					LD . preg_quote(T_SLASH, '/') . "if" . RD . "/s",
					'',
					$paginate_data
				);
			}
			else
			{
				$match['1'] 	= preg_replace(
					"/" . LD . $tag_path . '.*?' . RD . "/",
					$page_next,
					$match['1']
				);

				$match['1'] 	= preg_replace(
					"/" . LD . $tag_auto_path . RD . "/",
					$page_next,
					$match['1']
				);

				$paginate_data 	= str_replace(
					$match['0'],
					$match['1'],
					$paginate_data
				);
			}
		}

		// ----------------------------------------
		//	Add pagination
		// ----------------------------------------

		if ( ee()->TMPL->fetch_param('paginate') == 'both' )
		{
			$tagdata	= $paginate_data . $tagdata . $paginate_data;
		}
		elseif ( ee()->TMPL->fetch_param('paginate') == 'top' )
		{
			$tagdata	= $paginate_data . $tagdata;
		}
		else
		{
			$tagdata	= $tagdata . $paginate_data;
		}

		// ----------------------------------------
		//	Return
		// ----------------------------------------

		return $tagdata;
	}
	//END parse_pagination


	// --------------------------------------------------------------------

	/**
	 * pagination_prefix_replace
	 * gets the tag group id from a number of places and sets it to the
	 * instance default param
	 *
	 * @access 	public
	 * @param 	string 	prefix for tag
	 * @param 	string 	tagdata
	 * @param 	bool 	reverse, are we removing the preixes we did before?
	 * @return	string 	tag data with prefix changed out
	 */

	public function pagination_prefix_replace ($prefix = '', $tagdata = '', $reverse = FALSE)
	{
		if ($prefix == '')
		{
			return $tagdata;
		}

		//allowing ':' in a prefix
		if (substr($prefix, -1, 1) !== ':')
		{
			$prefix = rtrim($prefix, '_') . '_';
		}

		//if there is nothing prefixed, we don't want to do anything datastardly
		if ( ! $reverse AND
			strpos($tagdata, LD.$prefix . 'paginate'.RD) === FALSE)
		{
			return $tagdata;
		}

		$hash 	= 'e2c518d61874f2d4a14bbfb9087a7c2d';

		$items 	= array(
			'paginate',
			'pagination_links',
			'current_page',
			'total_pages',
			'page_count',
			'previous_page',
			'next_page',
			'auto_path',
			'path'
		);

		$find 			= array();
		$hash_replace 	= array();
		$prefix_replace = array();

		$length = count($items);

		foreach ($items as $key => $item)
		{
			$nkey = $key + $length;

			//this is terse, but it ensures that we
			//find any an all tag pairs if they occur
			$find[$key] 			= LD . $item . RD;
			$find[$nkey] 			= LD . T_SLASH .  $item . RD;
			$hash_replace[$key] 	= LD . $hash . $item . RD;
			$hash_replace[$nkey] 	= LD . T_SLASH .  $hash . $item . RD;
			$prefix_replace[$key] 	= LD . $prefix . $item . RD;
			$prefix_replace[$nkey] 	= LD . T_SLASH .  $prefix . $item . RD;
		}

		//prefix standard and replace prefixs
		if ( ! $reverse)
		{
			$tagdata = str_replace($find, $hash_replace, $tagdata);
			$tagdata = str_replace($prefix_replace, $find, $tagdata);
		}
		//we are on the return, fix the hashed ones
		else
		{
			$tagdata = str_replace($hash_replace, $find, $tagdata);
		}

		return $tagdata;
	}
	//END pagination_prefix_replace


	// --------------------------------------------------------------------

	/**
	 * Create XID
	 *
	 * This creates a new XID hash in the DB for usage.
	 *
	 * @access	public
	 * @return	string
	 */

	public function create_xid ()
	{
		$sql 		= "INSERT INTO exp_security_hashes (date, ip_address, hash) VALUES";

		$hash 		= ee()->functions->random('encrypt');
		$sql 		.= "(UNIX_TIMESTAMP(), '". ee()->input->ip_address() . "', '" . $hash . "')";

		$this->cacheless_query($sql);

		return $hash;
	}
	// END Create XID


	// --------------------------------------------------------------------

	/**
	 * cacheless_query
	 *
	 * this sends a query to the db non-cached
	 *
	 * @access	public
	 * @param	string	sql to query
	 * @return	object	query object
	 */
	public function cacheless_query ($sql)
	{
		$reset = FALSE;

		// Disable DB caching if it's currently set

		if (ee()->db->cache_on == TRUE)
		{
			ee()->db->cache_off();
			$reset = TRUE;
		}

		$query = ee()->db->query($sql);

		// Re-enable DB caching
		if ($reset == TRUE)
		{
			ee()->db->cache_on();
		}

		return $query;
	}
	// END cacheless_query


	// --------------------------------------------------------------------

	/**
	 * Implodes an Array and Hashes It
	 *
	 * @access	public
	 * @return	string
	 */

	public function _imploder ($arguments)
	{
		return md5(serialize($arguments));
	}
	// END


	// --------------------------------------------------------------------

	/**
	 * Prepare keyed result
	 *
	 * Take a query object and return an associative array. If $val is empty,
	 * the entire row per record will become the value attached to the indicated key.
	 *
	 * For example, if you do a query on exp_channel_titles and exp_channel_data
	 * you can use this to quickly create an associative array of channel entry
	 * data keyed to entry id.
	 *
	 * @access	public
	 * @return	mixed
	 */

	public function prepare_keyed_result ( $query, $key = '', $val = '' )
	{
		if ( ! is_object( $query )  OR $key == '' ) return FALSE;

		// --------------------------------------------
		//  Loop through query
		// --------------------------------------------

		$data	= array();

		foreach ( $query->result_array() as $row )
		{
			if ( isset( $row[$key] ) === FALSE ) continue;

			$data[ $row[$key] ]	= ( $val != '' AND isset( $row[$val] ) ) ? $row[$val]: $row;
		}

		return ( empty( $data ) ) ? FALSE : $data;
	}
	// END prepare_keyed_result


	// --------------------------------------------------------------------

	/**
	 * returns the truthy or last arg i
	 *
	 * @access	public
	 * @param	array 	args to be checked against
	 * @param	mixed	bool or array of items to check against
	 * @return	mixed
	 */
	public function either_or_base ($args = array(), $test = FALSE)
	{
		foreach ($args as $arg)
		{
			//do we have an array of nots?
			//if so, we need to be test for type
			if ( is_array($test))
			{
				if ( ! in_array($arg, $test, TRUE) ) return $arg;
			}
			//is it implicit false?
			elseif ($test)
			{
				if ($arg !== FALSE) return $arg;
			}
			//else just test for falsy
			else
			{
				if ($arg) return $arg;
			}
		}

		return end($args);
	}
	//END either_or_base


	// --------------------------------------------------------------------

	/**
	 * returns the truthy or last arg
	 *
	 * @access	public
	 * @param	mixed	any number of arguments consisting of variables to be returned false
	 * @return	mixed
	 */
	public function either_or ()
	{
		$args = func_get_args();

		return $this->either_or_base($args);
	}
	//END either_or


	// --------------------------------------------------------------------

	/**
	 * returns the non exact bool FALSE or last arg
	 *
	 * @access	public
	 * @param	mixed	any number of arguments consisting of variables to be returned false
	 * @return	mixed
	 */
	public function either_or_strict ()
	{
		$args = func_get_args();

		return $this->either_or_base($args, TRUE);
	}
	// END either_or_strict


	//---------------------------------------------------------------------

	/**
	 * add_right_link
	 * @access	public
	 * @param	(string)	string of link name
	 * @param	(string)	html link for right link
	 * @return	(null)
	 */

	public function add_right_link ($text, $link)
	{
		//no funny business
		if (REQ != 'CP') return;

		$this->right_links[$text] = $link;
	}
	//end add_right_link


	//---------------------------------------------------------------------

	/**
	 * build_right_links
	 * @access	public
	 * @return	(null)
	 */

	public function build_right_links ()
	{
		//no funny business
		if (REQ != 'CP' OR empty($this->right_links)) return;

		if (APP_VER < 2.0)
		{
			$this->cached_vars['right_links'] = $this->right_links;
		}
		else
		{
			ee()->cp->set_right_nav($this->right_links);
		}
	}
	//end build_right_links


	// --------------------------------------------------------------------

	/**
	 *	Fetch List of Member Fields and Data
	 *
	 *	@access		public
	 *	@return		string
	 */

	public function mfields ()
	{
		return $this->mfields = $this->data->get_member_fields();
	}
	// END mfields()


	// --------------------------------------------------------------------

	/**
	 * do we have any hooks?
	 *
	 *
	 * @access	public
	 * @return	bool	Whether the extensions are allowed
	 */

	public function has_hooks ()
	{
		//is it there? is it array? is it empty? Such are life's unanswerable questions, until now.
		if ( ! $this->updater() OR
			 ((! isset($this->updater()->hooks) 	OR
			  ! is_array($this->updater->hooks))	AND
			 (! isset($this->hooks) 				OR
			  ! is_array($this->hooks))) 			OR
			 (empty($this->hooks) AND empty($this->updater->hooks))
		)
		{
			return FALSE;
		}

		return TRUE;
	}
	//end has hooks


	// --------------------------------------------------------------------

	/**
	 * loads updater object and sets it to $this->upd and returns it
	 *
	 *
	 * @access	public
	 * @return	obj		updater object for module
	 */

	public function updater ()
	{
		if ( ! is_object($this->updater) )
		{
			//why not use the app_ver constant here?
			//well its not available while in wizard

			$ee1_class 		= $this->class_name . '_updater';
			$ee2_class 		= $this->class_name . '_upd';

			$update_file 	= $this->addon_path . 'upd.' . $this->lower_name . '.php';

			if ( ! class_exists($ee1_class) AND
				 ! class_exists($ee2_class))
			{
				if (is_file($update_file))
				{
					require_once $update_file;
				}
				else
				{
					//techincally, this is false, but we dont want to halt something else because the
					//file cannot be found that we need here. Needs to be a better solution
					return FALSE;
				}
			}

			$class 			= class_exists($ee2_class) ? $ee2_class : $ee1_class;

			$this->updater	= new $class();
		}

		return $this->updater;
	}
	//end updater


	// --------------------------------------------------------------------

	/**
	 * Checks to see if extensions are enabled for this module
	 *
	 *
	 * @access	public
	 * @param	bool	match exact number of hooks
	 * @return	bool	Whether the extensions are enabled if need be
	 */

	public function extensions_enabled ( $check_all_enabled = FALSE )
	{
		if ( ! $this->has_hooks() ) return TRUE;
		//we don't want to end on this as it would confuse users
		if ( $this->updater() === FALSE )	return TRUE;

		$num_enabled = 0;

		foreach ($this->updater()->hooks as $hook_data)
		{
			if (isset(ee()->extensions->extensions[$hook_data['hook']]))
			{
				foreach(ee()->extensions->extensions[$hook_data['hook']] as $priority => $hook_array)
				{
					if (isset($hook_array[$this->extension_name]))
					{
						$num_enabled++;
					}
				}
			}
		}

		//we arent going to look for all of the hooks
		//because some could be turned off manually for testing
		return (($check_all_enabled) ?
					($num_enabled == count($this->updater()->hooks) ) :
					($num_enabled > 0) );
	}
	//END extensions_enabled


	// --------------------------------------------------------------------

	/**
	 * AJAX Request
	 *
	 * Tests via headers or GET/POST parameter whether the incoming
	 * request is AJAX in nature
	 * Useful when we want to change the output of a method.
	 *
	 * @access public
	 * @return boolean
	 */

	public function is_ajax_request ()
	{
		// --------------------------------------------
        //  Headers indicate this is an AJAX Request
        //	- They can disable via a parameter or GET/POST
        //	- If not, TRUE
        // --------------------------------------------

		if (ee()->input->server('HTTP_X_REQUESTED_WITH') === 'XMLHttpRequest')
		{
			// Check for parameter
			if (isset(ee()->TMPL) AND is_object(ee()->TMPL))
			{
				if (ee()->TMPL->fetch_param('ajax_request') !== FALSE &&
					$this->check_no(ee()->TMPL->fetch_param('ajax_request')))
				{
					return FALSE;
				}
			}

			// Check for GET/POST variable
			if (ee()->input->get_post('ajax_request') !== FALSE &&
				$this->check_no(ee()->input->get_post('ajax_request')))
			{
				return FALSE;
			}

			// Not disabled
			return TRUE;
		}

		// --------------------------------------------
        //  Headers do NOT indicate it is an AJAX Request
        //	- They can force with a parameter OR GET/POST variable
        //	- If not, FALSE
        // --------------------------------------------

		if (isset(ee()->TMPL) AND is_object(ee()->TMPL))
		{
			if ($this->check_yes(ee()->TMPL->fetch_param('ajax_request')))
			{
				return TRUE;
			}
		}

      	if ($this->check_yes(ee()->input->get_post('ajax_request')))
		{
			return TRUE;
		}

		return FALSE;
	}
	// END is_ajax_request()


	// --------------------------------------------------------------------

	/**
	 * Send AJAX response
	 *
	 * Outputs and exit either an HTML string or a
	 * JSON array with the Profile disabled and correct
	 * headers sent.
	 *
	 * @access	public
	 * @param	string|array	String is sent as HTML, Array is sent as JSON
	 * @param	bool			Is this an error message?
	 * @param 	bool 			bust cache for JSON?
	 * @return	void
	 */

	public function send_ajax_response ($msg, $error = FALSE, $cache_bust = TRUE)
	{
		ee()->output->enable_profiler(FALSE);

		if ($error === TRUE)
		{
			//ee()->output->set_status_header(500);
		}

		$send_headers = (ee()->config->item('send_headers') == 'y');

		//if this is an array or object, output json
		if (is_array($msg) OR is_object($msg))
		{
			if ($send_headers)
			{
				if ($cache_bust)
				{
					//cache bust
					@header('Cache-Control: no-cache, must-revalidate');
					@header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
				}

				@header('Content-Type: application/json');
			}

			echo $this->json_encode($msg);
		}
		else
		{
			if ($send_headers)
			{
				@header('Content-Type: text/html; charset=UTF-8');
			}

			echo (string) $msg;
		}

		exit();
	}
	//END send_ajax_response()


	// --------------------------------------------------------------------

	/**
	 *	Validate Emails
	 *
	 *	Validates an array or parses a string of emails and then validates
	 *
	 *	@access		public
	 *	@param		string|array
	 *	@return		array  $vars - Contains two keys good/bad of, what else, good and bad emails
	 */
	public function validate_emails ($emails)
	{
		ee()->load->helper('email');

		if ( is_string($emails))
		{
			// Remove all white space and replace with commas
			$email	= trim(preg_replace("/\s*(\S+)\s*/s", "\\1,", trim($emails)), ',');

			// Remove duplicate commas
			$email	= str_replace(',,', ',', $email);

			// Explode and make unique
			$emails	= array_unique(explode(",", $email));
		}

		$vars['good']	= array();
		$vars['bad']	= array();

		foreach($emails as $addr)
		{
			if (preg_match('/<(.*)>/', $addr, $match))
			{
				$addr = $match[1];
			}

			if ( ! valid_email($addr))
			{
				$vars['bad'][] = $addr;
				continue;
			}

			$vars['good'][] = $addr;
		}

		return $vars;
	}
	// END validate_emails();


	// --------------------------------------------------------------------

	/**
	 *	Get Action URL
	 *
	 * 	returns a full URL for an action
	 *
	 *	@access		public
	 *	@param		string method name
	 *	@return		string url for action
	 */

	public function get_action_url ($method_name)
	{
		$action_id 	= ee()->db->where(
			array(
				'class' 	=> $this->class_name,
				'method' 	=> $method_name
			)
		)->get('actions')->row('action_id');

		return ee()->functions->fetch_site_index(0, 0) . QUERY_MARKER . 'ACT=' . $action_id;
	}
	//END get_action_url


	// --------------------------------------------------------------------

	/**
	 * is_positive_intlike
	 *
	 * return
	 *
	 * (is_positive_entlike would have taken forever)
	 *
	 * @access 	public
	 * @param 	mixed 	num 		number/int/string to check for numeric
	 * @param 	int 	threshold 	lowest number acceptable (default 1)
	 * @return  bool
	 */

	public function is_positive_intlike ($num, $threshold = 1)
	{
		//without is_numeric, bools return positive
		//because preg_match auto converts to string
		return (
			is_numeric($num) AND
			preg_match("/^[0-9]+$/", $num) AND
			$num >= $threshold
		);
	}
	//END is_positive_intlike


	// --------------------------------------------------------------------

	/**
	 * get_post_or_zero
	 *
	 * @access	public
	 * @param 	string 	name of GET/POST var to check
	 * @return	int 	returns 0 if the get/post is not present or numeric or above 0
	 */

	public function get_post_or_zero ($name)
	{
		$name = ee()->input->get_post($name);
		return ($this->is_positive_intlike($name) ? $name : 0);
	}
	//END get_post_or_zero
}
// END Addon_builder Class