It possible now to expand the tilde-path written in the config and stop server in cli.

Author: roquie

bin/server

@@ -7,6 +7,7 @@ use StaticServer\Console\DumpConfigCommand;
 use StaticServer\Console\ReloadServerCommand;
 use StaticServer\Console\RunServerCommand;
 use StaticServer\Console\SignalHandler;
+use StaticServer\Console\StopServerCommand;
 use Symfony\Component\Console\Application;
 
 $locations = [
@@ -35,6 +36,7 @@ pcntl_signal(SIGUSR1, [$sig, 'handle']);
 try {
     $app = new Application('Static server', Server::VERSION);
     $app->add(new RunServerCommand());
+    $app->add(new StopServerCommand());
     $app->add(new DumpConfigCommand());
     $app->add(new ReloadServerCommand());
     $app->run();

composer.json

@@ -11,6 +11,7 @@
     "ext-json": "*",
     "ext-dom": "*",
     "ext-pcntl": "*",
+    "ext-posix": "*",
     "microparts/configuration-php": "2.*",
     "monolog/monolog": "^1.24",
     "masterminds/html5": "^2.5",

configuration/defaults/___server.yaml

@@ -14,8 +14,8 @@ defaults:
     handler:
       name: nginx
       options:
-        pid: /tmp/spa_nginx.pid
-        config: /tmp/generated_nginx.conf
+        pid: ~/.server/spa_nginx.pid
+        config: ~/.server/generated_nginx.conf
     prerender:
       enabled: false
       url: null

src/Application.php

@@ -75,6 +75,7 @@ public function setModifyConfigurator(ModifyConfiguratorInterface $configurator)
      * Dry run without start of server.
      *
      * @return void
+     * @throws \Exception
      */
     public function dryRun(): void
     {
@@ -100,7 +101,9 @@ public function run(): void
             $this->ready();
             $this->handler->start();
         } catch (Throwable $e) {
-            $this->handler->stop();
+            if (isset($this->handler)) {
+                $this->handler->stop();
+            }
             throw $e;
         }
     }
@@ -120,7 +123,9 @@ public function reload(): void
             $this->handler->reload();
             $this->logger->info('Configuration reloaded');
         } catch (Throwable $e) {
-            $this->handler->stop();
+            if (isset($this->handler)) {
+                $this->handler->stop();
+            }
             throw $e;
         }
     }
@@ -144,6 +149,7 @@ public function stop(): void
      * @codeCoverageIgnore
      * @param bool $checkConfig
      * @return void
+     * @throws \Exception
      */
     private function ready(bool $checkConfig = true): void
     {

src/Console/RunServerCommand.php

@@ -15,6 +15,7 @@ protected function configure(): void
     {
         $this
             ->setName('run')
+            ->setAliases(['start'])
             ->setDescription('Run server')
             ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Dry run command without server starting.')
             ->setHelp('Example of usage: `server run`. If u want to change starting host or port, please change the __server_*.yaml configuration files.');

src/Console/StopServerCommand.php

@@ -0,0 +1,36 @@
+<?php declare(strict_types=1);
+
+namespace StaticServer\Console;
+
+use StaticServer\Server;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class StopServerCommand extends Command
+{
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('stop')
+            ->setDescription('Stop server')
+            ->setHelp('Example of usage: `server stop`.');
+    }
+
+    /**
+     * Execute command, captain.
+     *
+     * @param \Symfony\Component\Console\Input\InputInterface $input
+     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     * @throws \Throwable
+     *
+     * @return int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        Server::fromGlobals()->stop();
+
+        return 0;
+    }
+}

src/Handler/AbstractHandler.php

@@ -6,20 +6,36 @@
 use Microparts\Configuration\ConfigurationAwareTrait;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Process\Process;
 
 abstract class AbstractHandler implements HandlerInterface, ConfigurationAwareInterface, LoggerAwareInterface
 {
     use ConfigurationAwareTrait, LoggerAwareTrait;
 
+    /**
+     * @var \Symfony\Component\Filesystem\Filesystem
+     */
+    protected Filesystem $filesystem;
+
+    /**
+     * AbstractHandler constructor.
+     */
+    public function __construct()
+    {
+        $this->filesystem = new Filesystem();
+    }
+
     /**
      * @return string
      */
     protected function getServerRoot(): string
     {
-        return $this->configuration->get('server.modify.enabled')
+        $path = $this->configuration->get('server.modify.enabled')
             ? $this->configuration->get('server.modify.root')
             : $this->configuration->get('server.root');
+
+        return $this->expandPathLikeShell($path);
     }
 
     /**
@@ -40,4 +56,49 @@ protected function runProcess(array $args, ?callable $callback = null): void
             $this->logger->info($buffer);
         });
     }
+
+    /**
+     * @param string $filename
+     */
+    protected function touchFile(string $filename): void
+    {
+        $filename = $this->expandPathLikeShell($filename);
+        $this->logger->debug("Touch file: $filename");
+
+        $this->filesystem->touch($filename);
+    }
+
+    /**
+     * @param array $paths
+     */
+    protected function makePathForFiles(array $paths): void
+    {
+        static $created = [];
+
+        foreach ($paths as $path) {
+            $path = pathinfo($this->expandPathLikeShell($path), PATHINFO_DIRNAME);
+
+            if (!isset($created[$path])) {
+                $this->logger->debug("Create nested dirs for: $path");
+                $this->filesystem->mkdir($path, 0755);
+                $created[$path]= true;
+            }
+        }
+    }
+
+    /**
+     * https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_01
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function expandPathLikeShell(string $path): string
+    {
+        if (strpos($path, '~') !== false) {
+            $info = posix_getpwuid(posix_getuid());
+            $path = str_replace('~', $info['dir'], $path);
+        }
+
+        return $path;
+    }
 }

src/Handler/NginxHandler.php

@@ -19,9 +19,14 @@ class NginxHandler extends AbstractHandler
     private Engine $templates;
 
     /**
-     * @var array<string, string>
+     * @var string
      */
-    private array $options;
+    private string $pidFile;
+
+    /**
+     * @var string
+     */
+    private string $configFile;
 
     /**
      * @var bool
@@ -40,8 +45,11 @@ class NginxHandler extends AbstractHandler
      */
     public function __construct(array $options = [])
     {
-        $this->templates = new Engine(__DIR__ . DIRECTORY_SEPARATOR . 'templates');
-        $this->options   = $options;
+        $this->templates  = new Engine(__DIR__ . DIRECTORY_SEPARATOR . 'templates');
+        $this->pidFile    = $this->expandPathLikeShell($options['pid']);
+        $this->configFile = $this->expandPathLikeShell($options['config']);
+
+        parent::__construct();
     }
 
     /**
@@ -60,7 +68,9 @@ public function checkDependenciesBeforeStart(): void
      */
     public function generateConfig(HeaderInterface $header): void
     {
-        $this->logger->info("Nginx PID location: {$this->options['pid']}");
+        $this->logger->info("Nginx PID location: {$this->pidFile}");
+        $this->makePathForFiles([$this->pidFile, $this->configFile]);
+        $this->touchFile($this->pidFile);
 
         $data = $this->templates->render('nginx_default.conf', [
             'serverRoot' => realpath($this->getServerRoot()),
@@ -73,25 +83,25 @@ public function generateConfig(HeaderInterface $header): void
             'prerenderHost' => $this->getHostWithoutTrailingSlash('server.prerender.host'),
             'headers' => $header->convert($this->configuration),
             'connProcMethod' => $this->getConnectionProcessingMethod(),
-            'pidLocation' => $this->options['pid'],
+            'pidLocation' => $this->pidFile,
             'moduleBrotliInstalled' => $this->moduleBrotliInstalled,
             'platformSupportsAsyncIo' => $this->platformSupportsAsyncIo,
         ]);
 
-        file_put_contents($this->options['config'], $data);
+        file_put_contents($this->configFile, $data);
     }
 
     public function checkConfig(): void
     {
-        $this->runProcess(['nginx', '-c', $this->options['config'], '-t']);
+        $this->runProcess(['nginx', '-c', $this->configFile, '-t']);
     }
 
     /**
      * Start the web-server.
      */
     public function start(): void
     {
-        $this->runProcess(['nginx', '-c', $this->options['config']], function () {
+        $this->runProcess(['nginx', '-c', $this->configFile], function () {
             $this->logger->info(sprintf(
                 'Server started at: %s:%d',
                 $this->configuration->get('server.host'),
@@ -102,20 +112,24 @@ public function start(): void
 
     public function reload(): void
     {
-        if (!file_exists($this->options['pid'])) {
+        if (!file_exists($this->pidFile)) {
             throw new LogicException('Can\'t reload server. Pid file not found.');
         }
 
-        if (empty(file_get_contents($this->options['pid']))) {
+        if (empty(file_get_contents($this->pidFile))) {
             throw new LogicException('Can\'t reload server. Pid file is empty.');
         }
 
-        $this->runProcess(['nginx', '-c', $this->options['config'], '-s', 'reload']);
+        $this->runProcess(['nginx', '-c', $this->configFile, '-s', 'reload']);
     }
 
     public function stop(): void
     {
-        $this->runProcess(['nginx', '-c', $this->options['config'], '-s', 'stop']);
+        $this->runProcess(['nginx', '-c', $this->configFile, '-s', 'stop']);
+
+        if ($this->filesystem->exists($this->configFile)) {
+            $this->filesystem->remove($this->configFile);
+        }
     }
 
     /**

src/Server.php

@@ -3,7 +3,6 @@
 namespace StaticServer;
 
 use Microparts\Configuration\Configuration;
-use Microparts\Configuration\ConfigurationInterface;
 
 final class Server
 {

tests/Handler/HandlerFactoryTest.php

@@ -11,7 +11,7 @@ class HandlerFactoryTest extends TestCase
 {
     public function testHowFactoryCreatesObjects()
     {
-        $object = HandlerFactory::createHandler('nginx', []);
+        $object = HandlerFactory::createHandler('nginx', ['pid' => '', 'config' => '']);
 
         $this->assertInstanceOf(NginxHandler::class, $object);
     }