ElggInstaller Class Reference

Elgg Installer. More...

Public Member Functions
	run ()
	Dispatches a request to one of the step controllers. More...
	setAutoLogin ($flag)
	Set the auto login flag. More...
	batchInstall (array $params, $create_htaccess=false)
	A batch install of Elgg. More...

Public Attributes
const	MARIADB_MINIMAL_VERSION = '10.3'
const	MYSQL_MINIMAL_VERSION = '5.7'
const	PHP_MINIMAL_VERSION = '8.0.0'

Protected Member Functions
	getApp ()
	Build the application needed by the installer. More...
	render ($step, $vars=[])
	Renders the data passed by a controller. More...
	runWelcome ($vars)
	Step controllers. More...
	runRequirements ($vars)
	Requirements controller. More...
	runDatabase ($submissionVars)
	Database set up controller. More...
	runSettings ($submissionVars)
	Site settings controller. More...
	runAdmin ($submissionVars)
	Admin account controller. More...
	runComplete ()
	Controller for last step. More...
	getSteps ()
	Step management. More...
	getCurrentStep ()
	Returns current step. More...
	continueToNextStep ($currentStep)
	Forwards the browser to the next step. More...
	getNextStep ($currentStep)
	Get the next step as a string. More...
	getNextStepUrl ($currentStep)
	Get the URL of the next step. More...
	determineInstallStatus ()
	Updates $this->has_completed according to the current installation. More...
	checkInstallCompletion ($step)
	Security check to ensure the installer cannot be run after installation has finished. More...
	resumeInstall ($step)
	Check if this is a case of a install being resumed and figure out where to continue from. More...
	finishBootstrapping ($step)
	Bootstrapping. More...
	loadSettingsFile ()
	Load settings. More...
	makeFormSticky ($formVars, $submissionVars)
	Action handling methods. More...
	isInstallDirWritable (&$report)
	Indicates whether the webserver can add settings.php on its own or not. More...
	checkSettingsFile (&$report=[])
	Check that the settings file exists. More...
	checkPHP (&$report)
	Check version of PHP, extensions, and variables. More...
	checkPhpExtensions (&$phpReport)
	Check the server's PHP extensions. More...
	checkPhpDirectives (&$phpReport)
	Check PHP parameters. More...
	checkRewriteRules (&$report)
	Confirm that the rewrite rules are firing. More...
	countNumConditions ($report, $condition)
	Count the number of failures in the requirements report. More...
	validateDatabaseVars ($submissionVars, $formVars)
	Database support methods. More...
	checkDatabaseSettings ($user, $password, $dbname, $host, $port)
	Confirm the settings for the database. More...
	createSettingsFile ($params)
	Writes the settings file to the engine directory. More...
	connectToDatabase ()
	Bootstrap database connection before entire engine is available. More...
	installDatabase ()
	Create the database tables. More...
	createDataDirectory (&$submissionVars, $formVars)
	Site settings support methods. More...
	validateSettingsVars ($submissionVars, $formVars)
	Validate the site settings form variables. More...
	saveSiteSettings ($submissionVars)
	Initialize the site including site entity, plugins, and configuration. More...
	validateAdminVars ($submissionVars, $formVars)
	Validate account form variables. More...
	createAdminAccount ($submissionVars, $login=false)
	Create a user account for the admin. More...
	sanitizeInputValue ($input_value)
	Sanitize input to help prevent XSS. More...

Detailed Description

Elgg Installer.

Controller for installing Elgg. Supports both web-based on CLI installation.

This controller steps the user through the install process. The method for each step handles both the GET and POST requests. There is no XSS/CSRF protection on the POST processing since the installer is only run once by the administrator.

The installation process can be resumed by hitting the first page. The installer will try to figure out where to pick up again.

All the logic for the installation process is in this class, but it depends on the core libraries. To do this, we selectively load a subset of the core libraries for the first few steps and then load the entire engine once the database and site settings are configured. In addition, this controller does its own session handling until the database is setup.

There is an aborted attempt in the code at creating the data directory for users as a subdirectory of Elgg's root. The idea was to protect this directory through a .htaccess file. The problem is that a malicious user can upload a .htaccess of his own that overrides the protection for his user directory. The best solution is server level configuration that turns off AllowOverride for the data directory. See ticket #3453 for discussion on this.

Definition at line 41 of file ElggInstaller.php.

Member Function Documentation

ElggInstaller::batchInstall	(	array	$params,
			$create_htaccess = false
	)

A batch install of Elgg.

All required parameters must be passed in as an associative array. See $requiredParams for a list of them. This creates the necessary files, loads the database, configures the site settings, and creates the admin account. If it fails, an exception is thrown. It does not check any of the requirements as the multiple step web installer does.

Parameters

array	$params	Array of key value pairs
bool	$create_htaccess	Should .htaccess be created

Returns

void

Exceptions

InstallationException

Definition at line 200 of file ElggInstaller.php.

ElggInstaller::checkDatabaseSettings (   $user,   $password,   $dbname,   $host,   $port  )

protected

Confirm the settings for the database.

Parameters

string	$user	Username
string	$password	Password
string	$dbname	Database name
string	$host	Host
int	$port	Port

Returns

bool

Definition at line 1231 of file ElggInstaller.php.

ElggInstaller::checkInstallCompletion (   $step )

protected

Security check to ensure the installer cannot be run after installation has finished.

If this is detected, the viewer is sent to the front page.

Parameters

string

$step

Installation step to check against

Returns

|null

Definition at line 817 of file ElggInstaller.php.

ElggInstaller::checkPHP ( &  $report )

protected

Check version of PHP, extensions, and variables.

Parameters

array

$report

The requirements report array

Returns

void

Definition at line 982 of file ElggInstaller.php.

ElggInstaller::checkPhpDirectives ( &  $phpReport )

protected

Check PHP parameters.

Parameters

array

$phpReport

The PHP requirements report array

Returns

void

Definition at line 1050 of file ElggInstaller.php.

ElggInstaller::checkPhpExtensions ( &  $phpReport )

protected

Check the server's PHP extensions.

Parameters

array

$phpReport

The PHP requirements report array

Returns

void

Definition at line 1013 of file ElggInstaller.php.

ElggInstaller::checkRewriteRules ( &  $report )

protected

Confirm that the rewrite rules are firing.

Parameters

array

$report

The requirements report array

Returns

void

Definition at line 1095 of file ElggInstaller.php.

ElggInstaller::checkSettingsFile ( &  $report = [] )

protected

Check that the settings file exists.

Parameters

array

$report

The requirements report array

Returns

bool

Definition at line 958 of file ElggInstaller.php.

ElggInstaller::connectToDatabase ( )

protected

Bootstrap database connection before entire engine is available.

Returns

bool

Definition at line 1330 of file ElggInstaller.php.

ElggInstaller::continueToNextStep (   $currentStep )

protected

Forwards the browser to the next step.

Parameters

string

$currentStep

Current installation step

Returns

Definition at line 699 of file ElggInstaller.php.

ElggInstaller::countNumConditions (   $report,   $condition  )

protected

Count the number of failures in the requirements report.

Parameters

array	$report	The requirements report array
string	$condition	'failure' or 'warning'

Returns

int

Definition at line 1114 of file ElggInstaller.php.

ElggInstaller::createAdminAccount (   $submissionVars,   $login = false  )

protected

Create a user account for the admin.

Parameters

array	$submissionVars	Submitted vars
bool	$login	Login in the admin user?

Returns

bool

Definition at line 1567 of file ElggInstaller.php.

ElggInstaller::createDataDirectory ( &  $submissionVars,   $formVars  )

protected

Site settings support methods.

Create the data directory if requested

Parameters

array	$submissionVars	Submitted vars
array	$formVars	Variables in the form

Returns

bool

Definition at line 1368 of file ElggInstaller.php.

ElggInstaller::createSettingsFile (   $params )

protected

Writes the settings file to the engine directory.

Parameters

array

$params

Array of inputted params from the user

Returns

bool

Definition at line 1277 of file ElggInstaller.php.

ElggInstaller::determineInstallStatus ( )

protected

Updates $this->has_completed according to the current installation.

Returns

void

Exceptions

InstallationException

Definition at line 738 of file ElggInstaller.php.

ElggInstaller::finishBootstrapping (   $step )

protected

Bootstrapping.

Load remaining engine libraries and complete bootstrapping

Parameters

string

$step

Which step to boot strap for. Required because boot strapping is different until the DB is populated.

Returns

void

Definition at line 870 of file ElggInstaller.php.

ElggInstaller::getApp ( )

protected

Build the application needed by the installer.

Returns

Application

Exceptions

InstallationException

Definition at line 112 of file ElggInstaller.php.

ElggInstaller::getCurrentStep ( )

protected

Returns current step.

Returns

string

Definition at line 682 of file ElggInstaller.php.

ElggInstaller::getNextStep (   $currentStep )

protected

Get the next step as a string.

Parameters

string

$currentStep

Current installation step

Returns

string

Definition at line 712 of file ElggInstaller.php.

ElggInstaller::getNextStepUrl (   $currentStep )

protected

Get the URL of the next step.

Parameters

string

$currentStep

Current installation step

Returns

string

Definition at line 725 of file ElggInstaller.php.

ElggInstaller::getSteps ( )

protected

Step management.

Get an array of steps

Returns

array

Definition at line 673 of file ElggInstaller.php.

ElggInstaller::installDatabase ( )

protected

Create the database tables.

Returns

bool

Definition at line 1348 of file ElggInstaller.php.

ElggInstaller::isInstallDirWritable ( &  $report )

protected

Indicates whether the webserver can add settings.php on its own or not.

Parameters

array

$report

The requirements report object

Returns

bool

Definition at line 936 of file ElggInstaller.php.

ElggInstaller::loadSettingsFile ( )

protected

Load settings.

Returns

void

Exceptions

InstallationException

Definition at line 893 of file ElggInstaller.php.

ElggInstaller::makeFormSticky (   $formVars,   $submissionVars  )

protected

Action handling methods.

If form is reshown, remember previously submitted variables

Parameters

array	$formVars	Vars int he form
array	$submissionVars	Submitted vars

Returns

array

Definition at line 919 of file ElggInstaller.php.

ElggInstaller::render (   $step,   $vars = []  )

protected

Renders the data passed by a controller.

Parameters

string	$step	The current step
array	$vars	Array of vars to pass to the view

Returns

Definition at line 306 of file ElggInstaller.php.

ElggInstaller::resumeInstall (   $step )

protected

Check if this is a case of a install being resumed and figure out where to continue from.

Returns the best guess on the step.

Parameters

string

$step

Installation step to resume from

Returns

|null

Definition at line 836 of file ElggInstaller.php.

ElggInstaller::run

(

)

Dispatches a request to one of the step controllers.

Returns

Definition at line 77 of file ElggInstaller.php.

ElggInstaller::runAdmin (   $submissionVars )

protected

Admin account controller.

Creates an admin user account

Parameters

array

$submissionVars

Submitted vars

Returns

Definition at line 571 of file ElggInstaller.php.

ElggInstaller::runComplete ( )

protected

Controller for last step.

Returns

Definition at line 646 of file ElggInstaller.php.

ElggInstaller::runDatabase (   $submissionVars )

protected

Database set up controller.

Creates the settings.php file and creates the database tables

Parameters

array

$submissionVars

Submitted form variables

Returns

Definition at line 398 of file ElggInstaller.php.

ElggInstaller::runRequirements (   $vars )

protected

Requirements controller.

Checks version of php, libraries, permissions, and rewrite rules

Parameters

array

$vars

Vars

Returns

Definition at line 349 of file ElggInstaller.php.

ElggInstaller::runSettings (   $submissionVars )

protected

Site settings controller.

Sets the site name, URL, data directory, etc.

Parameters

array

$submissionVars

Submitted vars

Returns

Definition at line 513 of file ElggInstaller.php.

ElggInstaller::runWelcome (   $vars )

protected

Step controllers.

Welcome controller

Parameters

array

$vars

Not used

Returns

Definition at line 336 of file ElggInstaller.php.

ElggInstaller::sanitizeInputValue (   $input_value )

protected

Sanitize input to help prevent XSS.

Parameters

mixed

$input_value

the input to sanitize

Returns

mixed

Definition at line 1616 of file ElggInstaller.php.

ElggInstaller::saveSiteSettings (   $submissionVars )

protected

Initialize the site including site entity, plugins, and configuration.

Parameters

array

$submissionVars

Submitted vars

Returns

bool

Definition at line 1434 of file ElggInstaller.php.

ElggInstaller::setAutoLogin

(

$flag

)

Set the auto login flag.

Parameters

bool

$flag

Auto login

Returns

void

Definition at line 181 of file ElggInstaller.php.

ElggInstaller::validateAdminVars (   $submissionVars,   $formVars  )

protected

Validate account form variables.

Parameters

array	$submissionVars	Submitted vars
array	$formVars	Form vars

Returns

bool

Definition at line 1516 of file ElggInstaller.php.

ElggInstaller::validateDatabaseVars (   $submissionVars,   $formVars  )

protected

Database support methods.

Validate the variables for the database step

Parameters

array	$submissionVars	Submitted vars
array	$formVars	Vars in the form

Returns

bool

Definition at line 1139 of file ElggInstaller.php.

ElggInstaller::validateSettingsVars (   $submissionVars,   $formVars  )

protected

Validate the site settings form variables.

Parameters

array	$submissionVars	Submitted vars
array	$formVars	Vars in the form

Returns

bool

Definition at line 1403 of file ElggInstaller.php.

Member Data Documentation

const ElggInstaller::MARIADB_MINIMAL_VERSION = '10.3'

Definition at line 43 of file ElggInstaller.php.

const ElggInstaller::MYSQL_MINIMAL_VERSION = '5.7'

Definition at line 44 of file ElggInstaller.php.

const ElggInstaller::PHP_MINIMAL_VERSION = '8.0.0'

Definition at line 45 of file ElggInstaller.php.

---

The documentation for this class was generated from the following file:

• engine/classes/ElggInstaller.php