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(); |
|
|
|
|
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']); |
|
|
|
|
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); |
134
|
|
|
return ''; |
135
|
|
|
} |
136
|
|
|
ksort($metadata); |
137
|
|
|
// Get hook objects. |
138
|
|
|
$this->hookObjects = Helper::getHookObjects($this->scriptRelPath); |
|
|
|
|
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
|
|
|
if ($useOriginalIiifManifestMetadata) { |
161
|
|
|
$iiifData = []; |
162
|
|
|
foreach ($metadataArray as $metadata) { |
163
|
|
|
foreach ($metadata as $key => $group) { |
164
|
|
|
if ($key == '_id') { |
165
|
|
|
continue; |
166
|
|
|
} |
167
|
|
|
if (!is_array($group)) { |
168
|
|
|
if ( |
169
|
|
|
IRI::isAbsoluteIri($group) |
170
|
|
|
&& (($scheme = (new IRI($group))->getScheme()) == 'http' || $scheme == 'https') |
171
|
|
|
) { |
172
|
|
|
// Build link |
173
|
|
|
$iiifData[$key] = [ |
174
|
|
|
'label' => $key, |
175
|
|
|
'value' => $group, |
176
|
|
|
'buildUrl' => true |
177
|
|
|
]; |
178
|
|
|
} else { |
179
|
|
|
// Data output |
180
|
|
|
$iiifData[$key] = [ |
181
|
|
|
'label' => $key, |
182
|
|
|
'value' => $group, |
183
|
|
|
'buildUrl' => false |
184
|
|
|
]; |
185
|
|
|
} |
186
|
|
|
} else { |
187
|
|
|
foreach ($group as $label => $value) { |
188
|
|
|
if ($label == '_id') { |
189
|
|
|
continue; |
190
|
|
|
} |
191
|
|
|
if (is_array($value)) { |
192
|
|
|
$value = implode($this->settings['separator'], $value); |
193
|
|
|
} |
194
|
|
|
if (IRI::isAbsoluteIri($value) && (($scheme = (new IRI($value))->getScheme()) == 'http' || $scheme == 'https')) { |
195
|
|
|
$nolabel = $value == $label; |
196
|
|
|
$iiifData[$key]['data'][] = [ |
197
|
|
|
'label' => $nolabel ? '' : htmlspecialchars($label), |
198
|
|
|
'value' => $value, |
199
|
|
|
'buildUrl' => true |
200
|
|
|
]; |
201
|
|
|
} else { |
202
|
|
|
$iiifData[$key]['data'][] = [ |
203
|
|
|
'label' => htmlspecialchars($label), |
204
|
|
|
'value' => $value, |
205
|
|
|
'buildUrl' => false |
206
|
|
|
]; |
207
|
|
|
} |
208
|
|
|
} |
209
|
|
|
} |
210
|
|
|
$this->view->assign('useIiif', true); |
211
|
|
|
$this->view->assign('iiifData', $iiifData); |
212
|
|
|
} |
213
|
|
|
} |
214
|
|
|
} else { |
215
|
|
|
|
216
|
|
|
$metadataResult = $this->metadataRepository->findAll(); |
217
|
|
|
|
218
|
|
|
// Get collections to check if they are hidden |
219
|
|
|
$collections = $this->collectionRepository->getCollectionForMetadata($this->settings['pages']); |
220
|
|
|
|
221
|
|
|
$collList = []; |
222
|
|
|
/** @var Collection $collection */ |
223
|
|
|
foreach ($collections as $collection) { |
224
|
|
|
$collList[] = $collection->getIndexName(); |
225
|
|
|
} |
226
|
|
|
|
227
|
|
|
$buildUrl = []; |
228
|
|
|
$i = 0; |
229
|
|
|
foreach ($metadataArray as $metadataSection) { |
230
|
|
|
foreach ($metadataSection as $metadataName => $metadataValue) { |
231
|
|
|
if ($metadataName == 'title') { |
232
|
|
|
// Get title of parent document if needed. |
233
|
|
|
if (empty($metadataValue) && $this->settings['getTitle'] && $this->doc->parentId) { |
234
|
|
|
$superiorTitle = Document::getTitle($this->doc->parentId, true); |
235
|
|
|
if (!empty($superiorTitle)) { |
236
|
|
|
$metadataArray[$i][$metadataName] = ['[' . $superiorTitle . ']']; |
237
|
|
|
} |
238
|
|
|
} |
239
|
|
|
if (!empty($metadataValue)) { |
240
|
|
|
$metadataArray[$i][$metadataName][0] = htmlspecialchars($metadataArray[$i][$metadataName][0]); |
241
|
|
|
// Link title to pageview. |
242
|
|
|
if ($this->settings['linkTitle'] && $metadataSection['_id']) { |
243
|
|
|
$details = $this->doc->getLogicalStructure($metadataSection['_id']); |
244
|
|
|
$buildUrl[$i][$metadataName]['buildUrl'] = [ |
245
|
|
|
'id' => $this->doc->uid, |
246
|
|
|
'page' => (!empty($details['points']) ? intval($details['points']) : 1), |
247
|
|
|
'targetPid' => (!empty($this->settings['targetPid']) ? $this->settings['targetPid'] : 0) |
248
|
|
|
]; |
249
|
|
|
} |
250
|
|
|
} |
251
|
|
|
} elseif ($metadataName == 'owner' && !empty($metadataValue)) { |
252
|
|
|
// Translate name of holding library. |
253
|
|
|
$metadataArray[$i][$metadataName][0] = htmlspecialchars(Helper::translate($metadataArray[$i][$metadataName][0], 'tx_dlf_libraries', $this->settings['pages'])); |
254
|
|
|
} elseif ($metadataName == 'type' && !empty($metadataValue)) { |
255
|
|
|
// Translate document type. |
256
|
|
|
$metadataArray[$i][$metadataName][0] = htmlspecialchars(Helper::translate($metadataArray[$i][$metadataName][0], 'tx_dlf_structures', $this->settings['pages'])); |
257
|
|
|
} elseif ($metadataName == 'collection' && !empty($metadataValue)) { |
258
|
|
|
// Check if collections isn't hidden. |
259
|
|
|
$j = 0; |
260
|
|
|
foreach ($metadataValue as $metadataEntry) { |
261
|
|
|
if (in_array($metadataEntry, $collList)) { |
262
|
|
|
// Translate collection. |
263
|
|
|
$metadataArray[$i][$metadataName][$j] = htmlspecialchars(Helper::translate($metadataArray[$i][$metadataName][$j], 'tx_dlf_collections', $this->settings['pages'])); |
264
|
|
|
} else { |
265
|
|
|
$metadataArray[$i][$metadataName][$j] = ''; |
266
|
|
|
} |
267
|
|
|
$j++; |
268
|
|
|
} |
269
|
|
|
} elseif ($metadataName == 'language' && !empty($metadataValue)) { |
270
|
|
|
// Translate ISO 639 language code. |
271
|
|
|
$metadataArray[$i][$metadataName][0] = htmlspecialchars(Helper::getLanguageName($metadataArray[$i][$metadataName][0])); |
272
|
|
|
} elseif (!empty($metadataValue)) { |
273
|
|
|
// Sanitize value for output. |
274
|
|
|
$metadataArray[$i][$metadataName][0] = htmlspecialchars($metadataArray[$i][$metadataName][0]); |
275
|
|
|
} |
276
|
|
|
} |
277
|
|
|
$i++; |
278
|
|
|
} |
279
|
|
|
|
280
|
|
|
$this->view->assign('buildUrl', $buildUrl); |
281
|
|
|
$this->view->assign('documentMetadataSections', $metadataArray); |
282
|
|
|
$this->view->assign('configMetadata', $metadataResult); |
283
|
|
|
$this->view->assign('separator', $this->settings['separator']); |
284
|
|
|
|
285
|
|
|
} |
286
|
|
|
} |
287
|
|
|
} |
288
|
|
|
|