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 (#715)
by Alexander
04:02 queued 01:34
created

MetadataController::printMetadata()   F

Complexity

Conditions 54
Paths 120

Size

Total Lines 177
Code Lines 116

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 54
eloc 116
c 1
b 0
f 0
nc 120
nop 2
dl 0
loc 177
rs 3.1999

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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\Document;
15
use Kitodo\Dlf\Common\Helper;
16
use Kitodo\Dlf\Common\IiifManifest;
17
use Kitodo\Dlf\Domain\Model\Collection;
18
use Kitodo\Dlf\Domain\Model\Metadata;
19
use TYPO3\CMS\Core\Utility\GeneralUtility;
20
use Ubl\Iiif\Context\IRI;
21
use Kitodo\Dlf\Domain\Repository\CollectionRepository;
22
use Kitodo\Dlf\Domain\Repository\MetadataRepository;
23
24
class MetadataController extends AbstractController
25
{
26
    public $prefixId = 'tx_dlf';
27
28
    protected $metadataRepository;
29
30
    protected $collectionRepository;
31
32
    /**
33
     * @param CollectionRepository $collectionRepository
34
     */
35
    public function injectCollectionRepository(CollectionRepository $collectionRepository)
36
    {
37
        $this->collectionRepository = $collectionRepository;
38
    }
39
40
    /**
41
     * @param MetadataRepository $metadataRepository
42
     */
43
    public function injectMetadataRepository(MetadataRepository $metadataRepository)
44
    {
45
        $this->metadataRepository = $metadataRepository;
46
    }
47
48
    /**
49
     * @return string|void
50
     */
51
    public function mainAction()
52
    {
53
        $requestData = GeneralUtility::_GPmerged('tx_dlf');
54
        unset($requestData['__referrer'], $requestData['__trustedProperties']);
55
56
        $this->cObj = $this->configurationManager->getContentObject();
0 ignored issues
show
Bug Best Practice introduced by
The property cObj does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.
Loading history...
57
58
        // Load current document.
59
        $this->loadDocument($requestData);
60
        if ($this->doc === null) {
61
            // Quit without doing anything if required variables are not set.
62
            return '';
63
        } else {
64
            // Set default values if not set.
65
            if (!isset($this->settings['rootline'])) {
66
                $this->settings['rootline'] = 0;
67
            }
68
            if (!isset($this->settings['originalIiifMetadata'])) {
69
                $this->settings['originalIiifMetadata'] = 0;
70
            }
71
            if (!isset($this->settings['displayIiifDescription'])) {
72
                $this->settings['displayIiifDescription'] = 1;
73
            }
74
            if (!isset($this->settings['displayIiifRights'])) {
75
                $this->settings['displayIiifRights'] = 1;
76
            }
77
            if (!isset($this->settings['displayIiifLinks'])) {
78
                $this->settings['displayIiifLinks'] = 1;
79
            }
80
        }
81
        $useOriginalIiifManifestMetadata = $this->settings['originalIiifMetadata'] == 1 && $this->doc instanceof IiifManifest;
82
        $metadata = [];
83
        if ($this->settings['rootline'] < 2) {
84
            // Get current structure's @ID.
85
            $ids = [];
86
            if (!empty($this->doc->physicalStructure[$requestData['page']]) && !empty($this->doc->smLinks['p2l'][$this->doc->physicalStructure[$requestData['page']]])) {
87
                foreach ($this->doc->smLinks['p2l'][$this->doc->physicalStructure[$requestData['page']]] as $logId) {
88
                    $count = $this->doc->getStructureDepth($logId);
89
                    $ids[$count][] = $logId;
90
                }
91
            }
92
            ksort($ids);
93
            reset($ids);
94
            // Check if we should display all metadata up to the root.
95
            if ($this->settings['rootline'] == 1) {
96
                foreach ($ids as $id) {
97
                    foreach ($id as $sid) {
98
                        if ($useOriginalIiifManifestMetadata) {
99
                            $data = $this->doc->getManifestMetadata($sid, $this->settings['pages']);
100
                        } else {
101
                            $data = $this->doc->getMetadata($sid, $this->settings['pages']);
102
                        }
103
                        if (!empty($data)) {
104
                            $data['_id'] = $sid;
105
                            $metadata[] = $data;
106
                        }
107
                    }
108
                }
109
            } else {
110
                $id = array_pop($ids);
111
                if (is_array($id)) {
112
                    foreach ($id as $sid) {
113
                        if ($useOriginalIiifManifestMetadata) {
114
                            $data = $this->doc->getManifestMetadata($sid, $this->settings['pages']);
115
                        } else {
116
                            $data = $this->doc->getMetadata($sid, $this->settings['pages']);
117
                        }
118
                        if (!empty($data)) {
119
                            $data['_id'] = $sid;
120
                            $metadata[] = $data;
121
                        }
122
                    }
123
                }
124
            }
125
        }
126
        // Get titledata?
127
        if (empty($metadata) || ($this->settings['rootline'] == 1 && $metadata[0]['_id'] != $this->doc->toplevelId)) {
128
            $data = $useOriginalIiifManifestMetadata ? $this->doc->getManifestMetadata($this->doc->toplevelId, $this->settings['pages']) : $this->doc->getTitleData($this->settings['pages']);
0 ignored issues
show
Bug introduced by
The method getManifestMetadata() does not exist on Kitodo\Dlf\Common\Document. It seems like you code against a sub-type of Kitodo\Dlf\Common\Document such as Kitodo\Dlf\Common\IiifManifest. ( Ignorable by Annotation )

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

128
            $data = $useOriginalIiifManifestMetadata ? $this->doc->/** @scrutinizer ignore-call */ getManifestMetadata($this->doc->toplevelId, $this->settings['pages']) : $this->doc->getTitleData($this->settings['pages']);
Loading history...
129
            $data['_id'] = $this->doc->toplevelId;
130
            array_unshift($metadata, $data);
131
        }
132
        if (empty($metadata)) {
133
            $this->logger->warning('No metadata found for document with UID ' . $this->doc->uid);
1 ignored issue
show
Bug introduced by
The method warning() does not exist on null. ( Ignorable by Annotation )

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

133
            $this->logger->/** @scrutinizer ignore-call */ 
134
                           warning('No metadata found for document with UID ' . $this->doc->uid);

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...
134
            return '';
135
        }
136
        ksort($metadata);
137
        // Get hook objects.
138
        $this->hookObjects = Helper::getHookObjects($this->scriptRelPath);
0 ignored issues
show
Bug Best Practice introduced by
The property hookObjects does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.
Loading history...
Bug Best Practice introduced by
The property scriptRelPath does not exist on Kitodo\Dlf\Controller\MetadataController. Did you maybe forget to declare it?
Loading history...
139
        // Hook for getting a customized title bar (requested by SBB).
140
        foreach ($this->hookObjects as $hookObj) {
141
            if (method_exists($hookObj, 'main_customizeTitleBarGetCustomTemplate')) {
142
                $hookObj->main_customizeTitleBarGetCustomTemplate($this, $metadata);
143
            }
144
        }
145
        $this->printMetadata($metadata, $useOriginalIiifManifestMetadata);
146
    }
147
148
    /**
149
     * Prepares the metadata array for output
150
     *
151
     * @access protected
152
     *
153
     * @param array $metadataArray: The metadata array
154
     * @param bool $useOriginalIiifManifestMetadata: Output IIIF metadata as simple key/value pairs?
155
     *
156
     * @return string The metadata array ready for output
157
     */
158
    protected function printMetadata(array $metadataArray, $useOriginalIiifManifestMetadata = false)
159
    {
160
        // Save original data array.
161
        $cObjData = $this->cObj->data;
162
        // Get list of metadata to show.
163
        $metaList = [];
164
        if ($useOriginalIiifManifestMetadata) {
165
            if ($this->settings['iiifMetadataWrap']) {
166
                $iiifwrap = $this->parseTS($this->settings['iiifMetadataWrap']);
167
            } else {
168
                $iiifwrap['key.']['wrap'] = '<dt>|</dt>';
169
                $iiifwrap['value.']['required'] = 1;
170
                $iiifwrap['value.']['wrap'] = '<dd>|</dd>';
171
            }
172
            $iiifLink = [];
173
            $iiifLink['key.']['wrap'] = '<dt>|</dt>';
174
            $iiifLink['value.']['required'] = 1;
175
            $iiifLink['value.']['setContentToCurrent'] = 1;
176
            $iiifLink['value.']['typolink.']['parameter.']['current'] = 1;
177
            $iiifLink['value.']['typolink.']['forceAbsoluteUrl'] = !empty($this->settings['forceAbsoluteUrl']) ? 1 : 0;
178
            $iiifLink['value.']['typolink.']['forceAbsoluteUrl.']['scheme'] = !empty($this->settings['forceAbsoluteUrl']) && !empty($this->settings['forceAbsoluteUrlHttps']) ? 'https' : 'http';
179
            $iiifLink['value.']['wrap'] = '<dd>|</dd>';
180
            foreach ($metadataArray as $metadata) {
181
                foreach ($metadata as $key => $group) {
182
                    $markerArray['METADATA'] = '<span class="tx-dlf-metadata-group">' . $this->pi_getLL($key) . '</span>';
183
                    // Reset content object's data array.
184
                    $this->cObj->data = $cObjData;
185
                    if (!is_array($group)) {
186
                        if ($key == '_id') {
187
                            continue;
188
                        }
189
                        $this->cObj->data[$key] = $group;
190
                        if (
191
                            IRI::isAbsoluteIri($this->cObj->data[$key])
192
                            && (($scheme = (new IRI($this->cObj->data[$key]))->getScheme()) == 'http' || $scheme == 'https')
193
                        ) {
194
                            $field = $this->cObj->stdWrap('', $iiifLink['key.']);
195
                            $field .= $this->cObj->stdWrap($this->cObj->data[$key], $iiifLink['value.']);
196
                        } else {
197
                            $field = $this->cObj->stdWrap('', $iiifwrap['key.']);
198
                            $field .= $this->cObj->stdWrap($this->cObj->data[$key], $iiifwrap['value.']);
199
                        }
200
                        $markerArray['METADATA'] .= $this->cObj->stdWrap($field, $iiifwrap['all.']);
201
                    } else {
202
                        // Load all the metadata values into the content object's data array.
203
                        foreach ($group as $label => $value) {
204
                            if ($label == '_id') {
205
                                continue;
206
                            }
207
                            if (is_array($value)) {
208
                                $this->cObj->data[$label] = implode($this->settings['separator'], $value);
209
                            } else {
210
                                $this->cObj->data[$label] = $value;
211
                            }
212
                            if (IRI::isAbsoluteIri($this->cObj->data[$label]) && (($scheme = (new IRI($this->cObj->data[$label]))->getScheme()) == 'http' || $scheme == 'https')) {
213
                                $nolabel = $this->cObj->data[$label] == $label;
214
                                $field = $this->cObj->stdWrap($nolabel ? '' : htmlspecialchars($label), $iiifLink['key.']);
215
                                $field .= $this->cObj->stdWrap($this->cObj->data[$label], $iiifLink['value.']);
216
                            } else {
217
                                $field = $this->cObj->stdWrap(htmlspecialchars($label), $iiifwrap['key.']);
218
                                $field .= $this->cObj->stdWrap($this->cObj->data[$label], $iiifwrap['value.']);
219
                            }
220
                            $markerArray['METADATA'] .= $this->cObj->stdWrap($field, $iiifwrap['all.']);
221
                        }
222
                    }
223
                }
224
            }
225
        } else {
226
227
            $metadataResult = $this->metadataRepository->findAll();
228
229
            /** @var Metadata $metadata */
230
            foreach ($metadataResult as $metadata) {
231
                if ($metadata) {
232
                    if ($this->settings['showFull'] || $metadata->getIsListed()) {
233
                        $metaList[$metadata->getIndexName()] = [
234
                            'wrap' => $metadata->getWrap(),
235
                            'label' => Helper::translate($metadata->getIndexName(), 'tx_dlf_metadata', $this->settings['pages'])
236
                        ];
237
                    }
238
                }
239
            }
240
241
            $collections = $this->collectionRepository->getCollectionForMetadata($this->settings['pages']);
242
243
            /** @var Collection $collection */
244
            foreach ($collections as $collection) {
245
                $collList[] = $collection->getIndexName();
246
            }
247
248
            // Parse the metadata arrays.
249
            foreach ($metadataArray as $metadata) {
250
                $markerArray['METADATA'] = '';
251
                // Reset content object's data array.
252
                $this->cObj->data = $cObjData;
253
                // Load all the metadata values into the content object's data array.
254
                foreach ($metadata as $index_name => $value) {
255
                    if (is_array($value)) {
256
                        $this->cObj->data[$index_name] = implode($this->settings['separator'], $value);
257
                    } else {
258
                        $this->cObj->data[$index_name] = $value;
259
                    }
260
                }
261
                // Process each metadate.
262
                foreach ($metaList as $index_name => $metaConf) {
263
                    $parsedValue = '';
264
                    $fieldwrap = $this->parseTS($metaConf['wrap']);
265
                    do {
266
                        $value = @array_shift($metadata[$index_name]);
267
                        if ($index_name == 'title') {
268
                            // Get title of parent document if needed.
269
                            if (empty($value) && $this->settings['getTitle'] && $this->doc->parentId) {
270
                                $superiorTitle = Document::getTitle($this->doc->parentId, true);
271
                                if (!empty($superiorTitle)) {
272
                                    $value = '[' . $superiorTitle . ']';
273
                                }
274
                            }
275
                            if (!empty($value)) {
276
                                $value = htmlspecialchars($value);
277
                                // Link title to pageview.
278
                                if ($this->settings['linkTitle'] && $metadata['_id']) {
279
                                    $details = $this->doc->getLogicalStructure($metadata['_id']);
280
                                    $uri = $this->uriBuilder->reset()
281
                                        ->setArguments([
282
                                            $this->prefixId => [
283
                                                'id' => $this->doc->uid,
284
                                                'page' => (!empty($details['points']) ? intval($details['points']) : 1)
285
                                            ]
286
                                        ])
287
                                        ->setTargetPageUid($this->settings['targetPid'])
288
                                        ->build();
289
                                    $value = '<a href="' . $uri . '">' . $value . '</a>';
290
                                }
291
                            }
292
                        } elseif ($index_name == 'owner' && !empty($value)) {
293
                            // Translate name of holding library.
294
                            $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_libraries', $this->settings['pages']));
295
                        } elseif ($index_name == 'type' && !empty($value)) {
296
                            // Translate document type.
297
                            $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_structures', $this->settings['pages']));
298
                        } elseif ($index_name == 'collection' && !empty($value)) {
299
                            // Check if collections isn't hidden.
300
                            if (in_array($value, $collList)) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $collList seems to be defined by a foreach iteration on line 244. Are you sure the iterator is never empty, otherwise this variable is not defined?
Loading history...
301
                                // Translate collection.
302
                                $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_collections', $this->settings['pages']));
303
                            } else {
304
                                $value = '';
305
                            }
306
                        } elseif ($index_name == 'language' && !empty($value)) {
307
                            // Translate ISO 639 language code.
308
                            $value = htmlspecialchars(Helper::getLanguageName($value));
309
                        } elseif (!empty($value)) {
310
                            // Sanitize value for output.
311
                            $value = htmlspecialchars($value);
312
                        }
313
                        // Hook for getting a customized value (requested by SBB).
314
                        foreach ($this->hookObjects as $hookObj) {
315
                            if (method_exists($hookObj, 'printMetadata_customizeMetadata')) {
316
                                $hookObj->printMetadata_customizeMetadata($value);
317
                            }
318
                        }
319
                        // $value might be empty for aggregation metadata fields including other "hidden" fields.
320
                        $value = $this->cObj->stdWrap($value, $fieldwrap['value.']);
321
                        if (!empty($value)) {
322
                            $parsedValue .= $value;
323
                        }
324
                    } while (is_array($metadata[$index_name]) && count($metadata[$index_name]) > 0);
325
326
                    if (!empty($parsedValue)) {
327
                        $field = $this->cObj->stdWrap(htmlspecialchars($metaConf['label']), $fieldwrap['key.']);
328
                        $field .= $parsedValue;
329
                        $markerArray['METADATA'] .= $this->cObj->stdWrap($field, $fieldwrap['all.']);
330
                    }
331
                }
332
            }
333
        }
334
        $this->view->assign('metadata', $markerArray['METADATA']);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $markerArray does not seem to be defined for all execution paths leading up to this point.
Loading history...
335
    }
336
337
    // TODO: Needs to be placed in an abstract class (like before in AbstractPlugin)
338
    /**
339
     * Parses a string into a Typoscript array
340
     *
341
     * @access protected
342
     *
343
     * @param string $string: The string to parse
344
     *
345
     * @return array The resulting typoscript array
346
     */
347
    protected function parseTS($string = '')
348
    {
349
        $parser = GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::class);
350
        $parser->parse($string);
351
        return $parser->setup;
352
    }
353
354
    protected function pi_getLL($label)
355
    {
356
        return $GLOBALS['TSFE']->sL('LLL:EXT:dlf/Resources/Private/Language/Metadata.xml:' . $label);
357
    }
358
359
}
360