Adds timeout flag to most commands, adjusts default timeout to be logical for each command

Author: jonesiscoding

README.md

@@ -17,7 +17,7 @@ Usage involves first reading the rest of this README, then running one of the co
 
     /usr/local/bin/macupdate list --recommended --restart 
 
-This will display a list of all pending updates that are recommend and require a restart.    
+This will display a list of all pending updates that are recommended and require a restart.    
 
 ## Important Difference    
  It is important to note the one way in which MacUpdate differs from using the `softwareupdate` binary directly, which involves the usage of the `--restart` and `--shutdown` flags.    
@@ -46,6 +46,7 @@ The most useful command is `summary`, which will output a count of total, recomm
 |--|--|    
 | json | Output results in JSON format. |    
 | no-scan | Do not scan for new updates, used cached results. |  
+| timeout | The maximum time in seconds that the softwareupdate process should be allowed to run. |
 
 ### Wait Command
 This command is only useful when used in other scripting.  It will wait for the given number of seconds, or when conditions are met, based on the flags given at runtime.  The command can wait for the following conditions to clear:
@@ -84,7 +85,8 @@ An example of where this command is useful is when users can only access the Sof
 |Flags  | Purpose |    
 |--|--|    
 | json | Output results in JSON format. |    
-| no-scan | Do not scan for new updates, used cached results. |    
+| no-scan | Do not scan for new updates, used cached results. |
+| timeout | The maximum time in seconds that the softwareupdate process should be allowed to download. |
 | recommend | Only include recommended updates. |    
 | restart | Only include updates requiring a restart. |    
 | shutdown | Only include updates requiring a shutdown. |    
@@ -104,6 +106,7 @@ Several conditions are checked to verify that it is safe to install updates:
 |--|--|    
 | json | Output results in JSON format. |    
 | no-scan | Do not scan for new updates, used cached results. |    
+| timeout | The maximum time in seconds that the softwareupdate process should be allowed to run. |
 | force | Install even if on battery power or user is logged in. |  
 | recommend | Only include recommended updates. |    
 | restart | Only include updates requiring a restart. |    
@@ -116,6 +119,7 @@ Several conditions are checked to verify that it is safe to install updates:
 |--|--|    
 | json | Output results in JSON format. |    
 | no-scan | Do not scan for new updates, used cached results. |    
+| timeout | The maximum time in seconds that the softwareupdate process should be allowed to run. |
 | quiet | Displays only the name of the updates. |    
 | recommend | Only include recommended updates. |    
 | restart | Only include updates requiring a restart. |    
@@ -129,6 +133,7 @@ This command is mostly redundant; the `summary` command is more useful, and can
 |Flags  | Purpose |    
 |--|--|    
 | no-scan | Do not scan for new updates, used cached results. |    
+| timeout | The maximum time in seconds that the softwareupdate process should be allowed to run. |
 | quiet | Display no results, just a return code. |    
 | recommend | Only include recommended updates. |    
 | restart | Only include updates requiring a restart. |    

bin/console

@@ -14,6 +14,6 @@ $command[] = new DevCoding\Mac\Update\Command\DownloadCommand();
 $command[] = new DevCoding\Mac\Update\Command\InstallCommand();
 $command[] = new DevCoding\Mac\Update\Command\SummaryCommand();
 $command[] = new DevCoding\Mac\Update\Command\WaitCommand();
-$app       = new Application('MacUpdate', 'v1.6.4');
+$app       = new Application('MacUpdate', 'v1.7');
 $app->addCommands($command);
 $app->run();

composer.json

@@ -14,7 +14,7 @@
             "DevCoding\\Mac\\Update\\": "src"
         }
     },
-    "version": "1.6.4",
+    "version": "1.7",
     "require": {
         "php": "^7.0",
         "ext-json": "*",

composer.lock

@@ -32,6 +32,7 @@ protected function configure()
         ->addOption('restart', null, InputOption::VALUE_NONE, 'Only include restart updates')
         ->addOption('shutdown', null, InputOption::VALUE_NONE, 'Only include shutdown updates')
         ->addOption('no-scan', null, InputOption::VALUE_NONE, 'Do not scan for new updates')
+        ->addOption('timeout', null, InputOption::VALUE_REQUIRED, 'Software Update timeout in seconds.', $this->getDefaultTimeout())
     ;
   }
 
@@ -40,7 +41,34 @@ protected function isAllowUserOption()
     return false;
   }
 
-  // endregion ///////////////////////////////////////////// End Symfony Copmmand Methods
+  /**
+   * Returns the default number of seconds that softwareupdate should be allowed to run before determining that
+   * it has stalled.  This can be overridden with the --timeout option.
+   *
+   * @return int
+   */
+  protected function getDefaultTimeout()
+  {
+    return 7200; # 2 Hours
+  }
+
+  /**
+   * Returns the default number of seconds that softwareupdate should be allowed to run before determining that
+   * it has stalled.  Set with the --timeout option, which provides a default based on the getDefaultTimeout method.
+   *
+   * @throws \Exception If for some reason, the value of the timeout option is falsy.
+   */
+  private function getTimeout()
+  {
+    if (!$timeout = $this->io()->getOption('timeout'))
+    {
+      throw new \Exception('A default timeout for softwareupdate was not provided.');
+    }
+
+    return (is_numeric($timeout) && $timeout > 0) ? $timeout : null;
+  }
+
+  // endregion ///////////////////////////////////////////// End Symfony Command Methods
 
   // region //////////////////////////////////////////////// Software Update Methods
 
@@ -162,10 +190,11 @@ protected function getUpdateList()
       if ($suBin = $this->getSoftwareUpdate())
       {
         // Create Process
+        $timeout = $this->getTimeout();
         $noScan  = $this->isNoScan() ? '--no-scan' : null;
         $Process = Process::fromShellCommandline(trim(sprintf('%s -l %s', $suBin, $noScan)));
         // Eliminate Timeouts
-        $Process->setIdleTimeout(null)->setTimeout(null);
+        $Process->setIdleTimeout($timeout)->setTimeout($timeout);
         // Run the Process
         $Process->run();
 
@@ -300,7 +329,8 @@ protected function isNoScan()
    */
   protected function runSoftwareUpdate($cmd, &$errors = [])
   {
-    $P = Process::fromShellCommandline($cmd)->setTimeout(86400)->setIdleTimeout(86400);
+    $t = $this->getTimeout();
+    $P = Process::fromShellCommandline($cmd)->setTimeout($t)->setIdleTimeout($t);
     $P->run();
 
     if (!$P->isSuccessful())

dist/macupdate.phar

@@ -14,6 +14,11 @@ protected function configure()
     parent::configure();
   }
 
+  protected function getDefaultTimeout()
+  {
+    return 14400; # 4 Hours
+  }
+
   protected function execute(InputInterface $input, OutputInterface $output)
   {
     $this->io()->msg('Checking For Updates', 50);

src/Command/AbstractUpdateConsole.php

@@ -22,6 +22,14 @@ protected function isForced()
     return $this->io()->getOption('force') ? true : false;
   }
 
+  /**
+   * @return int
+   */
+  protected function getDefaultTimeout()
+  {
+    return 21600; #6 Hours
+  }
+
   protected function execute(InputInterface $input, OutputInterface $output)
   {
     $errors     = [];

src/Command/DownloadCommand.php

@@ -14,6 +14,7 @@ protected function configure()
     $this->setName('summary');
     $this->addOption('json', null, InputOption::VALUE_NONE, 'Output results in JSON');
     $this->addOption('no-scan', null, InputOption::VALUE_NONE, 'Do not scan for new updates.');
+    $this->addOption('timeout', null, InputOption::VALUE_REQUIRED, 'Software Update timeout in seconds.', $this->getDefaultTimeout());
   }
 
   protected function execute(InputInterface $input, OutputInterface $output)