UrlAliasGenerator::doGenerate() - Code Metrics - Inspection of "EZP-31644: [CR] Fixed serialization of Compound Si..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — EZP-31644 ( 2e0a1e...93bb44 )

unknown

created 2020-05-21 14:13 UTC

UrlAliasGenerator::doGenerate() C

↳ Parent: UrlAliasGenerator

Complexity

Conditions	13
Paths	80

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
nc	80
nop	2
dl	0
loc	54
rs	6.6166
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

/**
 * File containing the UrlAliasGenerator class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\MVC\Symfony\Routing\Generator;

use eZ\Publish\API\Repository\Repository;
use eZ\Publish\Core\MVC\ConfigResolverInterface;
use eZ\Publish\Core\MVC\Symfony\Routing\Generator;
use Symfony\Component\Routing\RouterInterface;

/**
 * URL generator for UrlAlias based links.
 *
 * @see \eZ\Publish\Core\MVC\Symfony\Routing\UrlAliasRouter
 */
class UrlAliasGenerator extends Generator
{
    const INTERNAL_LOCATION_ROUTE = '_ezpublishLocation';
    const INTERNAL_CONTENT_VIEW_ROUTE = '_ez_content_view';

    /**
     * @var \eZ\Publish\Core\Repository\Repository
     */
    private $repository;

    /**
     * The default router (that works with declared routes).
     *
     * @var \Symfony\Component\Routing\RouterInterface
     */
    private $defaultRouter;

    /**
     * @var int
     */
    private $rootLocationId;

    /**
     * @var array
     */
    private $excludedUriPrefixes = [];

    /**
     * @var array
     */
    private $pathPrefixMap = [];

    /**
     * @var \eZ\Publish\Core\MVC\ConfigResolverInterface
     */
    private $configResolver;

    /**
     * Array of characters that are potentially unsafe for output for (x)html, json, etc,
     * and respective url-encoded value.
     *
     * @var array
     */
    private $unsafeCharMap;

    public function __construct(Repository $repository, RouterInterface $defaultRouter, ConfigResolverInterface $configResolver, array $unsafeCharMap = [])
    {
        $this->repository = $repository;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->defaultRouter = $defaultRouter;
        $this->configResolver = $configResolver;
        $this->unsafeCharMap = $unsafeCharMap;
    }

    /**
     * Generates the URL from $urlResource and $parameters.
     * Entries in $parameters will be added in the query string.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     * @param array $parameters
     *
     * @return string
     */
    public function doGenerate($location, array $parameters)
    {
        $urlAliasService = $this->repository->getURLAliasService();

        $siteaccess = null;
        if (isset($parameters['siteaccess'])) {
            $siteaccess = $parameters['siteaccess'];
            unset($parameters['siteaccess']);
        }

        if ($siteaccess) {
            // We generate for a different SiteAccess, so potentially in a different language.
            $languages = $this->configResolver->getParameter('languages', null, $siteaccess);
            $urlAliases = $urlAliasService->listLocationAliases($location, false, null, null, $languages);
            // Use the target SiteAccess root location
            $rootLocationId = $this->configResolver->getParameter('content.tree_root.location_id', null, $siteaccess);
        } else {
            $languages = null;
            $urlAliases = $urlAliasService->listLocationAliases($location, false);
            $rootLocationId = $this->rootLocationId;
        }

        $queryString = '';
        unset($parameters['language'], $parameters['contentId']);
        if (!empty($parameters)) {
            $queryString = '?' . http_build_query($parameters, '', '&');
        }

        if (!empty($urlAliases)) {
            $path = $urlAliases[0]->path;
            // Remove rootLocation's prefix if needed.
            if ($rootLocationId !== null) {
                $pathPrefix = $this->getPathPrefixByRootLocationId($rootLocationId, $languages, $siteaccess);
                // "/" cannot be considered as a path prefix since it's root, so we ignore it.
                if ($pathPrefix !== '/' && ($path === $pathPrefix || mb_stripos($path, $pathPrefix . '/') === 0)) {
                    $path = mb_substr($path, mb_strlen($pathPrefix));
                } elseif ($pathPrefix !== '/' && !$this->isUriPrefixExcluded($path) && $this->logger !== null) {
                    // Location path is outside configured content tree and doesn't have an excluded prefix.
                    // This is most likely an error (from content edition or link generation logic).
                    $this->logger->warning("Generating a link to a location outside root content tree: '$path' is outside tree starting to location #$rootLocationId");
                }
            }
        } else {
            $path = $this->defaultRouter->generate(
                self::INTERNAL_CONTENT_VIEW_ROUTE,
                ['contentId' => $location->contentId, 'locationId' => $location->id]
            );
        }

        $path = $path ?: '/';

        // replace potentially unsafe characters with url-encoded counterpart
        return strtr($path . $queryString, $this->unsafeCharMap);
    }

    /**
     * Injects current root locationId that will be used for link generation.
     *
     * @param int $rootLocationId
     */
    public function setRootLocationId($rootLocationId)
    {
        $this->rootLocationId = $rootLocationId;
    }

    /**
     * @param array $excludedUriPrefixes
     */
    public function setExcludedUriPrefixes(array $excludedUriPrefixes)
    {
        $this->excludedUriPrefixes = $excludedUriPrefixes;
    }

    /**
     * Returns path corresponding to $rootLocationId.
     *
     * @param int $rootLocationId
     * @param array $languages
     * @param string $siteaccess
     *
     * @return string
     */
    public function getPathPrefixByRootLocationId($rootLocationId, $languages = null, $siteaccess = null)
    {
        if (!$rootLocationId) {
            return '';
        }

        if (!isset($this->pathPrefixMap[$siteaccess])) {
            $this->pathPrefixMap[$siteaccess] = [];
        }

        if (!isset($this->pathPrefixMap[$siteaccess][$rootLocationId])) {
            $this->pathPrefixMap[$siteaccess][$rootLocationId] = $this->repository
                ->getURLAliasService()
                ->reverseLookup(
                    $this->loadLocation($rootLocationId),
                    null,
                    false,
                    $languages
                )
                ->path;
        }

        return $this->pathPrefixMap[$siteaccess][$rootLocationId];
    }

    /**
     * Checks if passed URI has an excluded prefix, when a root location is defined.
     *
     * @param string $uri
     *
     * @return bool
     */
    public function isUriPrefixExcluded($uri)
    {
        foreach ($this->excludedUriPrefixes as $excludedPrefix) {
            $excludedPrefix = '/' . trim($excludedPrefix, '/');
            if (mb_stripos($uri, $excludedPrefix) === 0) {
                return true;
            }
        }

        return false;
    }

    /**
     * Loads a location by its locationId, regardless to user limitations since the router is invoked BEFORE security (no user authenticated yet).
     * Not to be used for link generation.
     *
     * @param int $locationId
     *
     * @return \eZ\Publish\Core\Repository\Values\Content\Location
     */
    public function loadLocation($locationId)
    {
        return $this->repository->sudo(
            function (Repository $repository) use ($locationId) {
                /* @var $repository \eZ\Publish\Core\Repository\Repository */
                return $repository->getLocationService()->loadLocation($locationId);
            }
        );
    }
}


1			<?php
2
3			/**
4			* File containing the UrlAliasGenerator class.
5			*
6			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7			* @license For full copyright and license information view LICENSE file distributed with this source code.
8			*/
9			namespace eZ\Publish\Core\MVC\Symfony\Routing\Generator;
10
11			use eZ\Publish\API\Repository\Repository;
12			use eZ\Publish\Core\MVC\ConfigResolverInterface;
13			use eZ\Publish\Core\MVC\Symfony\Routing\Generator;
14			use Symfony\Component\Routing\RouterInterface;
15
16			/**
17			* URL generator for UrlAlias based links.
18			*
19			* @see \eZ\Publish\Core\MVC\Symfony\Routing\UrlAliasRouter
20			*/
21			class UrlAliasGenerator extends Generator
22			{
23			const INTERNAL_LOCATION_ROUTE = '_ezpublishLocation';
24			const INTERNAL_CONTENT_VIEW_ROUTE = '_ez_content_view';
25
26			/**
27			* @var \eZ\Publish\Core\Repository\Repository
28			*/
29			private $repository;
30
31			/**
32			* The default router (that works with declared routes).
33			*
34			* @var \Symfony\Component\Routing\RouterInterface
35			*/
36			private $defaultRouter;
37
38			/**
39			* @var int
40			*/
41			private $rootLocationId;
42
43			/**
44			* @var array
45			*/
46			private $excludedUriPrefixes = [];
47
48			/**
49			* @var array
50			*/
51			private $pathPrefixMap = [];
52
53			/**
54			* @var \eZ\Publish\Core\MVC\ConfigResolverInterface
55			*/
56			private $configResolver;
57
58			/**
59			* Array of characters that are potentially unsafe for output for (x)html, json, etc,
60			* and respective url-encoded value.
61			*
62			* @var array
63			*/
64			private $unsafeCharMap;
65
66			public function __construct(Repository $repository, RouterInterface $defaultRouter, ConfigResolverInterface $configResolver, array $unsafeCharMap = [])
67			{
68			$this->repository = $repository;
			0 ignored issues – show Documentation Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report `$repository` is of type `object<eZ\Publish\API\Repository\Repository>`, but the property `$repository` was declared to be of type `object<eZ\Publish\Core\Repository\Repository>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
69			$this->defaultRouter = $defaultRouter;
70			$this->configResolver = $configResolver;
71			$this->unsafeCharMap = $unsafeCharMap;
72			}
73
74			/**
75			* Generates the URL from $urlResource and $parameters.
76			* Entries in $parameters will be added in the query string.
77			*
78			* @param \eZ\Publish\API\Repository\Values\Content\Location $location
79			* @param array $parameters
80			*
81			* @return string
82			*/
83			public function doGenerate($location, array $parameters)
84			{
85			$urlAliasService = $this->repository->getURLAliasService();
86
87			$siteaccess = null;
88			if (isset($parameters['siteaccess'])) {
89			$siteaccess = $parameters['siteaccess'];
90			unset($parameters['siteaccess']);
91			}
92
93			if ($siteaccess) {
94			// We generate for a different SiteAccess, so potentially in a different language.
95			$languages = $this->configResolver->getParameter('languages', null, $siteaccess);
96			$urlAliases = $urlAliasService->listLocationAliases($location, false, null, null, $languages);
97			// Use the target SiteAccess root location
98			$rootLocationId = $this->configResolver->getParameter('content.tree_root.location_id', null, $siteaccess);
99			} else {
100			$languages = null;
101			$urlAliases = $urlAliasService->listLocationAliases($location, false);
102			$rootLocationId = $this->rootLocationId;
103			}
104
105			$queryString = '';
106			unset($parameters['language'], $parameters['contentId']);
107			if (!empty($parameters)) {
108			$queryString = '?' . http_build_query($parameters, '', '&');
109			}
110
111			if (!empty($urlAliases)) {
112			$path = $urlAliases[0]->path;
113			// Remove rootLocation's prefix if needed.
114			if ($rootLocationId !== null) {
115			$pathPrefix = $this->getPathPrefixByRootLocationId($rootLocationId, $languages, $siteaccess);
116			// "/" cannot be considered as a path prefix since it's root, so we ignore it.
117			if ($pathPrefix !== '/' && ($path === $pathPrefix \|\| mb_stripos($path, $pathPrefix . '/') === 0)) {
118			$path = mb_substr($path, mb_strlen($pathPrefix));
119			} elseif ($pathPrefix !== '/' && !$this->isUriPrefixExcluded($path) && $this->logger !== null) {
120			// Location path is outside configured content tree and doesn't have an excluded prefix.
121			// This is most likely an error (from content edition or link generation logic).
122			$this->logger->warning("Generating a link to a location outside root content tree: '$path' is outside tree starting to location #$rootLocationId");
123			}
124			}
125			} else {
126			$path = $this->defaultRouter->generate(
127			self::INTERNAL_CONTENT_VIEW_ROUTE,
128			['contentId' => $location->contentId, 'locationId' => $location->id]
129			);
130			}
131
132			$path = $path ?: '/';
133
134			// replace potentially unsafe characters with url-encoded counterpart
135			return strtr($path . $queryString, $this->unsafeCharMap);
136			}
137
138			/**
139			* Injects current root locationId that will be used for link generation.
140			*
141			* @param int $rootLocationId
142			*/
143			public function setRootLocationId($rootLocationId)
144			{
145			$this->rootLocationId = $rootLocationId;
146			}
147
148			/**
149			* @param array $excludedUriPrefixes
150			*/
151			public function setExcludedUriPrefixes(array $excludedUriPrefixes)
152			{
153			$this->excludedUriPrefixes = $excludedUriPrefixes;
154			}
155
156			/**
157			* Returns path corresponding to $rootLocationId.
158			*
159			* @param int $rootLocationId
160			* @param array $languages
161			* @param string $siteaccess
162			*
163			* @return string
164			*/
165			public function getPathPrefixByRootLocationId($rootLocationId, $languages = null, $siteaccess = null)
166			{
167			if (!$rootLocationId) {
168			return '';
169			}
170
171			if (!isset($this->pathPrefixMap[$siteaccess])) {
172			$this->pathPrefixMap[$siteaccess] = [];
173			}
174
175			if (!isset($this->pathPrefixMap[$siteaccess][$rootLocationId])) {
176			$this->pathPrefixMap[$siteaccess][$rootLocationId] = $this->repository
177			->getURLAliasService()
178			->reverseLookup(
179			$this->loadLocation($rootLocationId),
180			null,
181			false,
182			$languages
183			)
184			->path;
185			}
186
187			return $this->pathPrefixMap[$siteaccess][$rootLocationId];
188			}
189
190			/**
191			* Checks if passed URI has an excluded prefix, when a root location is defined.
192			*
193			* @param string $uri
194			*
195			* @return bool
196			*/
197			public function isUriPrefixExcluded($uri)
198			{
199			foreach ($this->excludedUriPrefixes as $excludedPrefix) {
200			$excludedPrefix = '/' . trim($excludedPrefix, '/');
201			if (mb_stripos($uri, $excludedPrefix) === 0) {
202			return true;
203			}
204			}
205
206			return false;
207			}
208
209			/**
210			* Loads a location by its locationId, regardless to user limitations since the router is invoked BEFORE security (no user authenticated yet).
211			* Not to be used for link generation.
212			*
213			* @param int $locationId
214			*
215			* @return \eZ\Publish\Core\Repository\Values\Content\Location
216			*/
217			public function loadLocation($locationId)
218			{
219			return $this->repository->sudo(
220			function (Repository $repository) use ($locationId) {
221			/* @var $repository \eZ\Publish\Core\Repository\Repository */
222			return $repository->getLocationService()->loadLocation($locationId);
223			}
224			);
225			}
226			}
227

ezsystems / ezpublish-kernel

Push — EZP-31644 ( 2e0a1e...93bb44 )

UrlAliasGenerator::doGenerate() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like