Issues in CKEditorRenderer.php - Fixed Issues - Inspection of "Cleanup (#154)" - FriendsOfSymfony/FOSCKEditorBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b28d44...6f2c13 )

by Marko

created 2018-10-04 20:49 UTC

src/Renderer/CKEditorRenderer.php (1 issue)

Severity

Unknown 1

<?php

/*
 * This file is part of the FOSCKEditor Bundle.
 *
 * (c) 2018 - present  Friends of Symfony
 * (c) 2009 - 2017     Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\CKEditorBundle\Renderer;

use FOS\CKEditorBundle\Builder\JsonBuilder;
use Symfony\Component\Asset\Packages;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Routing\RouterInterface;
use Twig\Environment;

/**
 * @author GeLo <[email protected]>
 */
final class CKEditorRenderer implements CKEditorRendererInterface
{
    /**
     * @var JsonBuilder
     */
    private $jsonBuilder;

    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @var Packages
     */
    private $assetsPackages;

    /**
     * @var Environment
     */
    private $twig;

    /**
     * @var RequestStack
     */
    private $requestStack;

    /**
     * @var null|string
     */
    private $locale;

    /**
     * @param JsonBuilder|ContainerInterface $containerOrJsonBuilder
     * @param RouterInterface                $router
     * @param Packages                       $packages
     * @param RequestStack                   $requestStack
     * @param Environment                    $twig
     * @param null|string                    $locale
     */
    public function __construct(
        $containerOrJsonBuilder,
        RouterInterface $router = null,
        Packages $packages = null,
        RequestStack $requestStack = null,
        Environment $twig = null,
        $locale = null
    ) {
        if ($containerOrJsonBuilder instanceof ContainerInterface) {
            @trigger_error(sprintf(
                'Passing a %s as %s first argument is deprecated since FOSCKEditor 1.0, and will be removed in 2.0.'
                .' Use %s instead.',
                ContainerInterface::class,
                __METHOD__,
                JsonBuilder::class
            ), E_USER_DEPRECATED);
            $jsonBuilder = $containerOrJsonBuilder->get('fos_ck_editor.renderer.json_builder');
            $router = $containerOrJsonBuilder->get('router');
            $packages = $containerOrJsonBuilder->get('assets.packages');
            $requestStack = $containerOrJsonBuilder->get('request_stack');
            $twig = $containerOrJsonBuilder->get('twig');
        } elseif ($containerOrJsonBuilder instanceof JsonBuilder) {

            $jsonBuilder = $containerOrJsonBuilder;
            if (null === $router) {
                throw new \InvalidArgumentException(sprintf(
                    '%s 2nd argument must not be null when using %s as first argument',
                    __METHOD__,
                    JsonBuilder::class
                ));
            } elseif (null === $packages) {
                throw new \InvalidArgumentException(sprintf(
                    '%s 3rd argument must not be null when using %s as first argument',
                    __METHOD__,
                    JsonBuilder::class
                ));
            } elseif (null === $requestStack) {
                throw new \InvalidArgumentException(sprintf(
                    '%s 4th argument must not be null when using %s as first argument',
                    __METHOD__,
                    JsonBuilder::class
                ));
            } elseif (null === $twig) {
                throw new \InvalidArgumentException(sprintf(
                    '%s 5th argument must not be null when using %s as first argument',
                    __METHOD__,
                    JsonBuilder::class
                ));
            }
        } else {
            throw new \InvalidArgumentException(sprintf(
                '%s first argument must be an instance of %s or %s (%s given).',
                __METHOD__,
                ContainerInterface::class,
                JsonBuilder::class,
                is_object($containerOrJsonBuilder)
                    ? get_class($containerOrJsonBuilder)
                    : gettype($containerOrJsonBuilder)
            ));
        }

        $this->jsonBuilder = $jsonBuilder;
        $this->router = $router;
        $this->assetsPackages = $packages;
        $this->twig = $twig;
        $this->requestStack = $requestStack;
        $this->locale = $locale;
    }

    /**
     * {@inheritdoc}
     */
    public function renderBasePath($basePath)
    {
        return $this->fixPath($basePath);
    }

    /**
     * {@inheritdoc}
     */
    public function renderJsPath($jsPath)
    {
        return $this->fixPath($jsPath);
    }

    /**
     * {@inheritdoc}
     */
    public function renderWidget($id, array $config, array $options = [])
    {
        $config = $this->fixConfigLanguage($config);
        $config = $this->fixConfigContentsCss($config);
        $config = $this->fixConfigFilebrowsers(
            $config,
            isset($options['filebrowsers']) ? $options['filebrowsers'] : []
        );

        $autoInline = isset($options['auto_inline']) && !$options['auto_inline']
            ? 'CKEDITOR.disableAutoInline = true;'."\n"
            : null;

        $builder = $this->jsonBuilder->reset()->setValues($config);
        $this->fixConfigEscapedValues($builder, $config);

        $widget = sprintf(
            'CKEDITOR.%s("%s", %s);',
            isset($options['inline']) && $options['inline'] ? 'inline' : 'replace',
            $id,
            $this->fixConfigConstants($builder->build())
        );

        if (isset($options['input_sync']) && $options['input_sync']) {
            $variable = 'fos_ckeditor_'.$id;
            $widget = 'var '.$variable.' = '.$widget."\n";

            return $autoInline.$widget.$variable.'.on(\'change\', function() { '.$variable.'.updateElement(); });';
        }

        return $autoInline.$widget;
    }

    /**
     * {@inheritdoc}
     */
    public function renderDestroy($id)
    {
        return sprintf(
            'if (CKEDITOR.instances["%1$s"]) { '.
            'CKEDITOR.instances["%1$s"].destroy(true); '.
            'delete CKEDITOR.instances["%1$s"]; '.
            '}',
            $id
        );
    }

    /**
     * {@inheritdoc}
     */
    public function renderPlugin($name, array $plugin)
    {
        return sprintf(
            'CKEDITOR.plugins.addExternal("%s", "%s", "%s");',
            $name,
            $this->fixPath($plugin['path']),
            $plugin['filename']
        );
    }

    /**
     * {@inheritdoc}
     */
    public function renderStylesSet($name, array $stylesSet)
    {
        return sprintf(
            'if (CKEDITOR.stylesSet.get("%1$s") === null) { '.
            'CKEDITOR.stylesSet.add("%1$s", %2$s); '.
            '}',
            $name,
            $this->jsonBuilder->reset()->setValues($stylesSet)->build()
        );
    }

    /**
     * {@inheritdoc}
     */
    public function renderTemplate($name, array $template)
    {
        if (isset($template['imagesPath'])) {
            $template['imagesPath'] = $this->fixPath($template['imagesPath']);
        }

        if (isset($template['templates'])) {
            foreach ($template['templates'] as &$rawTemplate) {
                if (isset($rawTemplate['template'])) {
                    $rawTemplate['html'] = $this->twig->render(
                        $rawTemplate['template'],
                        isset($rawTemplate['template_parameters']) ? $rawTemplate['template_parameters'] : []
                    );
                }

                unset($rawTemplate['template'], $rawTemplate['template_parameters']);
            }
        }

        return sprintf(
            'CKEDITOR.addTemplates("%s", %s);',
            $name,
            $this->jsonBuilder->reset()->setValues($template)->build()
        );
    }

    /**
     * @param array $config
     *
     * @return array
     */
    private function fixConfigLanguage(array $config)
    {
        if (!isset($config['language']) && null !== ($language = $this->getLanguage())) {
            $config['language'] = $language;
        }

        if (isset($config['language'])) {
            $config['language'] = strtolower(str_replace('_', '-', $config['language']));
        }

        return $config;
    }

    /**
     * @param array $config
     *
     * @return array
     */
    private function fixConfigContentsCss(array $config)
    {
        if (isset($config['contentsCss'])) {
            $cssContents = (array) $config['contentsCss'];

            $config['contentsCss'] = [];
            foreach ($cssContents as $cssContent) {
                $config['contentsCss'][] = $this->fixPath($cssContent);
            }
        }

        return $config;
    }

    /**
     * @param array $config
     * @param array $filebrowsers
     *
     * @return array
     */
    private function fixConfigFilebrowsers(array $config, array $filebrowsers)
    {
        $filebrowsers = array_unique(array_merge([
            'Browse',
            'FlashBrowse',
            'ImageBrowse',
            'ImageBrowseLink',
            'Upload',
            'FlashUpload',
            'ImageUpload',
        ], $filebrowsers));

        foreach ($filebrowsers as $filebrowser) {
            $fileBrowserKey = 'filebrowser'.$filebrowser;
            $handler = $fileBrowserKey.'Handler';
            $url = $fileBrowserKey.'Url';
            $route = $fileBrowserKey.'Route';
            $routeParameters = $fileBrowserKey.'RouteParameters';
            $routeType = $fileBrowserKey.'RouteType';

            if (isset($config[$handler])) {
                $config[$url] = $config[$handler]($this->router);
            } elseif (isset($config[$route])) {
                $config[$url] = $this->router->generate(
                    $config[$route],
                    isset($config[$routeParameters]) ? $config[$routeParameters] : [],
                    isset($config[$routeType]) ? $config[$routeType] : UrlGeneratorInterface::ABSOLUTE_PATH
                );
            }

            unset($config[$handler], $config[$route], $config[$routeParameters], $config[$routeType]);
        }

        return $config;
    }

    /**
     * @param JsonBuilder $builder
     * @param array       $config
     */
    private function fixConfigEscapedValues(JsonBuilder $builder, array $config)
    {
        if (isset($config['protectedSource'])) {
            foreach ($config['protectedSource'] as $key => $value) {
                $builder->setValue(sprintf('[protectedSource][%s]', $key), $value, false);
            }
        }

        $escapedValueKeys = [
            'stylesheetParser_skipSelectors',
            'stylesheetParser_validSelectors',
        ];

        foreach ($escapedValueKeys as $escapedValueKey) {
            if (isset($config[$escapedValueKey])) {
                $builder->setValue(sprintf('[%s]', $escapedValueKey), $config[$escapedValueKey], false);
            }
        }
    }

    /**
     * @param string $json
     *
     * @return string
     */
    private function fixConfigConstants($json)
    {
        return preg_replace('/"(CKEDITOR\.[A-Z_]+)"/', '$1', $json);
    }

    /**
     * @param string $path
     *
     * @return string
     */
    private function fixPath($path)
    {
        if (null === $this->assetsPackages) {
            return $path;
        }

        $url = $this->assetsPackages->getUrl($path);

        if ('/' === substr($path, -1) && false !== ($position = strpos($url, '?'))) {
            $url = substr($url, 0, $position);
        }

        return $url;
    }

    /**
     * @return null|string
     */
    private function getLanguage()
    {
        $request = $this->requestStack->getCurrentRequest();
        if (null !== $request) {
            return $request->getLocale();
        }

        return $this->locale;
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSCKEditor Bundle.
5			*
6			* (c) 2018 - present Friends of Symfony
7			* (c) 2009 - 2017 Eric GELOEN <[email protected]>
8			*
9			* For the full copyright and license information, please read the LICENSE
10			* file that was distributed with this source code.
11			*/
12
13			namespace FOS\CKEditorBundle\Renderer;
14
15			use FOS\CKEditorBundle\Builder\JsonBuilder;
16			use Symfony\Component\Asset\Packages;
17			use Symfony\Component\DependencyInjection\ContainerInterface;
18			use Symfony\Component\HttpFoundation\RequestStack;
19			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
20			use Symfony\Component\Routing\RouterInterface;
21			use Twig\Environment;
22
23			/**
24			* @author GeLo <[email protected]>
25			*/
26			final class CKEditorRenderer implements CKEditorRendererInterface
27			{
28			/**
29			* @var JsonBuilder
30			*/
31			private $jsonBuilder;
32
33			/**
34			* @var RouterInterface
35			*/
36			private $router;
37
38			/**
39			* @var Packages
40			*/
41			private $assetsPackages;
42
43			/**
44			* @var Environment
45			*/
46			private $twig;
47
48			/**
49			* @var RequestStack
50			*/
51			private $requestStack;
52
53			/**
54			* @var null\|string
55			*/
56			private $locale;
57
58			/**
59			* @param JsonBuilder\|ContainerInterface $containerOrJsonBuilder
60			* @param RouterInterface $router
61			* @param Packages $packages
62			* @param RequestStack $requestStack
63			* @param Environment $twig
64			* @param null\|string $locale
65			*/
66			public function __construct(
67			$containerOrJsonBuilder,
68			RouterInterface $router = null,
69			Packages $packages = null,
70			RequestStack $requestStack = null,
71			Environment $twig = null,
72			$locale = null
73			) {
74			if ($containerOrJsonBuilder instanceof ContainerInterface) {
75			@trigger_error(sprintf(
76			'Passing a %s as %s first argument is deprecated since FOSCKEditor 1.0, and will be removed in 2.0.'
77			.' Use %s instead.',
78			ContainerInterface::class,
79			__METHOD__,
80			JsonBuilder::class
81			), E_USER_DEPRECATED);
82			$jsonBuilder = $containerOrJsonBuilder->get('fos_ck_editor.renderer.json_builder');
83			$router = $containerOrJsonBuilder->get('router');
84			$packages = $containerOrJsonBuilder->get('assets.packages');
85			$requestStack = $containerOrJsonBuilder->get('request_stack');
86			$twig = $containerOrJsonBuilder->get('twig');
87			} elseif ($containerOrJsonBuilder instanceof JsonBuilder) {
			0 ignored issues – show introduced 2018-04-29 01:33 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$containerOrJsonBuilder` is always a sub-type of `FOS\CKEditorBundle\Builder\JsonBuilder`. Loading history...
88			$jsonBuilder = $containerOrJsonBuilder;
89			if (null === $router) {
90			throw new \InvalidArgumentException(sprintf(
91			'%s 2nd argument must not be null when using %s as first argument',
92			__METHOD__,
93			JsonBuilder::class
94			));
95			} elseif (null === $packages) {
96			throw new \InvalidArgumentException(sprintf(
97			'%s 3rd argument must not be null when using %s as first argument',
98			__METHOD__,
99			JsonBuilder::class
100			));
101			} elseif (null === $requestStack) {
102			throw new \InvalidArgumentException(sprintf(
103			'%s 4th argument must not be null when using %s as first argument',
104			__METHOD__,
105			JsonBuilder::class
106			));
107			} elseif (null === $twig) {
108			throw new \InvalidArgumentException(sprintf(
109			'%s 5th argument must not be null when using %s as first argument',
110			__METHOD__,
111			JsonBuilder::class
112			));
113			}
114			} else {
115			throw new \InvalidArgumentException(sprintf(
116			'%s first argument must be an instance of %s or %s (%s given).',
117			__METHOD__,
118			ContainerInterface::class,
119			JsonBuilder::class,
120			is_object($containerOrJsonBuilder)
121			? get_class($containerOrJsonBuilder)
122			: gettype($containerOrJsonBuilder)
123			));
124			}
125
126			$this->jsonBuilder = $jsonBuilder;
127			$this->router = $router;
128			$this->assetsPackages = $packages;
129			$this->twig = $twig;
130			$this->requestStack = $requestStack;
131			$this->locale = $locale;
132			}
133
134			/**
135			* {@inheritdoc}
136			*/
137			public function renderBasePath($basePath)
138			{
139			return $this->fixPath($basePath);
140			}
141
142			/**
143			* {@inheritdoc}
144			*/
145			public function renderJsPath($jsPath)
146			{
147			return $this->fixPath($jsPath);
148			}
149
150			/**
151			* {@inheritdoc}
152			*/
153			public function renderWidget($id, array $config, array $options = [])
154			{
155			$config = $this->fixConfigLanguage($config);
156			$config = $this->fixConfigContentsCss($config);
157			$config = $this->fixConfigFilebrowsers(
158			$config,
159			isset($options['filebrowsers']) ? $options['filebrowsers'] : []
160			);
161
162			$autoInline = isset($options['auto_inline']) && !$options['auto_inline']
163			? 'CKEDITOR.disableAutoInline = true;'."\n"
164			: null;
165
166			$builder = $this->jsonBuilder->reset()->setValues($config);
167			$this->fixConfigEscapedValues($builder, $config);
168
169			$widget = sprintf(
170			'CKEDITOR.%s("%s", %s);',
171			isset($options['inline']) && $options['inline'] ? 'inline' : 'replace',
172			$id,
173			$this->fixConfigConstants($builder->build())
174			);
175
176			if (isset($options['input_sync']) && $options['input_sync']) {
177			$variable = 'fos_ckeditor_'.$id;
178			$widget = 'var '.$variable.' = '.$widget."\n";
179
180			return $autoInline.$widget.$variable.'.on(\'change\', function() { '.$variable.'.updateElement(); });';
181			}
182
183			return $autoInline.$widget;
184			}
185
186			/**
187			* {@inheritdoc}
188			*/
189			public function renderDestroy($id)
190			{
191			return sprintf(
192			'if (CKEDITOR.instances["%1$s"]) { '.
193			'CKEDITOR.instances["%1$s"].destroy(true); '.
194			'delete CKEDITOR.instances["%1$s"]; '.
195			'}',
196			$id
197			);
198			}
199
200			/**
201			* {@inheritdoc}
202			*/
203			public function renderPlugin($name, array $plugin)
204			{
205			return sprintf(
206			'CKEDITOR.plugins.addExternal("%s", "%s", "%s");',
207			$name,
208			$this->fixPath($plugin['path']),
209			$plugin['filename']
210			);
211			}
212
213			/**
214			* {@inheritdoc}
215			*/
216			public function renderStylesSet($name, array $stylesSet)
217			{
218			return sprintf(
219			'if (CKEDITOR.stylesSet.get("%1$s") === null) { '.
220			'CKEDITOR.stylesSet.add("%1$s", %2$s); '.
221			'}',
222			$name,
223			$this->jsonBuilder->reset()->setValues($stylesSet)->build()
224			);
225			}
226
227			/**
228			* {@inheritdoc}
229			*/
230			public function renderTemplate($name, array $template)
231			{
232			if (isset($template['imagesPath'])) {
233			$template['imagesPath'] = $this->fixPath($template['imagesPath']);
234			}
235
236			if (isset($template['templates'])) {
237			foreach ($template['templates'] as &$rawTemplate) {
238			if (isset($rawTemplate['template'])) {
239			$rawTemplate['html'] = $this->twig->render(
240			$rawTemplate['template'],
241			isset($rawTemplate['template_parameters']) ? $rawTemplate['template_parameters'] : []
242			);
243			}
244
245			unset($rawTemplate['template'], $rawTemplate['template_parameters']);
246			}
247			}
248
249			return sprintf(
250			'CKEDITOR.addTemplates("%s", %s);',
251			$name,
252			$this->jsonBuilder->reset()->setValues($template)->build()
253			);
254			}
255
256			/**
257			* @param array $config
258			*
259			* @return array
260			*/
261			private function fixConfigLanguage(array $config)
262			{
263			if (!isset($config['language']) && null !== ($language = $this->getLanguage())) {
264			$config['language'] = $language;
265			}
266
267			if (isset($config['language'])) {
268			$config['language'] = strtolower(str_replace('_', '-', $config['language']));
269			}
270
271			return $config;
272			}
273
274			/**
275			* @param array $config
276			*
277			* @return array
278			*/
279			private function fixConfigContentsCss(array $config)
280			{
281			if (isset($config['contentsCss'])) {
282			$cssContents = (array) $config['contentsCss'];
283
284			$config['contentsCss'] = [];
285			foreach ($cssContents as $cssContent) {
286			$config['contentsCss'][] = $this->fixPath($cssContent);
287			}
288			}
289
290			return $config;
291			}
292
293			/**
294			* @param array $config
295			* @param array $filebrowsers
296			*
297			* @return array
298			*/
299			private function fixConfigFilebrowsers(array $config, array $filebrowsers)
300			{
301			$filebrowsers = array_unique(array_merge([
302			'Browse',
303			'FlashBrowse',
304			'ImageBrowse',
305			'ImageBrowseLink',
306			'Upload',
307			'FlashUpload',
308			'ImageUpload',
309			], $filebrowsers));
310
311			foreach ($filebrowsers as $filebrowser) {
312			$fileBrowserKey = 'filebrowser'.$filebrowser;
313			$handler = $fileBrowserKey.'Handler';
314			$url = $fileBrowserKey.'Url';
315			$route = $fileBrowserKey.'Route';
316			$routeParameters = $fileBrowserKey.'RouteParameters';
317			$routeType = $fileBrowserKey.'RouteType';
318
319			if (isset($config[$handler])) {
320			$config[$url] = $config[$handler]($this->router);
321			} elseif (isset($config[$route])) {
322			$config[$url] = $this->router->generate(
323			$config[$route],
324			isset($config[$routeParameters]) ? $config[$routeParameters] : [],
325			isset($config[$routeType]) ? $config[$routeType] : UrlGeneratorInterface::ABSOLUTE_PATH
326			);
327			}
328
329			unset($config[$handler], $config[$route], $config[$routeParameters], $config[$routeType]);
330			}
331
332			return $config;
333			}
334
335			/**
336			* @param JsonBuilder $builder
337			* @param array $config
338			*/
339			private function fixConfigEscapedValues(JsonBuilder $builder, array $config)
340			{
341			if (isset($config['protectedSource'])) {
342			foreach ($config['protectedSource'] as $key => $value) {
343			$builder->setValue(sprintf('[protectedSource][%s]', $key), $value, false);
344			}
345			}
346
347			$escapedValueKeys = [
348			'stylesheetParser_skipSelectors',
349			'stylesheetParser_validSelectors',
350			];
351
352			foreach ($escapedValueKeys as $escapedValueKey) {
353			if (isset($config[$escapedValueKey])) {
354			$builder->setValue(sprintf('[%s]', $escapedValueKey), $config[$escapedValueKey], false);
355			}
356			}
357			}
358
359			/**
360			* @param string $json
361			*
362			* @return string
363			*/
364			private function fixConfigConstants($json)
365			{
366			return preg_replace('/"(CKEDITOR\.[A-Z_]+)"/', '$1', $json);
367			}
368
369			/**
370			* @param string $path
371			*
372			* @return string
373			*/
374			private function fixPath($path)
375			{
376			if (null === $this->assetsPackages) {
377			return $path;
378			}
379
380			$url = $this->assetsPackages->getUrl($path);
381
382			if ('/' === substr($path, -1) && false !== ($position = strpos($url, '?'))) {
383			$url = substr($url, 0, $position);
384			}
385
386			return $url;
387			}
388
389			/**
390			* @return null\|string
391			*/
392			private function getLanguage()
393			{
394			$request = $this->requestStack->getCurrentRequest();
395			if (null !== $request) {
396			return $request->getLocale();
397			}
398
399			return $this->locale;
400			}
401			}
402

FriendsOfSymfony / FOSCKEditorBundle

Push — master ( b28d44...6f2c13 )

src/Renderer/CKEditorRenderer.php (1 issue)

Severity

Introduced By

Duplication Side-by-Side

Filter issues like