mirror of
https://github.com/flarum/core.git
synced 2025-07-16 14:26:25 +02:00
fa5c7cb123
And redirect to the "no JS" mode if the JS app crashes on boot. ClientView/ClientAction is all a bit of a mess and will need to be radically cleaned up at some point...
334 lines
7.5 KiB
PHP
334 lines
7.5 KiB
PHP
<?php namespace Flarum\Support;
|
|
|
|
use Flarum\Api\Client;
|
|
use Flarum\Assets\AssetManager;
|
|
use Flarum\Core\Users\User;
|
|
use Illuminate\Contracts\Support\Renderable;
|
|
use Psr\Http\Message\ServerRequestInterface as Request;
|
|
use Flarum\Locale\JsCompiler;
|
|
|
|
/**
|
|
* This class represents a view which boots up Flarum's client.
|
|
*/
|
|
class ClientView implements Renderable
|
|
{
|
|
/**
|
|
* The user who is using the client.
|
|
*
|
|
* @var User
|
|
*/
|
|
protected $actor;
|
|
|
|
/**
|
|
* The title of the document, displayed in the <title> tag.
|
|
*
|
|
* @var null|string
|
|
*/
|
|
protected $title;
|
|
|
|
/**
|
|
* The SEO content of the page, displayed in <noscript> tags.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $content;
|
|
|
|
/**
|
|
* The path to the client layout view to display.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $layout;
|
|
|
|
/**
|
|
* An API response that should be preloaded into the page.
|
|
*
|
|
* @var null|array|object
|
|
*/
|
|
protected $document;
|
|
|
|
/**
|
|
* Other variables to preload into the page.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $variables = [];
|
|
|
|
/**
|
|
* An array of JS modules to import before booting the app.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $bootstrappers = ['locale'];
|
|
|
|
/**
|
|
* An array of strings to append to the page's <head>.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $headStrings = [];
|
|
|
|
/**
|
|
* An array of strings to prepend before the page's </body>.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $footStrings = [];
|
|
|
|
/**
|
|
* @var Client
|
|
*/
|
|
protected $apiClient;
|
|
|
|
/**
|
|
* @var Request
|
|
*/
|
|
protected $request;
|
|
|
|
/**
|
|
* @var AssetManager
|
|
*/
|
|
protected $assets;
|
|
|
|
/**
|
|
* @var JsCompiler
|
|
*/
|
|
protected $locale;
|
|
|
|
/**
|
|
* @param Client $apiClient
|
|
* @param Request $request
|
|
* @param User $actor
|
|
* @param AssetManager $assets
|
|
* @param JsCompiler $locale
|
|
* @param string $layout
|
|
*/
|
|
public function __construct(
|
|
Client $apiClient,
|
|
Request $request,
|
|
User $actor,
|
|
AssetManager $assets,
|
|
JsCompiler $locale,
|
|
$layout
|
|
) {
|
|
$this->apiClient = $apiClient;
|
|
$this->request = $request;
|
|
$this->actor = $actor;
|
|
$this->assets = $assets;
|
|
$this->locale = $locale;
|
|
$this->layout = $layout;
|
|
}
|
|
|
|
/**
|
|
* The title of the document, to be displayed in the <title> tag.
|
|
*
|
|
* @param null|string $title
|
|
*/
|
|
public function setTitle($title)
|
|
{
|
|
$this->title = $title;
|
|
}
|
|
|
|
/**
|
|
* Set the SEO content of the page, to be displayed in <noscript> tags.
|
|
*
|
|
* @param null|string $content
|
|
*/
|
|
public function setContent($content)
|
|
{
|
|
$this->content = $content;
|
|
}
|
|
|
|
/**
|
|
* Set the name of the client layout view to display.
|
|
*
|
|
* @param string $layout
|
|
*/
|
|
public function setLayout($layout)
|
|
{
|
|
$this->layout = $layout;
|
|
}
|
|
|
|
/**
|
|
* Add a string to be appended to the page's <head>.
|
|
*
|
|
* @param string $string
|
|
*/
|
|
public function addHeadString($string)
|
|
{
|
|
$this->headStrings[] = $string;
|
|
}
|
|
|
|
/**
|
|
* Add a string to be prepended before the page's </body>.
|
|
*
|
|
* @param string $string
|
|
*/
|
|
public function addFootString($string)
|
|
{
|
|
$this->footStrings[] = $string;
|
|
}
|
|
|
|
/**
|
|
* Set an API response to be preloaded into the page. This should be a
|
|
* JSON-API document.
|
|
*
|
|
* @param null|array|object $document
|
|
*/
|
|
public function setDocument($document)
|
|
{
|
|
$this->document = $document;
|
|
}
|
|
|
|
/**
|
|
* Set a variable to be preloaded into the app.
|
|
*
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*/
|
|
public function setVariable($name, $value)
|
|
{
|
|
$this->variables[$name] = $value;
|
|
}
|
|
|
|
/**
|
|
* Add a JavaScript module to be imported before the app is booted.
|
|
*
|
|
* @param string $string
|
|
*/
|
|
public function addBootstrapper($string)
|
|
{
|
|
$this->bootstrappers[] = $string;
|
|
}
|
|
|
|
/**
|
|
* Get the view's asset manager.
|
|
*
|
|
* @return AssetManager
|
|
*/
|
|
public function getAssets()
|
|
{
|
|
return $this->assets;
|
|
}
|
|
|
|
/**
|
|
* Get the string contents of the view.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function render()
|
|
{
|
|
$view = app('view')->file(__DIR__.'/../../views/app.blade.php');
|
|
|
|
$forum = $this->getForumDocument();
|
|
$data = $this->getDataFromDocument($forum);
|
|
|
|
if ($this->actor->exists) {
|
|
$user = $this->getUserDocument();
|
|
$data = array_merge($data, $this->getDataFromDocument($user));
|
|
}
|
|
|
|
$view->app = [
|
|
'preload' => [
|
|
'data' => $data,
|
|
'session' => $this->getSession(),
|
|
'document' => $this->document
|
|
]
|
|
] + $this->variables;
|
|
$view->bootstrappers = $this->bootstrappers;
|
|
|
|
$noJs = array_get($this->request->getQueryParams(), 'nojs');
|
|
|
|
$view->title = ($this->title ? $this->title . ' - ' : '') . $forum->data->attributes->title;
|
|
$view->forum = $forum->data;
|
|
$view->layout = app('view')->file($this->layout, [
|
|
'forum' => $forum->data,
|
|
'content' => app('view')->file(__DIR__.'/../../views/content.blade.php', [
|
|
'content' => $this->content,
|
|
'noJs' => $noJs,
|
|
'forum' => $forum->data
|
|
])
|
|
]);
|
|
$view->noJs = $noJs;
|
|
|
|
$view->styles = [$this->assets->getCssFile()];
|
|
$view->scripts = [$this->assets->getJsFile(), $this->locale->getFile()];
|
|
|
|
$view->head = implode("\n", $this->headStrings);
|
|
$view->foot = implode("\n", $this->footStrings);
|
|
|
|
return $view->render();
|
|
}
|
|
|
|
/**
|
|
* Get the string contents of the view.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return $this->render();
|
|
}
|
|
|
|
/**
|
|
* Get the result of an API request to show the forum.
|
|
*
|
|
* @return object
|
|
*/
|
|
protected function getForumDocument()
|
|
{
|
|
return $this->apiClient->send($this->actor, 'Flarum\Api\Actions\Forum\ShowAction')->getBody();
|
|
}
|
|
|
|
/**
|
|
* Get the result of an API request to show the current user.
|
|
*
|
|
* @return object
|
|
*/
|
|
protected function getUserDocument()
|
|
{
|
|
// TODO: calling on the API here results in an extra query to get
|
|
// the user + their groups, when we already have this information on
|
|
// $this->actor. Can we simply run the CurrentUserSerializer
|
|
// manually? Or can we somehow inject this data into the ShowAction?
|
|
$document = $this->apiClient->send(
|
|
$this->actor,
|
|
'Flarum\Api\Actions\Users\ShowAction',
|
|
['id' => $this->actor->id]
|
|
)->getBody();
|
|
|
|
return $document;
|
|
}
|
|
|
|
/**
|
|
* Get an array of data by merging the 'data' and 'included' keys of a
|
|
* JSON-API document.
|
|
*
|
|
* @param object $document
|
|
* @return array
|
|
*/
|
|
protected function getDataFromDocument($document)
|
|
{
|
|
$data[] = $document->data;
|
|
|
|
if (isset($document->included)) {
|
|
$data = array_merge($data, $document->included);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Get information about the current session.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getSession()
|
|
{
|
|
return [
|
|
'userId' => $this->actor->id,
|
|
'token' => array_get($this->request->getCookieParams(), 'flarum_remember'),
|
|
];
|
|
}
|
|
}
|