MediaListModule::listUrl() - Code Metrics - Inspection of "Refactor list controllers into list modules - fixe..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7b2840...06a438 )

by Greg

created 2020-07-17 09:41 UTC

MediaListModule::listUrl() A

↳ Parent: MediaListModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2020 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\Module;

use Aura\Router\RouterContainer;
use Fig\Http\Message\RequestMethodInterface;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\Factory;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Media;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Database\Query\Builder;
use Illuminate\Database\Query\JoinClause;
use Illuminate\Support\Collection;
use League\Flysystem\FilesystemInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

use function addcslashes;
use function app;
use function array_combine;
use function array_unshift;
use function assert;
use function dirname;
use function max;
use function min;
use function redirect;
use function route;

/**
 * Class MediaListModule
 */
class MediaListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface
{
    use ModuleListTrait;

    protected const ROUTE_URL = '/tree/{tree}/media-list';

    /**
     * Initialization.
     *
     * @return void
     */
    public function boot(): void
    {
        $router_container = app(RouterContainer::class);
        assert($router_container instanceof RouterContainer);

        $router_container->getMap()
            ->get(static::class, static::ROUTE_URL, $this)
            ->allows(RequestMethodInterface::METHOD_POST);
    }

    /**
     * How should this module be identified in the control panel, etc.?
     *
     * @return string
     */
    public function title(): string
    {
        /* I18N: Name of a module/list */
        return I18N::translate('Media objects');
    }

    /**
     * A sentence describing what this module does.
     *
     * @return string
     */
    public function description(): string
    {
        /* I18N: Description of the “Media objects” module */
        return I18N::translate('A list of media objects.');
    }

    /**
     * CSS class for the URL.
     *
     * @return string
     */
    public function listMenuClass(): string
    {
        return 'menu-list-obje';
    }

    /**
     * @param Tree    $tree
     * @param mixed[] $parameters
     *
     * @return string
     */
    public function listUrl(Tree $tree, array $parameters = []): string
    {
        $parameters['tree'] = $tree->name();

        return route(static::class, $parameters);
    }

    /**
     * @return string[]
     */
    public function listUrlAttributes(): array
    {
        return [];
    }

    /**
     * @param Tree $tree
     *
     * @return bool
     */
    public function listIsEmpty(Tree $tree): bool
    {
        return !DB::table('media')
            ->where('m_file', '=', $tree->id())
            ->exists();
    }

    /**
     * Handle URLs generated by older versions of webtrees
     *
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function getListAction(ServerRequestInterface $request): ResponseInterface
    {
        return redirect($this->listUrl($request->getAttribute('tree'), $request->getQueryParams()));
    }

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

        $user = $request->getAttribute('user');
        assert($user instanceof UserInterface);

        $data_filesystem = $request->getAttribute('filesystem.data');
        assert($data_filesystem instanceof FilesystemInterface);

        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);

        // Convert POST requests into GET requests for pretty URLs.
        if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
            return redirect($this->listUrl($tree, (array) $request->getParsedBody()));
        }

        $params  = $request->getQueryParams();
        $formats = GedcomTag::getFileFormTypes();
        $go      = $params['go'] ?? '';
        $page    = (int) ($params['page'] ?? 1);
        $max     = (int) ($params['max'] ?? 20);
        $folder  = $params['folder'] ?? '';
        $filter  = $params['filter'] ?? '';
        $subdirs = $params['subdirs'] ?? '';
        $format  = $params['format'] ?? '';

        $folders = $this->allFolders($tree);

        if ($go === '1') {
            $media_objects = $this->allMedia(
                $tree,
                $folder,
                $subdirs === '1' ? 'include' : 'exclude',
                'title',
                $filter,
                $format
            );
        } else {
            $media_objects = new Collection();
        }

        // Pagination
        $count = $media_objects->count();
        $pages = (int) (($count + $max - 1) / $max);
        $page  = max(min($page, $pages), 1);

        $media_objects = $media_objects->slice(($page - 1) * $max, $max);

        return $this->viewResponse('modules/media-list/page', [
            'count'           => $count,
            'filter'          => $filter,
            'folder'          => $folder,
            'folders'         => $folders,
            'format'          => $format,
            'formats'         => $formats,
            'max'             => $max,
            'media_objects'   => $media_objects,
            'page'            => $page,
            'pages'           => $pages,
            'subdirs'         => $subdirs,
            'data_filesystem' => $data_filesystem,
            'module'          => $this,
            'title'           => I18N::translate('Media'),
            'tree'            => $tree,
        ]);
    }

    /**
     * Generate a list of all the folders in a current tree.
     *
     * @param Tree $tree
     *
     * @return string[]
     */
    private function allFolders(Tree $tree): array
    {
        $folders = DB::table('media_file')
            ->where('m_file', '=', $tree->id())
            ->where('multimedia_file_refn', 'NOT LIKE', 'http:%')
            ->where('multimedia_file_refn', 'NOT LIKE', 'https:%')
            ->where('multimedia_file_refn', 'LIKE', '%/%')
            ->pluck('multimedia_file_refn', 'multimedia_file_refn')
            ->map(static function (string $path): string {
                return dirname($path);
            })
            ->uniqueStrict()
            ->sort()
            ->all();

        // Ensure we have an empty (top level) folder.
        array_unshift($folders, '');

        return array_combine($folders, $folders);
    }

    /**
     * Generate a list of all the media objects matching the criteria in a current tree.
     *
     * @param Tree   $tree       find media in this tree
     * @param string $folder     folder to search
     * @param string $subfolders either "include" or "exclude"
     * @param string $sort       either "file" or "title"
     * @param string $filter     optional search string
     * @param string $format     option OBJE/FILE/FORM/TYPE
     *
     * @return Collection<Media>
     */
    private function allMedia(Tree $tree, string $folder, string $subfolders, string $sort, string $filter, string $format): Collection
    {
        $query = DB::table('media')
            ->join('media_file', static function (JoinClause $join): void {
                $join
                    ->on('media_file.m_file', '=', 'media.m_file')
                    ->on('media_file.m_id', '=', 'media.m_id');
            })
            ->where('media.m_file', '=', $tree->id());

        if ($folder === '') {
            // Include external URLs in the root folder.
            if ($subfolders === 'exclude') {
                $query->where(static function (Builder $query): void {
                    $query
                        ->where('multimedia_file_refn', 'NOT LIKE', '%/%')
                        ->orWhere('multimedia_file_refn', 'LIKE', 'http:%')
                        ->orWhere('multimedia_file_refn', 'LIKE', 'https:%');
                });
            }
        } else {
            // Exclude external URLs from the root folder.
            $query
                ->where('multimedia_file_refn', 'LIKE', $folder . '/%')
                ->where('multimedia_file_refn', 'NOT LIKE', 'http:%')
                ->where('multimedia_file_refn', 'NOT LIKE', 'https:%');

            if ($subfolders === 'exclude') {
                $query->where('multimedia_file_refn', 'NOT LIKE', $folder . '/%/%');
            }
        }

        // Apply search terms
        if ($filter !== '') {
            $query->where(static function (Builder $query) use ($filter): void {
                $like = '%' . addcslashes($filter, '\\%_') . '%';
                $query
                    ->where('multimedia_file_refn', 'LIKE', $like)
                    ->orWhere('descriptive_title', 'LIKE', $like);
            });
        }

        if ($format) {
            $query->where('source_media_type', '=', $format);
        }

        switch ($sort) {
            case 'file':
                $query->orderBy('multimedia_file_refn');
                break;
            case 'title':
                $query->orderBy('descriptive_title');
                break;
        }

        return $query
            ->get()
            ->map(Factory::media()->mapper($tree))
            ->uniqueStrict()
            ->filter(GedcomRecord::accessFilter());
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2020 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
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Module;
21
22			use Aura\Router\RouterContainer;
23			use Fig\Http\Message\RequestMethodInterface;
24			use Fisharebest\Webtrees\Auth;
25			use Fisharebest\Webtrees\Contracts\UserInterface;
26			use Fisharebest\Webtrees\Factory;
27			use Fisharebest\Webtrees\GedcomRecord;
28			use Fisharebest\Webtrees\GedcomTag;
29			use Fisharebest\Webtrees\I18N;
30			use Fisharebest\Webtrees\Media;
31			use Fisharebest\Webtrees\Tree;
32			use Illuminate\Database\Capsule\Manager as DB;
33			use Illuminate\Database\Query\Builder;
34			use Illuminate\Database\Query\JoinClause;
35			use Illuminate\Support\Collection;
36			use League\Flysystem\FilesystemInterface;
37			use Psr\Http\Message\ResponseInterface;
38			use Psr\Http\Message\ServerRequestInterface;
39			use Psr\Http\Server\RequestHandlerInterface;
40
41			use function addcslashes;
42			use function app;
43			use function array_combine;
44			use function array_unshift;
45			use function assert;
46			use function dirname;
47			use function max;
48			use function min;
49			use function redirect;
50			use function route;
51
52			/**
53			* Class MediaListModule
54			*/
55			class MediaListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface
56			{
57			use ModuleListTrait;
58
59			protected const ROUTE_URL = '/tree/{tree}/media-list';
60
61			/**
62			* Initialization.
63			*
64			* @return void
65			*/
66			public function boot(): void
67			{
68			$router_container = app(RouterContainer::class);
69			assert($router_container instanceof RouterContainer);
70
71			$router_container->getMap()
72			->get(static::class, static::ROUTE_URL, $this)
73			->allows(RequestMethodInterface::METHOD_POST);
74			}
75
76			/**
77			* How should this module be identified in the control panel, etc.?
78			*
79			* @return string
80			*/
81			public function title(): string
82			{
83			/* I18N: Name of a module/list */
84			return I18N::translate('Media objects');
85			}
86
87			/**
88			* A sentence describing what this module does.
89			*
90			* @return string
91			*/
92			public function description(): string
93			{
94			/* I18N: Description of the “Media objects” module */
95			return I18N::translate('A list of media objects.');
96			}
97
98			/**
99			* CSS class for the URL.
100			*
101			* @return string
102			*/
103			public function listMenuClass(): string
104			{
105			return 'menu-list-obje';
106			}
107
108			/**
109			* @param Tree $tree
110			* @param mixed[] $parameters
111			*
112			* @return string
113			*/
114			public function listUrl(Tree $tree, array $parameters = []): string
115			{
116			$parameters['tree'] = $tree->name();
117
118			return route(static::class, $parameters);
119			}
120
121			/**
122			* @return string[]
123			*/
124			public function listUrlAttributes(): array
125			{
126			return [];
127			}
128
129			/**
130			* @param Tree $tree
131			*
132			* @return bool
133			*/
134			public function listIsEmpty(Tree $tree): bool
135			{
136			return !DB::table('media')
137			->where('m_file', '=', $tree->id())
138			->exists();
139			}
140
141			/**
142			* Handle URLs generated by older versions of webtrees
143			*
144			* @param ServerRequestInterface $request
145			*
146			* @return ResponseInterface
147			*/
148			public function getListAction(ServerRequestInterface $request): ResponseInterface
149			{
150			return redirect($this->listUrl($request->getAttribute('tree'), $request->getQueryParams()));
151			}
152
153			/**
154			* @param ServerRequestInterface $request
155			*
156			* @return ResponseInterface
157			*/
158			public function handle(ServerRequestInterface $request): ResponseInterface
159			{
160			$tree = $request->getAttribute('tree');
161			assert($tree instanceof Tree);
162
163			$user = $request->getAttribute('user');
164			assert($user instanceof UserInterface);
165
166			$data_filesystem = $request->getAttribute('filesystem.data');
167			assert($data_filesystem instanceof FilesystemInterface);
168
169			Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
170
171			// Convert POST requests into GET requests for pretty URLs.
172			if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
173			return redirect($this->listUrl($tree, (array) $request->getParsedBody()));
174			}
175
176			$params = $request->getQueryParams();
177			$formats = GedcomTag::getFileFormTypes();
178			$go = $params['go'] ?? '';
179			$page = (int) ($params['page'] ?? 1);
180			$max = (int) ($params['max'] ?? 20);
181			$folder = $params['folder'] ?? '';
182			$filter = $params['filter'] ?? '';
183			$subdirs = $params['subdirs'] ?? '';
184			$format = $params['format'] ?? '';
185
186			$folders = $this->allFolders($tree);
187
188			if ($go === '1') {
189			$media_objects = $this->allMedia(
190			$tree,
191			$folder,
192			$subdirs === '1' ? 'include' : 'exclude',
193			'title',
194			$filter,
195			$format
196			);
197			} else {
198			$media_objects = new Collection();
199			}
200
201			// Pagination
202			$count = $media_objects->count();
203			$pages = (int) (($count + $max - 1) / $max);
204			$page = max(min($page, $pages), 1);
205
206			$media_objects = $media_objects->slice(($page - 1) * $max, $max);
207
208			return $this->viewResponse('modules/media-list/page', [
209			'count' => $count,
210			'filter' => $filter,
211			'folder' => $folder,
212			'folders' => $folders,
213			'format' => $format,
214			'formats' => $formats,
215			'max' => $max,
216			'media_objects' => $media_objects,
217			'page' => $page,
218			'pages' => $pages,
219			'subdirs' => $subdirs,
220			'data_filesystem' => $data_filesystem,
221			'module' => $this,
222			'title' => I18N::translate('Media'),
223			'tree' => $tree,
224			]);
225			}
226
227			/**
228			* Generate a list of all the folders in a current tree.
229			*
230			* @param Tree $tree
231			*
232			* @return string[]
233			*/
234			private function allFolders(Tree $tree): array
235			{
236			$folders = DB::table('media_file')
237			->where('m_file', '=', $tree->id())
238			->where('multimedia_file_refn', 'NOT LIKE', 'http:%')
239			->where('multimedia_file_refn', 'NOT LIKE', 'https:%')
240			->where('multimedia_file_refn', 'LIKE', '%/%')
241			->pluck('multimedia_file_refn', 'multimedia_file_refn')
242			->map(static function (string $path): string {
243			return dirname($path);
244			})
245			->uniqueStrict()
246			->sort()
247			->all();
248
249			// Ensure we have an empty (top level) folder.
250			array_unshift($folders, '');
251
252			return array_combine($folders, $folders);
253			}
254
255			/**
256			* Generate a list of all the media objects matching the criteria in a current tree.
257			*
258			* @param Tree $tree find media in this tree
259			* @param string $folder folder to search
260			* @param string $subfolders either "include" or "exclude"
261			* @param string $sort either "file" or "title"
262			* @param string $filter optional search string
263			* @param string $format option OBJE/FILE/FORM/TYPE
264			*
265			* @return Collection<Media>
266			*/
267			private function allMedia(Tree $tree, string $folder, string $subfolders, string $sort, string $filter, string $format): Collection
268			{
269			$query = DB::table('media')
270			->join('media_file', static function (JoinClause $join): void {
271			$join
272			->on('media_file.m_file', '=', 'media.m_file')
273			->on('media_file.m_id', '=', 'media.m_id');
274			})
275			->where('media.m_file', '=', $tree->id());
276
277			if ($folder === '') {
278			// Include external URLs in the root folder.
279			if ($subfolders === 'exclude') {
280			$query->where(static function (Builder $query): void {
281			$query
282			->where('multimedia_file_refn', 'NOT LIKE', '%/%')
283			->orWhere('multimedia_file_refn', 'LIKE', 'http:%')
284			->orWhere('multimedia_file_refn', 'LIKE', 'https:%');
285			});
286			}
287			} else {
288			// Exclude external URLs from the root folder.
289			$query
290			->where('multimedia_file_refn', 'LIKE', $folder . '/%')
291			->where('multimedia_file_refn', 'NOT LIKE', 'http:%')
292			->where('multimedia_file_refn', 'NOT LIKE', 'https:%');
293
294			if ($subfolders === 'exclude') {
295			$query->where('multimedia_file_refn', 'NOT LIKE', $folder . '/%/%');
296			}
297			}
298
299			// Apply search terms
300			if ($filter !== '') {
301			$query->where(static function (Builder $query) use ($filter): void {
302			$like = '%' . addcslashes($filter, '\\%_') . '%';
303			$query
304			->where('multimedia_file_refn', 'LIKE', $like)
305			->orWhere('descriptive_title', 'LIKE', $like);
306			});
307			}
308
309			if ($format) {
310			$query->where('source_media_type', '=', $format);
311			}
312
313			switch ($sort) {
314			case 'file':
315			$query->orderBy('multimedia_file_refn');
316			break;
317			case 'title':
318			$query->orderBy('descriptive_title');
319			break;
320			}
321
322			return $query
323			->get()
324			->map(Factory::media()->mapper($tree))
325			->uniqueStrict()
326			->filter(GedcomRecord::accessFilter());
327			}
328			}
329

fisharebest / webtrees

Push — master ( 7b2840...06a438 )

MediaListModule::listUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like