Skip to content
This repository
tree: f1dfc4688f
Fetching contributors…

Cannot retrieve contributors at this time

file 767 lines (662 sloc) 17.225 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
<?php
/**
* @package Joomla.Platform
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/

defined('JPATH_PLATFORM') or die;

/**
* Joomla Platform Factory class
*
* @package Joomla.Platform
* @since 11.1
*/
abstract class JFactory
{
/**
* @var JApplication
* @since 11.1
*/
public static $application = null;

/**
* @var JCache
* @since 11.1
*/
public static $cache = null;

/**
* @var JConfig
* @since 11.1
*/
public static $config = null;

/**
* @var array
* @since 11.3
*/
public static $dates = array();

/**
* @var JSession
* @since 11.1
*/
public static $session = null;

/**
* @var JLanguage
* @since 11.1
*/
public static $language = null;

/**
* @var JDocument
* @since 11.1
*/
public static $document = null;

/**
* @var JAccess
* @since 11.1
* @deprecated 13.3
*/
public static $acl = null;

/**
* @var JDatabaseDriver
* @since 11.1
*/
public static $database = null;

/**
* @var JMail
* @since 11.1
*/
public static $mailer = null;

/**
* Get a application object.
*
* Returns the global {@link JApplication} object, only creating it if it doesn't already exist.
*
* @param mixed $id A client identifier or name.
* @param array $config An optional associative array of configuration settings.
* @param string $prefix Application prefix
*
* @return JApplication object
*
* @see JApplication
* @since 11.1
* @throws Exception
*/
public static function getApplication($id = null, array $config = array(), $prefix = 'J')
{
if (!self::$application)
{
if (!$id)
{
throw new Exception('Application Instantiation Error', 500);
}

self::$application = JApplication::getInstance($id, $config, $prefix);
}

return self::$application;
}

/**
* Get a configuration object
*
* Returns the global {@link JRegistry} object, only creating it if it doesn't already exist.
*
* @param string $file The path to the configuration file
* @param string $type The type of the configuration file
* @param string $namespace The namespace of the configuration file
*
* @return JRegistry
*
* @see JRegistry
* @since 11.1
*/
public static function getConfig($file = null, $type = 'PHP', $namespace = '')
{
if (!self::$config)
{
if ($file === null)
{
$file = JPATH_PLATFORM . '/config.php';
}

self::$config = self::createConfig($file, $type, $namespace);
}

return self::$config;
}

/**
* Get a session object.
*
* Returns the global {@link JSession} object, only creating it if it doesn't already exist.
*
* @param array $options An array containing session options
*
* @return JSession object
*
* @see JSession
* @since 11.1
*/
public static function getSession(array $options = array())
{
if (!self::$session)
{
self::$session = self::createSession($options);
}

return self::$session;
}

/**
* Get a language object.
*
* Returns the global {@link JLanguage} object, only creating it if it doesn't already exist.
*
* @return JLanguage object
*
* @see JLanguage
* @since 11.1
*/
public static function getLanguage()
{
if (!self::$language)
{
self::$language = self::createLanguage();
}

return self::$language;
}

/**
* Get a document object.
*
* Returns the global {@link JDocument} object, only creating it if it doesn't already exist.
*
* @return JDocument object
*
* @see JDocument
* @since 11.1
*/
public static function getDocument()
{
if (!self::$document)
{
self::$document = self::createDocument();
}

return self::$document;
}

/**
* Get an user object.
*
* Returns the global {@link JUser} object, only creating it if it doesn't already exist.
*
* @param integer $id The user to load - Can be an integer or string - If string, it is converted to ID automatically.
*
* @return JUser object
*
* @see JUser
* @since 11.1
*/
public static function getUser($id = null)
{
$instance = self::getSession()->get('user');

if (is_null($id))
{
if (!($instance instanceof JUser))
{
$instance = JUser::getInstance();
}
}
elseif ($instance->id != $id)
{
$instance = JUser::getInstance($id);
}

return $instance;
}

/**
* Get a cache object
*
* Returns the global {@link JCache} object
*
* @param string $group The cache group name
* @param string $handler The handler to use
* @param string $storage The storage method
*
* @return JCacheController object
*
* @see JCache
*/
public static function getCache($group = '', $handler = 'callback', $storage = null)
{
$hash = md5($group . $handler . $storage);
if (isset(self::$cache[$hash]))
{
return self::$cache[$hash];
}
$handler = ($handler == 'function') ? 'callback' : $handler;

$options = array('defaultgroup' => $group);

if (isset($storage))
{
$options['storage'] = $storage;
}

$cache = JCache::getInstance($handler, $options);

self::$cache[$hash] = $cache;

return self::$cache[$hash];
}

/**
* Get an authorization object
*
* Returns the global {@link JAccess} object, only creating it
* if it doesn't already exist.
*
* @return JAccess object
*
* @deprecated 13.3 Use JAccess directly.
*/
public static function getACL()
{
JLog::add(__METHOD__ . ' is deprecated. Use JAccess directly.', JLog::WARNING, 'deprecated');

if (!self::$acl)
{
self::$acl = new JAccess;
}

return self::$acl;
}

/**
* Get a database object.
*
* Returns the global {@link JDatabaseDriver} object, only creating it if it doesn't already exist.
*
* @return JDatabaseDriver
*
* @see JDatabaseDriver
* @since 11.1
*/
public static function getDbo()
{
if (!self::$database)
{
// Get the debug configuration setting
$conf = self::getConfig();
$debug = $conf->get('debug');

self::$database = self::createDbo();
self::$database->setDebug($debug);
}

return self::$database;
}

/**
* Get a mailer object.
*
* Returns the global {@link JMail} object, only creating it if it doesn't already exist.
*
* @return JMail object
*
* @see JMail
* @since 11.1
*/
public static function getMailer()
{
if (!self::$mailer)
{
self::$mailer = self::createMailer();
}
$copy = clone self::$mailer;

return $copy;
}

/**
* Get a parsed XML Feed Source
*
* @param string $url Url for feed source.
* @param integer $cache_time Time to cache feed for (using internal cache mechanism).
*
* @return mixed SimplePie parsed object on success, false on failure.
*
* @since 11.1
* @deprecated 13.3 Use JSimplepieFactory::getFeedParser() instead.
*/
public static function getFeedParser($url, $cache_time = 0)
{
if (!class_exists('JSimplepieFactory'))
{
throw new BadMethodCallException('JSimplepieFactory not found');
}

JLog::add(__METHOD__ . ' is deprecated. Use JSimplepieFactory::getFeedParser() instead.', JLog::WARNING, 'deprecated');

return JSimplepieFactory::getFeedParser($url, $cache_time);
}

/**
* Reads a XML file.
*
* @param string $data Full path and file name.
* @param boolean $isFile true to load a file or false to load a string.
*
* @return mixed JXMLElement or SimpleXMLElement on success or false on error.
*
* @see JXMLElement
* @since 11.1
* @note When JXMLElement is not present a SimpleXMLElement will be returned.
* @deprecated 13.3 Use SimpleXML directly.
*/
public static function getXML($data, $isFile = true)
{
JLog::add(__METHOD__ . ' is deprecated. Use SimpleXML directly.', JLog::WARNING, 'deprecated');

$class = 'SimpleXMLElement';
if (class_exists('JXMLElement'))
{
$class = 'JXMLElement';
}

// Disable libxml errors and allow to fetch error information as needed
libxml_use_internal_errors(true);

if ($isFile)
{
// Try to load the XML file
$xml = simplexml_load_file($data, $class);
}
else
{
// Try to load the XML string
$xml = simplexml_load_string($data, $class);
}

if ($xml === false)
{
JLog::add(JText::_('JLIB_UTIL_ERROR_XML_LOAD'), JLog::WARNING, 'jerror');

if ($isFile)
{
JLog::add($data, JLog::WARNING, 'jerror');
}

foreach (libxml_get_errors() as $error)
{
JLog::add($error->message, JLog::WARNING, 'jerror');
}
}

return $xml;
}

/**
* Get an editor object.
*
* @param string $editor The editor to load, depends on the editor plugins that are installed
*
* @return JEditor instance of JEditor
*
* @since 11.1
* @deprecated 12.2 CMS developers should use JEditor directly.
* @note There is no direct replacement in the Joomla Platform.
*/
public static function getEditor($editor = null)
{
JLog::add(__METHOD__ . ' is deprecated. CMS developers should use JEditor directly.', JLog::WARNING, 'deprecated');

if (!class_exists('JEditor'))
{
throw new BadMethodCallException('JEditor not found');
}

JLog::add(__METHOD__ . ' is deprecated. Use JEditor directly.', JLog::WARNING, 'deprecated');

// Get the editor configuration setting
if (is_null($editor))
{
$conf = self::getConfig();
$editor = $conf->get('editor');
}

return JEditor::getInstance($editor);
}

/**
* Return a reference to the {@link JURI} object
*
* @param string $uri Uri name.
*
* @return JURI object
*
* @see JURI
* @since 11.1
* @deprecated 13.3 Use JURI directly.
*/
public static function getURI($uri = 'SERVER')
{
JLog::add(__METHOD__ . ' is deprecated. Use JURI directly.', JLog::WARNING, 'deprecated');

return JURI::getInstance($uri);
}

/**
* Return the {@link JDate} object
*
* @param mixed $time The initial time for the JDate object
* @param mixed $tzOffset The timezone offset.
*
* @return JDate object
*
* @see JDate
* @since 11.1
*/
public static function getDate($time = 'now', $tzOffset = null)
{
static $classname;
static $mainLocale;

$language = self::getLanguage();
$locale = $language->getTag();

if (!isset($classname) || $locale != $mainLocale)
{
// Store the locale for future reference
$mainLocale = $locale;

if ($mainLocale !== false)
{
$classname = str_replace('-', '_', $mainLocale) . 'Date';

if (!class_exists($classname))
{
// The class does not exist, default to JDate
$classname = 'JDate';
}
}
else
{
// No tag, so default to JDate
$classname = 'JDate';
}
}

$key = $time . '-' . ($tzOffset instanceof DateTimeZone ? $tzOffset->getName() : (string) $tzOffset);

if (!isset(self::$dates[$classname][$key]))
{
self::$dates[$classname][$key] = new $classname($time, $tzOffset);
}

$date = clone self::$dates[$classname][$key];

return $date;
}

/**
* Create a configuration object
*
* @param string $file The path to the configuration file.
* @param string $type The type of the configuration file.
* @param string $namespace The namespace of the configuration file.
*
* @return JRegistry
*
* @see JRegistry
* @since 11.1
*/
protected static function createConfig($file, $type = 'PHP', $namespace = '')
{
if (is_file($file))
{
include_once $file;
}

// Create the registry with a default namespace of config
$registry = new JRegistry;

// Sanitize the namespace.
$namespace = ucfirst((string) preg_replace('/[^A-Z_]/i', '', $namespace));

// Build the config name.
$name = 'JConfig' . $namespace;

// Handle the PHP configuration type.
if ($type == 'PHP' && class_exists($name))
{
// Create the JConfig object
$config = new $name;

// Load the configuration values into the registry
$registry->loadObject($config);
}

return $registry;
}

/**
* Create a session object
*
* @param array $options An array containing session options
*
* @return JSession object
*
* @since 11.1
*/
protected static function createSession(array $options = array())
{
// Get the editor configuration setting
$conf = self::getConfig();
$handler = $conf->get('session_handler', 'none');

// Config time is in minutes
$options['expire'] = ($conf->get('lifetime')) ? $conf->get('lifetime') * 60 : 900;

$session = JSession::getInstance($handler, $options);
if ($session->getState() == 'expired')
{
$session->restart();
}

return $session;
}

/**
* Create an database object
*
* @return JDatabaseDriver
*
* @see JDatabaseDriver
* @since 11.1
*/
protected static function createDbo()
{
$conf = self::getConfig();

$host = $conf->get('host');
$user = $conf->get('user');
$password = $conf->get('password');
$database = $conf->get('db');
$prefix = $conf->get('dbprefix');
$driver = $conf->get('dbtype');
$debug = $conf->get('debug');

$options = array('driver' => $driver, 'host' => $host, 'user' => $user, 'password' => $password, 'database' => $database, 'prefix' => $prefix);

try
{
$db = JDatabaseDriver::getInstance($options);
}
catch (RuntimeException $e)
{
if (!headers_sent())
{
header('HTTP/1.1 500 Internal Server Error');
}
jexit('Database Error: ' . $e->getMessage());
}

$db->setDebug($debug);

return $db;
}

/**
* Create a mailer object
*
* @return JMail object
*
* @see JMail
* @since 11.1
*/
protected static function createMailer()
{
$conf = self::getConfig();

$smtpauth = ($conf->get('smtpauth') == 0) ? null : 1;
$smtpuser = $conf->get('smtpuser');
$smtppass = $conf->get('smtppass');
$smtphost = $conf->get('smtphost');
$smtpsecure = $conf->get('smtpsecure');
$smtpport = $conf->get('smtpport');
$mailfrom = $conf->get('mailfrom');
$fromname = $conf->get('fromname');
$mailer = $conf->get('mailer');

// Create a JMail object
$mail = JMail::getInstance();

// Set default sender without Reply-to
$mail->SetFrom(JMailHelper::cleanLine($mailfrom), JMailHelper::cleanLine($fromname), 0);

// Default mailer is to use PHP's mail function
switch ($mailer)
{
case 'smtp':
$mail->useSMTP($smtpauth, $smtphost, $smtpuser, $smtppass, $smtpsecure, $smtpport);
break;

case 'sendmail':
$mail->IsSendmail();
break;

default:
$mail->IsMail();
break;
}

return $mail;
}

/**
* Create a language object
*
* @return JLanguage object
*
* @see JLanguage
* @since 11.1
*/
protected static function createLanguage()
{
$conf = self::getConfig();
$locale = $conf->get('language');
$debug = $conf->get('debug_lang');
$lang = JLanguage::getInstance($locale, $debug);

return $lang;
}

/**
* Create a document object
*
* @return JDocument object
*
* @see JDocument
* @since 11.1
*/
protected static function createDocument()
{
$lang = self::getLanguage();

$input = self::getApplication()->input;
$type = $input->get('format', 'html', 'word');

$attributes = array('charset' => 'utf-8', 'lineend' => 'unix', 'tab' => ' ', 'language' => $lang->getTag(),
'direction' => $lang->isRTL() ? 'rtl' : 'ltr');

return JDocument::getInstance($type, $attributes);
}

/**
* Creates a new stream object with appropriate prefix
*
* @param boolean $use_prefix Prefix the connections for writing
* @param boolean $use_network Use network if available for writing; use false to disable (e.g. FTP, SCP)
* @param string $ua UA User agent to use
* @param boolean $uamask User agent masking (prefix Mozilla)
*
* @return JStream
*
* @see JStream
* @since 11.1
*/
public static function getStream($use_prefix = true, $use_network = true, $ua = null, $uamask = false)
{
jimport('joomla.filesystem.stream');

// Setup the context; Joomla! UA and overwrite
$context = array();
$version = new JVersion;

// Set the UA for HTTP and overwrite for FTP
$context['http']['user_agent'] = $version->getUserAgent($ua, $uamask);
$context['ftp']['overwrite'] = true;

if ($use_prefix)
{
$FTPOptions = JClientHelper::getCredentials('ftp');
$SCPOptions = JClientHelper::getCredentials('scp');

if ($FTPOptions['enabled'] == 1 && $use_network)
{
$prefix = 'ftp://' . $FTPOptions['user'] . ':' . $FTPOptions['pass'] . '@' . $FTPOptions['host'];
$prefix .= $FTPOptions['port'] ? ':' . $FTPOptions['port'] : '';
$prefix .= $FTPOptions['root'];
}
elseif ($SCPOptions['enabled'] == 1 && $use_network)
{
$prefix = 'ssh2.sftp://' . $SCPOptions['user'] . ':' . $SCPOptions['pass'] . '@' . $SCPOptions['host'];
$prefix .= $SCPOptions['port'] ? ':' . $SCPOptions['port'] : '';
$prefix .= $SCPOptions['root'];
}
else
{
$prefix = JPATH_ROOT . '/';
}

$retval = new JStream($prefix, JPATH_ROOT, $context);
}
else
{
$retval = new JStream('', '', $context);
}

return $retval;
}
}
Something went wrong with that request. Please try again.