Issues in BaseSetting.php (master) - Issues in master - shurik2k5/yii2-settings - Measure and Improve Code Quality continuously with Scrutinizer

Issues (13)

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/models/BaseSetting.php (3 issues)

Labels

Severity

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
/**
 * @link http://phe.me
 * @copyright Copyright (c) 2014 Pheme
 * @license MIT http://opensource.org/licenses/MIT
 */

namespace pheme\settings\models;

use Yii;
use yii\base\InvalidArgumentException;
use yii\helpers\Json;
use yii\db\ActiveRecord;
use yii\helpers\ArrayHelper;
use yii\behaviors\TimestampBehavior;

/**
 * This is the model class for table "settings".
 *
 * @property integer $id
 * @property string $type
 * @property string $section
 * @property string $key
 * @property string $value
 * @property boolean $active
 * @property string $created
 * @property string $modified
 *
 * @author Aris Karageorgos <[email protected]>
 */
class BaseSetting extends ActiveRecord implements SettingInterface
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%settings}}';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['value'], 'string'],
            [['section', 'key'], 'string', 'max' => 255],
            [
                ['key'],
                'unique',
                'targetAttribute' => ['section', 'key'],
            ],
            ['type', 'in', 'range' => ['string', 'integer', 'boolean', 'float', 'double', 'object', 'null', 'ip', 'email', 'url']],
            [['created', 'modified'], 'safe'],
            [['active'], 'boolean'],
        ];
    }

    public function afterSave($insert, $changedAttributes)
    {
        parent::afterSave($insert, $changedAttributes);
        Yii::$app->settings->clearCache();
    }

    public function afterDelete()
    {
        parent::afterDelete();
        Yii::$app->settings->clearCache();
    }

    /**
     * @return array
     */
    public function behaviors()
    {
        return [
            'timestamp' => [
                'class' => TimestampBehavior::className(),

                'attributes' => [
                    ActiveRecord::EVENT_BEFORE_INSERT => 'created',
                    ActiveRecord::EVENT_BEFORE_UPDATE => 'modified',
                ],
                'value' => date('Y-m-d H:i:s'),//new Expression('NOW()'),
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function getSettings()
    {
        $settings = static::find()->where(['active' => true])->asArray()->all();
        return array_merge_recursive(
            ArrayHelper::map($settings, 'key', 'value', 'section'),
            ArrayHelper::map($settings, 'key', 'type', 'section')
        );
    }

    /**
     * @inheritdoc
     */
    public function setSetting($section, $key, $value, $type = null)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model === null) {
            $model = new static();
            $model->active = 1;
        }
        $model->section = $section;
        $model->key = $key;
        $model->value = strval($value);

        if ($type !== null) {
            $model->type = $type;
        } elseif ( ! isset($model->type) ) {
            $type = $this->getValueType($value);
            $model->type = $type;
        }

        return $model->save();
    }

    /**
     * @inheritdoc
     */
    public function activateSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model && $model->active == 0) {
            $model->active = 1;
            return $model->save();
        }
        return false;
    }

    /**
     * @inheritdoc
     */
    public function deactivateSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model && $model->active == 1) {
            $model->active = 0;
            return $model->save();
        }
        return false;
    }

    /**
     * @inheritdoc
     */
    public function deleteSetting($section, $key)
    {
        $model = static::findOne(['section' => $section, 'key' => $key]);

        if ($model) {
            return $model->delete();
        }
    }

    /**
     * @inheritdoc
     */
    public function deleteAllSettings()
    {
        return static::deleteAll();
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());
}
    }

    /**
     * @inheritdoc
     */
    public function findSetting($key, $section = null)
    {
        if (is_null($section)) {
            $pieces = explode('.', $key, 2);
            if (count($pieces) > 1) {
                $section = $pieces[0];
                $key = $pieces[1];
            } else {
                $section = '';
            }
        }
        return $this->find()->where(['section' => $section, 'key' => $key])->limit(1)->one();
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());
}
    }

    /**
     * @param $value
     * @return string|void
     */
    protected function getValueType($value)
    {

        if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
            return 'email';
        }

        if (filter_var($value, FILTER_VALIDATE_URL)) {
            return 'url';
        }

        if (filter_var($value, FILTER_VALIDATE_IP)) {
            return 'ip';
        }

        if (filter_var($value, FILTER_VALIDATE_BOOLEAN)) {
            return 'boolean';
        }

        if (filter_var($value, FILTER_VALIDATE_INT)) {
            return 'integer';
        }

        if (filter_var($value, FILTER_VALIDATE_FLOAT)) {
            return 'float';
        }

        $t = gettype($value);

        if ($t === 'string' && !empty($value)) {
            $error = false;
            try {
                Json::decode($value);
            } catch (InvalidArgumentException $e) {
                $error = true;
            }
            if (!$error) {
                $t = 'object';
            }
        }
        return $t;
    }
}


1		<?php
2		/**
3		* @link http://phe.me
4		* @copyright Copyright (c) 2014 Pheme
5		* @license MIT http://opensource.org/licenses/MIT
6		*/
7
8		namespace pheme\settings\models;
9
10		use Yii;
11		use yii\base\InvalidArgumentException;
12		use yii\helpers\Json;
13		use yii\db\ActiveRecord;
14		use yii\helpers\ArrayHelper;
15		use yii\behaviors\TimestampBehavior;
16
17		/**
18		* This is the model class for table "settings".
19		*
20		* @property integer $id
21		* @property string $type
22		* @property string $section
23		* @property string $key
24		* @property string $value
25		* @property boolean $active
26		* @property string $created
27		* @property string $modified
28		*
29		* @author Aris Karageorgos <[email protected]>
30		*/
31		class BaseSetting extends ActiveRecord implements SettingInterface
32		{
33		/**
34		* @inheritdoc
35		*/
36	37	public static function tableName()
37		{
38	37	return '{{%settings}}';
39		}
40
41		/**
42		* @inheritdoc
43		*/
44	18	public function rules()
45		{
46		return [
47	18	[['value'], 'string'],
48		[['section', 'key'], 'string', 'max' => 255],
49		[
50		['key'],
51		'unique',
52		'targetAttribute' => ['section', 'key'],
53		],
54		['type', 'in', 'range' => ['string', 'integer', 'boolean', 'float', 'double', 'object', 'null', 'ip', 'email', 'url']],
55		[['created', 'modified'], 'safe'],
56		[['active'], 'boolean'],
57		];
58		}
59
60	34	public function afterSave($insert, $changedAttributes)
61		{
62	34	parent::afterSave($insert, $changedAttributes);
63	34	Yii::$app->settings->clearCache();
64	34	}
65
66	4	public function afterDelete()
67		{
68	4	parent::afterDelete();
69	4	Yii::$app->settings->clearCache();
70	4	}
71
72		/**
73		* @return array
74		*/
75	37	public function behaviors()
76		{
77		return [
78		'timestamp' => [
79	37	'class' => TimestampBehavior::className(),
		0 ignored issues – show Deprecated Code introduced 2019-04-17 13:21 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `yii\base\BaseObject::className()` has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
80		'attributes' => [
81	37	ActiveRecord::EVENT_BEFORE_INSERT => 'created',
82	37	ActiveRecord::EVENT_BEFORE_UPDATE => 'modified',
83		],
84	37	'value' => date('Y-m-d H:i:s'),//new Expression('NOW()'),
85		],
86		];
87		}
88
89		/**
90		* @inheritdoc
91		*/
92	7	public function getSettings()
93		{
94	7	$settings = static::find()->where(['active' => true])->asArray()->all();
95	7	return array_merge_recursive(
96	7	ArrayHelper::map($settings, 'key', 'value', 'section'),
97	7	ArrayHelper::map($settings, 'key', 'type', 'section')
98		);
99		}
100
101		/**
102		* @inheritdoc
103		*/
104	14	public function setSetting($section, $key, $value, $type = null)
105		{
106	14	$model = static::findOne(['section' => $section, 'key' => $key]);
107
108	14	if ($model === null) {
109	13	$model = new static();
110	13	$model->active = 1;
111		}
112	14	$model->section = $section;
113	14	$model->key = $key;
114	14	$model->value = strval($value);
115
116	14	if ($type !== null) {
117	3	$model->type = $type;
118	12	} elseif ( ! isset($model->type) ) {
119	11	$type = $this->getValueType($value);
120	11	$model->type = $type;
121		}
122
123	14	return $model->save();
124		}
125
126		/**
127		* @inheritdoc
128		*/
129	6	public function activateSetting($section, $key)
130		{
131	6	$model = static::findOne(['section' => $section, 'key' => $key]);
132
133	6	if ($model && $model->active == 0) {
134	6	$model->active = 1;
135	6	return $model->save();
136		}
137	1	return false;
138		}
139
140		/**
141		* @inheritdoc
142		*/
143	4	public function deactivateSetting($section, $key)
144		{
145	4	$model = static::findOne(['section' => $section, 'key' => $key]);
146
147	4	if ($model && $model->active == 1) {
148	4	$model->active = 0;
149	4	return $model->save();
150		}
151	1	return false;
152		}
153
154		/**
155		* @inheritdoc
156		*/
157	2	public function deleteSetting($section, $key)
158		{
159	2	$model = static::findOne(['section' => $section, 'key' => $key]);
160
161	2	if ($model) {
162	2	return $model->delete();
163		}
164		}
165
166		/**
167		* @inheritdoc
168		*/
169	2	public function deleteAllSettings()
170		{
171	2	return static::deleteAll();
		0 ignored issues – show Bug Best Practice introduced 2019-04-17 13:21 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return static::deleteAll();` (`integer`) is incompatible with the return type declared by the interface `pheme\settings\models\Se...face::deleteAllSettings` of type `boolean`. 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...
172		}
173
174		/**
175		* @inheritdoc
176		*/
177	2	public function findSetting($key, $section = null)
178		{
179	2	if (is_null($section)) {
180	2	$pieces = explode('.', $key, 2);
181	2	if (count($pieces) > 1) {
182	2	$section = $pieces[0];
183	2	$key = $pieces[1];
184		} else {
185	1	$section = '';
186		}
187		}
188	2	return $this->find()->where(['section' => $section, 'key' => $key])->limit(1)->one();
		0 ignored issues – show Bug Best Practice introduced 2019-04-17 13:21 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this->find()->wh...key))->limit(1)->one();` (`yii\db\ActiveRecord\|array\|null`) is incompatible with the return type declared by the interface `pheme\settings\models\Se...gInterface::findSetting` of type `pheme\settings\models\SettingInterface`. 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...
189		}
190
191		/**
192		* @param $value
193		* @return string\|void
194		*/
195	11	protected function getValueType($value)
196		{
197
198	11	if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
199	1	return 'email';
200		}
201
202	10	if (filter_var($value, FILTER_VALIDATE_URL)) {
203	1	return 'url';
204		}
205
206	9	if (filter_var($value, FILTER_VALIDATE_IP)) {
207	1	return 'ip';
208		}
209
210	8	if (filter_var($value, FILTER_VALIDATE_BOOLEAN)) {
211	1	return 'boolean';
212		}
213
214	7	if (filter_var($value, FILTER_VALIDATE_INT)) {
215	2	return 'integer';
216		}
217
218	5	if (filter_var($value, FILTER_VALIDATE_FLOAT)) {
219	1	return 'float';
220		}
221
222	4	$t = gettype($value);
223
224	4	if ($t === 'string' && !empty($value)) {
225	4	$error = false;
226		try {
227	4	Json::decode($value);
228	2	} catch (InvalidArgumentException $e) {
229	2	$error = true;
230		}
231	4	if (!$error) {
232	2	$t = 'object';
233		}
234		}
235	4	return $t;
236		}
237		}
238

shurik2k5 / yii2-settings

Issues (13)

Security Analysis not enabled

src/models/BaseSetting.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like