GetFileController::attachmentAction() - Code Metrics - Inspection of "Cmr 136" - kitodo/kitodo-publication - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#108)

by Ralf

created 2019-03-04 13:32 UTC

GetFileController::attachmentAction() F

↳ Parent: GetFileController

Complexity

Conditions	28
Paths	13

Size

Total Lines	209
Code Lines	113

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	28
eloc	113
nc	13
nop	0
dl	0
loc	209
rs	3.3333
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
namespace EWW\Dpf\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

/**
 * API to return METS dissemination and Attachments from Fedora.
 * Also renders METS XML for preview. Structure of the URIs totally
 * depend on proper RealURL configuration.
 *
 * Example:
 *
 * 1. METS from Fedora
 *   http://localhost/api/qucosa:1234/mets/
 *
 *   This always returns METS which is supplemented with additional information.
 *   The embedded MODS record is not the original MODS as it is stored in the
 *   repository datastream.
 *
 * 2. Attachment from Fedora
 *   http://localhost/api/qucosa:1234/attachment/ATT-0/
 *
 * 3. METS from Kitodo.Publication (this extension)
 *   http://localhost/api/3/preview/
 *
 * 4. DataCite from Kitodo.Publication (this extension)
 *
 * @author    Alexander Bigga <[email protected]>
 * @author    Ralf Claussnitzer <[email protected]>
 * @author    Florian Rügamer <[email protected]>
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;
filter:
    dependency_paths: ["lib/*"]

/**
 * GetFileController
 */
class GetFileController extends \EWW\Dpf\Controller\AbstractController
{

    /**
     * documentRepository
     *
     * @var \EWW\Dpf\Domain\Repository\DocumentRepository
     * @inject
     */
    protected $documentRepository;

    /**
     * clientConfigurationManager
     *
     * @var \EWW\Dpf\Configuration\ClientConfigurationManager
     * @inject
     */
    protected $clientConfigurationManager;

    public function attachmentAction()
    {

        $piVars = GeneralUtility::_GP('tx_dpf'); // get GET params from powermail

        $fedoraHost = $this->clientConfigurationManager->getFedoraHost();

        if ($this->isForbidden($piVars['action'])) {
            $this->response->setStatus(403);
            return 'Forbidden';
        }

        switch ($piVars['action']) {
            case 'mets':
                $path = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'/methods/qucosa:SDef/getMETSDissemination?supplement=yes';
                break;

            case 'preview':

                $document = $this->documentRepository->findByUid($piVars['qid']);

                if ($document) {

                    $metsXml = $this->buildMetsXml($document);
                    $this->response->setHeader('Content-Type', 'text/xml; charset=UTF-8');
                    return $metsXml;

                } else {

                    $this->response->setStatus(404);
                    return 'No such document';

                }

            case 'attachment':

                $qid = $piVars['qid'];

                $attachment = $piVars['attachment'];

                if (is_numeric($piVars['qid'])) {

                    // qid is local uid
                    $document = $this->documentRepository->findByUid($piVars['qid']);

                    $files = $document->getCurrentFileData();

                    foreach ($files['download'] as $id => $file) {

                        if ($file['id'] == $attachment) {

                            $path = $file['path'];

                            $contentType = $file['type'];

                            break;

                        }
                    }

                } else {

                    $path = rtrim('http://' . $fedoraHost, "/") . '/fedora/objects/' . $qid . '/datastreams/' . $attachment . '/content';

                }

                if (empty($path)) {
                    $this->response->setStatus(404);
                    return 'No file found';
                }

                break;

            case 'dataCite':

                $qid = $piVars['qid'];
                $source = explode(':', $qid);
                if($source[0] == 'qucosa') {

                    $path = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'/methods/qucosa:SDef/getMETSDissemination?supplement=yes';
                    $metsXml = str_replace('&', '&amp;', file_get_contents($path));
                    $dataCiteXml = \EWW\Dpf\Helper\DataCiteXml::convertFromMetsXml($metsXml);

                } elseif($document = $this->documentRepository->findByUid($piVars['qid'])) {

                    $metsXml = str_replace('&', '&amp;', $this->buildMetsXml($document));
                    $dataCiteXml = \EWW\Dpf\Helper\DataCiteXml::convertFromMetsXml($metsXml);

                } else {

                    $this->response->setStatus(404);
                    return 'No such document';

                }
                $dom = new \DOMDocument('1.0', 'UTF-8');
                $dom->loadXML($dataCiteXml);
                $title = $dom->getElementsByTagName('title')[0];

                $this->response->setHeader('Content-Disposition', 'attachment; filename="' . self::sanitizeFilename($title->nodeValue) . '.DataCite.xml"');
                $this->response->setHeader('Content-Type', 'text/xml; charset=UTF-8');
                return $dataCiteXml;

                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'zip':
                // FIXME Service locations on Fedora host are hard coded
                $metsUrl = rtrim('http://' . $fedoraHost,"/") . '/mets?pid=' . $piVars['qid'];
                $path = rtrim('http://' . $fedoraHost,"/") . '/zip?metsurl=' . rawurlencode($metsUrl);
                break;

            default:

                $this->response->setStatus(404);

                return 'No such action';
        }

        // stop here, if inactive Fedora objects are not allowed to be disseminated

        // allow dissemination if a request parameter 'deliverInactive' has the secret
        // TYPOScript configuration value 'deliverInactiveSecretKey'

        $restrictToActiveDocuments = TRUE;
        $deliverInactiveSecretKey = $this->settings['deliverInactiveSecretKey'];

        if ($deliverInactiveSecretKey == $piVars['deliverInactive']) {
            $restrictToActiveDocuments = FALSE;
        }

        if (TRUE === $restrictToActiveDocuments) {
            // if restriction applies, check object state before dissemination
            $objectProfileURI = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'?format=XML';
            $objectProfileXML = file_get_contents($objectProfileURI);
            if (FALSE !== $objectProfileXML) {
                $objectProfileDOM = new \DOMDocument('1.0', 'UTF-8');
                if (TRUE === $objectProfileDOM->loadXML($objectProfileXML)) {
                    $objectState = $objectProfileDOM->getElementsByTagName('objState')[0];
                    if ('I' === $objectState->nodeValue) {
                        $this->response->setStatus(403);
                        return 'Forbidden';
                    }
                    if ('D' === $objectState->nodeValue) {
                        $this->response->setStatus(404);
                        return 'Not Found';
                    }
                }
            } else {
                $this->response->setStatus(500);
                return 'Internal Server Error';
            }
        }

        // get remote header and set it before passtrough
        $headers = get_headers($path);


        if (FALSE === $headers) {
            $this->response->setStatus(500);
            return 'Error while fetching headers';
        }

        $contentDispFlag = false;
        $contentTypeFlag = false;

        foreach ($headers as $value) {

            if (FALSE !== stripos($value, 'Content-Disposition')) {
                header($value);
                $contentDispFlag = true;
                continue;
            }

            if (FALSE !== stripos($value, 'Content-Type')) {
                header($value);
                $contentTypeFlag = true;
                continue;
            }

            if (FALSE !== stripos($value, 'Content-Length')) {
                header($value);
                continue;
            }
        }

        if (!$contentDispFlag) {
            header('Content-Disposition: attachment');
        }

        if (!$contentTypeFlag) {
            header('Content-Type: ' . $contentType);

        }

        if ($stream = fopen($path, 'r')) {

            // close active session if any
            session_write_close();

            // stop output buffering
            ob_end_clean();

            fpassthru($stream);

            fclose($stream);

            // Hard exit PHP script to avoid sending TYPO3 framework HTTP artifacts
            exit;


        } else {
            $this->response->setStatus(500);
            return 'Error while opening stream';
        }

    }

    private static function sanitizeFilename($filename)
    {
        // remove anything which isn't a word, whitespace, number or any of the following caracters -_~,;[]().
        $filename = mb_ereg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $filename);
        // turn diacritical characters to ASCII
        setlocale(LC_ALL, 'en_US.utf8');
        $filename = iconv('utf-8', 'us-ascii//TRANSLIT', trim($filename));
        // replace whitespaces with underscore
        $filename = preg_replace('/\s+/', '_', $filename);

        return $filename;
    }

    private function buildMetsXml($document)
    {

        $exporter = new \EWW\Dpf\Services\MetsExporter();
        $fileData = $document->getCurrentFileData();
        $exporter->setFileData($fileData);
        $exporter->setMods($document->getXmlData());
        $exporter->setSlubInfo($document->getSlubInfoData());

        if (empty($document->getObjectIdentifier())) {

            $exporter->setObjId($document->getUid());

        } else {

            $exporter->setObjId($document->getObjectIdentifier());

        }

        $exporter->buildMets();
        $metsXml = $exporter->getMetsData();

        return $metsXml;
    }

    private function isForbidden($action)
    {
        $allowed =
            array_key_exists('allowedActions', $this->settings)
            && is_array($this->settings['allowedActions'])
            && in_array($action, $this->settings['allowedActions']);
        return !$allowed;
    }
}



1			<?php
2			namespace EWW\Dpf\Controller;
3
4			/*
5			* This file is part of the TYPO3 CMS project.
6			*
7			* It is free software; you can redistribute it and/or modify it under
8			* the terms of the GNU General Public License, either version 2
9			* of the License, or any later version.
10			*
11			* For the full copyright and license information, please read the
12			* LICENSE.txt file that was distributed with this source code.
13			*
14			* The TYPO3 project - inspiring people to share!
15			*/
16
17			/**
18			* API to return METS dissemination and Attachments from Fedora.
19			* Also renders METS XML for preview. Structure of the URIs totally
20			* depend on proper RealURL configuration.
21			*
22			* Example:
23			*
24			* 1. METS from Fedora
25			* http://localhost/api/qucosa:1234/mets/
26			*
27			* This always returns METS which is supplemented with additional information.
28			* The embedded MODS record is not the original MODS as it is stored in the
29			* repository datastream.
30			*
31			* 2. Attachment from Fedora
32			* http://localhost/api/qucosa:1234/attachment/ATT-0/
33			*
34			* 3. METS from Kitodo.Publication (this extension)
35			* http://localhost/api/3/preview/
36			*
37			* 4. DataCite from Kitodo.Publication (this extension)
38			*
39			* @author Alexander Bigga <[email protected]>
40			* @author Ralf Claussnitzer <[email protected]>
41			* @author Florian Rügamer <[email protected]>
42			*/
43
44			use TYPO3\CMS\Core\Utility\GeneralUtility;
			0 ignored issues – show Bug introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Core\Utility\GeneralUtility` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
45
46			/**
47			* GetFileController
48			*/
49			class GetFileController extends \EWW\Dpf\Controller\AbstractController
50			{
51
52			/**
53			* documentRepository
54			*
55			* @var \EWW\Dpf\Domain\Repository\DocumentRepository
56			* @inject
57			*/
58			protected $documentRepository;
59
60			/**
61			* clientConfigurationManager
62			*
63			* @var \EWW\Dpf\Configuration\ClientConfigurationManager
64			* @inject
65			*/
66			protected $clientConfigurationManager;
67
68			public function attachmentAction()
69			{
70
71			$piVars = GeneralUtility::_GP('tx_dpf'); // get GET params from powermail
72
73			$fedoraHost = $this->clientConfigurationManager->getFedoraHost();
74
75			if ($this->isForbidden($piVars['action'])) {
76			$this->response->setStatus(403);
77			return 'Forbidden';
78			}
79
80			switch ($piVars['action']) {
81			case 'mets':
82			$path = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'/methods/qucosa:SDef/getMETSDissemination?supplement=yes';
83			break;
84
85			case 'preview':
86
87			$document = $this->documentRepository->findByUid($piVars['qid']);
88
89			if ($document) {
90
91			$metsXml = $this->buildMetsXml($document);
92			$this->response->setHeader('Content-Type', 'text/xml; charset=UTF-8');
93			return $metsXml;
94
95			} else {
96
97			$this->response->setStatus(404);
98			return 'No such document';
99
100			}
101
102			case 'attachment':
103
104			$qid = $piVars['qid'];
105
106			$attachment = $piVars['attachment'];
107
108			if (is_numeric($piVars['qid'])) {
109
110			// qid is local uid
111			$document = $this->documentRepository->findByUid($piVars['qid']);
112
113			$files = $document->getCurrentFileData();
114
115			foreach ($files['download'] as $id => $file) {
116
117			if ($file['id'] == $attachment) {
118
119			$path = $file['path'];
120
121			$contentType = $file['type'];
122
123			break;
124
125			}
126			}
127
128			} else {
129
130			$path = rtrim('http://' . $fedoraHost, "/") . '/fedora/objects/' . $qid . '/datastreams/' . $attachment . '/content';
131
132			}
133
134			if (empty($path)) {
135			$this->response->setStatus(404);
136			return 'No file found';
137			}
138
139			break;
140
141			case 'dataCite':
142
143			$qid = $piVars['qid'];
144			$source = explode(':', $qid);
145			if($source[0] == 'qucosa') {
146
147			$path = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'/methods/qucosa:SDef/getMETSDissemination?supplement=yes';
148			$metsXml = str_replace('&', '&', file_get_contents($path));
149			$dataCiteXml = \EWW\Dpf\Helper\DataCiteXml::convertFromMetsXml($metsXml);
150
151			} elseif($document = $this->documentRepository->findByUid($piVars['qid'])) {
152
153			$metsXml = str_replace('&', '&', $this->buildMetsXml($document));
154			$dataCiteXml = \EWW\Dpf\Helper\DataCiteXml::convertFromMetsXml($metsXml);
155
156			} else {
157
158			$this->response->setStatus(404);
159			return 'No such document';
160
161			}
162			$dom = new \DOMDocument('1.0', 'UTF-8');
163			$dom->loadXML($dataCiteXml);
164			$title = $dom->getElementsByTagName('title')[0];
165
166			$this->response->setHeader('Content-Disposition', 'attachment; filename="' . self::sanitizeFilename($title->nodeValue) . '.DataCite.xml"');
167			$this->response->setHeader('Content-Type', 'text/xml; charset=UTF-8');
168			return $dataCiteXml;
169
170			break;
			0 ignored issues – show Unused Code introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
171
172			case 'zip':
173			// FIXME Service locations on Fedora host are hard coded
174			$metsUrl = rtrim('http://' . $fedoraHost,"/") . '/mets?pid=' . $piVars['qid'];
175			$path = rtrim('http://' . $fedoraHost,"/") . '/zip?metsurl=' . rawurlencode($metsUrl);
176			break;
177
178			default:
179
180			$this->response->setStatus(404);
181
182			return 'No such action';
183			}
184
185			// stop here, if inactive Fedora objects are not allowed to be disseminated
186
187			// allow dissemination if a request parameter 'deliverInactive' has the secret
188			// TYPOScript configuration value 'deliverInactiveSecretKey'
189
190			$restrictToActiveDocuments = TRUE;
191			$deliverInactiveSecretKey = $this->settings['deliverInactiveSecretKey'];
192
193			if ($deliverInactiveSecretKey == $piVars['deliverInactive']) {
194			$restrictToActiveDocuments = FALSE;
195			}
196
197			if (TRUE === $restrictToActiveDocuments) {
198			// if restriction applies, check object state before dissemination
199			$objectProfileURI = rtrim('http://' . $fedoraHost,"/").'/fedora/objects/'.$piVars['qid'].'?format=XML';
200			$objectProfileXML = file_get_contents($objectProfileURI);
201			if (FALSE !== $objectProfileXML) {
202			$objectProfileDOM = new \DOMDocument('1.0', 'UTF-8');
203			if (TRUE === $objectProfileDOM->loadXML($objectProfileXML)) {
204			$objectState = $objectProfileDOM->getElementsByTagName('objState')[0];
205			if ('I' === $objectState->nodeValue) {
206			$this->response->setStatus(403);
207			return 'Forbidden';
208			}
209			if ('D' === $objectState->nodeValue) {
210			$this->response->setStatus(404);
211			return 'Not Found';
212			}
213			}
214			} else {
215			$this->response->setStatus(500);
216			return 'Internal Server Error';
217			}
218			}
219
220			// get remote header and set it before passtrough
221			$headers = get_headers($path);
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report The variable `$path` does not seem to be defined for all execution paths leading up to this point. Loading history...
222
223			if (FALSE === $headers) {
224			$this->response->setStatus(500);
225			return 'Error while fetching headers';
226			}
227
228			$contentDispFlag = false;
229			$contentTypeFlag = false;
230
231			foreach ($headers as $value) {
232
233			if (FALSE !== stripos($value, 'Content-Disposition')) {
234			header($value);
235			$contentDispFlag = true;
236			continue;
237			}
238
239			if (FALSE !== stripos($value, 'Content-Type')) {
240			header($value);
241			$contentTypeFlag = true;
242			continue;
243			}
244
245			if (FALSE !== stripos($value, 'Content-Length')) {
246			header($value);
247			continue;
248			}
249			}
250
251			if (!$contentDispFlag) {
252			header('Content-Disposition: attachment');
253			}
254
255			if (!$contentTypeFlag) {
256			header('Content-Type: ' . $contentType);
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report The variable `$contentType` does not seem to be defined for all execution paths leading up to this point. Loading history...
257			}
258
259			if ($stream = fopen($path, 'r')) {
260
261			// close active session if any
262			session_write_close();
263
264			// stop output buffering
265			ob_end_clean();
266
267			fpassthru($stream);
268
269			fclose($stream);
270
271			// Hard exit PHP script to avoid sending TYPO3 framework HTTP artifacts
272			exit;
			0 ignored issues – show Best Practice introduced 2017-12-20 21:05 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
273
274			} else {
275			$this->response->setStatus(500);
276			return 'Error while opening stream';
277			}
278
279			}
280
281			private static function sanitizeFilename($filename)
282			{
283			// remove anything which isn't a word, whitespace, number or any of the following caracters -_~,;[]().
284			$filename = mb_ereg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $filename);
285			// turn diacritical characters to ASCII
286			setlocale(LC_ALL, 'en_US.utf8');
287			$filename = iconv('utf-8', 'us-ascii//TRANSLIT', trim($filename));
288			// replace whitespaces with underscore
289			$filename = preg_replace('/\s+/', '_', $filename);
290
291			return $filename;
292			}
293
294			private function buildMetsXml($document)
295			{
296
297			$exporter = new \EWW\Dpf\Services\MetsExporter();
298			$fileData = $document->getCurrentFileData();
299			$exporter->setFileData($fileData);
300			$exporter->setMods($document->getXmlData());
301			$exporter->setSlubInfo($document->getSlubInfoData());
302
303			if (empty($document->getObjectIdentifier())) {
304
305			$exporter->setObjId($document->getUid());
306
307			} else {
308
309			$exporter->setObjId($document->getObjectIdentifier());
310
311			}
312
313			$exporter->buildMets();
314			$metsXml = $exporter->getMetsData();
315
316			return $metsXml;
317			}
318
319			private function isForbidden($action)
320			{
321			$allowed =
322			array_key_exists('allowedActions', $this->settings)
323			&& is_array($this->settings['allowedActions'])
324			&& in_array($action, $this->settings['allowedActions']);
325			return !$allowed;
326			}
327			}
328
329

kitodo / kitodo-publication

Pull Request — master (#108)

GetFileController::attachmentAction() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like