Issues in DocumentationController.php (master) - Issues in master - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

Issues (3948)

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.

app/Http/Controllers/DocumentationController.php (7 issues)

Labels

Documentation 7

Severity

Informational 7

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

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Http\Controllers;

use Parsedown;

/**
 * Documentation Viewer.
 */
class DocumentationController extends Controller
{
    /**
     * Show documentation content.
     */
    public function show()
    {
        $page = $this->request->getStringParam('file', 'index');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if (!preg_match('/^[a-z0-9\-]+/', $page)) {
            $page = 'index';
        }

        $filename = $this->getPageFilename($page);
        $this->response->html($this->helper->layout->app('doc/show', $this->render($filename)));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Regex callback to replace Markdown links.
     *
     * @param array $matches
     *
     * @return string
     */
    public function replaceMarkdownUrl(array $matches)
    {
        return '('.$this->helper->url->to('DocumentationController', 'show', ['file' => str_replace('.md', '', $matches[1])]).')';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Regex callback to replace image links.
     *
     * @param array $matches
     *
     * @return string
     */
    public function replaceImageUrl(array $matches)
    {
        return '('.$this->getFileBaseUrl($matches[1]).')';
    }

    /**
     * Prepare Markdown file.
     *
     * @param string $filename
     *
     * @return array
     */
    protected function render($filename)
    {
        $data = file_get_contents($filename);
        $content = preg_replace_callback('/\((.*.md)\)/', [$this, 'replaceMarkdownUrl'], $data);
        $content = preg_replace_callback('/\((screenshots.*\.png)\)/', [$this, 'replaceImageUrl'], $content);

        list($title) = explode("\n", $data, 2);

        return [
            'content' => Parsedown::instance()->text($content),
            'title'   => $title !== 'Documentation' ? t('Documentation: %s', $title) : $title,
        ];
    }

    /**
     * Get Markdown file according to the current language.
     *
     * @param string $page
     *
     * @return string
     */
    protected function getPageFilename($page)
    {
        return $this->getFileLocation($page.'.md') ?:
            implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', 'index.md']);
    }

    /**
     * Get base URL for Markdown links.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function getFileBaseUrl($filename)
    {
        $language = $this->languageModel->getCurrentLanguage();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $path = $this->getFileLocation($filename);

        if (strpos($path, $language) !== false) {
            $url = implode('/', ['doc', $language, $filename]);
        } else {
            $url = implode('/', ['doc', $filename]);
        }

        return $this->helper->url->base().$url;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Get file location according to the current language.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function getFileLocation($filename)
    {
        $files = [
            implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', $this->languageModel->getCurrentLanguage(), $filename]),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', $filename]),
        ];

        foreach ($files as $filename) {
            if (file_exists($filename)) {
                return $filename;
            }
        }

        return '';
    }
}


1			<?php
2
3			/*
4			* This file is part of Jitamin.
5			*
6			* Copyright (C) Jitamin Team
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Jitamin\Http\Controllers;
13
14			use Parsedown;
15
16			/**
17			* Documentation Viewer.
18			*/
19			class DocumentationController extends Controller
20			{
21			/**
22			* Show documentation content.
23			*/
24			public function show()
25			{
26			$page = $this->request->getStringParam('file', 'index');
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `request` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
27
28			if (!preg_match('/^[a-z0-9\-]+/', $page)) {
29			$page = 'index';
30			}
31
32			$filename = $this->getPageFilename($page);
33			$this->response->html($this->helper->layout->app('doc/show', $this->render($filename)));
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `response` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `helper` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
34			}
35
36			/**
37			* Regex callback to replace Markdown links.
38			*
39			* @param array $matches
40			*
41			* @return string
42			*/
43			public function replaceMarkdownUrl(array $matches)
44			{
45			return '('.$this->helper->url->to('DocumentationController', 'show', ['file' => str_replace('.md', '', $matches[1])]).')';
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `helper` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
46			}
47
48			/**
49			* Regex callback to replace image links.
50			*
51			* @param array $matches
52			*
53			* @return string
54			*/
55			public function replaceImageUrl(array $matches)
56			{
57			return '('.$this->getFileBaseUrl($matches[1]).')';
58			}
59
60			/**
61			* Prepare Markdown file.
62			*
63			* @param string $filename
64			*
65			* @return array
66			*/
67			protected function render($filename)
68			{
69			$data = file_get_contents($filename);
70			$content = preg_replace_callback('/\((.*.md)\)/', [$this, 'replaceMarkdownUrl'], $data);
71			$content = preg_replace_callback('/\((screenshots.*\.png)\)/', [$this, 'replaceImageUrl'], $content);
72
73			list($title) = explode("\n", $data, 2);
74
75			return [
76			'content' => Parsedown::instance()->text($content),
77			'title' => $title !== 'Documentation' ? t('Documentation: %s', $title) : $title,
78			];
79			}
80
81			/**
82			* Get Markdown file according to the current language.
83			*
84			* @param string $page
85			*
86			* @return string
87			*/
88			protected function getPageFilename($page)
89			{
90			return $this->getFileLocation($page.'.md') ?:
91			implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', 'index.md']);
92			}
93
94			/**
95			* Get base URL for Markdown links.
96			*
97			* @param string $filename
98			*
99			* @return string
100			*/
101			protected function getFileBaseUrl($filename)
102			{
103			$language = $this->languageModel->getCurrentLanguage();
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `languageModel` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
104			$path = $this->getFileLocation($filename);
105
106			if (strpos($path, $language) !== false) {
107			$url = implode('/', ['doc', $language, $filename]);
108			} else {
109			$url = implode('/', ['doc', $filename]);
110			}
111
112			return $this->helper->url->base().$url;
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `helper` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
113			}
114
115			/**
116			* Get file location according to the current language.
117			*
118			* @param string $filename
119			*
120			* @return string
121			*/
122			protected function getFileLocation($filename)
123			{
124			$files = [
125			implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', $this->languageModel->getCurrentLanguage(), $filename]),
			0 ignored issues – show Documentation introduced 2017-01-11 07:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `languageModel` does not exist on `object<Jitamin\Http\Cont...ocumentationController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
126			implode(DIRECTORY_SEPARATOR, [JITAMIN_DIR, 'doc', $filename]),
127			];
128
129			foreach ($files as $filename) {
130			if (file_exists($filename)) {
131			return $filename;
132			}
133			}
134
135			return '';
136			}
137			}
138

Jitamin / jitamin

Issues (3948)

Security Analysis not enabled

app/Http/Controllers/DocumentationController.php (7 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like