Merge pull request #190 from php-school/missing-problem-file

Missing problem file

Author: AydinHassan

src/Application.php

@@ -219,13 +219,20 @@ public function run(): int
                     )
                 );
             return 1;
-        } catch (RuntimeException $e) {
+        } catch (\Throwable $e) {
+            $message = $e->getMessage();
+            $basePath = canonicalise_path($container->get('basePath'));
+
+            if (strpos($message, $basePath) !== null) {
+                $message = str_replace($basePath, '', $message);
+            }
+
             $container
                 ->get(OutputInterface::class)
                 ->printError(
                     sprintf(
                         '%s',
-                        $e->getMessage()
+                        $message
                     )
                 );
             return 1;

src/Command/PrintCommand.php

@@ -4,6 +4,8 @@
 
 namespace PhpSchool\PhpWorkshop\Command;
 
+use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
+use PhpSchool\PhpWorkshop\Exception\ProblemFileDoesNotExistException;
 use PhpSchool\PhpWorkshop\ExerciseRepository;
 use PhpSchool\PhpWorkshop\MarkdownRenderer;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
@@ -68,7 +70,14 @@ public function __invoke(): void
         $currentExercise = $this->userState->getCurrentExercise();
         $exercise = $this->exerciseRepository->findByName($currentExercise);
 
-        $markDown = (string) file_get_contents($exercise->getProblem());
+        $problemFile = $exercise->getProblem();
+
+        if (!is_readable($problemFile)) {
+            throw ProblemFileDoesNotExistException::fromFile($problemFile);
+        }
+
+        $markDown = (string) file_get_contents($problemFile);
+
         $doc = $this->markdownRenderer->render($markDown);
         $doc = str_replace('{appname}', $this->appName, $doc);
         $this->output->write($doc);

src/Exception/ProblemFileDoesNotExistException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshop\Exception;
+
+class ProblemFileDoesNotExistException extends \RuntimeException
+{
+    public static function fromFile(string $file): self
+    {
+        return new self(sprintf(
+            'Exercise problem file: "%s" does not exist or is not readable',
+            canonicalise_path($file)
+        ));
+    }
+}

src/Exception/RuntimeException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshop\Exception;
+
+class RuntimeException extends \RuntimeException
+{
+
+}

src/ExerciseRenderer.php

@@ -6,6 +6,7 @@
 
 use Colors\Color;
 use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\PhpWorkshop\Exception\ProblemFileDoesNotExistException;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 
 /**
@@ -100,7 +101,12 @@ public function __invoke(CliMenu $menu): void
         $output .= $this->color->__invoke(" " . $exercise->getName())->yellow()->bold() . "\n";
         $output .= $this->color->__invoke(sprintf(" Exercise %d of %d\n\n", $exerciseIndex, $numExercises))->yellow();
 
-        $content = (string) file_get_contents($exercise->getProblem());
+        $problemFile = $exercise->getProblem();
+        if (!is_readable($problemFile)) {
+            throw ProblemFileDoesNotExistException::fromFile($problemFile);
+        }
+
+        $content = (string) file_get_contents($problemFile);
         $doc     = $this->markdownRenderer->render($content);
         $doc     = str_replace('{appname}', $this->appName, $doc);
         $output .= $doc;

src/Utils/StringUtils.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshop\Utils;
+
+use PhpSchool\PhpWorkshop\Exception\RuntimeException;
+
+class StringUtils
+{
+    public static function canonicalisePath(string $filename): string
+    {
+        $path = [];
+        foreach (explode('/', $filename) as $part) {
+            // ignore parts that have no value
+            if (strlen($part) === 0 || $part === '.') {
+                continue;
+            }
+
+            if ($part !== '..') {
+                $path[] = $part;
+            } elseif (count($path) > 0) {
+                array_pop($path);
+            } else {
+                throw new RuntimeException('Climbing above the root is not permitted.');
+            }
+        }
+
+        return $filename[0] === '/'
+            ? '/' . implode('/', $path)
+            : implode('/', $path);
+    }
+}

src/functions.php

@@ -2,6 +2,8 @@
 
 declare(strict_types=1);
 
+use PhpSchool\PhpWorkshop\Utils\StringUtils;
+
 if (!function_exists('mb_str_pad')) {
 
     /**
@@ -31,3 +33,15 @@ function camel_case_to_kebab_case(string $string): string
         }, $string);
     }
 }
+
+if (!function_exists('canonicalise_path')) {
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    function canonicalise_path(string $path): string
+    {
+        return StringUtils::canonicalisePath($path);
+    }
+}

test/Util/StringUtilsTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSchool\PhpWorkshopTest\Util;
+
+use PhpSchool\PhpWorkshop\Utils\StringUtils;
+use PHPUnit\Framework\TestCase;
+use PhpSchool\PhpWorkshop\Exception\RuntimeException;
+
+class StringUtilsTest extends TestCase
+{
+    public function testCanonicalisePath(): void
+    {
+        $this->assertEquals('/path/to/file', StringUtils::canonicalisePath('/path/to/file'));
+        $this->assertEquals('/path/to/file', StringUtils::canonicalisePath('/path/././to/file'));
+        $this->assertEquals('/path/to/file', StringUtils::canonicalisePath('/path///to/file'));
+        $this->assertEquals('/path/to/file', StringUtils::canonicalisePath('/path/to/file'));
+        $this->assertEquals('/', StringUtils::canonicalisePath('/path/to/../../'));
+        $this->assertEquals('/path', StringUtils::canonicalisePath('/path/to/some/../../'));
+        $this->assertEquals('/some', StringUtils::canonicalisePath('/path/../some/'));
+        $this->assertEquals('some', StringUtils::canonicalisePath('path/../some/'));
+    }
+
+    public function testExceptionIsThrownIfTryingToTraverseUpPastRoom(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Climbing above the root is not permitted.');
+
+        StringUtils::canonicalisePath('/path/to/../../../');
+    }
+}