File Source for setup.php

<?php
/**
* @package Joomla.Installation
* @subpackage Model
*
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
/**
* Setup model for the Joomla Core Installer.
*
* @package Joomla.Installation
* @subpackage Model
* @since 3.1
*/
class InstallationModelSetup extends JModelBase
{
/**
* Get the current setup options from the session.
*
* @return array An array of options from the session
*
* @since 3.1
*/
public function getOptions()
{
$session = JFactory::getSession();
$options = $session->get('setup.options', array());
return $options;
}
/**
* Store the current setup options in the session.
*
* @param array $options The installation options
*
* @return array An array of options from the session
*
* @since 3.1
*/
public function storeOptions($options)
{
// Get the current setup options from the session.
$session = JFactory::getSession();
$old = $session->get('setup.options', array());
// Ensure that we have language
if (!isset($options['language']) || empty($options['language']))
{
$options['language'] = JFactory::getLanguage()->getTag();
}
// Merge the new setup options into the current ones and store in the session.
$options = array_merge($old, (array) $options);
$session->set('setup.options', $options);
return $options;
}
/**
* Method to get the form.
*
* @param string $view The view being processed
*
* @return mixed JForm object on success, false on failure.
*
* @since 3.1
*/
public function getForm($view = null)
{
/* @var InstallationApplicationWeb $app */
$app = JFactory::getApplication();
if (!$view)
{
$view = $app->input->getWord('view', 'site');
}
// Get the form.
JForm::addFormPath(JPATH_COMPONENT . '/model/forms');
JForm::addFieldPath(JPATH_COMPONENT . '/model/fields');
JForm::addRulePath(JPATH_COMPONENT . '/model/rules');
try
{
$form = JForm::getInstance('jform', $view, array('control' => 'jform'));
}
catch (Exception $e)
{
$app->enqueueMessage($e->getMessage(), 'error');
return false;
}
// Check the session for previously entered form data.
$data = (array) $this->getOptions();
// Bind the form data if present.
if (!empty($data))
{
$form->bind($data);
}
return $form;
}
/**
* Method to check the form data
*
* @param string $page The view being checked
*
* @return array Validated form data
*
* @since 3.1
*/
public function checkForm($page = 'site')
{
// Get the application object.
/* @var InstallationApplicationWeb $app */
$app = JFactory::getApplication();
// Get the posted values from the request and validate them.
$data = $app->input->post->get('jform', array(), 'array');
$return = $this->validate($data, $page);
// Attempt to save the data before validation
$form = $this->getForm();
$data = $form->filter($data);
unset($data['admin_password2']);
$this->storeOptions($data);
// Check for validation errors.
if ($return === false)
{
// Redirect back to the previous page.
$r = new stdClass;
$r->view = $page;
$app->sendJsonResponse($r);
}
unset($return['admin_password2']);
// Store the options in the session.
$vars = $this->storeOptions($return);
return $vars;
}
/**
* Generate a panel of language choices for the user to select their language
*
* @return boolean True if successful
*
* @since 3.1
*/
public function getLanguages()
{
/* @var InstallationApplicationWeb $app */
$app = JFactory::getApplication();
// Detect the native language.
$native = JLanguageHelper::detectLanguage();
if (empty($native))
{
$native = 'en-GB';
}
// Get a forced language if it exists.
$forced = $app->getLocalise();
if (!empty($forced['language']))
{
$native = $forced['language'];
}
// Get the list of available languages.
$list = JLanguageHelper::createLanguageList($native);
if (!$list || $list instanceof Exception)
{
$list = array();
}
return $list;
}
/**
* Checks the availability of the parse_ini_file and parse_ini_string functions.
*
* @return boolean True if the method exists
*
* @since 3.1
*/
public function getIniParserAvailability()
{
$disabled_functions = ini_get('disable_functions');
if (!empty($disabled_functions))
{
// Attempt to detect them in the disable_functions black list
$disabled_functions = explode(',', trim($disabled_functions));
$number_of_disabled_functions = count($disabled_functions);
for ($i = 0; $i < $number_of_disabled_functions; $i++)
{
$disabled_functions[$i] = trim($disabled_functions[$i]);
}
$result = !in_array('parse_ini_string', $disabled_functions);
}
else
{
// Attempt to detect their existence; even pure PHP implementation of them will trigger a positive response, though.
$result = function_exists('parse_ini_string');
}
return $result;
}
/**
* Gets PHP options.
*
* @return array Array of PHP config options
*
* @since 3.1
*/
public function getPhpOptions()
{
$options = array();
// Check the PHP Version.
$option = new stdClass;
$option->label = JText::_('INSTL_PHP_VERSION') . ' >= 5.3.1';
$option->state = version_compare(PHP_VERSION, '5.3.1', '>=');
$option->notice = null;
$options[] = $option;
// Check for magic quotes gpc.
$option = new stdClass;
$option->label = JText::_('INSTL_MAGIC_QUOTES_GPC');
$option->state = (ini_get('magic_quotes_gpc') == false);
$option->notice = null;
$options[] = $option;
// Check for register globals.
$option = new stdClass;
$option->label = JText::_('INSTL_REGISTER_GLOBALS');
$option->state = (ini_get('register_globals') == false);
$option->notice = null;
$options[] = $option;
// Check for zlib support.
$option = new stdClass;
$option->label = JText::_('INSTL_ZLIB_COMPRESSION_SUPPORT');
$option->state = extension_loaded('zlib');
$option->notice = null;
$options[] = $option;
// Check for XML support.
$option = new stdClass;
$option->label = JText::_('INSTL_XML_SUPPORT');
$option->state = extension_loaded('xml');
$option->notice = null;
$options[] = $option;
// Check for database support.
// We are satisfied if there is at least one database driver available.
$available = JDatabaseDriver::getConnectors();
$option = new stdClass;
$option->label = JText::_('INSTL_DATABASE_SUPPORT');
$option->label .= '<br />(' . implode(', ', $available) . ')';
$option->state = count($available);
$option->notice = null;
$options[] = $option;
// Check for mbstring options.
if (extension_loaded('mbstring'))
{
// Check for default MB language.
$option = new stdClass;
$option->label = JText::_('INSTL_MB_LANGUAGE_IS_DEFAULT');
$option->state = (strtolower(ini_get('mbstring.language')) == 'neutral');
$option->notice = ($option->state) ? null : JText::_('INSTL_NOTICEMBLANGNOTDEFAULT');
$options[] = $option;
// Check for MB function overload.
$option = new stdClass;
$option->label = JText::_('INSTL_MB_STRING_OVERLOAD_OFF');
$option->state = (ini_get('mbstring.func_overload') == 0);
$option->notice = ($option->state) ? null : JText::_('INSTL_NOTICEMBSTRINGOVERLOAD');
$options[] = $option;
}
// Check for a missing native parse_ini_file implementation
$option = new stdClass;
$option->label = JText::_('INSTL_PARSE_INI_FILE_AVAILABLE');
$option->state = $this->getIniParserAvailability();
$option->notice = null;
$options[] = $option;
// Check for missing native json_encode / json_decode support
$option = new stdClass;
$option->label = JText::_('INSTL_JSON_SUPPORT_AVAILABLE');
$option->state = function_exists('json_encode') && function_exists('json_decode');
$option->notice = null;
$options[] = $option;
// Check for configuration file writable.
$writable = (is_writable(JPATH_CONFIGURATION . '/configuration.php')
|| (!file_exists(JPATH_CONFIGURATION . '/configuration.php') && is_writable(JPATH_ROOT)));
$option = new stdClass;
$option->label = JText::sprintf('INSTL_WRITABLE', 'configuration.php');
$option->state = $writable;
$option->notice = ($option->state) ? null : JText::_('INSTL_NOTICEYOUCANSTILLINSTALL');
$options[] = $option;
return $options;
}
/**
* Checks if all of the mandatory PHP options are met
*
* @return boolean True on success
*
* @since 3.1
*/
public function getPhpOptionsSufficient()
{
$result = true;
$options = $this->getPhpOptions();
foreach ($options as $option)
{
if (is_null($option->notice))
{
$result = ($result && $option->state);
}
}
return $result;
}
/**
* Gets PHP Settings.
*
* @return array
*
* @since 3.1
*/
public function getPhpSettings()
{
$settings = array();
// Check for safe mode.
$setting = new stdClass;
$setting->label = JText::_('INSTL_SAFE_MODE');
$setting->state = (bool) ini_get('safe_mode');
$setting->recommended = false;
$settings[] = $setting;
// Check for display errors.
$setting = new stdClass;
$setting->label = JText::_('INSTL_DISPLAY_ERRORS');
$setting->state = (bool) ini_get('display_errors');
$setting->recommended = false;
$settings[] = $setting;
// Check for file uploads.
$setting = new stdClass;
$setting->label = JText::_('INSTL_FILE_UPLOADS');
$setting->state = (bool) ini_get('file_uploads');
$setting->recommended = true;
$settings[] = $setting;
// Check for magic quotes runtimes.
$setting = new stdClass;
$setting->label = JText::_('INSTL_MAGIC_QUOTES_RUNTIME');
$setting->state = (bool) ini_get('magic_quotes_runtime');
$setting->recommended = false;
$settings[] = $setting;
// Check for output buffering.
$setting = new stdClass;
$setting->label = JText::_('INSTL_OUTPUT_BUFFERING');
$setting->state = (bool) ini_get('output_buffering');
$setting->recommended = false;
$settings[] = $setting;
// Check for session auto-start.
$setting = new stdClass;
$setting->label = JText::_('INSTL_SESSION_AUTO_START');
$setting->state = (bool) ini_get('session.auto_start');
$setting->recommended = false;
$settings[] = $setting;
// Check for native ZIP support
$setting = new stdClass;
$setting->label = JText::_('INSTL_ZIP_SUPPORT_AVAILABLE');
$setting->state = function_exists('zip_open') && function_exists('zip_read');
$setting->recommended = true;
$settings[] = $setting;
return $settings;
}
/**
* Method to validate the form data.
*
* @param array $data The form data.
* @param string $view The view.
*
* @return mixed Array of filtered data if valid, false otherwise.
*
* @since 3.1
*/
public function validate($data, $view = null)
{
/* @var InstallationApplicationWeb $app */
$app = JFactory::getApplication();
// Get the form.
$form = $this->getForm($view);
// Check for an error.
if ($form === false)
{
return false;
}
// Filter and validate the form data.
$data = $form->filter($data);
$return = $form->validate($data);
// Check for an error.
if ($return instanceof Exception)
{
$app->enqueueMessage($return->getMessage(), 'warning');
return false;
}
// Check the validation results.
if ($return === false)
{
// Get the validation messages from the form.
foreach ($form->getErrors() as $message)
{
if ($message instanceof Exception)
{
$app->enqueueMessage($message->getMessage(), 'warning');
}
else
{
$app->enqueueMessage($message, 'warning');
}
}
return false;
}
return $data;
}
}

Documentation generated on Tue, 19 Nov 2013 15:12:58 +0100 by phpDocumentor 1.4.3

Source for file setup.php