Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Passed
Pull Request — master (#837)
by Beatrycze
06:34 queued 02:52
created

TableOfContentsController::getTypes()   A

Complexity

Conditions 5
Paths 2

Size

Total Lines 15
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 9
c 0
b 0
f 0
nc 2
nop 1
dl 0
loc 15
rs 9.6111
1
<?php
2
/**
3
 * (c) Kitodo. Key to digital objects e.V. <[email protected]>
4
 *
5
 * This file is part of the Kitodo and TYPO3 projects.
6
 *
7
 * @license GNU General Public License version 3 or later.
8
 * For the full copyright and license information, please read the
9
 * LICENSE.txt file that was distributed with this source code.
10
 */
11
12
namespace Kitodo\Dlf\Controller;
13
14
use Kitodo\Dlf\Common\Helper;
15
use Kitodo\Dlf\Common\MetsDocument;
16
use TYPO3\CMS\Core\Utility\MathUtility;
17
use TYPO3\CMS\Core\Utility\GeneralUtility;
18
19
/**
20
 * Controller class for plugin 'Table Of Contents'.
21
 *
22
 * @author Sebastian Meyer <[email protected]>
23
 * @package TYPO3
24
 * @subpackage dlf
25
 * @access public
26
 */
27
class TableOfContentsController extends AbstractController
28
{
29
    /**
30
     * This holds the active entries according to the currently selected page
31
     *
32
     * @var array
33
     * @access protected
34
     */
35
    protected $activeEntries = [];
36
37
    /**
38
     * This holds the list of authors for autocomplete
39
     *
40
     * @var array
41
     * @access protected
42
     */
43
    protected $authors = [];
44
45
    /**
46
     * This holds the list of titles for autocomplete
47
     *
48
     * @var array
49
     * @access protected
50
     */
51
    protected $titles = [];
52
53
    /**
54
     * The main method of the plugin
55
     *
56
     * @return void
57
     */
58
    public function mainAction()
59
    {
60
        // Load current document.
61
        $this->loadDocument($this->requestData);
62
        if (
63
            $this->document === null
64
            || $this->document->getDoc() === null
65
        ) {
66
            // Quit without doing anything if required variables are not set.
67
            return;
68
        } else {
69
            if (!empty($this->requestData['logicalPage'])) {
70
                $this->requestData['page'] = $this->document->getDoc()->getPhysicalPage($this->requestData['logicalPage']);
71
                // The logical page parameter should not appear again
72
                unset($this->requestData['logicalPage']);
73
            }
74
            if ($this->document->getDoc()->tableOfContents[0]['type'] == 'collection') {
75
                $this->view->assign('currentList', $this->requestData['id']);
76
                if (isset($this->requestData['transform'])) {
77
                    $this->view->assign('transform', $this->requestData['transform']);
78
                } else {
79
                    $this->view->assign('transform', 'something');
80
                }
81
                $this->view->assign('type', 'collection');
82
                $this->view->assign('types', $this->getTypes($this->document->getDoc()->tableOfContents));
83
                $this->view->assign('toc', $this->makeMenuFor3DObjects());
84
                $this->view->assign('authors', $this->authors);
85
                $this->view->assign('titles', $this->titles);
86
            } else {
87
                $this->view->assign('type', 'other');
88
                $this->view->assign('toc', $this->makeMenuArray());
89
            }
90
        }
91
    }
92
93
    /**
94
     * This builds a menu array for HMENU
95
     *
96
     * @access protected
97
     * @return array HMENU array
98
     */
99
    protected function makeMenuArray()
100
    {
101
        // Set default values for page if not set.
102
        // $this->requestData['page'] may be integer or string (physical structure @ID)
103
        if (
104
            (int) $this->requestData['page'] > 0
105
            || empty($this->requestData['page'])
106
        ) {
107
            $this->requestData['page'] = MathUtility::forceIntegerInRange((int) $this->requestData['page'], 1, $this->document->getDoc()->numPages, 1);
108
        } else {
109
            $this->requestData['page'] = array_search($this->requestData['page'], $this->document->getDoc()->physicalStructure);
110
        }
111
        $this->requestData['double'] = MathUtility::forceIntegerInRange($this->requestData['double'], 0, 1, 0);
112
        $menuArray = [];
113
        // Does the document have physical elements or is it an external file?
114
        if (
115
            !empty($this->document->getDoc()->physicalStructure)
116
            || !MathUtility::canBeInterpretedAsInteger($this->requestData['id'])
117
        ) {
118
            // Get all logical units the current page or track is a part of.
119
            if (
120
                !empty($this->requestData['page'])
121
                && !empty($this->document->getDoc()->physicalStructure)
122
            ) {
123
                $this->activeEntries = array_merge((array) $this->document->getDoc()->smLinks['p2l'][$this->document->getDoc()->physicalStructure[0]],
124
                    (array) $this->document->getDoc()->smLinks['p2l'][$this->document->getDoc()->physicalStructure[$this->requestData['page']]]);
125
                if (
126
                    !empty($this->requestData['double'])
127
                    && $this->requestData['page'] < $this->document->getDoc()->numPages
128
                ) {
129
                    $this->activeEntries = array_merge($this->activeEntries,
130
                        (array) $this->document->getDoc()->smLinks['p2l'][$this->document->getDoc()->physicalStructure[$this->requestData['page'] + 1]]);
131
                }
132
            }
133
            // Go through table of contents and create all menu entries.
134
            foreach ($this->document->getDoc()->tableOfContents as $entry) {
135
                $menuArray[] = $this->getMenuEntry($entry, true);
136
            }
137
        } else {
138
            // Go through table of contents and create top-level menu entries.
139
            foreach ($this->document->getDoc()->tableOfContents as $entry) {
140
                $menuArray[] = $this->getMenuEntry($entry, false);
141
            }
142
            // Build table of contents from database.
143
            $result = $this->documentRepository->getTableOfContentsFromDb($this->document->getUid(), $this->document->getPid(), $this->settings);
144
145
            $allResults = $result->fetchAll();
0 ignored issues
show
Bug introduced by
The method fetchAll() does not exist on TYPO3\CMS\Extbase\Persistence\QueryResultInterface. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

145
            /** @scrutinizer ignore-call */ 
146
            $allResults = $result->fetchAll();

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
146
147
            if (count($allResults) > 0) {
148
                $menuArray[0]['ITEM_STATE'] = 'CURIFSUB';
149
                $menuArray[0]['_SUB_MENU'] = [];
150
                foreach ($allResults as $resArray) {
151
                    $entry = [
152
                        'label' => !empty($resArray['mets_label']) ? $resArray['mets_label'] : $resArray['title'],
153
                        'type' => $resArray['type'],
154
                        'volume' => $resArray['volume'],
155
                        'orderlabel' => $resArray['mets_orderlabel'],
156
                        'pagination' => '',
157
                        'targetUid' => $resArray['uid']
158
                    ];
159
                    $menuArray[0]['_SUB_MENU'][] = $this->getMenuEntry($entry, false);
160
                }
161
            }
162
        }
163
        return $menuArray;
164
    }
165
166
    /**
167
     * This builds a menu for list of 3D objects
168
     *
169
     * @access protected
170
     *
171
     * @param string $content: The PlugIn content
172
     * @param array $conf: The PlugIn configuration
173
     *
174
     * @return array HMENU array
175
     */
176
    protected function makeMenuFor3DObjects()
177
    {
178
        $menuArray = [];
179
180
        // Go through table of contents and create all menu entries.
181
        foreach ($this->document->getDoc()->tableOfContents as $entry) {
182
            $menuArray[] = $this->getMenuEntryWithImage($entry, true);
183
        }
184
        return $menuArray;
185
    }
186
187
    /**
188
     * This builds an array for one menu entry
189
     *
190
     * @access protected
191
     *
192
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
193
     * @param bool $recursive : Whether to include the child entries
194
     *
195
     * @return array HMENU array for menu entry
196
     */
197
    protected function getMenuEntry(array $entry, $recursive = false)
198
    {
199
        $entry = $this->resolveMenuEntry($entry);
200
201
        $entryArray = [];
202
        // Set "title", "volume", "type" and "pagination" from $entry array.
203
        $entryArray['title'] = !empty($entry['label']) ? $entry['label'] : $entry['orderlabel'];
204
        $entryArray['volume'] = $entry['volume'];
205
        $entryArray['orderlabel'] = $entry['orderlabel'];
206
        $entryArray['type'] = Helper::translate($entry['type'], 'tx_dlf_structures', $this->settings['storagePid']);
207
        $entryArray['pagination'] = htmlspecialchars($entry['pagination']);
208
        $entryArray['_OVERRIDE_HREF'] = '';
209
        $entryArray['doNotLinkIt'] = 1;
210
        $entryArray['ITEM_STATE'] = 'NO';
211
        // Build menu links based on the $entry['points'] array.
212
        if (
213
            !empty($entry['points'])
214
            && MathUtility::canBeInterpretedAsInteger($entry['points'])
215
        ) {
216
            $entryArray['page'] = $entry['points'];
217
218
            $entryArray['doNotLinkIt'] = 0;
219
            if ($this->settings['basketButton']) {
220
                $entryArray['basketButton'] = [
221
                    'logId' => $entry['id'],
222
                    'startpage' => $entry['points']
223
                ];
224
            }
225
        } elseif (
226
            !empty($entry['points'])
227
            && is_string($entry['points'])
228
        ) {
229
            $entryArray['id'] = $entry['points'];
230
            $entryArray['page'] = 1;
231
            $entryArray['doNotLinkIt'] = 0;
232
            if ($this->settings['basketButton']) {
233
                $entryArray['basketButton'] = [
234
                    'logId' => $entry['id'],
235
                    'startpage' => $entry['points']
236
                ];
237
            }
238
        } elseif (!empty($entry['targetUid'])) {
239
            $entryArray['id'] = $entry['targetUid'];
240
            $entryArray['page'] = 1;
241
            $entryArray['doNotLinkIt'] = 0;
242
            if ($this->settings['basketButton']) {
243
                $entryArray['basketButton'] = [
244
                    'logId' => $entry['id'],
245
                    'startpage' => $entry['targetUid']
246
                ];
247
            }
248
        }
249
        // Set "ITEM_STATE" to "CUR" if this entry points to current page.
250
        if (in_array($entry['id'], $this->activeEntries)) {
251
            $entryArray['ITEM_STATE'] = 'CUR';
252
        }
253
        // Build sub-menu if available and called recursively.
254
        if (
255
            $recursive === true
256
            && !empty($entry['children'])
257
        ) {
258
            // Build sub-menu only if one of the following conditions apply:
259
            // 1. Current menu node is in rootline
260
            // 2. Current menu node points to another file
261
            // 3. Current menu node has no corresponding images
262
            if (
263
                $entryArray['ITEM_STATE'] == 'CUR'
264
                || is_string($entry['points'])
265
                || empty($this->document->getDoc()->smLinks['l2p'][$entry['id']])
266
            ) {
267
                $entryArray['_SUB_MENU'] = [];
268
                foreach ($entry['children'] as $child) {
269
                    // Set "ITEM_STATE" to "ACT" if this entry points to current page and has sub-entries pointing to the same page.
270
                    if (in_array($child['id'], $this->activeEntries)) {
271
                        $entryArray['ITEM_STATE'] = 'ACT';
272
                    }
273
                    $entryArray['_SUB_MENU'][] = $this->getMenuEntry($child, true);
274
                }
275
            }
276
            // Append "IFSUB" to "ITEM_STATE" if this entry has sub-entries.
277
            $entryArray['ITEM_STATE'] = ($entryArray['ITEM_STATE'] == 'NO' ? 'IFSUB' : $entryArray['ITEM_STATE'] . 'IFSUB');
278
        }
279
        return $entryArray;
280
    }
281
282
    /**
283
     * If $entry references an external METS file (as mptr),
284
     * try to resolve its database UID and return an updated $entry.
285
     *
286
     * This is so that when linking from a child document back to its parent,
287
     * that link is via UID, so that subsequently the parent's TOC is built from database.
288
     *
289
     * @param array $entry
290
     * @return array
291
     */
292
    protected function resolveMenuEntry($entry)
293
    {
294
        // If the menu entry points to the parent document,
295
        // resolve to the parent UID set on indexation.
296
        $doc = $this->document->getDoc();
297
        if (
298
            $doc instanceof MetsDocument
299
            && $entry['points'] === $doc->parentHref
300
            && !empty($this->document->getPartof())
301
        ) {
302
            unset($entry['points']);
303
            $entry['targetUid'] = $this->document->getPartof();
304
        }
305
306
        return $entry;
307
    }
308
309
    /**
310
     * This builds an array for one 3D menu entry
311
     *
312
     * @access protected
313
     *
314
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
315
     * @param bool $recursive : Whether to include the child entries
316
     *
317
     * @return array HMENU array for 3D menu entry
318
     */
319
    protected function getMenuEntryWithImage(array $entry, $recursive = false)
320
    {
321
        $entryArray = [];
322
323
        // don't filter if the entry type is collection
324
        if ($entry['type'] != 'collection') {
325
            if (!$this->isFound($entry)) {
326
                return $entryArray;
327
            }
328
        }
329
330
        // Set "title", "volume", "type" and "pagination" from $entry array.
331
        $entryArray['title'] = !empty($entry['label']) ? $entry['label'] : $entry['orderlabel'];
332
        $entryArray['orderlabel'] = $entry['orderlabel'];
333
        $entryArray['type'] = Helper::translate($entry['type'], 'tx_dlf_structures', $this->settings['storagePid']);
334
        $entryArray['pagination'] = htmlspecialchars($entry['pagination']);
335
        $entryArray['doNotLinkIt'] = 1;
336
        $entryArray['ITEM_STATE'] = 'HEADER';
337
338
        if ($entry['children'] === null) {
339
            $entryArray['description'] = $entry['description'];
340
            $id = $this->document->getDoc()->smLinks['l2p'][$entry['id']][0];
341
            $entryArray['image'] = $this->document->getDoc()->getFileLocation($this->document->getDoc()->physicalStructureInfo[$id]['files']['THUMBS']);
342
            $entryArray['doNotLinkIt'] = 0;
343
            // index.php?tx_dlf%5Bid%5D=http%3A%2F%2Flink_to_METS_file.xml
344
            $entryArray['urlId'] = GeneralUtility::_GET('id');
345
            $entryArray['urlXml'] = $entry['points'];
346
            $entryArray['ITEM_STATE'] = 'ITEM';
347
348
            $this->addAuthorToAutocomplete($entryArray['author']);
349
            $this->addTitleToAutocomplete($entryArray['title']);
350
        }
351
352
        // Build sub-menu if available and called recursively.
353
        if (
354
            $recursive == true
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
355
            && !empty($entry['children'])
356
        ) {
357
            // Build sub-menu only if one of the following conditions apply:
358
            // 1. Current menu node points to another file
359
            // 2. Current menu node has no corresponding images
360
            if (
361
                is_string($entry['points'])
362
                || empty($this->document->getDoc()->smLinks['l2p'][$entry['id']])
363
            ) {
364
                $entryArray['_SUB_MENU'] = [];
365
                foreach ($entry['children'] as $child) {
366
                    $menuEntry = $this->getMenuEntryWithImage($child);
367
                    if (!empty($menuEntry)) {
368
                        $entryArray['_SUB_MENU'][] = $menuEntry;
369
                    }
370
                }
371
            }
372
        }
373
        return $entryArray;
374
    }
375
376
    /**
377
     * Check or possible combinations of requested params.
378
     *
379
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
380
     *
381
     * @return bool true if found, false otherwise
382
     */
383
    private function isFound($entry) {
384
        if (!empty($this->requestData['title'] && !empty($this->requestData['types']) && !empty($this->requestData['author']))) {
385
            return $this->isTitleFound($entry) && $this->isTypeFound($entry) && $this->isAuthorFound($entry);
386
        } else if (!empty($this->requestData['title']) && !empty($this->requestData['author'])) {
387
            return $this->isTitleFound($entry) && $this->isAuthorFound($entry);
388
        } else if (!empty($this->requestData['title']) && !empty($this->requestData['types'])) {
389
            return $this->isTitleFound($entry) && $this->isTypeFound($entry);
390
        } else if (!empty($this->requestData['author']) && !empty($this->requestData['types'])) {
391
            return $this->isAuthorFound($entry) && $this->isTypeFound($entry);
392
        } else if (!empty($this->requestData['title'])) {
393
            return $this->isTitleFound($entry);
394
        } else if (!empty($this->requestData['types'])) {
395
            return $this->isTypeFound($entry);
396
        } else if (!empty($this->requestData['author'])) {
397
            return $this->isAuthorFound($entry);
398
        } else {
399
            // no parameters so entry is matching
400
            return true;
401
        }
402
    }
403
404
    /**
405
     * Check if author is found.
406
     *
407
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
408
     *
409
     * @return bool true if found, false otherwise
410
     */
411
    private function isAuthorFound($entry) {
412
        $value = strtolower($entry['author']);
413
        $author = strtolower($this->requestData['author']);
414
        return str_contains($value, $author);
415
    }
416
417
    /**
418
     * Check if title is found.
419
     *
420
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
421
     *
422
     * @return bool true if found, false otherwise
423
     */
424
    private function isTitleFound($entry) {
425
        $value = strtolower($entry['label']);
426
        $title = strtolower($this->requestData['title']);
427
        return str_contains($value, $title);
428
    }
429
430
    /**
431
     * Check if type is found.
432
     *
433
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
434
     *
435
     * @return bool true if found, false otherwise
436
     */
437
    private function isTypeFound($entry) {
438
        return str_contains($entry['identifier'], $this->requestData['types']);
439
    }
440
441
    /**
442
     * Add author to the authors autocomplete array.
443
     *
444
     * @param string $author : author to be inserted to the authors autocomplete array
445
     *
446
     * @return void
447
     */
448
    private function addAuthorToAutocomplete($author) {
449
        if ($author != NULL && !(in_array($author, $this->authors))) {
450
            // additional check if actually not more than 1 author is included
451
            if (strpos($author, ',') !== false) {
452
                $authors = explode(",", $author);
453
                foreach ($authors as $value) {
454
                    if (!(in_array(trim($value), $this->authors))) {
455
                        $this->authors[] = trim($value);
456
                    }
457
                }
458
            } else {
459
                $this->authors[] = $author;
460
            }
461
        }
462
    }
463
464
    /**
465
     * Add title to the titles autocomplete array.
466
     *
467
     * @param string $title : title to be inserted to the titles autocomplete array
468
     *
469
     * @return void
470
     */
471
    private function addTitleToAutocomplete($title) {
472
        if (!(in_array($title, $this->titles)) && $title != NULL) {
473
            $this->titles[] = $title;
474
        }
475
    }
476
477
    /**
478
     * Get all types.
479
     *
480
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
481
     *
482
     * @return array of object types
483
     */
484
    private function getTypes($entry) {
485
        $types = [];
486
        $index = 0;
487
488
        if (!empty($entry[0]['children'])) {
489
            foreach ($entry[0]['children'] as $child) {
490
                $type = $this->getType($child);
491
                if (!(in_array($type, $types)) && $type != NULL) {
492
                    $types[$index] = $type;
493
                    $index++;
494
                }
495
            }
496
        }
497
498
        return $types;
499
    }
500
501
    /**
502
     * Get single type for given entry.
503
     *
504
     * @param array $entry : The entry's array from \Kitodo\Dlf\Common\Doc->getLogicalStructure
505
     *
506
     * @return string type name without number
507
     */
508
    private function getType($entry) {
509
        $type = $entry['identifier'];
510
        if (!empty($type)) {
511
            return strtok($type, ',');
512
        }
513
        return $type;
514
    }
515
}
516