Merge pull request #324 from asgrim/handle-sudo-prompts-better

Handle sudo prompts better in non-interactive terminals

Author: asgrim

.github/workflows/continuous-integration.yml

@@ -151,7 +151,7 @@ jobs:
         run: vendor/bin/behat --tags="~@non-windows"
       - name: Run Behat on non-Windows
         if: matrix.operating-system != 'windows-latest'
-        run: vendor/bin/behat
+        run: sudo vendor/bin/behat
 
   coding-standards:
     runs-on: ubuntu-latest

src/Container.php

@@ -46,13 +46,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
-use function defined;
-use function fopen;
 use function getcwd;
 use function str_starts_with;
 
-use const STDIN;
-
 /** @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks */
 final class Container
 {
@@ -65,14 +61,7 @@ public static function factory(): ContainerInterface
             static function () {
                 $input = new ArgvInput();
 
-                $stdin            = defined('STDIN') ? STDIN : fopen('php://stdin', 'r');
-                $noInteractionEnv = ComposerPlatform::getEnv('COMPOSER_NO_INTERACTION');
-                if (
-                    $noInteractionEnv === false
-                    || $noInteractionEnv === '1'
-                    || $stdin === false
-                    || ! ComposerPlatform::isTty($stdin)
-                ) {
+                if (! Platform::isInteractive()) {
                     $input->setInteractive(false);
                 }
 

src/File/Sudo.php

@@ -4,8 +4,9 @@
 
 namespace Php\Pie\File;
 
+use Php\Pie\Platform;
+use Php\Pie\Platform\TargetPlatform;
 use Symfony\Component\Process\ExecutableFinder;
-use Throwable;
 
 use function is_string;
 
@@ -29,6 +30,10 @@ public static function find(): string
                 throw SudoNotFoundOnSystem::new();
             }
 
+            if (! TargetPlatform::isRunningAsRoot() && ! Platform::isInteractive()) {
+                throw SudoRequiresInteractiveTerminal::fromSudo($sudo);
+            }
+
             self::$memoizedSudo = $sudo;
         }
 
@@ -41,7 +46,7 @@ public static function exists(): bool
             self::find();
 
             return true;
-        } catch (Throwable) {
+        } catch (SudoNotFoundOnSystem) {
             return false;
         }
     }

src/File/SudoRequiresInteractiveTerminal.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Pie\File;
+
+use RuntimeException;
+
+use function sprintf;
+
+class SudoRequiresInteractiveTerminal extends RuntimeException
+{
+    public static function fromSudo(string $sudoPath): self
+    {
+        return new self(sprintf(
+            'PIE needed to elevate privileges with %s, but you are running in a non-interactive terminal, so prompting for a password is not possible.',
+            $sudoPath,
+        ));
+    }
+}

src/Installing/UnixInstall.php

@@ -20,7 +20,7 @@
 /** @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks */
 final class UnixInstall implements Install
 {
-    private const MAKE_INSTALL_TIMEOUT_SECS = 60; // 1 minute
+    private const MAKE_INSTALL_TIMEOUT_SECS = 300; // 5 minutes
 
     public function __construct(private readonly SetupIniFile $setupIniFile)
     {
@@ -45,11 +45,11 @@ public function __invoke(
 
         // If the target directory isn't writable, or a .so file already exists and isn't writable, try to use sudo
         if (
-            Sudo::exists()
-            && (
+            (
                 ! is_writable($targetExtensionPath)
                 || (file_exists($expectedSharedObjectLocation) && ! is_writable($expectedSharedObjectLocation))
             )
+            && Sudo::exists()
         ) {
             $output->writeln(sprintf(
                 '<comment>Cannot write to %s, so using sudo to elevate privileges.</comment>',

src/Platform.php

@@ -10,17 +10,31 @@
 use RuntimeException;
 
 use function array_keys;
+use function defined;
+use function fopen;
 use function implode;
 use function md5;
 use function rtrim;
 use function strpos;
 use function strtr;
 
 use const DIRECTORY_SEPARATOR;
+use const STDIN;
 
 /** @internal This is not public API for PIE, so should not be depended upon unless you accept the risk of BC breaks */
 class Platform
 {
+    public static function isInteractive(): bool
+    {
+        $stdin            = defined('STDIN') ? STDIN : fopen('php://stdin', 'r');
+        $noInteractionEnv = ComposerPlatform::getEnv('COMPOSER_NO_INTERACTION');
+
+        return $noInteractionEnv !== false
+            && $noInteractionEnv !== '1'
+            && $stdin !== false
+            && ComposerPlatform::isTty($stdin);
+    }
+
     private static function useXdg(): bool
     {
         foreach (array_keys($_SERVER) as $key) {