Make the Request available to the Formatter\Rendering event (flarum#1721

)

This is important because extensions may wish to render post content
differently depending on Request factors such as the actor. For example,
an attachments extension might wish to hide attachments from guests.

This solution is a bit of a hack-job for now, but soon when we refactor
the API layer to use tobscure/json-api-server, and also refactor the
Formatter layer, it can be revised.

src/Api/Controller/AbstractSerializeController.php

@@ -102,7 +102,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface
         );
 
         $serializer = static::$container->make($this->serializer);
-        $serializer->setActor($request->getAttribute('actor'));
+        $serializer->setRequest($request);
 
         $element = $this->createElement($data, $serializer)
             ->with($this->extractInclude($request))

src/Api/Serializer/AbstractSerializer.php

@@ -20,6 +20,7 @@
 use Illuminate\Contracts\Events\Dispatcher;
 use InvalidArgumentException;
 use LogicException;
+use Psr\Http\Message\ServerRequestInterface as Request;
 use Tobscure\JsonApi\AbstractSerializer as BaseAbstractSerializer;
 use Tobscure\JsonApi\Collection;
 use Tobscure\JsonApi\Relationship;
@@ -28,6 +29,11 @@
 
 abstract class AbstractSerializer extends BaseAbstractSerializer
 {
+    /**
+     * @var Request
+     */
+    protected $request;
+
     /**
      * @var User
      */
@@ -44,19 +50,28 @@ abstract class AbstractSerializer extends BaseAbstractSerializer
     protected static $container;
 
     /**
-     * @return User
+     * @return Request
      */
-    public function getActor()
+    public function getRequest()
     {
-        return $this->actor;
+        return $this->request;
+    }
+
+    /**
+     * @param Request $request
+     */
+    public function setRequest(Request $request)
+    {
+        $this->request = $request;
+        $this->actor = $request->getAttribute('actor');
     }
 
     /**
-     * @param User $actor
+     * @return User
      */
-    public function setActor(User $actor)
+    public function getActor()
     {
-        $this->actor = $actor;
+        return $this->actor;
     }
 
     /**
@@ -231,7 +246,7 @@ protected function resolveSerializerClass($class)
     {
         $serializer = static::$container->make($class);
 
-        $serializer->setActor($this->actor);
+        $serializer->setRequest($this->request);
 
         return $serializer;
     }

src/Api/Serializer/BasicPostSerializer.php

@@ -44,7 +44,7 @@ protected function getDefaultAttributes($post)
         ];
 
         if ($post instanceof CommentPost) {
-            $attributes['contentHtml'] = $post->content_html;
+            $attributes['contentHtml'] = $post->formatContent($this->request);
         } else {
             $attributes['content'] = $post->content;
         }

src/Api/Serializer/PostSerializer.php

@@ -43,8 +43,6 @@ protected function getDefaultAttributes($post)
         $canEdit = $gate->allows('edit', $post);
 
         if ($post instanceof CommentPost) {
-            $attributes['contentHtml'] = $post->content_html;
-
             if ($canEdit) {
                 $attributes['content'] = $post->content;
             }

src/Formatter/Event/Rendering.php

@@ -11,6 +11,7 @@
 
 namespace Flarum\Formatter\Event;
 
+use Psr\Http\Message\ServerRequestInterface;
 use s9e\TextFormatter\Renderer;
 
 class Rendering
@@ -30,15 +31,22 @@ class Rendering
      */
     public $xml;
 
+    /**
+     * @var ServerRequestInterface
+     */
+    public $request;
+
     /**
      * @param Renderer $renderer
      * @param mixed $context
      * @param string $xml
+     * @param ServerRequestInterface|null $request
      */
-    public function __construct(Renderer $renderer, $context, &$xml)
+    public function __construct(Renderer $renderer, $context, &$xml, ServerRequestInterface $request = null)
     {
         $this->renderer = $renderer;
         $this->context = $context;
         $this->xml = &$xml;
+        $this->request = $request;
     }
 }

src/Formatter/Formatter.php

@@ -16,6 +16,7 @@
 use Flarum\Formatter\Event\Rendering;
 use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Contracts\Events\Dispatcher;
+use Psr\Http\Message\ServerRequestInterface;
 use s9e\TextFormatter\Configurator;
 use s9e\TextFormatter\Unparser;
 
@@ -69,13 +70,14 @@ public function parse($text, $context = null)
      *
      * @param string $xml
      * @param mixed $context
+     * @param ServerRequestInterface|null $request
      * @return string
      */
-    public function render($xml, $context = null)
+    public function render($xml, $context = null, ServerRequestInterface $request = null)
     {
         $renderer = $this->getRenderer();
 
-        $this->events->dispatch(new Rendering($renderer, $context, $xml));
+        $this->events->dispatch(new Rendering($renderer, $context, $xml, $request));
 
         return $renderer->render($xml);
     }

src/Post/CommentPost.php

@@ -18,12 +18,12 @@
 use Flarum\Post\Event\Restored;
 use Flarum\Post\Event\Revised;
 use Flarum\User\User;
+use Psr\Http\Message\ServerRequestInterface;
 
 /**
  * A standard comment in a discussion.
  *
  * @property string $parsed_content
- * @property string $content_html
  */
 class CommentPost extends Post
 {
@@ -166,11 +166,12 @@ public function setParsedContentAttribute($value)
     /**
      * Get the content rendered as HTML.
      *
+     * @param ServerRequestInterface $request
      * @return string
      */
-    public function getContentHtmlAttribute()
+    public function formatContent(ServerRequestInterface $request)
     {
-        return static::$formatter->render($this->attributes['content'], $this);
+        return static::$formatter->render($this->attributes['content'], $this, $request);
     }
 
     /**