2008-01-21 09:01:30 +01:00
< ? php
/**
* Configure Sapphire from the _ss_environment . php file .
* Usage : Put " require_once('sapphire/core/ConfigureFromEnv.php'); " into your _config . php file .
*
* If you include this file , you will be able to use the following defines in _ss_environment . php to control
* your site .
*
* Your database connection will be set up using these defines :
2009-05-27 01:45:54 +02:00
* - SS_DATABASE_CLASS : The database class to use , MySQLDatabase , MSSQLDatabase , etc . defaults to
* MySQLDatabase
* - SS_DATABASE_SERVER : The database server to use , defaulting to localhost
2008-01-21 09:01:30 +01:00
* - SS_DATABASE_USERNAME : The databsae username ( mandatory )
* - SS_DATABASE_PASSWORD : The database password ( mandatory )
2009-05-27 01:45:54 +02:00
* - SS_DATABASE_SUFFIX : A suffix to add to the database name .
* - SS_DATABASE_PREFIX : A prefix to add to the database name .
2008-01-21 09:01:30 +01:00
*
2008-11-18 02:48:37 +01:00
* There is one more setting that is intended to be used by people who work on SilverStripe .
2009-05-20 00:16:06 +02:00
* - SS_DATABASE_CHOOSE_NAME : Boolean / Int . If set , then the system will choose a default database name for you if one isn ' t give
2008-11-18 02:48:37 +01:00
* in the $database variable . The database name will be " SS_ " followed by the name of the folder into which you have installed
* SilverStripe . If this is enabled , it means that the phpinstaller will work out of the box without the installer needing to
* alter any files . This helps prevent accidental changes to the environment .
*
2009-05-20 00:16:06 +02:00
* If SS_DATABASE_CHOOSE_NAME is an integer greater than one , then an ancestor folder will be used for the database name . This
* is handy for a site that 's hosted from /sites/examplesite/www or /buildbot/allmodules-2.3/build. If it' s 2 , the parent folder
* will be chosen ; if it ' s 3 the grandparent , and so on .
*
2008-01-21 09:01:30 +01:00
* You can configure the environment with this define :
* - SS_ENVIRONMENT_TYPE : The environment type : dev , test or live .
*
2008-02-10 23:58:58 +01:00
* You can configure the default admin with these defines
* - SS_DEFAULT_ADMIN_USERNAME : The username of the default admin - this is a non - database user with administrative privileges .
* - SS_DEFAULT_ADMIN_PASSWORD : The password of the default admin .
2009-03-04 04:44:11 +01:00
* - SS_USE_BASIC_AUTH : Protect the site with basic auth ( good for test sites )
2008-02-10 23:58:58 +01:00
*
2008-01-21 09:01:30 +01:00
* Email :
* - SS_SEND_ALL_EMAILS_TO : If you set this define , all emails will be redirected to this address .
*
* @ package sapphire
* @ subpackage core
*/
/*
* _ss_environment . php handler
*/
2008-11-18 02:48:37 +01:00
if ( defined ( 'SS_ENVIRONMENT_FILE' )) {
// Only perform valdiation if SS_ENVIRONMENT_FILE is actually set, which is to say, there is an _ss_environment.php file
foreach ( array (
'SS_DATABASE_PASSWORD' ,
'SS_DATABASE_USERNAME' ,
'SS_ENVIRONMENT_TYPE' ,) as $reqDefine ) {
2009-11-06 04:35:07 +01:00
if ( ! defined ( $reqDefine )) user_error ( " $reqDefine must be defined in your _ss_environment.php. See http://doc.silverstripe.org/doku.php?id=environment-management for more infomration " , E_USER_ERROR );
2008-11-18 02:48:37 +01:00
}
}
2009-10-12 05:37:44 +02:00
if ( defined ( 'SS_USE_BASIC_AUTH' ) && SS_USE_BASIC_AUTH ) {
BasicAuth :: enable ();
}
2008-11-18 02:48:37 +01:00
if ( defined ( 'SS_ENVIRONMENT_TYPE' )) {
Director :: set_environment_type ( SS_ENVIRONMENT_TYPE );
2008-01-21 09:01:30 +01:00
}
2008-11-18 02:48:37 +01:00
global $database ;
// No database provided
if ( ! isset ( $database ) || ! $database ) {
// if SS_DATABASE_CHOOSE_NAME
if ( defined ( 'SS_DATABASE_CHOOSE_NAME' ) && SS_DATABASE_CHOOSE_NAME ) {
2009-05-20 00:16:06 +02:00
$loopCount = ( int ) SS_DATABASE_CHOOSE_NAME ;
$databaseDir = dirname ( $_SERVER [ 'SCRIPT_FILENAME' ]);
for ( $i = 0 ; $i < $loopCount ; $i ++ ) $databaseDir = dirname ( $databaseDir );
$database = " SS_ " . basename ( $databaseDir );
$database = str_replace ( '.' , '' , $database );
2008-11-18 02:48:37 +01:00
}
}
if ( defined ( 'SS_DATABASE_USERNAME' ) && defined ( 'SS_DATABASE_PASSWORD' )) {
global $databaseConfig ;
$databaseConfig = array (
2009-05-27 01:45:54 +02:00
" type " => defined ( 'SS_DATABASE_CLASS' ) ? SS_DATABASE_CLASS : " MySQLDatabase " ,
2008-11-18 02:48:37 +01:00
" server " => defined ( 'SS_DATABASE_SERVER' ) ? SS_DATABASE_SERVER : 'localhost' ,
" username " => SS_DATABASE_USERNAME ,
" password " => SS_DATABASE_PASSWORD ,
" database " => ( defined ( 'SS_DATABASE_PREFIX' ) ? SS_DATABASE_PREFIX : '' )
. $database
. ( defined ( 'SS_DATABASE_SUFFIX' ) ? SS_DATABASE_SUFFIX : '' ),
);
}
2008-01-21 09:01:30 +01:00
if ( defined ( 'SS_SEND_ALL_EMAILS_TO' )) {
Email :: send_all_emails_to ( SS_SEND_ALL_EMAILS_TO );
}
2008-02-10 23:58:58 +01:00
if ( defined ( 'SS_DEFAULT_ADMIN_USERNAME' )) {
2009-11-06 04:35:07 +01:00
if ( ! defined ( 'SS_DEFAULT_ADMIN_PASSWORD' )) user_error ( " SS_DEFAULT_ADMIN_PASSWORD must be defined in your _ss_environment.php, if SS_DEFAULT_ADMIN_USERNAME is defined. See http://doc.silverstripe.org/doku.php?id=environment-management for more infomration " , E_USER_ERROR );
2008-02-10 23:58:58 +01:00
Security :: setDefaultAdmin ( SS_DEFAULT_ADMIN_USERNAME , SS_DEFAULT_ADMIN_PASSWORD );
}
2009-03-04 04:44:11 +01:00
if ( defined ( 'SS_USE_BASIC_AUTH' ) && SS_USE_BASIC_AUTH ) {
BasicAuth :: enable ();
}
2008-08-11 06:41:54 +02:00
if ( defined ( 'SS_ERROR_LOG' )) {
Debug :: log_errors_to ( SS_ERROR_LOG );
2009-03-04 04:44:11 +01:00
}