Issues in BreadcrumbsBuilder.php (master) - Issues in master - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Issues (655)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Admin/BreadcrumbsBuilder.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Admin;

use Knp\Menu\ItemInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Stateless breadcrumbs builder (each method needs an Admin object).
 *
 * @author Grégoire Paris <[email protected]>
 */
final class BreadcrumbsBuilder implements BreadcrumbsBuilderInterface
{
    /**
     * @var string[]
     */
    private $config = [];

    /**
     * @param string[] $config
     */
    public function __construct(array $config = [])
    {
        $resolver = new OptionsResolver();
        $this->configureOptions($resolver);

        $this->config = $resolver->resolve($config);
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'child_admin_route' => 'edit',
        ]);
    }

    public function getBreadcrumbs(AdminInterface $admin, string $action): iterable
    {
        $breadcrumbs = [];
        if ($admin->isChild()) {
            return $this->getBreadcrumbs($admin->getParent(), $action);
        }

        $menu = $this->buildBreadcrumbs($admin, $action);

        do {
            $breadcrumbs[] = $menu;
        } while ($menu = $menu->getParent());

        $breadcrumbs = array_reverse($breadcrumbs);
        array_shift($breadcrumbs);

        return $breadcrumbs;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Builds breadcrumbs for $action, starting from $menu.
     *
     * Note: the method will be called by the top admin instance (parent => child)
     */
    public function buildBreadcrumbs(
        AdminInterface $admin,
        string $action,
        ?ItemInterface $menu = null
    ): ItemInterface {
        if (!$menu) {
            $menu = $admin->getMenuFactory()->createItem('root');

            $menu = $menu->addChild(
                'link_breadcrumb_dashboard',
                [
                    'uri' => $admin->getRouteGenerator()->generate('sonata_admin_dashboard'),
                    'extras' => ['translation_domain' => 'SonataAdminBundle'],
                ]
            );
        }

        $menu = $this->createMenuItem(
            $admin,
            $menu,
            sprintf('%s_list', $admin->getClassnameLabel()),
            $admin->getTranslationDomain(),
            [
                'uri' => $admin->hasRoute('list') && $admin->hasAccess('list') ?
                $admin->generateUrl('list') :
                null,
            ]
        );

        $childAdmin = $admin->getCurrentChildAdmin();

        if ($childAdmin && $admin->hasSubject()) {
            $id = $admin->getRequest()->get($admin->getIdParameter());

            $menu = $menu->addChild(
                $admin->toString($admin->getSubject()),
                [
                    'uri' => $admin->hasRoute($this->config['child_admin_route']) && $admin->hasAccess($this->config['child_admin_route'], $admin->getSubject()) ?
                    $admin->generateUrl($this->config['child_admin_route'], ['id' => $id]) :
                    null,
                    'extras' => [
                        'translation_domain' => false,
                    ],
                ]
            );

            $menu->setExtra('safe_label', false);

            return $this->buildBreadcrumbs($childAdmin, $action, $menu);
        }

        if ('list' === $action) {
            $menu->setUri(null);

            return $menu;
        }
        if ('create' !== $action && $admin->hasSubject()) {
            return $menu->addChild($admin->toString($admin->getSubject()), [
                'extras' => [
                    'translation_domain' => false,
                ],
            ]);
        }

        return $this->createMenuItem(
            $admin,
            $menu,
            sprintf('%s_%s', $admin->getClassnameLabel(), $action),
            $admin->getTranslationDomain()
        );
    }

    /**
     * Creates a new menu item from a simple name. The name is normalized and
     * translated with the specified translation domain.
     *
     * @param AdminInterface $admin             used for translation
     * @param ItemInterface  $menu              will be modified and returned
     * @param string         $name              the source of the final label
     * @param string         $translationDomain for label translation
     * @param array          $options           menu item options
     */
    private function createMenuItem(
        AdminInterface $admin,
        ItemInterface $menu,
        string $name,
        ?string $translationDomain = null,
        array $options = []
    ): ItemInterface {
        $options = array_merge([
            'extras' => [
                'translation_domain' => $translationDomain,
            ],
        ], $options);

        return $menu->addChild(
            $admin->getLabelTranslatorStrategy()->getLabel(
                $name,
                'breadcrumb',
                'link'
            ),
            $options
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\AdminBundle\Admin;
15
16			use Knp\Menu\ItemInterface;
17			use Symfony\Component\OptionsResolver\OptionsResolver;
18
19			/**
20			* Stateless breadcrumbs builder (each method needs an Admin object).
21			*
22			* @author Grégoire Paris <[email protected]>
23			*/
24			final class BreadcrumbsBuilder implements BreadcrumbsBuilderInterface
25			{
26			/**
27			* @var string[]
28			*/
29			private $config = [];
30
31			/**
32			* @param string[] $config
33			*/
34			public function __construct(array $config = [])
35			{
36			$resolver = new OptionsResolver();
37			$this->configureOptions($resolver);
38
39			$this->config = $resolver->resolve($config);
40			}
41
42			public function configureOptions(OptionsResolver $resolver): void
43			{
44			$resolver->setDefaults([
45			'child_admin_route' => 'edit',
46			]);
47			}
48
49			public function getBreadcrumbs(AdminInterface $admin, string $action): iterable
50			{
51			$breadcrumbs = [];
52			if ($admin->isChild()) {
53			return $this->getBreadcrumbs($admin->getParent(), $action);
54			}
55
56			$menu = $this->buildBreadcrumbs($admin, $action);
57
58			do {
59			$breadcrumbs[] = $menu;
60			} while ($menu = $menu->getParent());
61
62			$breadcrumbs = array_reverse($breadcrumbs);
63			array_shift($breadcrumbs);
64
65			return $breadcrumbs;
			0 ignored issues – show Bug Best Practice introduced 2020-03-30 01:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $breadcrumbs;` (`array`) is incompatible with the return type declared by the interface `Sonata\AdminBundle\Admin...terface::getBreadcrumbs` of type `Sonata\AdminBundle\Admin\iterable`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
66			}
67
68			/**
69			* Builds breadcrumbs for $action, starting from $menu.
70			*
71			* Note: the method will be called by the top admin instance (parent => child)
72			*/
73			public function buildBreadcrumbs(
74			AdminInterface $admin,
75			string $action,
76			?ItemInterface $menu = null
77			): ItemInterface {
78			if (!$menu) {
79			$menu = $admin->getMenuFactory()->createItem('root');
80
81			$menu = $menu->addChild(
82			'link_breadcrumb_dashboard',
83			[
84			'uri' => $admin->getRouteGenerator()->generate('sonata_admin_dashboard'),
85			'extras' => ['translation_domain' => 'SonataAdminBundle'],
86			]
87			);
88			}
89
90			$menu = $this->createMenuItem(
91			$admin,
92			$menu,
93			sprintf('%s_list', $admin->getClassnameLabel()),
94			$admin->getTranslationDomain(),
95			[
96			'uri' => $admin->hasRoute('list') && $admin->hasAccess('list') ?
97			$admin->generateUrl('list') :
98			null,
99			]
100			);
101
102			$childAdmin = $admin->getCurrentChildAdmin();
103
104			if ($childAdmin && $admin->hasSubject()) {
105			$id = $admin->getRequest()->get($admin->getIdParameter());
106
107			$menu = $menu->addChild(
108			$admin->toString($admin->getSubject()),
109			[
110			'uri' => $admin->hasRoute($this->config['child_admin_route']) && $admin->hasAccess($this->config['child_admin_route'], $admin->getSubject()) ?
111			$admin->generateUrl($this->config['child_admin_route'], ['id' => $id]) :
112			null,
113			'extras' => [
114			'translation_domain' => false,
115			],
116			]
117			);
118
119			$menu->setExtra('safe_label', false);
120
121			return $this->buildBreadcrumbs($childAdmin, $action, $menu);
122			}
123
124			if ('list' === $action) {
125			$menu->setUri(null);
126
127			return $menu;
128			}
129			if ('create' !== $action && $admin->hasSubject()) {
130			return $menu->addChild($admin->toString($admin->getSubject()), [
131			'extras' => [
132			'translation_domain' => false,
133			],
134			]);
135			}
136
137			return $this->createMenuItem(
138			$admin,
139			$menu,
140			sprintf('%s_%s', $admin->getClassnameLabel(), $action),
141			$admin->getTranslationDomain()
142			);
143			}
144
145			/**
146			* Creates a new menu item from a simple name. The name is normalized and
147			* translated with the specified translation domain.
148			*
149			* @param AdminInterface $admin used for translation
150			* @param ItemInterface $menu will be modified and returned
151			* @param string $name the source of the final label
152			* @param string $translationDomain for label translation
153			* @param array $options menu item options
154			*/
155			private function createMenuItem(
156			AdminInterface $admin,
157			ItemInterface $menu,
158			string $name,
159			?string $translationDomain = null,
160			array $options = []
161			): ItemInterface {
162			$options = array_merge([
163			'extras' => [
164			'translation_domain' => $translationDomain,
165			],
166			], $options);
167
168			return $menu->addChild(
169			$admin->getLabelTranslatorStrategy()->getLabel(
170			$name,
171			'breadcrumb',
172			'link'
173			),
174			$options
175			);
176			}
177			}
178

sonata-project / SonataAdminBundle

Issues (655)

Security Analysis not enabled

src/Admin/BreadcrumbsBuilder.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like