tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

ENHANCEMENT Allowing SQLite selection in installer

Browse Source 
ENHANCEMENT Moved all Javascript containedin  install.php and config-form.html to install.js, and using jQuery to simplify logic
ENHANCEMENT Allow installer to attach custom form fields based on the install driver (as defined in _register_database.php) (from r101054)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@111576 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Sam Minnee 2010-10-04 04:43:12 +00:00
parent 0dcf75f965
commit 555762299d
5 changed files with 138 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
_register_database.php
View File

@ -6,7 +6,7 @@ DatabaseAdapterRegistry::register(
'class' => 'MySQLDatabase', 'class' => 'MySQLDatabase',
'title' => 'MySQL 4.1+', 'title' => 'MySQL 4.1+',
'helperPath' => 'sapphire/dev/install/MySQLDatabaseConfigurationHelper.php', 'helperPath' => 'sapphire/dev/install/MySQLDatabaseConfigurationHelper.php',
'supported' => function_exists('mysql_connect') 'supported' => function_exists('mysql_connect'),
) )
); );
@ -36,6 +36,19 @@ DatabaseAdapterRegistry::register(
'title' => 'SQLite 3.3+', 'title' => 'SQLite 3.3+',
'helperPath' => 'sqlite3/code/SQLiteDatabaseConfigurationHelper.php', 'helperPath' => 'sqlite3/code/SQLiteDatabaseConfigurationHelper.php',
'supported' => (class_exists('SQLite3') || class_exists('PDO')), 'supported' => (class_exists('SQLite3') || class_exists('PDO')),
'missingExtensionText' => 'The <a href="http://php.net/manual/en/book.sqlite3.php">SQLite3</a> and <a href="http://php.net/manual/en/book.pdo.php">PDO</a> classes are not available. Please install or enable them and refresh this page.' 'missingExtensionText' => 'The <a href="http://php.net/manual/en/book.sqlite3.php">SQLite3</a> and <a href="http://php.net/manual/en/book.pdo.php">PDO</a> classes are not available. Please install or enable them and refresh this page.',
'fields' => array(
'path' => array(
'title' => 'Database path',
'default' => realpath(dirname($_SERVER['SCRIPT_FILENAME'])) . '/assets/.sqlitedb'
),
'database' => array(
'title' => 'Database name',
'default' => 'SS_mysite',
'attributes' => array(
"onchange" => "this.value = this.value.replace(/[\/\\:*?&quot;<>|. \t]+/g,'');"
)
)
)
) )
); );

28
dev/install/DatabaseAdapterRegistry.php
View File

@ -10,6 +10,31 @@
*/ */
class DatabaseAdapterRegistry { class DatabaseAdapterRegistry {
static $default_fields = array(
'server' => array(
'title' => 'Database server',
'envVar' => 'SS_DATABASE_SERVER',
'default' => 'localhost'
),
'username' => array(
'title' => 'Database username',
'envVar' => 'SS_DATABASE_USERNAME',
'default' => 'root'
),
'password' => array(
'title' => 'Database password',
'envVar' => 'SS_DATABASE_PASSWORD',
'default' => 'password'
),
'database' => array(
'title' => 'Database name',
'default' => 'SS_mysite',
'attributes' => array(
"onchange" => "this.value = this.value.replace(/[\/\\:*?&quot;<>|. \t]+/g,'');"
)
),
);
/** /**
* Internal array of registered database adapters * Internal array of registered database adapters
*/ */
@ -32,6 +57,9 @@ class DatabaseAdapterRegistry {
$config['missingModuleText'] = $missingModuleText; $config['missingModuleText'] = $missingModuleText;
$config['missingExtensionText'] = $missingExtensionText; $config['missingExtensionText'] = $missingExtensionText;
// set default fields if none are defined already
if(!isset($config['fields'])) $config['fields'] = self::$default_fields;
self::$adapters[$config['class']] = $config; self::$adapters[$config['class']] = $config;
} }

151
dev/install/config-form.html
View File

@ -3,53 +3,8 @@
<head> <head>
<title>SilverStripe CMS / Framework Installation</title> <title>SilverStripe CMS / Framework Installation</title>
<meta http-equiv="Content-type" content="text/html; charset=utf-8"> <meta http-equiv="Content-type" content="text/html; charset=utf-8">
<script type="text/javascript"> <script type="text/javascript" src="sapphire/thirdparty/jquery/jquery.js"></script>
function $(id) { <script type="text/javascript" src="sapphire/dev/install/install.js"></script>
return document.getElementById(id);
}
function show(id) {
document.getElementById(id).style.display = '';
}
function hide(id) {
document.getElementById(id).style.display = 'none';
}
function getElementsByClassName(classname, node) {
if(!node) node = document.getElementsByTagName("body")[0];
var a = [];
var re = new RegExp('\\b' + classname + '\\b');
var els = node.getElementsByTagName("*");
for(var i=0,j=els.length; i<j; i++)
if(re.test(els[i].className))a.push(els[i]);
return a;
}
function toggleDisabledFields(el) {
if(!el.checked) {
// Go through each environment supported field and enable
document.getElementById('db_server').disabled = '';
document.getElementById('db_username').disabled = '';
document.getElementById('db_password').disabled = '';
document.getElementById('admin_username').disabled = '';
document.getElementById('admin_password').disabled = '';
document.getElementById('devsites').disabled = '';
var dbs = getElementsByClassName('databaseClass');
for(var i = 0; i < dbs.length; i++) {
dbs[i].disabled = '';
}
} else {
// Go through each environment supported field and disable
document.getElementById('db_server').disabled = 'disabled';
document.getElementById('db_username').disabled = 'disabled';
document.getElementById('db_password').disabled = 'disabled';
document.getElementById('admin_username').disabled = 'disabled';
document.getElementById('admin_password').disabled = 'disabled';
document.getElementById('devsites').disabled = 'disabled';
var dbs = getElementsByClassName('databaseClass');
for(var i = 0; i < dbs.length; i++) {
dbs[i].disabled = 'disabled';
}
}
}
</script>
<link rel="stylesheet" type="text/css" href="themes/blackcandy/css/layout.css"> <link rel="stylesheet" type="text/css" href="themes/blackcandy/css/layout.css">
<link rel="stylesheet" type="text/css" href="themes/blackcandy/css/typography.css"> <link rel="stylesheet" type="text/css" href="themes/blackcandy/css/typography.css">
<link rel="stylesheet" type="text/css" href="themes/blackcandy/css/form.css"> <link rel="stylesheet" type="text/css" href="themes/blackcandy/css/form.css">
@ -119,15 +74,15 @@
<strong>Note:</strong> It seems as though SilverStripe is already installed here. If you ask me to install, I will overwrite <strong>Note:</strong> It seems as though SilverStripe is already installed here. If you ask me to install, I will overwrite
the <strong>.htaccess</strong> and <strong>mysite/_config.php</strong> files. the <strong>.htaccess</strong> and <strong>mysite/_config.php</strong> files.
<br> <br>
<input type="checkbox" id="ReIn" name="force_reinstall" onclick="document.getElementById('install_button').disabled = !this.checked"><label for="ReIn">That's okay, please re-install SilverStripe and overwrite these files.</label> <input type="checkbox" id="ReIn" name="force_reinstall"><label for="ReIn">That's okay, please re-install SilverStripe and overwrite these files.</label>
</p> </p>
<?php } ?> <?php } ?>
<p> <p>
<?php if($alreadyInstalled) { ?> <?php if($alreadyInstalled) { ?>
<input id="install_button" type="submit" disabled="disabled" class="action" name="go" value="Install SilverStripe" onclick="document.getElementById('saving_top').style.display = ''; this.value = 'Installing SilverStripe...'"> <input id="install_button" type="submit" disabled="disabled" class="action" name="go" value="Install SilverStripe">
<?php } else { ?> <?php } else { ?>
<input id="install_button" type="submit" class="action" name="go" value="Install SilverStripe" onclick="document.getElementById('saving_top').style.display = ''; this.value = 'Installing SilverStripe...'"> <input id="install_button" type="submit" class="action" name="go" value="Install SilverStripe">
<?php } ?> <?php } ?>
<span id="saving_top" style="display: none"> <span id="saving_top" style="display: none">
@ -150,7 +105,7 @@
<div class="fields"> <div class="fields">
<?php if($envFileExists) { ?> <?php if($envFileExists) { ?>
<div id="use_environment_field" class="field"> <div id="use_environment_field" class="field">
<input id="use_environment" type="checkbox" name="useEnv" <?php if($usingEnv) echo "checked=\"checked\"" ?> onclick="toggleDisabledFields(this);"> <input id="use_environment" type="checkbox" name="useEnv" <?php if($usingEnv) echo "checked=\"checked\"" ?>>
<label for="use_environment">Use _ss_environment file for configuration</label> <label for="use_environment">Use _ss_environment file for configuration</label>
</div> </div>
<?php } ?> <?php } ?>
@ -160,7 +115,7 @@
<ul id="database_selection"> <ul id="database_selection">
<?php <?php
foreach($databaseClasses as $class => $details) { foreach($databaseClasses as $class => $details) {
$checked = ($databaseConfig['type'] == $class) ? ' checked="checked"' : ''; $checked = ($databaseConfig['type'] == $class || $type == $class) ? ' checked="checked"' : '';
$disabled = $help = ''; $disabled = $help = '';
if($usingEnv) { if($usingEnv) {
// All are disabled by default when environment is used // All are disabled by default when environment is used
@ -192,35 +147,54 @@
if ($help) { if ($help) {
echo '<div class="error databaseError">'.$help.'</div>'; echo '<div class="error databaseError">'.$help.'</div>';
} }
// generate db-specific config fields
echo '<div class="dbfields">';
if(isset($details['fields'])) foreach($details['fields'] as $fieldName => $fieldSpec) {
$fieldTitle = $fieldSpec['title'];
// values
$defaultValue = (isset($fieldSpec['default'])) ? $fieldSpec['default'] : null;
if($usingEnv && isset($fieldSpec['envVar']) && defined($fieldSpec['envVar'])) {
$value = constant($fieldSpec['envVar']);
} else {
$value = (isset($databaseConfig[$class][$fieldName])) ? $databaseConfig[$class][$fieldName] : $defaultValue;
}
// attributes
$attrs = array(
'id' => "db_{$class}_{$fieldName}",
'class' => 'text',
'type' => 'text',
'name' => "db[$class][$fieldName]",
'value' => $value,
);
if($usingEnv && isset($fieldSpec['envVar']) && defined($fieldSpec['envVar'])) {
$attrs['disabled'] = 'disabled';
}
if(isset($fieldSpec['envVar'])) {
$attrs['class'] .= ' configured-by-env';
}
$attrHTML = '';
foreach($attrs as $attrName => $attrValue) $attrHTML .= "$attrName=\"$attrValue\" ";
if(isset($fieldSpec['attributes'])) $attrs = array_merge($attrs, $fieldSpec['attributes']);
// html
echo "<div class=\"field\">";
echo "<label for=\"db_$class_$fieldName\">$fieldTitle:</label>";
echo "<span class=\"middleColumn\">";
echo "<input $attrHTML>";
echo "</span>";
echo "</div>";
}
echo '</div>';
echo "</li>"; echo "</li>";
} }
?> ?>
</ul> </ul>
</div> </div>
<div class="field">
<label for="db_server">Database server:</label>
<span class="middleColumn">
<input id="db_server" class="text" type="text" name="db[server]" value="<?php echo $databaseConfig['server']; ?>" <?php if($usingEnv && defined('SS_DATABASE_SERVER')) echo 'disabled="disabled"'; ?>>
</span>
</div>
<div class="field">
<label for="db_username">Database username:</label>
<span class="middleColumn">
<input id="db_username" class="text" type="text" name="db[username]" value="<?php echo $databaseConfig['username']; ?>" <?php if($usingEnv && defined('SS_DATABASE_USERNAME')) echo 'disabled="disabled"'; ?>>
</span>
</div>
<div class="field">
<label for="db_password">Database password:</label>
<span class="middleColumn">
<input id="db_password" class="text" type="password" name="db[password]" value="<?php echo $databaseConfig['password']; ?>" <?php if($usingEnv && defined('SS_DATABASE_PASSWORD')) echo 'disabled="disabled"'; ?>>
</span>
</div>
<div class="field">
<label for="db_database">Database name:</label>
<span class="middleColumn">
<input id="db_database" class="text" type="text" name="db[database]" value="<?php echo $databaseConfig['database']; ?>" onchange="this.value = this.value.replace(/[\/\\:*?&quot;<>|. \t]+/g,'');">
</span>
</div>
<div class="action"> <div class="action">
<input type="submit" class="action" value="Re-check requirements"> <input type="submit" class="action" value="Re-check requirements">
</div> </div>
@ -240,13 +214,13 @@
<div class="field"> <div class="field">
<label for="admin_username">Administrator email:</label> <label for="admin_username">Administrator email:</label>
<span class="middleColumn"> <span class="middleColumn">
<input type="text" class="text" name="admin[username]" id="admin_username" value="<?php echo $adminConfig['username']; ?>" <?php if($usingEnv && defined('SS_DEFAULT_ADMIN_USERNAME')) echo 'disabled="disabled"' ?>> <input type="text" class="text configured-by-env" name="admin[username]" id="admin_username" value="<?php echo $adminConfig['username']; ?>" <?php if($usingEnv && defined('SS_DEFAULT_ADMIN_USERNAME')) echo 'disabled="disabled"' ?>>
</span> </span>
</div> </div>
<div class="field"> <div class="field">
<label for="admin_password">Administrator password:</label> <label for="admin_password">Administrator password:</label>
<span class="middleColumn"> <span class="middleColumn">
<input type="password" class="text" name="admin[password]" id="admin_password" value="<?php echo $adminConfig['password']; ?>" <?php if($usingEnv && defined('SS_DEFAULT_ADMIN_PASSWORD')) echo 'disabled="disabled"' ?>> <input type="password" class="text configured-by-env" name="admin[password]" id="admin_password" value="<?php echo $adminConfig['password']; ?>" <?php if($usingEnv && defined('SS_DEFAULT_ADMIN_PASSWORD')) echo 'disabled="disabled"' ?>>
</span> </span>
</div> </div>
<div class="field"> <div class="field">
@ -273,7 +247,7 @@
<div class="field"> <div class="field">
<label for="devsites">Development servers:</label> <label for="devsites">Development servers:</label>
<span class="middleColumn"> <span class="middleColumn">
<textarea name="devsites" id="devsites" rows="5" cols="10"> <textarea name="devsites" id="devsites" class="configured-by-env" rows="5" cols="10">
<?php if(@$_POST['devsites']) echo $_POST['devsites']; <?php if(@$_POST['devsites']) echo $_POST['devsites'];
else echo 'localhost else echo 'localhost
127.0.0.1'; ?></textarea> 127.0.0.1'; ?></textarea>
@ -327,24 +301,5 @@ else echo 'localhost
<p><a href="http://www.silverstripe.org">SilverStripe Open Source CMS / Framework</a> | Copyright &copy; 2010 SilverStripe Limited</p> <p><a href="http://www.silverstripe.org">SilverStripe Open Source CMS / Framework</a> | Copyright &copy; 2010 SilverStripe Limited</p>
</div> </div>
</div> </div>
<script type="text/javascript">
var children = $('database_selection').childNodes;
var disabledAdapterClick = function(e) {
// Hide all existing warnings
var elements = getElementsByClassName('databaseError');
for(var i = 0; i < elements.length; i++) elements[i].style.display = 'none';
if (this.parentNode.childNodes[0].getAttribute('notavailable')) {
// Show the warning for this adapter
getElementsByClassName('databaseError', this.parentNode)[0].style.display = 'block';
return false;
}
}
for(var i = 0; i < children.length; i++) {
if (children[i].nodeType != 3) {
children[i].childNodes[0].nextSibling.onclick = disabledAdapterClick;
children[i].childNodes[0].onclick = disabledAdapterClick;
}
}
</script>
</body> </body>
</html> </html>

4
dev/install/install.css
View File

@ -152,6 +152,10 @@ table.testResults {
margin-right: 5px; margin-right: 5px;
} }
.dbfields {
margin: 10px;
}
#database_credentials { #database_credentials {
margin: 0; margin: 0;
line-height: 1; line-height: 1;

38
dev/install/install.js Normal file
View File

@ -0,0 +1,38 @@
$(document).ready(function() {
/**
* Toggle field readonly modes, if check configuration comes from
* _ss_environment (values populated on reload).
*/
$('#use_environment').click(function(e) {
if(!$(this).is(':checked')) {
$('.configured-by-env').removeAttr('disabled');
} else {
$('.configured-by-env').attr('disabled', 'disabled');
}
});
/**
* Hide all existing database warnings, and show only current one
*/
$('#database_selection li').click(function(e) {
$('.dbfields').hide();
// only show fields if there's no db error
if(!$('.databaseError', this).length) $('.dbfields', this).show();
$('.databaseError').hide();
$('.databaseError', this).show();
});
// Select first
$('#database_selection li input:checked').parents('li:first').click();
/**
* Install button
*/
$('#ReIn').click(function() {
$('#install_button').attr('disabled', !$(this).is(':checked'));
})
$('#install_button').click(function() {
$('#saving_top').hide();
$(this).val('Installing SilverStripe...');
})
});