Modified console interface (incomplete)

Author: Rafael Grigorian

README.md

@@ -9,34 +9,17 @@ varnishadm "vcl.load default /usr/local/etc/varnish/default.vcl"
 varnishadm "vcl.use default"
 
 
-
-
-app code JetRails
-app design JetRails
-
-
-MODEL -> MAKE Model->Adminhtml
-
-
-
-
-Steps to configure
-__________________________________________________________________
-make sure you enable varnish in config->system->fpc as cache
-
-
-
-
-
+varnish:config
+varnish:status
+varnish:status:set <enable / disable>
 varnish:purge:url <url>
 varnish:purge:store <store_view_id>
 varnish:purge:all
 
-varnish:cache:status
-varnish:cache:enable
-varnish:cache:disable
+primer:config
+primer:status
+primer:status:set <enable / disable>
+primer:queue
+primer:queue:show
+
 
-varnish:primer:status
-varnish:primer:queue
-varnish:primer:enable
-varnish:primer:disable

src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php

@@ -10,7 +10,7 @@
 	use Symfony\Component\Console\Input\InputInterface;
 	use Symfony\Component\Console\Output\OutputInterface;
 
-	class AbstractCommand extends Command {
+	abstract class AbstractCommand extends Command {
 
 		protected $_data;
 
@@ -25,20 +25,53 @@ public function __construct ( Data $data, Logger $logger, Purger $purger ) {
 			parent::__construct ();
 		}
 
+		private function _printLabel ( $output, $label, $value ) {
+			$message = sprintf ( "<fg=cyan>%-16s%s</>", "$label", $value );
+			$output->writeln ( $message );
+		}
+
+		private function _printLine ( $output, $label, $value ) {
+			$message = sprintf ( "<fg=yellow>%-16s</>%s", "$label", $value );
+			$output->writeln ( $message );
+		}
+
 		protected function execute ( InputInterface $input, OutputInterface $output ) {
+			$output->writeln ("");
+			$this->_printLabel ( $output, "Powered By", "The JetRails Team" );
+			$this->_printLabel ( $output, "Email Us", "[email protected]" );
+			$this->_printLabel ( $output, "Call Us", "+1 (888) 554-9990" );
+			$output->writeln ("");
+
 			$purgeCommand = preg_match ( "/^varnish:purge/", $this->getName () );
+
 			if ( $purgeCommand && !$this->_data->isEnabled () ) {
 				$output->writeln (
-					"\nCache application must be set to <fg=red>Varnish Cache</>, set it by configuring" .
-					" Stores → Advanced → Developer → System → Full Page Cache → Caching Application.\n" . 
-					"Alternatively, you can run the <fg=red>varnish:cache:enable</> command.\n"
+					"Cache application must be set to <options=underscore>Varnish Cache</>\n" .
+					"<fg=yellow>Backend</>: Stores → Advanced → Developer → System → Full Page Cache → Caching Application\n" . 
+					"<fg=yellow>Console</>: varnish:status:set enable\n"
 				);
 			}
 			else {
-				$output->writeln ("");
-				$this->runCommand ( $input, $output );
+
+				$response = ( object ) $this->runCommand ( $input );
+
+				$status = $response->status ? "successful" : ( $response->status === null ? "mixed" : "unsuccessful" );
+				$parameters = $input->getArguments ();
+				unset ( $parameters ["command"] );
+				$parametersKeys = array_keys ( $parameters );
+				$parametersKeys = array_map ( function ( $i ) use ( $parameters ) { return "$i → " . $parameters [ $i ]; }, $parametersKeys );
+				$parameter = $parametersKeys;
+				$parameters = count ( $parameters ) == 0 ? "none" : implode ( ", ", $parameter );
+
+				$this->_printLine ( $output, "Command", $this->getName () );
+				$this->_printLine ( $output, "Parameters", $parameters );
+				$this->_printLine ( $output, "Status", $status );
+				$this->_printLine ( $output, "Response", $response->message );
+				if ( isset ( $response->payload ) ) $output->writeln ( "\n" . implode ( "\n", $response->payload ) );
 				$output->writeln ("");
 			}
 		}
+
+		protected abstract function runCommand ( InputInterface $input );
 
 	}

src/app/code/JetRails/Varnish/Console/Command/Cache/Disable.php

@@ -16,12 +16,16 @@ protected function configure () {
 	        ->addArgument ( "url", InputArgument::REQUIRED, "What URL do you want to purge?" );
 	    }
 
-	    protected function runCommand ( InputInterface $input, OutputInterface $output ) {
+	    protected function runCommand ( InputInterface $input ) {
 			// Load passed url parameter and validate it
 			$url = $input->getArgument ("url");
 			$url = $this->_purger->validateUrl ( $url );
 			// If an object was returned, then it was a valid url
 			if ( gettype ( $url ) == "object" ) {
+				$total = 0;
+				$success = 0;
+				$payload = [];
+
 				// Ask to purge and iterate over responses
 				foreach ( $this->_purger->purgeUrl ( $url ) as $response ) {
 					// Log what we are trying to do
@@ -37,21 +41,24 @@ protected function runCommand ( InputInterface $input, OutputInterface $output )
 						// Add success response message
 						$targetHtml = "<fg=green>$response->target</>";
 						$serverHtml = "<fg=green>$response->server</>";
-						$message = "Successfully purged url $targetHtml on $serverHtml";
-						$output->writeln ( $message );
+						$message = "<bg=green>           </>\n<bg=green;fg=white;options=bold>  SUCCESS  </> purged url $targetHtml on $serverHtml\n<bg=green>           </>";
+						array_push ( $payload, $message );
+						$success++;
 					}
 					else {
 						// Otherwise add an error message
 						$targetHtml = "<fg=red>$response->target</>";
 						$serverHtml = "<fg=red>$response->server</>";
 						$statusHtml = "<fg=red>$response->status</>";
-						$message = "Error purging url $targetHtml on $serverHtml with response code $statusHtml";
-						$output->writeln ( $message );
+						$message = "<bg=red>           </>\n<bg=red;fg=white;options=bold>   ERROR   </> couldn't purge url $targetHtml on $serverHtml with response code $statusHtml\n<bg=red>           </>";
+						array_push ( $payload, $message );
 					}
+					$total++;
 				}
+				return [ "status" => $success > 0 && $total - $success > 0 ? null : $total == $success, "message" => "purged url from $success/$total varnish servers", "payload" => $payload ];
 			}
 			// Otherwise an error was returned in the form of a string
-			else { $output->writeln ( "<fg=red>" . $url . "</>" ); }
+			return [ "status" => false, "message" => $url ];
 	    }
 
 	}

src/app/code/JetRails/Varnish/Console/Command/Cache/Enable.php

@@ -0,0 +1,28 @@
+<?php
+
+	namespace JetRails\Varnish\Console\Command;
+
+	use JetRails\Varnish\Console\Command\AbstractCommand;
+	use Symfony\Component\Console\Input\ArrayInput;
+	use Symfony\Component\Console\Input\InputArgument;
+	use Symfony\Component\Console\Input\InputInterface;
+	use Symfony\Component\Console\Output\OutputInterface;
+
+	class Status extends AbstractCommand {
+
+	    protected function configure () {
+	    	// Register the command and set the arguments 
+	        $this->setName ("varnish:status")
+	        ->setDescription ("Check to see if what caching application is being used");
+	    }
+	 
+	    protected function runCommand ( InputInterface $input ) {
+	    	// Check to see if varnish caching is enabled and prepare message
+	    	$status = $this->_data->isEnabled ();
+	    	$message = $status ? "<options=underscore>Varnish Cache</>" : "<options=underscore>Built-in Cache</>";
+	    	$message = "Caching application is set to $message";
+	    	// Return the message and status to caller
+			return [ "status" => $status, "message" => $message ];
+	    }
+	 
+	}

src/app/code/JetRails/Varnish/Console/Command/Cache/Status.php

@@ -0,0 +1,49 @@
+<?php
+
+	namespace JetRails\Varnish\Console\Command\Status;
+
+	use JetRails\Varnish\Console\Command\AbstractCommand;
+	use Magento\PageCache\Model\Config;
+	use Symfony\Component\Console\Input\ArrayInput;
+	use Symfony\Component\Console\Input\InputArgument;
+	use Symfony\Component\Console\Input\InputInterface;
+	use Symfony\Component\Console\Output\OutputInterface;
+
+	class Set extends AbstractCommand {
+
+	    protected function configure () {
+	    	// Register the command and set the arguments 
+	        $this->setName ("varnish:status:set")
+	        ->setDescription ("Check to see if what caching application is being used")
+	        ->addArgument ( "state", InputArgument::REQUIRED, "Should we enable varnish cache?" );
+	    }
+	 
+	    protected function runCommand ( InputInterface $input ) {
+	    	// Get the desired state and current state
+	    	$state = $input->getArgument ("state");
+	    	$current = $this->_data->isEnabled ();
+	    	// Check to see if the passed argument is valid
+	    	if ( $state == "enable" || $state == "disable" ) {
+	    		// Convert state to boolean
+	    		$state = $state == "enable";
+	    		// If the desired state is different then the current one
+	    		if ( $state != $current ) {
+	    			// Set the state value in the store config
+	    			$stateValue = $state ? Config::VARNISH : Config::BUILT_IN;
+	    			$this->_data->setCachingApplication ( $stateValue );
+	    			// Construct the message and respond to caller
+	    			$message = $state ? "Varnish" : "Built-in";
+	    			$message = "<options=underscore>" . $message . " Cache</>";
+	    			$message = "Caching application is now set to " . $message;
+    				return [ "status" => true, "message" => $message ];
+	    		}
+	    		// Respond to caller that the desired argument is already in place
+	    		$message = "Requested state already in place";
+	    		return [ "status" => false, "message" => $message ];
+	    	}
+	    	// Respond to caller stating what arguments are valid
+	    	$message = "Invalid argument, pass either enable or disable as an argument";
+	    	return [ "status" => false, "message" => $message ];
+	    }
+	 
+	}

src/app/code/JetRails/Varnish/Console/Command/Purge/Url.php

@@ -6,13 +6,12 @@
 	<type name="Magento\Framework\Console\CommandList" >
 		<arguments>
 			<argument name="commands" xsi:type="array" >
-				<item name="cache:status" xsi:type="object" >JetRails\Varnish\Console\Command\Cache\Status</item>
-				<item name="cache:enable" xsi:type="object" >JetRails\Varnish\Console\Command\Cache\Enable</item>
-				<item name="cache:disable" xsi:type="object" >JetRails\Varnish\Console\Command\Cache\Disable</item>
-				<item name="config:show" xsi:type="object" >JetRails\Varnish\Console\Command\Config\Show</item>
+				<item name="status" xsi:type="object" >JetRails\Varnish\Console\Command\Status</item>
+				<item name="status:set" xsi:type="object" >JetRails\Varnish\Console\Command\Status\Set</item>
+				<!-- <item name="config:show" xsi:type="object" >JetRails\Varnish\Console\Command\Config\Show</item> -->
 				<item name="purge:url" xsi:type="object" >JetRails\Varnish\Console\Command\Purge\Url</item>
-				<item name="purge:store" xsi:type="object" >JetRails\Varnish\Console\Command\Purge\Store</item>
-				<item name="purge:all" xsi:type="object" >JetRails\Varnish\Console\Command\Purge\All</item>
+				<!-- <item name="purge:store" xsi:type="object" >JetRails\Varnish\Console\Command\Purge\Store</item> -->
+				<!-- <item name="purge:all" xsi:type="object" >JetRails\Varnish\Console\Command\Purge\All</item>  -->
 			</argument>
 		</arguments>
 	</type>

src/app/code/JetRails/Varnish/Console/Command/Status.php

@@ -2,9 +2,6 @@ vcl 4.0;
 
 import std;
 
-# The minimal Varnish version is 4.0
-# For SSL offloading, pass the following header in your proxy server or load balancer: 'X-Forwarded-Proto: https'
-
 backend default {
 	.host = "{{_BACKEND_HOST_}}";
 	.port = "{{_BACKEND_PORT_}}";