made the router configurable via env vars

symfony · fabpot · Jan 6, 2017 · Dec 23, 2016 · Dec 23, 2016 · Dec 23, 2016
commit ac1ba7700ef0009a9f91cb9f3012b044029ce272
diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerCommand.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\WebServerBundle\Command;
 
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+
 /**
  * Base methods for commands related to PHP's built-in web server.
  *
@@ -62,4 +64,50 @@ protected function isOtherServerProcessRunning($address)
 
         return false;
     }
+
+    /**
+     * Determine the absolute file path for the router script, using the environment to choose a standard script
+     * if no custom router script is specified.
+     *
+     * @param string       $documentRoot Document root
+     * @param string|null  $router       File path of the custom router script, if set by the user; otherwise null
+     * @param string       $env          The application environment
+     *
+     * @return string|bool The absolute file path of the router script, or false on failure
+     */
+    protected function determineRouterScript($documentRoot, $router, $env)
+    {
+        if (null !== $router) {
+            return realpath($router);
+        }
+
+        if (false === $frontController = $this->guessFrontController($documentRoot, $env)) {
+            return false;
+        }
+
+        putenv('APP_FRONT_CONTROLLER='.$frontController);
+
+        return realpath($this
+            ->getContainer()
+            ->get('kernel')
+            ->locateResource(sprintf('@WebServerBundle/Resources/router.php'))
+        );
+    }
+
+    private function guessFrontController($documentRoot, $env)
+    {
+        foreach (array('app', 'index') as $prefix) {
+            $file = sprintf('%s_%s.php', $prefix, $env);
+            if (file_exists($documentRoot.'/'.$file)) {
+                return $file;
+            }
+
+            $file = sprintf('%s.php', $prefix);
+            if (file_exists($documentRoot.'/'.$file)) {
+                return $file;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php
@@ -77,14 +77,13 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new SymfonyStyle($input, $output);
-        $documentRoot = $input->getOption('docroot');
 
-        if (null === $documentRoot) {
+        if (null === $documentRoot = $input->getOption('docroot')) {
             $documentRoot = $this->getContainer()->getParameter('kernel.root_dir').'/../web';
         }
 
         if (!is_dir($documentRoot)) {
-            $io->error(sprintf('The given document root directory "%s" does not exist', $documentRoot));
+            $io->error(sprintf('The document root directory "%s" does not exist', $documentRoot));
 
             return 1;
         }
@@ -102,14 +101,20 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
 
+        if (false === $router = $this->determineRouterScript($documentRoot, $input->getOption('router'), $env)) {
+            $io->error('Unable to guess the front controller file.');
+
+            return 1;
+        }
+
         if ('prod' === $env) {
             $io->error('Running PHP built-in server in production environment is NOT recommended!');
         }
 
-        $io->success(sprintf('Server running on http://%s', $address));
+        $io->success(sprintf('Server listening on http://%s', $address));
         $io->comment('Quit the server with CONTROL-C.');
 
-        if (null === $builder = $this->createPhpProcessBuilder($io, $address, $input->getOption('router'), $env)) {
+        if (null === $builder = $this->createPhpProcessBuilder($io, $address, $router, $env)) {
             return 1;
         }
 
@@ -149,19 +154,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
     private function createPhpProcessBuilder(SymfonyStyle $io, $address, $router, $env)
     {
-        $router = $router ?: $this
-            ->getContainer()
-            ->get('kernel')
-            ->locateResource(sprintf('@FrameworkBundle/Resources/router_%s.php', $env))
-        ;
-
-        if (!file_exists($router)) {
-            $io->error(sprintf('The given router script "%s" does not exist.', $router));
-
-            return;
-        }
-
-        $router = realpath($router);
         $finder = new PhpExecutableFinder();
 
         if (false === $binary = $finder->find()) {

diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php
@@ -91,24 +91,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
 
-        $documentRoot = $input->getOption('docroot');
-
-        if (null === $documentRoot) {
+        if (null === $documentRoot = $input->getOption('docroot')) {
             $documentRoot = $this->getContainer()->getParameter('kernel.root_dir').'/../web';
         }
 
         if (!is_dir($documentRoot)) {
-            $io->error(sprintf('The given document root directory "%s" does not exist.', $documentRoot));
+            $io->error(sprintf('The document root directory "%s" does not exist.', $documentRoot));
 
             return 1;
         }
 8000
         $env = $this->getContainer()->getParameter('kernel.environment');
-
-        if (false === $router = $this->determineRouterScript($input->getOption('router'), $env, $io)) {
-            return 1;
-        }
-
         $address = $input->getArgument('address');
 
         if (false === strpos($address, ':')) {
@@ -124,6 +117,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
 
+        if (false === $router = $this->determineRouterScript($documentRoot, $input->getOption('router'), $env)) {
+            $io->error('Unable to guess the front controller file.');
+
+            return 1;
+        }
+
         if ('prod' === $env) {
             $io->error('Running PHP built-in server in production environment is NOT recommended!');
         }
@@ -137,7 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         if ($pid > 0) {
-            $io->success(sprintf('Web server listening on http://%s', $address));
+            $io->success(sprintf('Server listening on http://%s', $address));
 
             return;
         }
@@ -174,35 +173,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
     }
 
-    /**
-     * Determine the absolute file path for the router script, using the environment to choose a standard script
-     * if no custom router script is specified.
-     *
-     * @param string|null  $router File path of the custom router script, if set by the user; otherwise null
-     * @param string       $env    The application environment
-     * @param SymfonyStyle $io     An SymfonyStyle instance
-     *
-     * @return string|bool The absolute file path of the router script, or false on failure
-     */
-    private function determineRouterScript($router, $env, SymfonyStyle $io)
-    {
-        if (null === $router) {
-            $router = $this
-                ->getContainer()
-                ->get('kernel')
-                ->locateResource(sprintf('@FrameworkBundle/Resources/router_%s.php', $env))
-            ;
-        }
-
-        if (false === $path = realpath($router)) {
-            $io->error(sprintf('The given router script "%s" does not exist.', $router));
-
-            return false;
-        }
-
-        return $path;
-    }
-
     /**
      * Creates a process to start PHP's built-in web server.
      *

diff --git a/.../WebServerBundle/Resources/router_dev.php → ...ndle/WebServerBundle/Resources/router.php b/.../WebServerBundle/Resources/router_dev.php → ...ndle/WebServerBundle/Resources/router.php
@@ -30,13 +30,15 @@
     return false;
 }
 
+$script = getenv('APP_FRONT_CONTROLLER') ?: 'index.php';
+
 $_SERVER = array_merge($_SERVER, $_ENV);
-$_SERVER['SCRIPT_FILENAME'] = $_SERVER['DOCUMENT_ROOT'].DIRECTORY_SEPARATOR.'app_dev.php';
+$_SERVER['SCRIPT_FILENAME'] = $_SERVER['DOCUMENT_ROOT'].DIRECTORY_SEPARATOR.$script;
 
 // Since we are rewriting to app_dev.php, adjust SCRIPT_NAME and PHP_SELF accordingly
-$_SERVER['SCRIPT_NAME'] = DIRECTORY_SEPARATOR.'app_dev.php';
-$_SERVER['PHP_SELF'] = DIRECTORY_SEPARATOR.'app_dev.php';
+$_SERVER['SCRIPT_NAME'] = DIRECTORY_SEPARATOR.$script;
+$_SERVER['PHP_SELF'] = DIRECTORY_SEPARATOR.$script;
 
-require 'app_dev.php';
+require $script;
 
 error_log(sprintf('%s:%d [%d]: %s', $_SERVER['REMOTE_ADDR'], $_SERVER['REMOTE_PORT'], http_response_code(), $_SERVER['REQUEST_URI']), 4);
diff --git a/src/Symfony/Bundle/WebServerBundle/Resources/router_prod.php b/src/Symfony/Bundle/WebServerBundle/Resources/router_prod.php
diff --git a/src/Symfony/Bundle/WebServerBundle/Resources/router_test.php b/src/Symfony/Bundle/WebServerBundle/Resources/router_test.php