Fetch.php

<?php

/*!
 * Fetch Class
 *
 * Copyright (c) 2014 Dave Olsen, http://dmolsen.com
 * Licensed under the MIT license
 *
 * Copy a package from GitHub and put it in it's appropriate location
 *
 */

namespace PatternLab;

use \Alchemy\Zippy\Zippy;
use \PatternLab\Config;
use \PatternLab\Console;
use \PatternLab\Zippy\UnpackFileStrategy;
use \Symfony\Component\Filesystem\Filesystem;
use \Symfony\Component\Filesystem\Exception\IOExceptionInterface;

class Fetch {
	
	public $rules = array();
	
	/**
	* Set-up a default var
	*/
	public function __construct() {
		if (!is_dir(Config::$options["sourceDir"])) {
			mkdir(Config::$options["sourceDir"]);
		}
		if (!is_dir(Config::$options["pluginDir"])) {
			mkdir(Config::$options["pluginDir"]);
		}
	}
	
	/**
	 * Fetch a package from GitHub
	 * @param  {String}    the command option to provide the rule for
	 * @param  {String}    the path to the package to be downloaded
	 *
	 * @return {String}    the modified file contents
	 */
	public function fetch($commandOption = "", $package = "") {
		
		$this->loadRules();
		
		if (empty($commandOption)) {
			
			$package = "";
			$name    = "";
			
			// iterate over the rules and see if the current file matches one, if so run the rule
			foreach ($this->rules as $rule) {
				if ($package = Console::findCommandOptionValue($rule->shortCommand."|".$rule->longCommand)) {
					$name     = $rule->name;
					$unpack   = $rule->unpack;
					$writeDir = $rule->writeDir;
					break;
				}
			}
			
		} else {
			
			foreach ($this->rules as $rule) {
				if ($rule->shortCommand == $commandOption) {
					$name     = $rule->name;
					$unpack   = $rule->unpack;
					$writeDir = $rule->writeDir;
				}
			}
			
		}
		
		if (empty($name)) {
			print_r(Console::$options);
			print "fetch rule not found...\n";
			exit;
		}
		
		// see if the user passed anythign useful
		if (empty($package)) {
			print "please provide a path for the ".$name." before trying to fetch it...\n";
			exit;
		}
		
		// figure out the options for the GH path
		list($org,$repo,$tag) = $this->getPackageInfo($package);
		
		//get the path to the GH repo and validate it
		$tarballUrl = "https://github.com/".$org."/".$repo."/archive/".$tag.".tar.gz";
		
		print "downloading the ".$name."...\n";
		
		// try to download the given package
		if (!$package = @file_get_contents($tarballUrl)) {
			$error = error_get_last();
			print $name." wasn't downloaded because:\n\n  ".$error["message"]."\n";
			exit;
		}
		
		// write the package to the temp directory
		$tempFile = tempnam(sys_get_temp_dir(), "pl-sk-archive.tar.gz");
		file_put_contents($tempFile, $package);
		
		print "installing the ".$name."...\n";
		
		// see if the source directory is empty
		$emptyDir = true;
		$checkDir = (!$unpack) ? $writeDir."/".$repo."-".$tag : $writeDir;
		if (is_dir($checkDir)) {
			$objects  = new \DirectoryIterator($checkDir);
			foreach ($objects as $object) {
				if (!$object->isDot() && ($object->getFilename() != "README") && ($object->getFilename() != ".DS_Store")) {
					$emptyDir = false;
				}
			}
		}
		
		// if source directory isn't empty ask if it's ok to nuke what's there
		if (!$emptyDir) {
			$stdin = fopen("php://stdin", "r");
			print($name." already installed. delete it to install or update the ".$name."? Y/n\n");
			$answer = strtolower(trim(fgets($stdin)));
			fclose($stdin);
			if ($answer == "y") {
				
				print "deleting the ".$name." and re-installing it...\n";
				
				$objects = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($checkDir), \RecursiveIteratorIterator::CHILD_FIRST);
				
				// make sure dots are skipped
				$objects->setFlags(\FilesystemIterator::SKIP_DOTS);
				
				foreach($objects as $filename => $object) {
					
					if ($object->isDir()) {
						rmdir($filename);
					} else if ($object->isFile()) {
						unlink($filename);
					}
					
				}
				
			} else {
				print "aborting install of the ".$name."...\n";
				unlink($tempFile);
				exit;
			}
			
		}
		
		// extract, if the zip is supposed to be unpacked do that (e.g. stripdir)
		$zippy      = Zippy::load();
		if ($unpack) {
			$zippy->addStrategy(new UnpackFileStrategy());
		}
		$zipAdapter = $zippy->getAdapterFor('tar.gz');
		$archiveZip = $zipAdapter->open($tempFile);
		$archiveZip = $archiveZip->extract($writeDir);
		
		// remove the temp file
		unlink($tempFile);
		
		// run composer against any composer.json file in the package
		if (file_exists($checkDir."/composer.json")) {
			
			// load composer
			$composerConfig = json_decode(file_get_contents($checkDir."/composer.json"),true);
			if ($jsonErrorMessage = JSON::hasError()) {
				JSON::lastErrorMsg($filepath,$jsonErrorMessage,$listItems);
				print "stopping install of ".$name."...";
				exit;
			}
			
			// see if we should generate the vendor directory
			if (!isset($composerConfig["extra"]) || (!isset($composerConfig["extra"]["runComposer"]) || ($composerConfig["extra"]["runComposer"])) {
				print "running composer...\n";
				$composerPath = __DIR__."/../../bin/composer.phar";
				passthru("cd ".$checkDir." && php ".$composerPath." install");
			}
			
			// see if there are assets to be moved
			if (isset($composerConfig["extra"]) && isset($composerConfig["extra"]["assets"])) {
				
				if (isset($composerConfig["extra"]["assets"]["publicDir"])) {
					$this->parseFileList($checkDir,Config::$options["publicDir"],$composerConfig["extra"]["assets"]["publicDir"]);
				}
				
				if (isset($composerConfig["extra"]["assets"]["sourceDir"])) {
					$this->parseFileList($checkDir,Config::$options["sourceDir"],$composerConfig["extra"]["assets"]["sourceDir"]);
				}
				
			}
			
			// see if we need to prompt the user to modify the config
			if (isset($composerConfig["extra"]) && (isset($composerConfig["extra"]["configUpdate"]) && $composerConfig["extra"]["configUpdate"]) && (isset($composerConfig["extra"]["configOption"]) && $composerConfig["extra"]["configOption"]) && (isset($composerConfig["extra"]["configValue"]) && $composerConfig["extra"]["configValue"])) {
				$stdin = fopen("php://stdin", "r");
				print("make this package the default ".$name."? Y/n\n");
				$answer = strtolower(trim(fgets($stdin)));
				fclose($stdin);
				if ($answer == "y") {
					Config::update($composerConfig["extra"]["configOptions"],$composerConfig["extra"]["configValue"]);
					print "config updated...\n";
				} else {
					print "config not updated...\n";
				}
			}
			
		}
		
		// move any assets to source/ (requirejs?)
		
		print $name." installation complete...\n";
		
	}
	
	/**
	 * Break up the package path
	 * @param  {String}    path of the GitHub repo
	 *
	 * @return {Array}     the parts of the package path
	 */
	protected function getPackageInfo($package) {
		
		$org  = "";
		$repo = "";
		$tag  = "master";
		
		if (strpos($package, "#") !== false) {
			list($package,$tag) = explode("#",$package);
		}
		
		if (strpos($package, "/") !== false) {
			list($org,$repo) = explode("/",$package);
		} else {
			print "please provide a real path to a package...\n";
			exit;
		}
		
		return array($org,$repo,$tag);
		
	}
	
	/**
	* Load all of the rules related to Fetch
	*/
	public function loadRules() {
		foreach (glob(__DIR__."/Fetch/Rules/*.php") as $filename) {
			$rule = str_replace(".php","",str_replace(__DIR__."/Fetch/Rules/","",$filename));
			if ($rule[0] != "_") {
				$ruleClass     = "\PatternLab\Fetch\Rules\\".$rule;
				$this->rules[] = new $ruleClass();
			}
		}
	}
	
	/**
	 * Move the files from the package to their location in the public dir or source dir
	 * @param  {String}    the base directory for the source of the files
	 * @param  {String}    the base directory for the destintation of the files (publicDir or sourceDir)
	 * @param  {Array}     the list of files to be moved
	 */
	protected function parseFileList($sourceBase,$destinationBase,$fileList) {
		
		$fs = new Filesystem();
		
		foreach ($fileList as $source => $destination) {
			
			if ($source[strlen($source)-1] == "*") {
				$source      = rtrim($source,"/*");
				$destination = rtrim($destination,"/*");
				$fs->mirror($sourceBase.$source,$destintationBase.$destination);
			} else {
				$pathInfo       = explode("/",$destination);
				$file           = array_pop($pathInfo);
				$destinationDir = implode("/",$pathInfo);
				if (!$fs->exists($destinationBase.$destinationDir)) {
					$fs->mkdir($destinationBase.$destinationDir);
				}
				$fs->copy($sourceBase.$source,$destinationBase.$destination,true);
			}
			
		}
		
	}
	
}