Project: Joomla

Revision: 10153

Author: eddieajau

Date: 19 Mar 2008 07:12:04

• /development/trunk/libraries/joomla/application/helper.php

  ......	@@ -1,332 +1,332 @@
  1		<?php
  2		/**
  3		* @version $Id$
  4		* @package Joomla.Framework
  5		* @subpackage Application
  6		* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
  7		* @license GNU/GPL, see LICENSE.php
  8		* Joomla! is free software. This version may have been modified pursuant
  9		* to the GNU General Public License, and as distributed it includes or
  10		* is derivative of works licensed under the GNU General Public License or
  11		* other free or open source software licenses.
  12		* See COPYRIGHT.php for copyright notices and details.
  13		*/
  14
  15		// Check to ensure this file is within the rest of the framework
  16		defined('JPATH_BASE') or die();
  17
  18		/**
  19		* Application helper functions
  20		*
  21		* @static
  22		* @package Joomla.Framework
  23		* @subpackage Application
  24		* @since 1.5
  25		*/
  26		class JApplicationHelper
  27		{
  28		/**
  29		* Gets information on a specific client id. This method will be useful in
  30		* future versions when we start mapping applications in the database.
  31		*
  32		* @access public
  33		* @param int $id A client identifier
  34		* @param boolean $byName If True, find the client by it's name
  35		* @return mixed Object describing the client or false if not known
  36		* @since 1.5
  37		*/
  38		function &getClientInfo($id = null, $byName = false)
  39		{
  40		static $clients;
  41
  42		// Only create the array if it does not exist
  43		if (!is_array($clients))
  44		{
  45		$obj = new stdClass();
  46
  47		// Site Client
  48		$obj->id = 0;
  49		$obj->name = 'site';
  50		$obj->path = JPATH_SITE;
  51		$clients[0] = clone($obj);
  52
  53		// Administrator Client
  54		$obj->id = 1;
  55		$obj->name = 'administrator';
  56		$obj->path = JPATH_ADMINISTRATOR;
  57		$clients[1] = clone($obj);
  58
  59		// Installation Client
  60		$obj->id = 2;
  61		$obj->name = 'installation';
  62		$obj->path = JPATH_INSTALLATION;
  63		$clients[2] = clone($obj);
  64
  65		// XMLRPC Client
  66		$obj->id = 3;
  67		$obj->name = 'xmlrpc';
  68		$obj->path = JPATH_XMLRPC;
  69		$clients[3] = clone($obj);
  70		}
  71
  72		//If no client id has been passed return the whole array
  73		if(is_null($id)) {
  74		return $clients;
  75		}
  76
  77		// Are we looking for client information by id or by name?
  78		if (!$byName)
  79		{
  80		if (isset($clients[$id])){
  81		return $clients[$id];
  82		}
  83		}
  84		else
  85		{
  86		foreach ($clients as $client)
  87		{
  88		if ($client->name == strtolower($id)) {
  89		return $client;
  90		}
  91		}
  92		}
  93		$null = null;
  94		return $null;
  95		}
  96
  97		/**
  98		* Get a path
  99		*
  100		* @access public
  101		* @param string $varname
  102		* @param string $user_option
  103		* @return string The requested path
  104		* @since 1.0
  105		*/
  106		function getPath( $varname, $user_option=null )
  107		{
  108		// check needed for handling of custom/new module xml file loading
  109		$check = ( ( $varname == 'mod0_xml' ) || ( $varname == 'mod1_xml' ) );
  110
  111		if ( !$user_option && !$check ) {
  112		$user_option = JRequest::getCmd('option');
  113		} else {
  114		$user_option = JFilterInput::clean($user_option, 'path');
  115		}
  116
  117		$result = null;
  118		$name = substr( $user_option, 4 );
  119
  120		switch ($varname) {
  121		case 'front':
  122		$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.php', 0 );
  123		break;
  124
  125		case 'html':
  126		case 'front_html':
  127		if ( !( $result = JApplicationHelper::_checkPath( DS.'templates'.DS. JApplication::getTemplate() .DS.'components'.DS. $name .'.html.php', 0 ) ) ) {
  128		$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.html.php', 0 );
  129		}
  130		break;
  131
  132		case 'toolbar':
  133		$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.php', -1 );
  134		break;
  135
  136		case 'toolbar_html':
  137		$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.html.php', -1 );
  138		break;
  139
  140		case 'toolbar_default':
  141		case 'toolbar_front':
  142		$result = JApplicationHelper::_checkPath( DS.'includes'.DS.'HTML_toolbar.php', 0 );
  143		break;
  144
  145		case 'admin':
  146		$path = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.php';
  147		$result = JApplicationHelper::_checkPath( $path, -1 );
  148		break;
  149
  150		case 'admin_html':
  151		$path = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.html.php';
  152		$result = JApplicationHelper::_checkPath( $path, -1 );
  153		break;
  154
  155		case 'admin_functions':
  156		$path = DS.'components'.DS. $user_option .DS. $name .'.functions.php';
  157		$result = JApplicationHelper::_checkPath( $path, -1 );
  158		break;
  159
  160		case 'class':
  161		if ( !( $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.class.php' ) ) ) {
  162		$result = JApplicationHelper::_checkPath( DS.'includes'.DS. $name .'.php' );
  163		}
  164		break;
  165
  166		case 'helper':
  167		$path = DS.'components'.DS. $user_option .DS. $name .'.helper.php';
  168		$result = JApplicationHelper::_checkPath( $path );
  169		break;
  170
  171		case 'com_xml':
  172		$path = DS.'components'.DS. $user_option .DS. $name .'.xml';
  173		$result = JApplicationHelper::_checkPath( $path, 1 );
  174		break;
  175
  176		case 'mod0_xml':
  177		$path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  178		$result = JApplicationHelper::_checkPath( $path );
  179		break;
  180
  181		case 'mod1_xml':
  182		// admin modules
  183		$path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  184		$result = JApplicationHelper::_checkPath( $path, -1 );
  185		break;
  186
  187		case 'bot_xml':
  188		// legacy value
  189		case 'plg_xml':
  190		// Site plugins
  191		$path = DS.'plugins'.DS. $user_option .'.xml';
  192		$result = JApplicationHelper::_checkPath( $path, 0 );
  193		break;
  194
  195		case 'menu_xml':
  196		$path = DS.'components'.DS.'com_menus'.DS. $user_option .DS. $user_option .'.xml';
  197		$result = JApplicationHelper::_checkPath( $path, -1 );
  198		break;
  199		}
  200
  201		return $result;
  202		}
  203
  204		function parseXMLInstallFile($path)
  205		{
  206		// Read the file to see if it's a valid component XML file
  207		$xml = & JFactory::getXMLParser('Simple');
  208
  209		if (!$xml->loadFile($path)) {
  210		unset($xml);
  211		return false;
  212		}
  213
  214		/*
  215		* Check for a valid XML root tag.
  216		*
  217		* Should be 'install', but for backward compatability we will accept 'mosinstall'.
  218		*/
  219		if ($xml->document->name() != 'install' && $xml->document->name() != 'mosinstall') {
  220		unset($xml);
  221		return false;
  222		}
  223
  224		$data = array();
  225
  226		$element = & $xml->document->name[0];
  227		$data['name'] = $element ? $element->data() : '';
  228		$data['type'] = $element ? $xml->document->attributes("type") : '';
  229
  230		$element = & $xml->document->creationDate[0];
  231		$data['creationdate'] = $element ? $element->data() : 'Unknown';
  232
  233		$element = & $xml->document->author[0];
  234		$data['author'] = $element ? $element->data() : 'Unknown';
  235
  236		$element = & $xml->document->copyright[0];
  237		$data['copyright'] = $element ? $element->data() : '';
  238
  239		$element = & $xml->document->authoremail[0];
  240		$data['authorEmail'] = $element ? $element->data() : '';
  241
  242		$element = & $xml->document->authorurl[0];
  243		$data['authorUrl'] = $element ? $element->data() : '';
  244
  245		$element = & $xml->document->version[0];
  246		$data['version'] = $element ? $element->data() : '';
  247
  248		$element = & $xml->document->description[0];
  249		$data['description'] = $element ? $element->data() : '';
  250
  251		$element = & $xml->document->group[0];
  252		$data['group'] = $element ? $element->data() : '';
  253
  254		return $data;
  255		}
  256
  257		function parseXMLLangMetaFile($path)
  258		{
  259		// Read the file to see if it's a valid component XML file
  260		$xml = & JFactory::getXMLParser('Simple');
  261
  262		if (!$xml->loadFile($path)) {
  263		unset($xml);
  264		return false;
  265		}
  266
  267		/*
  268		* Check for a valid XML root tag.
  269		*
  270		* Should be 'langMetaData'.
  271		*/
  272		if ($xml->document->name() != 'metafile') {
  273		unset($xml);
  274		return false;
  275		}
  276
  277		$data = array();
  278
  279		$element = & $xml->document->name[0];
  280		$data['name'] = $element ? $element->data() : '';
  281		$data['type'] = $element ? $xml->document->attributes("type") : '';
  282
  283		$element = & $xml->document->creationDate[0];
  284		$data['creationdate'] = $element ? $element->data() : 'Unknown';
  285
  286		$element = & $xml->document->author[0];
  287
  288		$data['author'] = $element ? $element->data() : 'Unknown';
  289
  290		$element = & $xml->document->copyright[0];
  291		$data['copyright'] = $element ? $element->data() : '';
  292
  293		$element = & $xml->document->authorEmail[0];
  294		$data['authorEmail'] = $element ? $element->data() : '';
  295
  296		$element = & $xml->document->authorUrl[0];
  297		$data['authorUrl'] = $element ? $element->data() : '';
  298
  299		$element = & $xml->document->version[0];
  300		$data['version'] = $element ? $element->data() : '';
  301
  302		$element = & $xml->document->description[0];
  303		$data['description'] = $element ? $element->data() : '';
  304
  305		$element = & $xml->document->group[0];
  306		$data['group'] = $element ? $element->group() : '';
  307		return $data;
  308		}
  309
  310		/**
  311		* Tries to find a file in the administrator or site areas
  312		*
  313		* @access private
  314		* @param string $parth A file name
  315		* @param integer $checkAdmin 0 to check site only, 1 to check site and admin, -1 to check admin only
  316		* @since 1.5
  317		*/
  318		function _checkPath( $path, $checkAdmin=1 )
  319		{
  320		$file = JPATH_SITE . $path;
  321		if ($checkAdmin > -1 && file_exists( $file )) {
  322		return $file;
  323		} else if ($checkAdmin != 0) {
  324		$file = JPATH_ADMINISTRATOR . $path;
  325		if (file_exists( $file )) {
  326		return $file;
  327		}
  328		}
  329
  330		return null;
  331		}
  332		}
  	1	<?php
  	2	/**
  	3	* @version $Id$
  	4	* @package Joomla.Framework
  	5	* @subpackage Application
  	6	* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
  	7	* @license GNU/GPL, see LICENSE.php
  	8	* Joomla! is free software. This version may have been modified pursuant
  	9	* to the GNU General Public License, and as distributed it includes or
  	10	* is derivative of works licensed under the GNU General Public License or
  	11	* other free or open source software licenses.
  	12	* See COPYRIGHT.php for copyright notices and details.
  	13	*/
  	14
  	15	// Check to ensure this file is within the rest of the framework
  	16	defined('JPATH_BASE') or die();
  	17
  	18	/**
  	19	* Application helper functions
  	20	*
  	21	* @static
  	22	* @package Joomla.Framework
  	23	* @subpackage Application
  	24	* @since 1.5
  	25	*/
  	26	class JApplicationHelper
  	27	{
  	28	/**
  	29	* Gets information on a specific client id. This method will be useful in
  	30	* future versions when we start mapping applications in the database.
  	31	*
  	32	* @access public
  	33	* @param int $id A client identifier
  	34	* @param boolean $byName If True, find the client by it's name
  	35	* @return mixed Object describing the client or false if not known
  	36	* @since 1.5
  	37	*/
  	38	function &getClientInfo($id = null, $byName = false)
  	39	{
  	40	static $clients;
  	41
  	42	// Only create the array if it does not exist
  	43	if (!is_array($clients))
  	44	{
  	45	$obj = new stdClass();
  	46
  	47	// Site Client
  	48	$obj->id = 0;
  	49	$obj->name = 'site';
  	50	$obj->path = JPATH_SITE;
  	51	$clients[0] = clone($obj);
  	52
  	53	// Administrator Client
  	54	$obj->id = 1;
  	55	$obj->name = 'administrator';
  	56	$obj->path = JPATH_ADMINISTRATOR;
  	57	$clients[1] = clone($obj);
  	58
  	59	// Installation Client
  	60	$obj->id = 2;
  	61	$obj->name = 'installation';
  	62	$obj->path = JPATH_INSTALLATION;
  	63	$clients[2] = clone($obj);
  	64
  	65	// XMLRPC Client
  	66	$obj->id = 3;
  	67	$obj->name = 'xmlrpc';
  	68	$obj->path = JPATH_XMLRPC;
  	69	$clients[3] = clone($obj);
  	70	}
  	71
  	72	//If no client id has been passed return the whole array
  	73	if(is_null($id)) {
  	74	return $clients;
  	75	}
  	76
  	77	// Are we looking for client information by id or by name?
  	78	if (!$byName)
  	79	{
  	80	if (isset($clients[$id])){
  	81	return $clients[$id];
  	82	}
  	83	}
  	84	else
  	85	{
  	86	foreach ($clients as $client)
  	87	{
  	88	if ($client->name == strtolower($id)) {
  	89	return $client;
  	90	}
  	91	}
  	92	}
  	93	$null = null;
  	94	return $null;
  	95	}
  	96
  	97	/**
  	98	* Get a path
  	99	*
  	100	* @access public
  	101	* @param string $varname
  	102	* @param string $user_option
  	103	* @return string The requested path
  	104	* @since 1.0
  	105	*/
  	106	function getPath( $varname, $user_option=null )
  	107	{
  	108	// check needed for handling of custom/new module xml file loading
  	109	$check = ( ( $varname == 'mod0_xml' ) || ( $varname == 'mod1_xml' ) );
  	110
  	111	if ( !$user_option && !$check ) {
  	112	$user_option = JRequest::getCmd('option');
  	113	} else {
  	114	$user_option = JFilterInput::clean($user_option, 'path');
  	115	}
  	116
  	117	$result = null;
  	118	$name = substr( $user_option, 4 );
  	119
  	120	switch ($varname) {
  	121	case 'front':
  	122	$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.php', 0 );
  	123	break;
  	124
  	125	case 'html':
  	126	case 'front_html':
  	127	if ( !( $result = JApplicationHelper::_checkPath( DS.'templates'.DS. JApplication::getTemplate() .DS.'components'.DS. $name .'.html.php', 0 ) ) ) {
  	128	$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.html.php', 0 );
  	129	}
  	130	break;
  	131
  	132	case 'toolbar':
  	133	$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.php', -1 );
  	134	break;
  	135
  	136	case 'toolbar_html':
  	137	$result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.html.php', -1 );
  	138	break;
  	139
  	140	case 'toolbar_default':
  	141	case 'toolbar_front':
  	142	$result = JApplicationHelper::_checkPath( DS.'includes'.DS.'HTML_toolbar.php', 0 );
  	143	break;
  	144
  	145	case 'admin':
  	146	$path = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.php';
  	147	$result = JApplicationHelper::_checkPath( $path, -1 );
  	148	break;
  	149
  	150	case 'admin_html':
  	151	$path = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.html.php';
  	152	$result = JApplicationHelper::_checkPath( $path, -1 );
  	153	break;
  	154
  	155	case 'admin_functions':
  	156	$path = DS.'components'.DS. $user_option .DS. $name .'.functions.php';
  	157	$result = JApplicationHelper::_checkPath( $path, -1 );
  	158	break;
  	159
  	160	case 'class':
  	161	if ( !( $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.class.php' ) ) ) {
  	162	$result = JApplicationHelper::_checkPath( DS.'includes'.DS. $name .'.php' );
  	163	}
  	164	break;
  	165
  	166	case 'helper':
  	167	$path = DS.'components'.DS. $user_option .DS. $name .'.helper.php';
  	168	$result = JApplicationHelper::_checkPath( $path );
  	169	break;
  	170
  	171	case 'com_xml':
  	172	$path = DS.'components'.DS. $user_option .DS. $name .'.xml';
  	173	$result = JApplicationHelper::_checkPath( $path, 1 );
  	174	break;
  	175
  	176	case 'mod0_xml':
  	177	$path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  	178	$result = JApplicationHelper::_checkPath( $path );
  	179	break;
  	180
  	181	case 'mod1_xml':
  	182	// admin modules
  	183	$path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  	184	$result = JApplicationHelper::_checkPath( $path, -1 );
  	185	break;
  	186
  	187	case 'bot_xml':
  	188	// legacy value
  	189	case 'plg_xml':
  	190	// Site plugins
  	191	$path = DS.'plugins'.DS. $user_option .'.xml';
  	192	$result = JApplicationHelper::_checkPath( $path, 0 );
  	193	break;
  	194
  	195	case 'menu_xml':
  	196	$path = DS.'components'.DS.'com_menus'.DS. $user_option .DS. $user_option .'.xml';
  	197	$result = JApplicationHelper::_checkPath( $path, -1 );
  	198	break;
  	199	}
  	200
  	201	return $result;
  	202	}
  	203
  	204	function parseXMLInstallFile($path)
  	205	{
  	206	// Read the file to see if it's a valid component XML file
  	207	$xml = & JFactory::getXMLParser('Simple');
  	208
  	209	if (!$xml->loadFile($path)) {
  	210	unset($xml);
  	211	return false;
  	212	}
  	213
  	214	/*
  	215	* Check for a valid XML root tag.
  	216	*
  	217	* Should be 'install', but for backward compatability we will accept 'mosinstall'.
  	218	*/
  	219	if ( !is_object($xml->document) || ($xml->document->name() != 'install' && $xml->document->name() != 'mosinstall')) {
  	220	unset($xml);
  	221	return false;
  	222	}
  	223
  	224	$data = array();
  	225
  	226	$element = & $xml->document->name[0];
  	227	$data['name'] = $element ? $element->data() : '';
  	228	$data['type'] = $element ? $xml->document->attributes("type") : '';
  	229
  	230	$element = & $xml->document->creationDate[0];
  	231	$data['creationdate'] = $element ? $element->data() : 'Unknown';
  	232
  	233	$element = & $xml->document->author[0];
  	234	$data['author'] = $element ? $element->data() : 'Unknown';
  	235
  	236	$element = & $xml->document->copyright[0];
  	237	$data['copyright'] = $element ? $element->data() : '';
  	238
  	239	$element = & $xml->document->authoremail[0];
  	240	$data['authorEmail'] = $element ? $element->data() : '';
  	241
  	242	$element = & $xml->document->authorurl[0];
  	243	$data['authorUrl'] = $element ? $element->data() : '';
  	244
  	245	$element = & $xml->document->version[0];
  	246	$data['version'] = $element ? $element->data() : '';
  	247
  	248	$element = & $xml->document->description[0];
  	249	$data['description'] = $element ? $element->data() : '';
  	250
  	251	$element = & $xml->document->group[0];
  	252	$data['group'] = $element ? $element->data() : '';
  	253
  	254	return $data;
  	255	}
  	256
  	257	function parseXMLLangMetaFile($path)
  	258	{
  	259	// Read the file to see if it's a valid component XML file
  	260	$xml = & JFactory::getXMLParser('Simple');
  	261
  	262	if (!$xml->loadFile($path)) {
  	263	unset($xml);
  	264	return false;
  	265	}
  	266
  	267	/*
  	268	* Check for a valid XML root tag.
  	269	*
  	270	* Should be 'langMetaData'.
  	271	*/
  	272	if ($xml->document->name() != 'metafile') {
  	273	unset($xml);
  	274	return false;
  	275	}
  	276
  	277	$data = array();
  	278
  	279	$element = & $xml->document->name[0];
  	280	$data['name'] = $element ? $element->data() : '';
  	281	$data['type'] = $element ? $xml->document->attributes("type") : '';
  	282
  	283	$element = & $xml->document->creationDate[0];
  	284	$data['creationdate'] = $element ? $element->data() : 'Unknown';
  	285
  	286	$element = & $xml->document->author[0];
  	287
  	288	$data['author'] = $element ? $element->data() : 'Unknown';
  	289
  	290	$element = & $xml->document->copyright[0];
  	291	$data['copyright'] = $element ? $element->data() : '';
  	292
  	293	$element = & $xml->document->authorEmail[0];
  	294	$data['authorEmail'] = $element ? $element->data() : '';
  	295
  	296	$element = & $xml->document->authorUrl[0];
  	297	$data['authorUrl'] = $element ? $element->data() : '';
  	298
  	299	$element = & $xml->document->version[0];
  	300	$data['version'] = $element ? $element->data() : '';
  	301
  	302	$element = & $xml->document->description[0];
  	303	$data['description'] = $element ? $element->data() : '';
  	304
  	305	$element = & $xml->document->group[0];
  	306	$data['group'] = $element ? $element->group() : '';
  	307	return $data;
  	308	}
  	309
  	310	/**
  	311	* Tries to find a file in the administrator or site areas
  	312	*
  	313	* @access private
  	314	* @param string $parth A file name
  	315	* @param integer $checkAdmin 0 to check site only, 1 to check site and admin, -1 to check admin only
  	316	* @since 1.5
  	317	*/
  	318	function _checkPath( $path, $checkAdmin=1 )
  	319	{
  	320	$file = JPATH_SITE . $path;
  	321	if ($checkAdmin > -1 && file_exists( $file )) {
  	322	return $file;
  	323	} else if ($checkAdmin != 0) {
  	324	$file = JPATH_ADMINISTRATOR . $path;
  	325	if (file_exists( $file )) {
  	326	return $file;
  	327	}
  	328	}
  	329
  	330	return null;
  	331	}
  	332	}