./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:

<br /> #!/usr/bin/php<br /> <?php</p> <p>/*<br /> ChangeLocalHost v0.1 – last updated Mar 07 2007<br /> Must be root to execute. Alters the DocumentRoot in Apache2’s conf file, then restarts Apache2.<br /> */</p> <p>$obj_clh = new ChangeLocalHost(’/etc/apache2/sites-available/’, ‘default’, ‘/home/www/’);</p> <p>$obj_clh->setArgs($_SERVER['argv']);<br /> $obj_clh->run();</p> <p>/**<br /> * CLH class constructor<br /> * @constructor<br /> */<br /> class ChangeLocalHost {</p> <p> private $arr_args,<br /> $bit_msgs,<br /> $str_dir,<br /> $str_file,<br /> $str_pre;</p> <p> protected $str_version;</p> <p> /**<br /> * Constructor method<br /> * @param string str_dir The location of the Apache conf file to mod<br /> * @param string str_file The name of the Apache conf file to mod<br /> * @param string str_pre The needle to search for in the conf file<br /> */<br /> function __construct($str_dir, $str_file, $str_pre) {</p> <p> $this->str_version = ‘ChangeLocalHost v0.1′;</p> <p> $this->arr_args = Array();<br /> $this->bit_msgs = true;<br /> $this->str_dir = $str_dir;<br /> $this->str_file = $str_file;<br /> $this->str_pre = $str_pre;</p> <p> }</p> <p> /**<br /> * Modify Apache’s DocumentRoot<br /> * @param string str_file The (conf) file to mod<br /> * @param string str_new_dir The new directory to set as DocumentRoot<br /> * @private<br /> */<br /> private function alterLocalHost($str_file, $str_new_dir) {</p> <p> $str_contents = file_get_contents($str_file);</p> <p> if (!$str_contents) {<br /> $this->showError(’Could not read ‘ . $str_file);<br /> }</p> <p> $int_begin = strpos($str_contents, $this->str_pre);<br /> $int_end = strpos(substr($str_contents, $int_begin), “\n”);<br /> $str_search = substr($str_contents, $int_begin, $int_end);<br /> $str_contents = str_replace($str_search, $str_new_dir, $str_contents);<br /> $bit_written = file_put_contents($str_file, $str_contents);</p> <p> if ($bit_written) {<br /> $this->showMessage(’Successfully set DocumentRoot to ‘ . $str_new_dir);<br /> } else {<br /> $this->showError(’Could not write ‘ . $str_file);<br /> }</p> <p> }</p> <p> /**<br /> * Validates the new directory to set<br /> * @param string str_new_dir The potential new directory<br /> * @private<br /> */<br /> private function checkLocalHost($str_new_dir) {</p> <p> $str_set_to = $this->str_pre . $str_new_dir;</p> <p> if (is_dir($str_set_to)) {</p> <p> $this->setLocalHost($str_set_to);<br /> $this->restartApache2();</p> <p> } else {<br /> $this->showError($str_set_to . ‘ is not a valid directory.’);<br /> }</p> <p> }</p> <p> /**<br /> * Ensures this app is being executed as root<br /> * @private<br /> */<br /> private function checkRoot() {</p> <p> // Make sure user is root<br /> $str_command = ‘whoami’;</p> <p> exec($str_command, $arr_output, $int_return);</p> <p> if ($arr_output[0] != ‘root’) {<br /> $this->showError(’You must be root to run this program.’);<br /> }</p> <p> }</p> <p> /**<br /> * Makes a backup of the Apache conf file<br /> * @param string str_source The original to copy<br /> * @param string str_new The location of the backup<br /> * @return bool Whether the copy was successful or not<br /> * @private<br /> */<br /> private function makeCopy($str_source, $str_new) {</p> <p> $bit_copy = copy($str_source, $str_new);</p> <p> if (!$bit_copy) {<br /> $this->showError(’Could not make copy of ‘ . $str_source);<br /> }</p> <p> return true;</p> <p> }</p> <p> /**<br /> * Restarts Apache2<br /> * @private<br /> */<br /> private function restartApache2() {</p> <p> $str_command = ‘apache2ctl restart’;</p> <p> exec($str_command, $arr_output, $int_return);</p> <p> if ($int_return > 0) {<br /> $this->showError(’Could not restart Apache2.’ . $str_source);<br /> }</p> <p> $this->showMessage(’Successfully restarted Apache2.’);</p> <p> }</p> <p> /**<br /> * Executes the script<br /> */<br /> function run() {</p> <p> $this->checkRoot();</p> <p> $str_new_dir = $this->arr_args[1];</p> <p> switch ($this->arr_args[1]) {</p> <p> case ‘-c’ :<br /> case ‘–current’ :<br /> $this->showCurrent();<br /> break;</p> <p> case ” :<br /> case ‘-h’ :<br /> case ‘–help’ :<br /> $this->showHelp();<br /> break;</p> <p> case ‘-q’ :<br /> case ‘–quiet’ :<br /> $str_new_dir = $this->arr_args[2];<br /> $this->bit_msgs = false;<br /> break;</p> <p> case ‘-v’ :<br /> case ‘–version’ :<br /> $this->showVersion();<br /> break;</p> <p> default :<br /> break;</p> <p> }</p> <p> $this->checkLocalHost($str_new_dir);<br /> exit(0);</p> <p> }</p> <p> /**<br /> * Create a copy of the arguments global<br /> * @param array array_args The arguments to set<br /> */<br /> function setArgs($arr_args) {<br /> $this->arr_args = &$arr_args;<br /> }</p> <p> /**<br /> * Call the other methods to initiate the altering of the DocumentRoot<br /> * @param string str_new_dir The new value of DocumentRoot<br /> * @private<br /> */<br /> private function setLocalHost($str_new_dir) {</p> <p> $str_ext = ‘.bak’;<br /> $str_file = ($this->str_dir . $this->str_file);<br /> $str_backup = $str_file . $str_ext;</p> <p> if (is_file($str_file)) {</p> <p> if ($this->makeCopy($str_file, $str_backup)) {<br /> $this->showMessage(’Copied backup of ‘ . $this->str_file . ‘ to ‘ . $this->str_file . $str_ext);<br /> }</p> <p> $this->alterLocalHost($str_file, $str_new_dir);</p> <p> } else {<br /> $this->showError($str_file . ‘ cannot be found.’);<br /> }</p> <p> }</p> <p> /**<br /> * Show what DocumentRoot is currently set to<br /> * @private<br /> */<br /> private function showCurrent() {</p> <p> $str_file = ($this->str_dir . $this->str_file);</p> <p> if (is_file($str_file)) {</p> <p> $str_contents = file_get_contents($str_file);</p> <p> if (!$str_contents) {<br /> $this->showError(’Could not read ‘ . $str_file);<br /> }</p> <p> $int_begin = strpos($str_contents, $this->str_pre);<br /> $int_end = strpos(substr($str_contents, $int_begin), “\n”);<br /> $str_search = substr($str_contents, $int_begin, $int_end);</p> <p> $this->showMessage(’The current DocumentRoot is: ‘ . $str_search);<br /> exit;</p> <p> } else {<br /> $this->showError($str_file . ‘ cannot be found.’);<br /> }</p> <p> }</p> <p> /**<br /> * Display a message and exit<br /> * @param string str_error The message to display<br /> * @private<br /> */<br /> private function showError($str_error) {</p> <p> echo ‘Error: ‘ . $str_error . “\n”;</p> <p> exit(1);</p> <p> }</p> <p> /**<br /> * Show the help text and exit<br /> * @private<br /> */<br /> private function showHelp() {</p> <p> $str_help .= ‘Usage: clh [DIRECTORY]… [OPTIONS]‘ . “\n”;<br /> $str_help .= ‘Alter the DocumentRoot in Apache2.’ . “\n”;<br /> $str_help .= “\n”;<br /> $str_help .= ‘ -c, –current display current DocumentRoot and exit’ . “\n”;<br /> $str_help .= ‘ -h, –help display this help and exit’ . “\n”;<br /> $str_help .= ‘ -q, –quiet suppress most messages’ . “\n”;<br /> $str_help .= ‘ -v, –version output version information and exit’ . “\n”;<br /> $str_help .= “\n”;<br /> $str_help .= ‘Report bugs to <scriptnode@gmail.com>.’ . “\n”; // Hahahaha</p> <p> echo $str_help;</p> <p> exit(0);</p> <p> }</p> <p> /**<br /> * Display a message to the user<br /> * @param string str_message The message to show<br /> * @private<br /> */<br /> private function showMessage($str_message) {</p> <p> if ($this->bit_msgs) {<br /> echo $str_message . “\n”;<br /> }</p> <p> }</p> <p> /**<br /> * Attempt to be more like a real application by displaying the version<br /> * @private<br /> */<br /> private function showVersion() {</p> <p> echo $this->str_version . “\n”;</p> <p> exit(0);</p> <p> }</p> <p>}<br />

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)