deprecated not passing dash symbol (-) to STDIN commands

yceruto · yceruto · commit 8759ffcba586 · 2019-09-07T07:28:31.000-04:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -207,12 +207,14 @@ Translation
 -----------
 
  * Deprecated support for using `null` as the locale in `Translator`.
+ * Deprecated accepting STDIN implicitly when using the `lint:xliff` command, use `lint:xliff -` (append a dash) instead to make it explicit.
 
 TwigBridge
 ----------
 
  * Deprecated to pass `$rootDir` and `$fileLinkFormatter` as 5th and 6th argument respectively to the
    `DebugCommand::__construct()` method, swap the variables position.
+ * Deprecated accepting STDIN implicitly when using the `lint:twig` command, use `lint:twig -` (append a dash) instead to make it explicit.
    
 TwigBundle
 ----------
@@ -326,3 +328,8 @@ WebServerBundle
 ---------------
 
  * The bundle is deprecated and will be removed in 5.0.
+ 
+Yaml
+----
+
+* Deprecated accepting STDIN implicitly when using the `lint:yaml` command, use `lint:yaml -` (append a dash) instead to make it explicit.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -531,6 +531,7 @@ Translation
  * The `MessageSelector`, `Interval` and `PluralizationRules` classes have been removed, use `IdentityTranslator` instead
  * The `Translator::getFallbackLocales()` and `TranslationDataCollector::getFallbackLocales()` method are now internal
  * The `Translator::transChoice()` method has been removed in favor of using `Translator::trans()` with "%count%" as the parameter driving plurals
+ * Removed support for implicit STDIN usage in the `lint:xliff` command, use `lint:xliff -` (append a dash) instead to make it explicit.
 
 TwigBundle
 ----------
@@ -548,6 +549,7 @@ TwigBridge
  * removed the `$requestStack` and `$requestContext` arguments of the
    `HttpFoundationExtension`, pass a `Symfony\Component\HttpFoundation\UrlHelper`
    instance as the only argument instead
+ * Removed support for implicit STDIN usage in the `lint:twig` command, use `lint:twig -` (append a dash) instead to make it explicit.
 
 Validator
 --------
@@ -653,6 +655,7 @@ Yaml
 
  * The parser is now stricter and will throw a `ParseException` when a
    mapping is found inside a multi-line string.
+ * Removed support for implicit STDIN usage in the `lint:yaml` command, use `lint:yaml -` (append a dash) instead to make it explicit.
 
 WebProfilerBundle
 -----------------
diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * deprecated to pass `$rootDir` and `$fileLinkFormatter` as 5th and 6th argument respectively to the 
    `DebugCommand::__construct()` method, swap the variables position.
  * the `LintCommand` lints all the templates stored in all configured Twig paths if none argument is provided
+ * deprecated accepting STDIN implicitly when using the `lint:twig` command, use `lint:twig -` (append a dash) instead to make it explicit.
 
 4.3.0
 -----
diff --git a/src/Symfony/Bridge/Twig/Command/LintCommand.php b/src/Symfony/Bridge/Twig/Command/LintCommand.php
@@ -77,15 +77,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new SymfonyStyle($input, $output);
         $filenames = $input->getArgument('filename');
+        $hasStdin = '-' === ($filenames[0] ?? '');
 
-        if (0 === \count($filenames)) {
-            if (0 === ftell(STDIN)) {
-                $template = '';
-                while (!feof(STDIN)) {
-                    $template .= fread(STDIN, 1024);
+        if ($hasStdin || 0 === \count($filenames)) {
+            if ($hasStdin || 0 === ftell(STDIN)) { // remove 0 === ftell(STDIN) check in 5.0
+                if (!$hasStdin) {
+                    @trigger_error('Calling to the "lint:twig" command providing pipe file content to STDIN without passing the dash symbol "-" explicitly is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
                 }
 
-                return $this->display($input, $output, $io, [$this->validate($template, uniqid('sf_', true))]);
+                return $this->display($input, $output, $io, [$this->validate($this->getStdin($io), uniqid('sf_', true))]);
             }
 
             $loader = $this->twig->getLoader();
@@ -107,6 +107,31 @@ protected function execute(InputInterface $input, OutputInterface $output)
         return $this->display($input, $output, $io, $filesInfo);
     }
 
+    private function getStdin(SymfonyStyle $io): string
+    {
+        $template = '';
+        if (0 === ftell(STDIN)) {
+            while (!feof(STDIN)) {
+                $template .= fread(STDIN, 1024);
+            }
+        } else {
+            $io->block('Write the template content (press <return> twice to stop)', null, 'fg=black;bg=yellow', ' ', true);
+            $break = 0;
+            while (true) {
+                if ("\n" === $char = fgetc(STDIN)) {
+                    if (2 === ++$break) {
+                        break;
+                    }
+                } else {
+                    $break = 0;
+                }
+                $template .= $char;
+            }
+        }
+
+        return $template;
+    }
+
     private function getFilesInfo(array $filenames)
     {
         $filesInfo = [];
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * deprecated support for using `null` as the locale in `Translator`
+ * deprecated accepting STDIN implicitly when using the `lint:xliff` command, use `lint:xliff -` (append a dash) instead to make it explicit.
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Translation/Command/XliffLintCommand.php b/src/Symfony/Component/Translation/Command/XliffLintCommand.php
@@ -83,13 +83,18 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $filenames = (array) $input->getArgument('filename');
         $this->format = $input->getOption('format');
         $this->displayCorrectFiles = $output->isVerbose();
+        $hasStdin = '-' === ($filenames[0] ?? '');
 
-        if (0 === \count($filenames)) {
-            if (!$stdin = $this->getStdin()) {
+        if ($hasStdin || 0 === \count($filenames)) {
+            if (!$hasStdin && 0 !== ftell(STDIN)) { // remove 0 !== ftell(STDIN) check in 5.0
                 throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
             }
 
-            return $this->display($io, [$this->validate($stdin)]);
+            if (!$hasStdin) {
+                @trigger_error('Calling to the "lint:xliff" command providing pipe file content to STDIN without passing the dash symbol "-" explicitly is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
+            }
+
+            return $this->display($io, [$this->validate($this->getStdin($io))]);
         }
 
         $filesInfo = [];
@@ -223,18 +228,29 @@ private function getFiles(string $fileOrDirectory)
         }
     }
 
-    private function getStdin(): ?string
+    private function getStdin(SymfonyStyle $io): string
     {
-        if (0 !== ftell(STDIN)) {
-            return null;
-        }
-
-        $inputs = '';
-        while (!feof(STDIN)) {
-            $inputs .= fread(STDIN, 1024);
+        $xliff = '';
+        if (0 === ftell(STDIN)) {
+            while (!feof(STDIN)) {
+                $xliff .= fread(STDIN, 1024);
+            }
+        } else {
+            $io->block('Write the Xliff content (press <return> twice to stop)', null, 'fg=black;bg=yellow', ' ', true);
+            $break = 0;
+            while (true) {
+                if ("\n" === $char = fgetc(STDIN)) {
+                    if (2 === ++$break) {
+                        break;
+                    }
+                } else {
+                    $break = 0;
+                }
+                $xliff .= $char;
+            }
         }
 
-        return $inputs;
+        return $xliff;
     }
 
     private function getDirectoryIterator(string $directory)
diff --git a/src/Symfony/Component/Yaml/CHANGELOG.md b/src/Symfony/Component/Yaml/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * Added support to dump `null` as `~` by using the `Yaml::DUMP_NULL_AS_TILDE` flag.
+ * deprecated accepting STDIN implicitly when using the `lint:yaml` command, use `lint:yaml -` (append a dash) instead to make it explicit.
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Yaml/Command/LintCommand.php b/src/Symfony/Component/Yaml/Command/LintCommand.php
@@ -86,13 +86,18 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->format = $input->getOption('format');
         $this->displayCorrectFiles = $output->isVerbose();
         $flags = $input->getOption('parse-tags') ? Yaml::PARSE_CUSTOM_TAGS : 0;
+        $hasStdin = '-' === ($filenames[0] ?? '');
 
-        if (0 === \count($filenames)) {
-            if (!$stdin = $this->getStdin()) {
+        if ($hasStdin || 0 === \count($filenames)) {
+            if (!$hasStdin && 0 !== ftell(STDIN)) { // remove 0 !== ftell(STDIN) check in 5.0
                 throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
             }
 
-            return $this->display($io, [$this->validate($stdin, $flags)]);
+            if (!$hasStdin) {
+                @trigger_error('Calling to the "lint:yaml" command providing pipe file content to STDIN without passing the dash symbol "-" explicitly is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
+            }
+
+            return $this->display($io, [$this->validate($this->getStdin($io), $flags)]);
         }
 
         $filesInfo = [];
@@ -199,18 +204,29 @@ private function getFiles(string $fileOrDirectory)
         }
     }
 
-    private function getStdin(): ?string
+    private function getStdin(SymfonyStyle $io): string
     {
-        if (0 !== ftell(STDIN)) {
-            return null;
-        }
-
-        $inputs = '';
-        while (!feof(STDIN)) {
-            $inputs .= fread(STDIN, 1024);
+        $yaml = '';
+        if (0 === ftell(STDIN)) {
+            while (!feof(STDIN)) {
+                $yaml .= fread(STDIN, 1024);
+            }
+        } else {
+            $io->block('Write the Yaml content (press <return> twice to stop)', null, 'fg=black;bg=yellow', ' ', true);
+            $break = 0;
+            while (true) {
+                if ("\n" === $char = fgetc(STDIN)) {
+                    if (2 === ++$break) {
+                        break;
+                    }
+                } else {
+                    $break = 0;
+                }
+                $yaml .= $char;
+            }
         }
 
-        return $inputs;
+        return $yaml;
     }
 
     private function getParser()
