scriptNode / Quickly Update DocumentRoot in Apache2

Quickly Update DocumentRoot in Apache2

Intermediate

Published August 10th, 2008 by Matt Hackett

For today's Script Sunday I thought I'd take a go back in time a little and provide an old utility that I still to this day find useful. It's a script I wrote called ChangeLocalHost which alters the DocumentRoot in apache2. An example of its use would be:

./clh.php local-site.com/public_html/

Note: you must be root to run it

Given this command, the script will change DocumentRoot to local-site.com/public_html/ and restart apache2. I work on a lot of websites (developing most of them on my laptop running apache2) so I use this script constantly.

Here's the code:

#!/usr/bin/php
<?php

/*
ChangeLocalHost v0.1 - last updated Mar 07 2007
Must be root to execute. Alters the DocumentRoot in Apache2's conf file, then restarts Apache2.
*/

$obj_clh = new ChangeLocalHost('/etc/apache2/sites-available/', 'default', '/home/www/');

$obj_clh->setArgs($_SERVER['argv']);
$obj_clh->run();

/**
 * CLH class constructor
 * @constructor
 */
class ChangeLocalHost {

private $arr_args,
			$bit_msgs,
			$str_dir,
			$str_file,
			$str_pre;

protected $str_version;

/**
	 * Constructor method
	 * @param string str_dir The location of the Apache conf file to mod
	 * @param string str_file The name of the Apache conf file to mod
	 * @param string str_pre The needle to search for in the conf file
	 */
	function __construct($str_dir, $str_file, $str_pre) {

$this->str_version = 'ChangeLocalHost v0.1';

$this->arr_args = Array();
		$this->bit_msgs = true;
		$this->str_dir  = $str_dir;
		$this->str_file = $str_file;
		$this->str_pre  = $str_pre;

}

/**
	 * Modify Apache's DocumentRoot
	 * @param string str_file The (conf) file to mod
	 * @param string str_new_dir The new directory to set as DocumentRoot
	 * @private
	 */
	private function alterLocalHost($str_file, $str_new_dir) {

$str_contents = file_get_contents($str_file);

if (!$str_contents) {
			$this->showError('Could not read ' . $str_file);
		}

$int_begin    = strpos($str_contents, $this->str_pre);
		$int_end      = strpos(substr($str_contents, $int_begin), "\n");
		$str_search   = substr($str_contents, $int_begin, $int_end);
		$str_contents = str_replace($str_search, $str_new_dir, $str_contents);
		$bit_written  = file_put_contents($str_file, $str_contents);

if ($bit_written) {
			$this->showMessage('Successfully set DocumentRoot to ' . $str_new_dir);
		} else {
			$this->showError('Could not write ' . $str_file);
		}

}

/**
	 * Validates the new directory to set
	 * @param string str_new_dir The potential new directory
	 * @private
	 */
	private function checkLocalHost($str_new_dir) {

$str_set_to = $this->str_pre . $str_new_dir;

if (is_dir($str_set_to)) {

$this->setLocalHost($str_set_to);
			$this->restartApache2();

} else {
			$this->showError($str_set_to . ' is not a valid directory.');
		}

}

/**
	 * Ensures this app is being executed as root
	 * @private
	 */
	private function checkRoot() {

// Make sure user is root
		$str_command = 'whoami';

exec($str_command, $arr_output, $int_return);

if ($arr_output[0] != 'root') {
			$this->showError('You must be root to run this program.');
		}

}

/**
	 * Makes a backup of the Apache conf file
	 * @param string str_source The original to copy
	 * @param string str_new The location of the backup
	 * @return bool Whether the copy was successful or not
	 * @private
	 */
	private function makeCopy($str_source, $str_new) {

$bit_copy = copy($str_source, $str_new);

if (!$bit_copy) {
			$this->showError('Could not make copy of ' . $str_source);
		}

return true;

}

/**
	 * Restarts Apache2
	 * @private
	 */
	private function restartApache2() {

$str_command = 'apache2ctl restart';

exec($str_command, $arr_output, $int_return);

if ($int_return > 0) {
			$this->showError('Could not restart Apache2.' . $str_source);
		}

$this->showMessage('Successfully restarted Apache2.');

}

/**
	 * Executes the script
	 */
	function run() {

$this->checkRoot();

$str_new_dir = $this->arr_args[1];

switch ($this->arr_args[1]) {

case '-c' :
			case '--current' :
				$this->showCurrent();
				break;

case '' :
			case '-h' :
			case '--help' :
				$this->showHelp();
				break;

case '-q' :
			case '--quiet' :
				$str_new_dir    = $this->arr_args[2];
				$this->bit_msgs = false;
				break;

case '-v' :
			case '--version' :
				$this->showVersion();
				break;

default :
				break;

}

$this->checkLocalHost($str_new_dir);
		exit(0);

}

/**
	 * Create a copy of the arguments global
	 * @param array array_args The arguments to set
	 */
	function setArgs($arr_args) {
		$this->arr_args = &$arr_args;
	}

/**
	 * Call the other methods to initiate the altering of the DocumentRoot
	 * @param string str_new_dir The new value of DocumentRoot
	 * @private
	 */
	private function setLocalHost($str_new_dir) {

$str_ext    = '.bak';
		$str_file   = ($this->str_dir . $this->str_file);
		$str_backup = $str_file . $str_ext;

if (is_file($str_file)) {

if ($this->makeCopy($str_file, $str_backup)) {
				$this->showMessage('Copied backup of ' . $this->str_file . ' to ' . $this->str_file . $str_ext);
			}

$this->alterLocalHost($str_file, $str_new_dir);

} else {
			$this->showError($str_file . ' cannot be found.');
		}

}

/**
	 * Show what DocumentRoot is currently set to
	 * @private
	 */
	private function showCurrent() {

$str_file = ($this->str_dir . $this->str_file);

if (is_file($str_file)) {

$str_contents = file_get_contents($str_file);

if (!$str_contents) {
				$this->showError('Could not read ' . $str_file);
			}

$int_begin  = strpos($str_contents, $this->str_pre);
			$int_end    = strpos(substr($str_contents, $int_begin), "\n");
			$str_search = substr($str_contents, $int_begin, $int_end);

$this->showMessage('The current DocumentRoot is: ' . $str_search);
			exit;

} else {
			$this->showError($str_file . ' cannot be found.');
		}

}

/**
	 * Display a message and exit
	 * @param string str_error The message to display
	 * @private
	 */
	private function showError($str_error) {

echo 'Error: ' . $str_error . "\n";

exit(1);

}

/**
	 * Show the help text and exit
	 * @private
	 */
	private function showHelp() {

$str_help .= 'Usage: clh [DIRECTORY]... [OPTIONS]' . "\n";
		$str_help .= 'Alter the DocumentRoot in Apache2.' . "\n";
		$str_help .= "\n";
		$str_help .= '  -c, --current  display current DocumentRoot and exit' . "\n";
		$str_help .= '  -h, --help     display this help and exit' . "\n";
		$str_help .= '  -q, --quiet    suppress most messages' . "\n";
		$str_help .= '  -v, --version  output version information and exit' . "\n";
		$str_help .= "\n";
		$str_help .= 'Report bugs to <scriptnode@gmail.com>.' . "\n"; // Hahahaha

echo $str_help;

exit(0);

}

/**
	 * Display a message to the user
	 * @param string str_message The message to show
	 * @private
	 */
	private function showMessage($str_message) {

if ($this->bit_msgs) {
			echo $str_message . "\n";
		}

}

/**
	 * Attempt to be more like a real application by displaying the version
	 * @private
	 */
	private function showVersion() {

echo $this->str_version . "\n";

exit(0);

}

You'll notice that the script is at least a year and a half old. Usually if code of mine is more than a year old, it's completely unusuable because my habits change pretty often. But I think I've finally gotten to that sweet spot where it's not total garbage, it just needs tweaking.

I was surprised that the code isn't too bad really. It's easily readable and well organized. There are many things that I wouldn't have done were I to write this again; for example, I stopped using type prefixes long ago (such as an array of users as $arr_users). I understand why I used to do this, but it's not necessary and only clutters up the code.

Anyway, I find this script useful and I thought someone else might too. Enjoy!

[Download clh.php.txt] (6,614 bytes)
[Download clh.zip] (1,975 bytes)

Read other articles tagged: apache, code-style, php, script-sunday, tutorials

scriptNode

Quickly Update DocumentRoot in Apache2

Thoughts?

Social Web

Tags

Links