xref: /webtrees/app/Http/RequestHandlers/SourcePage.php (revision b5c8fd7e66957665381ee23f19cf39bda22bc768)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\RequestHandlers;

use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\Services\ClipboardService;
use Fisharebest\Webtrees\Source;
use Fisharebest\Webtrees\Tree;
use Illuminate\Support\Collection;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

use function array_search;
use function assert;
use function is_string;
use function redirect;

use const PHP_INT_MAX;

/**
 * Show a source's page.
 */
class SourcePage implements RequestHandlerInterface
{
    use ViewResponseTrait;

    // Show the source's facts in this order:
    private const FACT_ORDER = [
        1 => 'TITL',
        'ABBR',
        'AUTH',
        'DATA',
        'PUBL',
        'TEXT',
        'REPO',
        'NOTE',
        'OBJE',
        'REFN',
        'RIN',
        '_UID',
        'CHAN',
        'RESN',
    ];

    /** @var ClipboardService */
    private $clipboard_service;

    /**
     * SourcePage constructor.
     *
     * @param ClipboardService $clipboard_service
     */
    public function __construct(ClipboardService $clipboard_service)
    {
        $this->clipboard_service = $clipboard_service;
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof Tree);

        $xref = $request->getAttribute('xref');
        assert(is_string($xref));

        $source = Source::getInstance($xref, $tree);
        $source = Auth::checkSourceAccess($source, false);

        // Redirect to correct xref/slug
        if ($source->xref() !== $xref || $request->getAttribute('slug') !== $source->slug()) {
            return redirect($source->url(), StatusCodeInterface::STATUS_MOVED_PERMANENTLY);
        }

        return $this->viewResponse('source-page', [
            'clipboard_facts' => $this->clipboard_service->pastableFacts($source, new Collection()),
            'facts'           => $this->facts($source),
            'families'        => $source->linkedFamilies('SOUR'),
            'individuals'     => $source->linkedIndividuals('SOUR'),
            'meta_robots'     => 'index,follow',
            'notes'           => $source->linkedNotes('SOUR'),
            'media_objects'   => $source->linkedMedia('SOUR'),
            'source'          => $source,
            'title'           => $source->fullName(),
            'tree'            => $tree,
        ]);
    }

    /**
     * @param Source $record
     *
     * @return Collection<Fact>
     */
    private function facts(Source $record): Collection
    {
        return $record->facts()
            ->sort(static function (Fact $x, Fact $y): int {
                $sort_x = array_search($x->getTag(), self::FACT_ORDER, true) ?: PHP_INT_MAX;
                $sort_y = array_search($y->getTag(), self::FACT_ORDER, true) ?: PHP_INT_MAX;

                return $sort_x <=> $sort_y;
            });
    }
}