File Source for PackageScaffolderAbstract.php

<?php
/**
* Copyright (c) 2009 - 2011, RealDolmen
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of RealDolmen nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Microsoft
* @package Microsoft_WindowsAzure
* @copyright Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
* @license http://phpazure.codeplex.com/license
* @version $Id: SharedKeyCredentials.php 14561 2009-05-07 08:05:12Z unknown $
*/
/**
* @see Microsoft_AutoLoader
*/
require_once dirname(__FILE__) . '/../../../AutoLoader.php';
/**
* @category Microsoft
* @package Microsoft_WindowsAzure_CommandLine
* @copyright Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
* @license http://phpazure.codeplex.com/license
*/
abstract class Microsoft_WindowsAzure_CommandLine_PackageScaffolder_PackageScaffolderAbstract
extends Microsoft_Console_Command
{
/**
* Displays the help information.
*
* @command-name <default>
* @command-name -h
* @command-name -help
* @command-description Displays the current help information.
*/
public function helpCommand() {
$handler = $this->getHandler();
$newline = "\r\n";
if (count($handler->headers) > 0) {
foreach ($handler->headers as $header) {
printf('%s%s', $header, $newline);
}
printf($newline);
}
printf('%s%s', $handler->description, $newline);
printf($newline);
printf('Available commands:%s', $newline);
foreach ($handler->commands as $command) {
if ($command->aliases[0] != '<default>') {
$description = str_split($command->description, 50);
printf(' %-25s %s%s', implode(', ', $command->aliases), $description[0], $newline);
for ($di = 1; $di < count($description); $di++) {
printf(' %-25s %s%s', '', $description[$di], $newline);
}
printf($newline);
if (count($command->parameters) > 0) {
foreach ($command->parameters as $parameter) {
if ($parameter->aliases[0] != '--Phar' && $parameter->aliases[0] != '--Path') {
$description = str_split($parameter->description, 50);
printf(' %-23s %s', implode(', ', $parameter->aliases), $newline);
for ($di = 0; $di < count($description); $di++) {
printf(' %-23s %s%s', '', $description[$di], $newline);
}
printf($newline);
}
}
}
printf($newline);
if (count($command->examples) > 0) {
printf(' Example usage:%s', $newline);
foreach ($command->examples as $example) {
printf(' %s%s', $example, $newline);
}
printf($newline);
}
}
}
if (count($handler->footers) > 0) {
printf($newline);
foreach ($handler->footers as $footer) {
printf('%s%s', $footer, $newline);
}
printf($newline);
}
}
/**
* Writes output to STDERR, followed by a newline (optional)
*
* @param string $message
* @param string $newLine
*/
protected function log($message, $newLine = true)
{
if (error_reporting() === 0) {
return;
}
file_put_contents('php://stderr', $message . ($newLine ? "\r\n" : ''));
}
/**
* Extract resources to a file system path
*
* @param Phar $phar Phar archive.
* @param string $path Output path root.
*/
protected function extractResources(Phar $phar, $path)
{
$this->deleteDirectory($path);
$phar->extractTo($path);
@unlink($path . '/index.php');
@unlink($path . '/build.bat');
$this->copyDirectory($path . '/resources', $path . '/tmp', false);
$this->deleteDirectory($path . '/resources');
$this->copyDirectory($path . '/tmp', $path, false);
$this->deleteDirectory($path . '/tmp');
}
/**
* Apply file transforms.
*
* @param string $rootPath Root path.
* @param array $values Key/value array.
*/
protected function applyTransforms($rootPath, $values)
{
if (is_null($rootPath) || !is_string($rootPath) || empty($rootPath)) {
throw new InvalidArgumentException("Undefined \"rootPath\"");
}
if (is_dir($rootPath)) {
$d = dir($rootPath);
while ( false !== ( $entry = $d->read() ) ) {
if ( $entry == '.' || $entry == '..' ) {
continue;
}
$entry = $rootPath . '/' . $entry;
$this->applyTransforms($entry, $values);
}
$d->close();
} else {
$contents = file_get_contents($rootPath);
foreach ($values as $key => $value) {
$contents = str_replace('$' . $key . '$', $value, $contents);
}
file_put_contents($rootPath, $contents);
}
return true;
}
/**
* Create directory
*
* @param string $path Path of directory to create.
* @param boolean $abortIfExists Abort if directory exists.
* @param boolean $recursive Create parent directories if not exist.
*
* @return boolean
*/
protected function createDirectory($path, $abortIfExists = true, $recursive = true) {
if (is_null($path) || !is_string($path) || empty($path)) {
throw new InvalidArgumentException ("Undefined \"path\"" );
}
if (is_dir($path) && $abortIfExists) {
return false;
}
if (is_dir($path) ) {
@chmod($path, '0777');
if (!self::deleteDirectory($path) ) {
throw new RuntimeException("Failed to delete \"{$path}\".");
}
}
if (!mkdir($path, '0777', $recursive) || !is_dir($path)) {
throw new RuntimeException( "Failed to create directory \"{$path}\"." );
}
return true;
}
/**
* Fully copy a source directory to a target directory.
*
* @param string $sourcePath Source directory
* @param string $destinationPath Target directory
* @param boolean $abortIfExists Query re-creating target directory if exists
* @param octal $mode Changes access mode
*
* @return boolean
*/
protected function copyDirectory($sourcePath, $destinationPath, $abortIfExists = true, $mode = '0777') {
if (is_null($sourcePath) || !is_string($sourcePath) || empty($sourcePath)) {
throw new InvalidArgumentException("Undefined \"sourcePath\"");
}
if (is_null($destinationPath) || !is_string($destinationPath) || empty($destinationPath)) {
throw new InvalidArgumentException("Undefined \"destinationPath\"");
}
if (is_dir($destinationPath) && $abortIfExists) {
return false;
}
if (is_dir($sourcePath)) {
if (!is_dir($destinationPath) && !mkdir($destinationPath, $mode)) {
throw new RuntimeException("Failed to create target directory \"{$destinationPath}\"" );
}
$d = dir($sourcePath);
while ( false !== ( $entry = $d->read() ) ) {
if ( $entry == '.' || $entry == '..' ) {
continue;
}
$strSourceEntry = $sourcePath . '/' . $entry;
$strTargetEntry = $destinationPath . '/' . $entry;
if (is_dir($strSourceEntry) ) {
$this->copyDirectory(
$strSourceEntry,
$strTargetEntry,
false,
$mode
);
continue;
}
if (!copy($strSourceEntry, $strTargetEntry) ) {
throw new RuntimeException (
"Failed to copy"
. " file \"{$strSourceEntry}\""
. " to \"{$strTargetEntry}\""
);
}
}
$d->close();
} else {
if (!copy($sourcePath, $destinationPath)) {
throw new RuntimeException (
"Failed to copy"
. " file \"{$sourcePath}\""
. " to \"{$destinationPath}\""
);
}
}
return true;
}
/**
* Delete directory and all of its contents;
*
* @param string $path Directory path
* @return boolean
*/
protected function deleteDirectory($path)
{
if (is_null($path) || !is_string($path) || empty($path)) {
throw new InvalidArgumentException( "Undefined \"path\"" );
}
$handleDir = false;
if (is_dir($path) ) {
$handleDir = @opendir($path);
}
if (!$handleDir) {
return false;
}
@chmod($path, 0777);
while ($file = readdir($handleDir)) {
if ($file == '.' || $file == '..') {
continue;
}
$fsEntity = $path . "/" . $file;
if (is_dir($fsEntity)) {
$this->deleteDirectory($fsEntity);
continue;
}
if (is_file($fsEntity)) {
@unlink($fsEntity);
continue;
}
throw new LogicException (
"Unexpected file type: \"{$fsEntity}\""
);
}
@chmod($path, 0777);
closedir($handleDir);
@rmdir($path);
return true;
}
}

Source for file PackageScaffolderAbstract.php