Merge pull request #21 from dlubitz/Neos-4.3-and-5.x

Fusion based 404 handling

Classes/Fusion/Eel/Helper/ContextHelper.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace MOC\NotFound\Fusion\Eel\Helper;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Eel\ProtectedContextAwareInterface;
+
+class ContextHelper implements ProtectedContextAwareInterface
+{
+    /**
+     * @Flow\InjectConfiguration(path="contentDimensions", package="Neos.ContentRepository")
+     * @var array
+     */
+    protected $contentDimensionsConfiguration;
+
+    /**
+     * Returns a context array with matched dimension values per dimension for given request uri path. If nothing
+     * matches, it returns a context array with default dimension values per dimension.
+     *
+     * @param $requestUriPath
+     * @return array
+     */
+    public function ofRequestUriPath($requestUriPath)
+    {
+        // No dimensions configured, context is empty
+        if (count($this->contentDimensionsConfiguration) === 0) {
+            return [];
+        }
+
+        $uriSegments = $this->getUriSegments($requestUriPath);
+        $dimensionValues = $this->getDimensionValuesForUriSegments($uriSegments);
+        if (empty($dimensionValues)) {
+            $dimensionValues = $this->getDefaultDimensionValues();
+        }
+
+        $targetDimensionValues = array_map(function ($dimensionValues) {
+            return reset($dimensionValues); // Default target dimension value is first dimension value
+        }, $dimensionValues);
+
+
+        return [
+            'dimensions' => $dimensionValues,
+            'targetDimensions' => $targetDimensionValues
+        ];
+    }
+
+    /**
+     * @param array $uriSegments
+     * @return array
+     */
+    protected function getDimensionValuesForUriSegments($uriSegments)
+    {
+        if (count($uriSegments) !== count($this->contentDimensionsConfiguration)) {
+            return [];
+        }
+
+        $index = 0;
+        $dimensionValues = [];
+        foreach ($this->contentDimensionsConfiguration as $dimensionName => $dimensionConfiguration) {
+            $uriSegment = $uriSegments[$index++];
+            foreach ($dimensionConfiguration['presets'] as $preset) {
+                if ($uriSegment === $preset['uriSegment']) {
+                    $dimensionValues[$dimensionName] = $preset['values'];
+                    continue 2;
+                }
+            }
+        }
+
+        if (count($uriSegments) !== count($dimensionValues)) {
+            return [];
+        }
+
+        return $dimensionValues;
+    }
+
+    /**
+     * Returns default dimension values per dimension.
+     *
+     * @return array
+     */
+    protected function getDefaultDimensionValues()
+    {
+        $dimensionValues = [];
+        foreach ($this->contentDimensionsConfiguration as $dimensionName => $dimensionConfiguration) {
+            $dimensionValues[$dimensionName] =  [$dimensionConfiguration['default']];
+        }
+        return $dimensionValues;
+    }
+
+    protected function getUriSegments($requestUriPath)
+    {
+        $pathParts = explode('/', trim($requestUriPath, '/'), 2);
+        return explode('_', $pathParts[0]);
+    }
+
+    public function allowsCallOfMethod($methodName)
+    {
+        return true;
+    }
+}

Configuration/Settings.yaml

@@ -1,12 +1,11 @@
 Neos:
-  Flow:
-    error:
-      exceptionHandler:
-        renderingGroups:
-          notFoundExceptions:
-            matchingStatusCodes: [ 404, 410 ]
-            options:
-              viewClassName: Neos\FluidAdaptor\View\TemplateView
-              templatePathAndFilename: 'resource://MOC.NotFound/Private/Templates/404.html'
-              variables:
-                path: '404.html' # skip suffix if unset
+  Fusion:
+    defaultContext:
+      NotFound.Context: MOC\NotFound\Fusion\Eel\Helper\ContextHelper
+  Neos:
+    fusion:
+      autoInclude:
+        MOC.NotFound: true
+MOC:
+  NotFound:
+    uriPathSegment: 404

README.md

@@ -11,29 +11,23 @@ Introduction
 
 Neos CMS package that loads a normal editable page for displaying a 404 error.
 
-Compatible with Neos 2.x-4.x
+Compatible with Neos 4.3 - 5.x 
 
 Supports multiple content dimensions with URI segments and empty segments for default dimensions.
 
 Installation
 ------------
-```composer require "moc/notfound:^3.0"```
+```composer require "moc/notfound:^4.0"```
 
 Create a page with the URI segment "404" in the root of your site. If using content dimensions with URI segments,
 ensure a page exists in all contexts or through fallbacks.
 
 Alternatively set the following configuration in ``Settings.yaml``:
 
 ```yaml
-Neos:
-  Flow:
-    error:
-      exceptionHandler:
-        renderingGroups:
-          notFoundExceptions:
-            options:
-              variables:
-                path: '404.html' # skip suffix if unset
+MOC:
+  NotFound:
+    uriPathSegment: 404
 ```
 
 Note: If you override the configuration in a package's configuration instead of globally, you need to ensure that package is loaded after this package. To do so, add ``"moc/notfound": "*"`` to the package's ``require`` section in it's ``composer.json``.

Resources/Private/Fusion/Root.fusion

@@ -0,0 +1,22 @@
+prototype(MOC.NotFound:NotFoundDocument) < prototype(Neos.Fusion:Value) {
+    uriPathSegment =  ${Configuration.setting('MOC.NotFound.uriPathSegment')}
+    context = ${NotFound.Context.ofRequestUriPath(this.requestUriPath)}
+
+    value = ${q(site).context(this.context).children('[instanceof Neos.Neos:Document]').filter('[uriPathSegment="' + this.uriPathSegment + '"]').get(0)}
+}
+
+error {
+    @context.notfoundDocument = MOC.NotFound:NotFoundDocument {
+        requestUriPath = ${request.httpRequest.uri.path}
+    }
+
+    4xx {
+        @position = 'start'
+        condition = ${statusCode >= 400 && statusCode < 500 && notfoundDocument}
+        renderer = Neos.Fusion:Renderer {
+            @context.node = ${notfoundDocument}
+            @context.documentNode = ${notfoundDocument}
+            renderPath = '/root'
+        }
+    }
+}

composer.json

@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "neos/neos": ">3.3"
+        "neos/neos": ">=4.3"
     },
     "autoload": {
         "psr-4": {