xref: /webtrees/app/Helpers/functions.php (revision 4874f72da8279544d9c0a459e2920a9986acfaa0) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20use Aura\Router\RouterContainer;
21use Fig\Http\Message\StatusCodeInterface;
22use Fisharebest\Webtrees\Application;
23use Fisharebest\Webtrees\Html;
24use Fisharebest\Webtrees\Session;
25use Fisharebest\Webtrees\View as WebtreesView;
26use Fisharebest\Webtrees\Webtrees;
27use Psr\Http\Message\ResponseFactoryInterface;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Message\StreamFactoryInterface;
31
32/**
33 * Get the IoC container, or fetch something from it.
34 *
35 * @param string|null $abstract
36 *
37 * @return mixed
38 */
39function app(string $abstract = null)
40{
41    if ($abstract === null) {
42        return Application::getInstance();
43    }
44
45    return Application::getInstance()->make($abstract);
46}
47
48/**
49 * Generate a URL to an asset file in the public folder.
50 * Add a version parameter for cache-busting.
51 *
52 * @param string $path
53 *
54 * @return string
55 */
56function asset(string $path): string
57{
58    if (substr($path, -1) === '/') {
59        $version = '';
60    } elseif (Webtrees::STABILITY === '') {
61        $version = '?v=' . Webtrees::VERSION;
62    } else {
63        $version = '?v=' . filemtime(Webtrees::ROOT_DIR . 'public/' . $path);
64    }
65
66    $base_url = app(ServerRequestInterface::class)->getAttribute('base_url');
67
68    return $base_url . '/public/' . $path . $version;
69}
70
71/**
72 * Generate a CSRF token form field.
73 *
74 * @return string
75 */
76function csrf_field()
77{
78    return '<input type="hidden" name="csrf" value="' . e(Session::getCsrfToken()) . '">';
79}
80
81/**
82 * Get the CSRF token value.
83 *
84 * @return string
85 */
86function csrf_token()
87{
88    return Session::getCsrfToken();
89}
90
91/**
92 * @param string $url
93 * @param int    $code
94 *
95 * @return ResponseInterface
96 */
97function redirect(string $url, $code = StatusCodeInterface::STATUS_FOUND): ResponseInterface
98{
99    /** @var ResponseFactoryInterface $response_factory */
100    $response_factory = app(ResponseFactoryInterface::class);
101
102    return $response_factory
103        ->createResponse($code)
104        ->withHeader('Location', $url);
105}
106
107/**
108 * Create a response.
109 *
110 * @param mixed    $content
111 * @param int      $code
112 * @param string[] $headers
113 *
114 * @return ResponseInterface
115 */
116function response($content = '', $code = StatusCodeInterface::STATUS_OK, $headers = []): ResponseInterface
117{
118    if ($headers === []) {
119        if (is_string($content)) {
120            $headers = [
121                'Content-Type'   => 'text/html; charset=utf-8',
122                'Content-Length' => strlen($content),
123            ];
124        } else {
125            $content = json_encode($content, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
126            $headers = [
127                'Content-Type'   => 'application/json',
128                'Content-Length' => strlen($content),
129            ];
130        }
131    }
132
133    /** @var ResponseFactoryInterface $response_factory */
134    $response_factory = app(ResponseFactoryInterface::class);
135
136    /** @var StreamFactoryInterface $stream_factory */
137    $stream_factory = app(StreamFactoryInterface::class);
138
139    $stream = $stream_factory->createStream($content);
140
141    $response = $response_factory
142        ->createResponse($code)
143        ->withBody($stream);
144
145    foreach ($headers as $key => $value) {
146        $response = $response->withHeader($key, $value);
147    }
148
149    return $response;
150}
151
152/**
153 * Generate a URL for a named route.
154 *
155 * @param string $route_name
156 * @param array  $parameters
157 *
158 * @return string
159 */
160function route(string $route_name, array $parameters = []): string
161{
162    $request          = app(ServerRequestInterface::class);
163    $router_container = app(RouterContainer::class);
164    $route            = $router_container->getMap()->getRoute($route_name);
165
166    // Generate the URL.
167    $url = $router_container->getGenerator()->generate($route_name, $parameters);
168
169    // Aura ignores parameters that are not tokens.  We need to add them as query parameters.
170    $parameters = array_filter($parameters, static function (string $key) use ($route): bool {
171        return strpos($route->path, '{' . $key . '}') === false && strpos($route->path, '{/' . $key . '}') === false;
172    }, ARRAY_FILTER_USE_KEY);
173
174    // Turn the pretty URL into an ugly one.
175    if ((bool) $request->getAttribute('rewrite_urls') === false) {
176        $path       = parse_url($url, PHP_URL_PATH);
177        $parameters = ['route' => $path] + $parameters;
178        $base_url   = $request->getAttribute('base_url');
179        $url        = $base_url . str_replace($path, '/index.php', $url);
180    }
181
182    return Html::url($url, $parameters);
183}
184
185/**
186 * Cerate and render a view in a single operation.
187 *
188 * @param string  $name
189 * @param mixed[] $data
190 *
191 * @return string
192 */
193function view(string $name, array $data = [])
194{
195    return WebtreesView::make($name, $data);
196}
197