xiaowang/kirby/src/Panel/View.php

<?php

namespace Kirby\Panel;

use Kirby\Http\Response;
use Kirby\Http\Url;
use Kirby\Toolkit\A;
use Kirby\Toolkit\Str;

/**
 * The View response class handles Fiber
 * requests to render either a JSON object
 * or a full HTML document for Panel views
 * @since 3.6.0
 *
 * @package   Kirby Panel
 * @author    Bastian Allgeier <bastian@getkirby.com>
 * @link      https://getkirby.com
 * @copyright Bastian Allgeier
 * @license   https://getkirby.com/license
 */
class View
{
    /**
     * Filters the data array based on headers or
     * query parameters. Requests can return only
     * certain data fields that way or globals can
     * be injected on demand.
     *
     * @param array $data
     * @return array
     */
    public static function apply(array $data): array
    {
        $request = kirby()->request();
        $only    = $request->header('X-Fiber-Only') ?? get('_only');

        if (empty($only) === false) {
            return static::applyOnly($data, $only);
        }

        $globals = $request->header('X-Fiber-Globals') ?? get('_globals');

        if (empty($globals) === false) {
            return static::applyGlobals($data, $globals);
        }

        return A::apply($data);
    }

    /**
     * Checks if globals should be included in a JSON Fiber request. They are normally
     * only loaded with the full document request, but sometimes need to be updated.
     *
     * A global request can be activated with the `X-Fiber-Globals` header or the
     * `_globals` query parameter.
     *
     * @param array $data
     * @param string|null $globals
     * @return array
     */
    public static function applyGlobals(array $data, ?string $globals = null): array
    {
        // split globals string into an array of fields
        $globalKeys = Str::split($globals, ',');

        // add requested globals
        if (empty($globalKeys) === true) {
            return $data;
        }

        $globals = static::globals();

        foreach ($globalKeys as $globalKey) {
            if (isset($globals[$globalKey]) === true) {
                $data[$globalKey] = $globals[$globalKey];
            }
        }

        // merge with shared data
        return A::apply($data);
    }

    /**
     * Checks if the request should only return a limited
     * set of data. This can be activated with the `X-Fiber-Only`
     * header or the `_only` query parameter in a request.
     *
     * Such requests can fetch shared data or globals.
     * Globals will be loaded on demand.
     *
     * @param array $data
     * @param string|null $only
     * @return array
     */
    public static function applyOnly(array $data, ?string $only = null): array
    {
        // split include string into an array of fields
        $onlyKeys = Str::split($only, ',');

        // if a full request is made, return all data
        if (empty($onlyKeys) === true) {
            return $data;
        }

        // otherwise filter data based on
        // dot notation, e.g. `$props.tab.columns`
        $result = [];

        // check if globals are requested and need to be merged
        if (Str::contains($only, '$')) {
            $data = array_merge_recursive(static::globals(), $data);
        }

        // make sure the data is already resolved to make
        // nested data fetching work
        $data = A::apply($data);

        // build a new array with all requested data
        foreach ($onlyKeys as $onlyKey) {
            $result[$onlyKey] = A::get($data, $onlyKey);
        }

        // Nest dotted keys in array but ignore $translation
        return A::nest($result, [
            '$translation'
        ]);
    }

    /**
     * Creates the shared data array for the individual views
     * The full shared data is always sent on every JSON and
     * full document request unless the `X-Fiber-Only` header or
     * the `_only` query parameter is set.
     *
     * @param array $view
     * @param array $options
     * @return array
     */
    public static function data(array $view = [], array $options = []): array
    {
        $kirby = kirby();

        // multilang setup check
        $multilang = Panel::multilang();

        // get the authenticated user
        $user = $kirby->user();

        // user permissions
        $permissions = $user ? $user->role()->permissions()->toArray() : [];

        // current content language
        $language = $kirby->language();

        // shared data for all requests
        return [
            '$direction' => function () use ($kirby, $multilang, $language, $user) {
                if ($multilang === true && $language && $user) {
                    $isDefault = $language->direction() === $kirby->defaultLanguage()->direction();
                    $isFromUser = $language->code() === $user->language();

                    if ($isDefault === false && $isFromUser === false) {
                        return $language->direction();
                    }
                }
            },
            '$language' => function () use ($kirby, $multilang, $language) {
                if ($multilang === true && $language) {
                    return [
                        'code'      => $language->code(),
                        'default'   => $language->isDefault(),
                        'direction' => $language->direction(),
                        'name'      => $language->name(),
                        'rules'     => $language->rules(),
                    ];
                }
            },
            '$languages' => function () use ($kirby, $multilang): array {
                if ($multilang === true) {
                    return $kirby->languages()->values(fn ($language) => [
                        'code'      => $language->code(),
                        'default'   => $language->isDefault(),
                        'direction' => $language->direction(),
                        'name'      => $language->name(),
                        'rules'     => $language->rules(),
                    ]);
                }

                return [];
            },
            '$menu' => function () use ($options, $permissions) {
                return static::menu($options['areas'] ?? [], $permissions, $options['area']['id'] ?? null);
            },
            '$permissions' => $permissions,
            '$license' => (bool)$kirby->system()->license(),
            '$multilang' => $multilang,
            '$searches' => static::searches($options['areas'] ?? [], $permissions),
            '$url' => Url::current(),
            '$user' => function () use ($user) {
                if ($user) {
                    return [
                        'email'       => $user->email(),
                        'id'          => $user->id(),
                        'language'    => $user->language(),
                        'role'        => $user->role()->id(),
                        'username'    => $user->username(),
                    ];
                }

                return null;
            },
            '$view' => function () use ($kirby, $options, $view) {
                $defaults = [
                    'breadcrumb' => [],
                    'code'       => 200,
                    'path'       => Str::after($kirby->path(), '/'),
                    'timestamp'  => (int)(microtime(true) * 1000),
                    'props'      => [],
                    'search'     => $kirby->option('panel.search.type', 'pages')
                ];

                $view = array_replace_recursive($defaults, $options['area'] ?? [], $view);

                // make sure that views and dialogs are gone
                unset(
                    $view['dialogs'],
                    $view['dropdowns'],
                    $view['searches'],
                    $view['views']
                );

                // resolve all callbacks in the view array
                return A::apply($view);
            }
        ];
    }

    /**
     * Renders the error view with provided message
     *
     * @param string $message
     * @param int $code
     * @return array
     */
    public static function error(string $message, int $code = 404)
    {
        return [
            'code'      => $code,
            'component' => 'k-error-view',
            'error'     => $message,
            'props'     => [
                'error'  => $message,
                'layout' => Panel::hasAccess(kirby()->user()) ? 'inside' : 'outside'
            ],
            'title' => 'Error'
        ];
    }

    /**
     * Creates global data for the Panel.
     * This will be injected in the full Panel
     * view via the script tag. Global data
     * is only requested once on the first page load.
     * It can be loaded partially later if needed,
     * but is otherwise not included in Fiber calls.
     *
     * @return array
     */
    public static function globals(): array
    {
        $kirby = kirby();

        return [
            '$config' => function () use ($kirby) {
                return [
                    'debug'     => $kirby->option('debug', false),
                    'kirbytext' => $kirby->option('panel.kirbytext', true),
                    'search'    => [
                        'limit' => $kirby->option('panel.search.limit', 10),
                        'type'  => $kirby->option('panel.search.type', 'pages')
                    ],
                    'translation' => $kirby->option('panel.language', 'en'),
                ];
            },
            '$system' => function () use ($kirby) {
                $locales = [];

                foreach ($kirby->translations() as $translation) {
                    $locales[$translation->code()] = $translation->locale();
                }

                return [
                    'ascii'   => Str::$ascii,
                    'csrf'    => $kirby->auth()->csrfFromSession(),
                    'isLocal' => $kirby->system()->isLocal(),
                    'locales' => $locales,
                    'slugs'   => Str::$language,
                    'title'   => $kirby->site()->title()->or('Kirby Panel')->toString()
                ];
            },
            '$translation' => function () use ($kirby) {
                if ($user = $kirby->user()) {
                    $translation = $kirby->translation($user->language());
                } else {
                    $translation = $kirby->translation($kirby->panelLanguage());
                }

                return [
                    'code'      => $translation->code(),
                    'data'      => $translation->dataWithFallback(),
                    'direction' => $translation->direction(),
                    'name'      => $translation->name(),
                ];
            },
            '$urls' => fn () => [
                'api'  => $kirby->url('api'),
                'site' => $kirby->url('index')
            ]
        ];
    }

    /**
     * Creates the menu for the topbar
     *
     * @param array $areas
     * @param array $permissions
     * @param string|null $current
     * @return array
     */
    public static function menu(?array $areas = [], ?array $permissions = [], ?string $current = null): array
    {
        $menu = [];

        // areas
        foreach ($areas as $areaId => $area) {
            $access = $permissions['access'][$areaId] ?? true;

            // areas without access permissions get skipped entirely
            if ($access === false) {
                continue;
            }

            // fetch custom menu settings from the area definition
            $menuSetting = $area['menu'] ?? false;

            // menu settings can be a callback that can return true, false or disabled
            if (is_a($menuSetting, 'Closure') === true) {
                $menuSetting = $menuSetting($areas, $permissions, $current);
            }

            // false will remove the area entirely just like with
            // disabled permissions
            if ($menuSetting === false) {
                continue;
            }

            $menu[] = [
                'current'  => $areaId === $current,
                'disabled' => $menuSetting === 'disabled',
                'icon'     => $area['icon'],
                'id'       => $areaId,
                'link'     => $area['link'],
                'text'     => $area['label'],
            ];
        }

        $menu[] = '-';
        $menu[] = [
            'current'  => $current === 'account',
            'icon'     => 'account',
            'id'       => 'account',
            'link'     => 'account',
            'disabled' => ($permissions['access']['account'] ?? false) === false,
            'text'     => t('view.account'),
        ];
        $menu[] = '-';

        // logout
        $menu[] = [
            'icon' => 'logout',
            'id'   => 'logout',
            'link' => 'logout',
            'text' => t('logout')
        ];
        return $menu;
    }

    /**
     * Renders the main panel view either as
     * JSON response or full HTML document based
     * on the request header or query params
     *
     * @param mixed $data
     * @param array $options
     * @return \Kirby\Http\Response
     */
    public static function response($data, array $options = [])
    {
        // handle redirects
        if (is_a($data, 'Kirby\Panel\Redirect') === true) {
            return Response::redirect($data->location(), $data->code());

        // handle Kirby exceptions
        } elseif (is_a($data, 'Kirby\Exception\Exception') === true) {
            $data = static::error($data->getMessage(), $data->getHttpCode());

        // handle regular exceptions
        } elseif (is_a($data, 'Throwable') === true) {
            $data = static::error($data->getMessage(), 500);

        // only expect arrays from here on
        } elseif (is_array($data) === false) {
            $data = static::error('Invalid Panel response', 500);
        }

        // get all data for the request
        $fiber = static::data($data, $options);

        // if requested, send $fiber data as JSON
        if (Panel::isFiberRequest() === true) {

            // filter data, if only or globals headers or
            // query parameters are set
            $fiber = static::apply($fiber);

            return Panel::json($fiber, $fiber['$view']['code'] ?? 200);
        }

        // load globals for the full document response
        $globals = static::globals();

        // resolve and merge globals and shared data
        $fiber = array_merge_recursive(A::apply($globals), A::apply($fiber));

        // render the full HTML document
        return Document::response($fiber);
    }

    public static function searches(array $areas, array $permissions)
    {
        $searches = [];

        foreach ($areas as $area) {
            foreach ($area['searches'] ?? [] as $id => $params) {
                $searches[$id] = [
                    'icon'  => $params['icon'] ?? 'search',
                    'label' => $params['label'] ?? Str::ucfirst($id),
                    'id'    => $id
                ];
            }
        }
        return $searches;
    }
}