local_mamp.php

#!/usr/bin/env php
<?php

# INTERNAL SETTINGS ###########################################################
define('MYSQL_BIN', '/Applications/MAMP/Library/bin/mysql');

define('STARTING_POINT_NAME_SAMPLE_CONTENT', 'standard');
define('STARTING_POINT_NAME_EMPTY_CONTENT', 'blank');

//The following files must exist in the same directory as this-here local_mamp.php script:
define('FILENAME_DOWNLOAD_URLS', 'download_urls.php'); //required
define('FILENAME_SETTINGS', 'settings.php'); //required
define('FILENAME_INSTALL_C5_CLI', 'install-concrete5.php'); //required
define('FILENAME_ADD_TO_CONFIG', 'append_to_config_site_php.txt'); //optional (use empty string if none)
define('FILENAME_CLI_LOGIN', 'temp_cli_login.html'); //optional (use empty string if none)
define('FILENAME_ZENDLOCALEDATA_BLACKLIST', 'remove_zend_locale_data.txt'); //optional (use empty string if none).


# LOAD AVAILABLE C5 VERSIONS ##################################################
$download_urls_file_path = dirname(__FILE__) . '/' . FILENAME_DOWNLOAD_URLS;
if (!is_file($download_urls_file_path)) {
	echo "ABORTING INSTALLATION: CANNOT LOCATE DOWNLOAD-URLS FILE ({$download_urls_file_path})!\n";
	exit;
}
require($download_urls_file_path); //sets the $c5_versions array


# LOAD USER SETTINGS ##########################################################
$settings_file_path = dirname(__FILE__) . '/' . FILENAME_SETTINGS;
if (!is_file($settings_file_path)) {
	echo "ABORTING INSTALLATION: CANNOT LOCATE SETTINGS FILE ({$settings_file_path})!\n";
	exit;
}
require($settings_file_path);


# VALIDATE CONFIG SETTINGS ####################################################
$c5_cli_script_path = dirname(__FILE__) . '/' . FILENAME_INSTALL_C5_CLI;
if (!is_file($c5_cli_script_path)) {
	echo "ABORTING INSTALLATION: CANNOT LOCATE C5 CLI INSTALL SCRIPT ({$c5_cli_script_path})!\n";
	exit;
}

if (strlen(ADMIN_PASSWORD) < 5 || strlen(ADMIN_PASSWORD) > 64) {
	echo "ABORTING INSTALLATION: ADMIN PASSWORD MUST BE BETWEEN 5 AND 64 CHARACTERS!\n";
	exit;
}

$zend_locale_data_blacklist = '';
if (FILENAME_ZENDLOCALEDATA_BLACKLIST !== '') {
	$zend_locale_data_blacklist = dirname(__FILE__) . '/' . FILENAME_ZENDLOCALEDATA_BLACKLIST;
	if (!is_file($zend_locale_data_blacklist)) {
		echo "ABORTING INSTALLATION: CANNOT LOCATE ZEND LOCALE DATA BLACKLIST ({$zend_locale_data_blacklist})!\n";
		exit;
	}
}


# ASK USER FOR PARAMS #########################################################
system('clear');
echo "Concrete5 MAMP Setup Script\n";
echo "===========================\n\n";

# Choose version
echo "Available Concrete5 versions...\n";
for ($i = 0, $len = count($c5_versions); $i < $len; $i++) {
	echo ($i + 1) . ') ' . $c5_versions[$i]['number'];
	echo ($i == 0) ? ' (DEFAULT)' : '';
	echo "\n";
}
echo "\n";
$version_choice = stdin("Enter line number (1, 2, 3, etc.) for the version to install (or leave blank for default):", false);
$version_choice = empty($version_choice) ? 1 : intval($version_choice);
$version_choice = ($version_choice < 1 || $version_choice > count($c5_versions)) ? 1 : $version_choice;
$version = $c5_versions[($version_choice-1)];

# Get target directory
$htdocs_dir = '/' . trim(HTDOCS_DIR, '/') . '/';
$htdocs_url = rtrim(BASE_URL, '/') . '/';
$response = stdin("Enter target directory (trailing slash will be stripped):\n" . $htdocs_dir);
$target_dir = $htdocs_dir . trim($response, '/');
$target_url = $htdocs_url . trim($response, '/');
if (is_dir($target_dir)) {
	echo "ABORTING INSTALLATION: TARGET DIRECTORY ({$target_dir}) ALREADY EXISTS!\n";
	exit;
}


# Get DB name
$database = stdin("Enter database name (must not already exist):\nDatabase Name: ");
$database = strip_unsafe_cli_chars($database);

# Get site name
$site = stdin("Enter Site Name (quotes/exclamations will be stripped)\nSite Name: ");
$site = strip_unsafe_cli_chars($site);

# Ask for sample content or blank
$response = stdin("Install C5 sample content (Y/n)?\ny/n (default y): ", false);
$starting_point = (strtolower($response) == "n") ? STARTING_POINT_NAME_EMPTY_CONTENT : STARTING_POINT_NAME_SAMPLE_CONTENT;

# Ask about optional functionality
$response = stdin("Remove empty top-level folders (y/N)?\ny/n (default: n): ", false);
$remove_empty_toplevel_folders = (strtolower($response) == 'y');

if (empty($zend_locale_data_blacklist)) {
	echo "Zend Locale Data: All files will remain in the installation because no blacklist file was specified.\n\n";
} else {
	$response = stdin("Remove non-english Zend Locale Data (y/N)?\ny/n (default: n): ", false);
	$remove_nonengligh_zend_locale_data = (strtolower($response) == 'y');
}


# CHECK DATABASE (ALSO SERVES AS A CHECK TO ENSURE MAMP IS RUNNING) ###########
$sql = "SHOW DATABASES LIKE '{$database}'";
$db_check = mysql_exec($sql, true);

if (strpos($db_check, 'ERROR') === 0) {
	echo "ABORTING INSTALLATION: THE FOLLOWING DATABASE ERROR OCCURRED: {$db_check}\n";
	if (strpos($db_check, 'ERROR 2002') === 0) {
		echo "(Make sure MAMP is up and running and that the MySQL server has started.)\n\n";
	}
	exit;
} else if (strlen($db_check) > 0) {
	echo "ABORTING INSTALLATION: DATABASE ({$database}) ALREADY EXISTS!\n";
	exit;
}

# VALIDATE & SETUP DIRECTORIES AND FILES ######################################
$parent_dir = dirname($target_dir);
$c5_download_zippath = $parent_dir . '/temp_concrete5_cli_download.zip';
$c5_download_unzipped_dir = $parent_dir . '/' . $version['unzips_to'];

if (is_file($c5_download_zippath)) {
	echo "ABORTING INSTALLATION: DOWNLOAD FILE NAME ({$c5_download_zippath}) ALREADY EXISTS!\n";
	exit;
}
if (is_dir($c5_download_unzipped_dir)) {
	echo "ABORTING INSTALLATION: DOWNLOAD UNZIPS-TO DIRECTORY NAME ({$c5_download_unzipped_dir}) ALREADY EXISTS!\n";
	exit;
}
system('mkdir -p ' . $parent_dir); //Ensure the target directory's parent directory exists (the -p option does 2 things for us: creates all necessary hierarchies, *AND* silcences error output if directory already exists)


# DOWNLOAD/INSTALL C5 FILES ###################################################
echo "Downloading Concrete5 version {$version['number']}...\n";
system("curl -o {$c5_download_zippath} {$version['url']}");

echo "Unzipping {$c5_download_zippath}...\n";
system("unzip {$c5_download_zippath} -d " . $parent_dir);

echo "Removing downloaded file...\n";
system("rm {$c5_download_zippath}");

echo "Move Concrete5 files to target directory...\n";
if (!is_dir($c5_download_unzipped_dir)) {
	echo "ERROR: CANNOT LOCATE UNZIPPED CONCRETE5 DIRECTORY -- EXPECTED IT IN: {$c5_download_unzipped_dir}\n";
	exit;
}
system("mv {$c5_download_unzipped_dir} {$target_dir}");

if ($version['number'] == '5.5.1') {
	fix_551_install_controller_bug($target_dir);
}

# INSTALL DATABASE AND C5 #####################################################
echo "Creating database $database...\n";
$sql = "CREATE DATABASE \`{$database}\` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci"; //note the very precise escaping of backticks -- if you don't do this, they messup the command line instruction (and if we didn't include backticks, then the SQL command might fail if there are certain characters (e.g. dashes) in the db name
mysql_exec($sql);

echo "Installing Concrete5...\n";
$c5_install_command = $c5_cli_script_path
                    . ' --db-server=' . DB_SERVER
                    . ' --db-username=' . DB_USERNAME
                    . ' --db-password=' . DB_PASSWORD
                    . ' --db-database=' . $database
                    . ' --admin-password=' . ADMIN_PASSWORD
                    . ' --admin-email=' . ADMIN_EMAIL
                    . ' --starting-point=' . $starting_point
                    . ' --target=' . $target_dir
                    . ' --site="' . $site . '"';
system($c5_install_command);


# CUSTOMIZE CONFIG FILE #######################################################
if (FILENAME_ADD_TO_CONFIG !== '') {
	echo "Customizing config/site.php file...\n";
	$add_to_config_php_path = dirname(__FILE__) . '/' . FILENAME_ADD_TO_CONFIG;
	if (is_file($add_to_config_php_path) && filesize($add_to_config_php_path) > 0) {
		#add a newline to end of file (to separate our items from existing items)
		system("echo >> {$target_dir}/config/site.php");
	} else {
		#create file, and put opening php tag at top
		system('echo -e "<?php\n" >> ' . $target_dir . '/config/site.php');
	}
	system('cat ' . dirname(__FILE__) . '/' . FILENAME_ADD_TO_CONFIG . " >> {$target_dir}/config/site.php");
}


# REMOVE NON-ENGLISH ZEND_LOCALE_DATA #########################################
if ($remove_nonengligh_zend_locale_data) {
	echo "Removing non-english Zend/Locale/Data files...\n";
	
	$blacklist_contents = file_get_contents($zend_locale_data_blacklist);
	$blacklist_contents = str_replace("\r\n", "\n", $blacklist_contents);
	$blacklist_contents = str_replace("\r", "\n", $blacklist_contents);
	$remove_filenames = explode("\n", $blacklist_contents);
	
	$zend_locale_data_dir = $target_dir . '/concrete/libraries/3rdparty/Zend/Locale/Data'; //NO trailing slash!
	
	foreach ($remove_filenames as $filename) {
		if (!empty($filename)) {
			unlink("{$zend_locale_data_dir}/{$filename}");
		}
	}
	
	//random note: if you want to remove these files from a site that has already been installed,
	//             copy the remove_zend_locale_data.txt file into SITE/concrete/libraries/3rdparty/Zend/Locale/Data/
	//             and then run this from the command line:   rm `cat remove_zend_locale_data.txt`
}


# REMOVE EMPTY TOP-LEVEL FOLDERS ##############################################
if ($remove_empty_toplevel_folders) {
	echo "Removing empty top-level folders...\n";
	if (version_compare($version['number'], '5.6.1', '<')) {
		fix_lt561_exception_raised_when_no_jobs_dir($target_dir, $version);
	}
	rmdir("{$target_dir}/blocks"); //???
	rmdir("{$target_dir}/controllers");
	rmdir("{$target_dir}/css");
	rmdir("{$target_dir}/elements");
	rmdir("{$target_dir}/helpers");
	rmdir("{$target_dir}/jobs");
	rmdir("{$target_dir}/js");
	rmdir("{$target_dir}/languages");
	rmdir("{$target_dir}/libraries");
	rmdir("{$target_dir}/mail");
	rmdir("{$target_dir}/models");
	rmdir("{$target_dir}/packages"); //???
	rmdir("{$target_dir}/page_types");
	rmdir("{$target_dir}/single_pages");
	rmdir("{$target_dir}/themes"); //???
	rmdir("{$target_dir}/tools");
	rmdir("{$target_dir}/updates");
	unlink("{$target_dir}/INSTALL");
	unlink("{$target_dir}/LICENSE.TXT");
}


# OPEN SITE IN FINDER & LOGIN IN BROWSER ######################################
system("open {$target_dir}");

if (FILENAME_CLI_LOGIN !== '') {
	echo "Logging in...\n";
	
	$login_file_source_path = dirname(__FILE__) . '/' . FILENAME_CLI_LOGIN;
	$login_file_dest_path = $target_dir . '/config/' . FILENAME_CLI_LOGIN;
	$login_file_url = $target_url . '/config/' . FILENAME_CLI_LOGIN . '#' . ADMIN_PASSWORD;
	
	system("cp {$login_file_source_path} {$login_file_dest_path}");
	system("open {$login_file_url}");
	echo "Deleting temporary login file ({$login_file_dest_path}) in 5 seconds...";
	shell_exec('sleep 5');
	system("rm {$login_file_dest_path}");
	echo "\nTemporary login file ({$login_file_dest_path}) has been deleted.";
}


# DONE! #######################################################################
echo "\n\nYour new site ({$site}) has been successfully installed!\n";
echo str_repeat('=', strlen($site));
echo "=================================================\n\n";


# Utility Functions ###########################################################
function stdin($prompt, $required = true) {
	echo $prompt;
	
	$handle = fopen('php://stdin', 'r');
	$response = fgets($handle);
	$response = trim($response); //response always comes back with a newline at the end!
	
	if ($required && empty($response)) {
		return stdin($prompt, $required);
	} else {
		echo "\n\n";
		return $response;
	}
}

//NOTE: $sql MUST NOT HAVE ANY QUOTES IN IT!!! (Apostrophes are okay though.)
function mysql_exec($sql, $return_output = false) {
	$command = MYSQL_BIN
             . ' -u' . DB_USERNAME
             . ((DB_PASSWORD == '') ? '' : ' -p' . DB_PASSWORD)
             . ' -e "' . $sql . '" 2>&1'; //the 2>&1 redirects STDERR to STDOUT (because the command might result in an error which doesn't actually output anything, but we want to return that error message as if it were outputted -- e.g. if MySQL isn't running)
	if ($return_output) {
		return shell_exec($command);
	} else {
		system($command);
	}
}

function strip_unsafe_cli_chars($str) {
	$bad_chars = array('"', "'", '`', '!'); //exclamations and backticks mess up command lines!
	return str_replace($bad_chars, '', $str);
}

function fix_551_install_controller_bug($target_dir) {
	//This issue only applies to 5.5.1, so don't call this function if you're on 5.5.2+
	$search = "\$this->redirect('/');";
	$replace = "if (PHP_SAPI != 'cli') { \$this->redirect('/'); }";
	$file = $target_dir . '/concrete/controllers/install.php';
	file_replace_contents($search, $replace, $file);
}

function fix_lt561_exception_raised_when_no_jobs_dir($target_dir, $version) {
	//This issue was fixed in 5.6.1, so don't call this function if you're on 5.6.1+
	$search = 'else throw new Exception( t(\'Error: Invalid Jobs Directory %s\', $jobClassLocation) );';
	$replace = '';
	if (version_compare($version['number'], '5.6', '<')) {
		$file = $target_dir . '/concrete/models/job.php';
	} else {
		$file = $target_dir . '/concrete/core/models/job.php';
	}
	file_replace_contents($search, $replace, $file);
}

function file_replace_contents($search, $replace, $file) {
	$size = filesize($file);
	$handle = fopen($file, 'r');
	$contents = fread($handle, $size);
	fclose($handle);
	
	$contents = str_replace($search, $replace, $contents);

	$handle = fopen($file, 'w');
	fwrite($handle, $contents);
	fclose($handle);
}