• Home
• ElggInstaller

PHP Class ElggInstaller, Elgg

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. ファイルを表示 Open project: elgg/elgg Class Usage Examples

Protected Properties

Property	Type	Description
$autoLogin
$isAction
$status
$steps

Public Methods

Method	Description
__construct ( )	Constructor bootstraps the Elgg engine
batchInstall ( array $params, boolean $createHtaccess = FALSE ) : void	A batch install of Elgg
run ( string $step ) : void	Dispatches a request to one of the step controllers
setAutoLogin ( boolean $flag ) : void	Set the auto login flag

Protected Methods

Method	Description
admin ( array $submissionVars ) : void	Admin account controller
bootstrapConfig ( ) : void	Set up configuration variables
bootstrapEngine ( ) : void	Load the essential libraries of the engine
checkDatabaseSettings ( string $user, string $password, string $dbname, string $host ) : boolean	Confirm the settings for the database
checkInstallCompletion ( string $step ) : void	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.
checkPHP ( &$report ) : void	Check version of PHP, extensions, and variables
checkPhpDirectives ( &$phpReport ) : void	Check PHP parameters
checkPhpExtensions ( &$phpReport ) : void	Check the server's PHP extensions
checkRewriteRules ( &$report ) : void	Confirm that the rewrite rules are firing
checkSettingsFile ( &$report = [] ) : boolean	Check that the settings file exists
complete ( ) : void	Controller for last step
connectToDatabase ( ) : boolean	Bootstrap database connection before entire engine is available
continueToNextStep ( string $currentStep ) : void	Forwards the browser to the next step
countNumConditions ( array $report, string $condition ) : integer	Count the number of failures in the requirements report
createAdminAccount ( array $submissionVars, boolean $login = FALSE ) : boolean	Create a user account for the admin
createDataDirectory ( &$submissionVars, array $formVars ) : boolean	Create the data directory if requested
createSettingsFile ( array $params ) : boolean	Writes the settings file to the engine directory
database ( array $submissionVars ) : void	Database set up controller
enablePlugins ( ) : void	Enable a set of default plugins
finishBootstraping ( string $step ) : void	Load remaining engine libraries and complete bootstrapping
getBaseUrl ( ) : string	Get the best guess at the base URL
getNextStep ( string $currentStep ) : string	Get the next step as a string
getNextStepUrl ( string $currentStep ) : string	Get the URL of the next step
getPostVariables ( ) : array	Return an associative array of post variables (could be selective based on expected variables)
getSteps ( ) : array	Get an array of steps
installDatabase ( ) : boolean	Create the database tables
isInstallDirWritable ( &$report ) : boolean	Indicates whether the webserver can add settings.php on its own or not.
loadSettingsFile ( ) : void	Load settings.php
makeFormSticky ( array $formVars, array $submissionVars ) : array	If form is reshown, remember previously submitted variables
processRewriteTest ( ) : void	Check if the request is coming from the URL rewrite test on the requirements page.
render ( string $step, array $vars = [] ) : void	Renders the data passed by a controller
requirements ( array $vars ) : void	Requirements controller
resumeInstall ( string $step ) : string	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.
saveSiteSettings ( array $submissionVars ) : boolean	Initialize the site including site entity, plugins, and configuration
setInstallStatus ( ) : void	Check the different install steps for completion
setSubtypeClasses ( ) : void	Register classes for core objects
settings ( array $submissionVars ) : void	Site settings controller
validateAdminVars ( array $submissionVars, array $formVars ) : boolean	Validate account form variables
validateDatabaseVars ( array $submissionVars, array $formVars ) : boolean	Validate the variables for the database step
validateSettingsVars ( array $submissionVars, array $formVars ) : boolean	Validate the site settings form variables
welcome ( array $vars ) : void	Welcome controller

Private Methods

Method	Description
getSettingsPath ( ) : string	Returns the path to the root settings.php file.
isHttps ( ) : boolean

Method Details

Property Details