File::checkAccessToFile() - Code Metrics - Inspection of "Refactor" - rkit/filemanager-yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d9f7a...3b1f1a )

by Igor

created 2016-10-18 04:17 UTC

File::checkAccessToFile() A

↳ Parent: File

Complexity

Conditions	4
Paths	6

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	4
nc	6
nop	1
crap	4

<?php

/**
 * @link https://github.com/rkit/filemanager-yii2
 * @copyright Copyright (c) 2015 Igor Romanov
 * @license [MIT](http://opensource.org/licenses/MIT)
 */

namespace rkit\filemanager\models;

use Yii;
use yii\behaviors\TimestampBehavior;
use yii\helpers\FileHelper;

/**
 * ActiveRecord for table "file"
 *
 * @property integer $id
 * @property integer $user_id
 * @property integer $owner_id
 * @property integer $owner_type
 * @property string $title
 * @property string $name
 * @property integer $size
 * @property string $extension
 * @property string $mime
 * @property string $date_create
 * @property string $date_update
 * @property integer $ip
 * @property integer $tmp
 * @property integer $position
 */
class File extends \yii\db\ActiveRecord
{
    /**
     * @inheritdoc
     * @codeCoverageIgnore
     * @internal
     */
    public static function tableName()
    {
        return 'file';
    }

    /**
     * @inheritdoc
     * @codeCoverageIgnore
     * @internal
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('filemanager-yii2', 'ID'),
            'user_id' => Yii::t('filemanager-yii2', 'User'),
            'owner_id' => Yii::t('filemanager-yii2', 'Owner'),
            'owner_type' => Yii::t('filemanager-yii2', 'Owner type'),
            'title' => Yii::t('filemanager-yii2', 'Title'),
            'name' => Yii::t('filemanager-yii2', 'Name'),
            'size' => Yii::t('filemanager-yii2', 'Size'),
            'extension' => Yii::t('filemanager-yii2', 'Extension'),
            'mime' => Yii::t('filemanager-yii2', 'Mime'),
            'date_create' => Yii::t('filemanager-yii2', 'Date create'),
            'date_update' => Yii::t('filemanager-yii2', 'Date update'),
            'ip' => Yii::t('filemanager-yii2', 'IP'),
            'position' => Yii::t('filemanager-yii2', 'Position'),
        ];
    }

    /**
     * @inheritdoc
     * @internal
     */
    public function behaviors()
    {
        return [
            [
                'class' => TimestampBehavior::className(),
                'createdAtAttribute' => 'date_create',
                'updatedAtAttribute' => 'date_update',
                'value' => new \yii\db\Expression('NOW()'),
            ],
        ];
    }

    /**
     * @internal
     */
    public function beforeSave($insert)
    {
        if (parent::beforeSave($insert)) {
            if ($insert) {
                if (!Yii::$app instanceof \yii\console\Application) {
                    $this->user_id = Yii::$app->user->isGuest ? 0 : Yii::$app->user->id; // @codeCoverageIgnore
                    $this->ip = ip2long(Yii::$app->request->getUserIP()); // @codeCoverageIgnore
                } // @codeCoverageIgnore

                if ($this->owner_id === null) {
                    $this->owner_id = 0;
                }
            }
            return true;
        }
        return false; // @codeCoverageIgnore
    }

    /**
     * Path to the file
     *
     * @return string
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function path()
    {
        if ($this->isNewRecord || is_object($this->date_create)) {
            $dateCreate = date('Ym');
        } else {
            $dateCreate = date_format(date_create($this->date_create), 'Ym');
        }

        return '/' . $dateCreate . '/' . $this->id . '/' . $this->name;
    }

    /**
     * Fill meta info
     *
     * @param string $path File path
     * @return void
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function fillMetaInfo($path)
    {
        $pathInfo = pathinfo($path);

        if ($this->title === null) {
            $this->title = $pathInfo['filename'];
        }

        $this->size = filesize($path);
        $this->mime = FileHelper::getMimeType($path);
        $this->extension = $this->getExtensionByMimeType($path, $this->mime);
        $this->name = $this->generateName();
    }

    /**
     * Get extension By MimeType
     *
     * $param string $path File path
     * @param string $mimeType MimeType of the file
     * @return string
     */
    private function getExtensionByMimeType($path, $mimeType)
    {
        $extensions = FileHelper::getExtensionsByMimeType($mimeType);
        $pathExtension = pathinfo($path, PATHINFO_EXTENSION);
        $titleExtension = pathinfo($this->title, PATHINFO_EXTENSION);

        if (array_search($pathExtension, $extensions) !== false) {
            return $pathExtension;
        } elseif (array_search($titleExtension, $extensions) !== false) {
            return $titleExtension;
        }
        $extension = explode('/', $mimeType);
        $extension = end($extension);
        if (array_search($extension, $extensions) !== false) {
            return $extension;
        }

        return current($extensions); // @codeCoverageIgnore

    }

    /**
     * Generate a name
     *
     * @return string
     */
    public function generateName()
    {
        $name = date('YmdHis') . substr(md5(microtime() . uniqid()), 0, 10);
        return $name . '.' . $this->extension;
    }

    /**
     * Checks whether the file is temp
     *
     * @return bool
     */
    public function isTmp()
    {
        return (bool)$this->tmp;
    }

    /**
     * Check access
     *
     * @param int $ownerId The id of the owner
     * @param int $ownerType The type of the owner
     * @return bool
     */
    public function checkAccess($ownerId, $ownerType)
    {
        return
            $this->checkAccessToModel($ownerId, $ownerType) ||
            $this->checkAccessToFile($ownerType);
    }

    /**
     * Check access to model
     *
     * @param int $ownerId The id of the owner
     * @param int $ownerType The type of the owner
     * @return bool
     */
    public function checkAccessToModel($ownerId, $ownerType)
    {
        $equalOwnerType = $this->owner_type === $ownerType;
        $equalOwnerId = $this->owner_id === $ownerId;

        return !$this->tmp && $equalOwnerType && $equalOwnerId;
    }

    /**
     * Check access to file
     *
     * @param int $ownerId The id of the owner
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $ownerType The type of the owner
     * @return bool
     */
    public function checkAccessToFile($ownerType)
    {
        $equalOwnerType = $this->owner_type === $ownerType;
        $user = $this->user_id === Yii::$app->user->id || $this->user_id === 0;

        return $this->tmp && $equalOwnerType && $user;
    }

    /**
     * Find all by owner
     *
     * @param int $ownerId The id of the owner
     * @param int $ownerType The type of the owner
     * @return array
     */
    public static function findAllByOwner($ownerId, $ownerType)
    {
        return static::find()
            ->where(['owner_id' => $ownerId, 'owner_type' => $ownerType])
            ->orderBy('position ASC')
            ->all();
    }

    /**
     * Find one by owner
     *
     * @param int $ownerId The id of the owner
     * @param int $ownerType The type of the owner
     * @return File|null
     */
    public static function findOneByOwner($ownerId, $ownerType)
    {
        return static::find()
            ->where(['owner_id' => $ownerId, 'owner_type' => $ownerType])
            ->one();
    }
}


1		<?php
2
3		/**
4		* @link https://github.com/rkit/filemanager-yii2
5		* @copyright Copyright (c) 2015 Igor Romanov
6		* @license [MIT](http://opensource.org/licenses/MIT)
7		*/
8
9		namespace rkit\filemanager\models;
10
11		use Yii;
12		use yii\behaviors\TimestampBehavior;
13		use yii\helpers\FileHelper;
14
15		/**
16		* ActiveRecord for table "file"
17		*
18		* @property integer $id
19		* @property integer $user_id
20		* @property integer $owner_id
21		* @property integer $owner_type
22		* @property string $title
23		* @property string $name
24		* @property integer $size
25		* @property string $extension
26		* @property string $mime
27		* @property string $date_create
28		* @property string $date_update
29		* @property integer $ip
30		* @property integer $tmp
31		* @property integer $position
32		*/
33		class File extends \yii\db\ActiveRecord
34		{
35		/**
36		* @inheritdoc
37		* @codeCoverageIgnore
38		* @internal
39		*/
40		public static function tableName()
41		{
42		return 'file';
43		}
44
45		/**
46		* @inheritdoc
47		* @codeCoverageIgnore
48		* @internal
49		*/
50		public function attributeLabels()
51		{
52		return [
53		'id' => Yii::t('filemanager-yii2', 'ID'),
54		'user_id' => Yii::t('filemanager-yii2', 'User'),
55		'owner_id' => Yii::t('filemanager-yii2', 'Owner'),
56		'owner_type' => Yii::t('filemanager-yii2', 'Owner type'),
57		'title' => Yii::t('filemanager-yii2', 'Title'),
58		'name' => Yii::t('filemanager-yii2', 'Name'),
59		'size' => Yii::t('filemanager-yii2', 'Size'),
60		'extension' => Yii::t('filemanager-yii2', 'Extension'),
61		'mime' => Yii::t('filemanager-yii2', 'Mime'),
62		'date_create' => Yii::t('filemanager-yii2', 'Date create'),
63		'date_update' => Yii::t('filemanager-yii2', 'Date update'),
64		'ip' => Yii::t('filemanager-yii2', 'IP'),
65		'position' => Yii::t('filemanager-yii2', 'Position'),
66		];
67		}
68
69		/**
70		* @inheritdoc
71		* @internal
72		*/
73	26	public function behaviors()
74		{
75		return [
76		[
77	26	'class' => TimestampBehavior::className(),
78	26	'createdAtAttribute' => 'date_create',
79	26	'updatedAtAttribute' => 'date_update',
80	26	'value' => new \yii\db\Expression('NOW()'),
81	26	],
82	26	];
83		}
84
85		/**
86		* @internal
87		*/
88	26	public function beforeSave($insert)
89		{
90	26	if (parent::beforeSave($insert)) {
91	26	if ($insert) {
92	26	if (!Yii::$app instanceof \yii\console\Application) {
93		$this->user_id = Yii::$app->user->isGuest ? 0 : Yii::$app->user->id; // @codeCoverageIgnore
94		$this->ip = ip2long(Yii::$app->request->getUserIP()); // @codeCoverageIgnore
95		} // @codeCoverageIgnore
96
97	26	if ($this->owner_id === null) {
98	25	$this->owner_id = 0;
99	25	}
100	26	}
101	26	return true;
102		}
103		return false; // @codeCoverageIgnore
104		}
105
106		/**
107		* Path to the file
108		*
109		* @return string
110		* @SuppressWarnings(PHPMD.ElseExpression)
111		*/
112	26	public function path()
113		{
114	26	if ($this->isNewRecord \|\| is_object($this->date_create)) {
115	26	$dateCreate = date('Ym');
116	26	} else {
117	15	$dateCreate = date_format(date_create($this->date_create), 'Ym');
118		}
119
120	26	return '/' . $dateCreate . '/' . $this->id . '/' . $this->name;
121		}
122
123		/**
124		* Fill meta info
125		*
126		* @param string $path File path
127		* @return void
128		* @SuppressWarnings(PHPMD.ElseExpression)
129		*/
130	26	public function fillMetaInfo($path)
131		{
132	26	$pathInfo = pathinfo($path);
133
134	26	if ($this->title === null) {
135	5	$this->title = $pathInfo['filename'];
136	5	}
137
138	26	$this->size = filesize($path);
139	26	$this->mime = FileHelper::getMimeType($path);
140	26	$this->extension = $this->getExtensionByMimeType($path, $this->mime);
141	26	$this->name = $this->generateName();
142	26	}
143
144		/**
145		* Get extension By MimeType
146		*
147		* $param string $path File path
148		* @param string $mimeType MimeType of the file
149		* @return string
150		*/
151	26	private function getExtensionByMimeType($path, $mimeType)
152		{
153	26	$extensions = FileHelper::getExtensionsByMimeType($mimeType);
154	26	$pathExtension = pathinfo($path, PATHINFO_EXTENSION);
155	26	$titleExtension = pathinfo($this->title, PATHINFO_EXTENSION);
156
157	26	if (array_search($pathExtension, $extensions) !== false) {
158	24	return $pathExtension;
159	2	} elseif (array_search($titleExtension, $extensions) !== false) {
160	1	return $titleExtension;
161		}
162	1	$extension = explode('/', $mimeType);
163	1	$extension = end($extension);
164	1	if (array_search($extension, $extensions) !== false) {
165	1	return $extension;
166		}
167
168		return current($extensions); // @codeCoverageIgnore
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-03-28 15:50 UTC by Report Bug Copy Issue Report The expression `current($extensions);` of type `integer\|string\|false` adds `false` to the return on line 168 which is incompatible with the return type documented by `rkit\filemanager\models\...:getExtensionByMimeType` of type `string`. It seems like you forgot to handle an error condition. Loading history...
169		}
170
171		/**
172		* Generate a name
173		*
174		* @return string
175		*/
176	26	public function generateName()
177		{
178	26	$name = date('YmdHis') . substr(md5(microtime() . uniqid()), 0, 10);
179	26	return $name . '.' . $this->extension;
180		}
181
182		/**
183		* Checks whether the file is temp
184		*
185		* @return bool
186		*/
187	9	public function isTmp()
188		{
189	9	return (bool)$this->tmp;
190		}
191
192		/**
193		* Check access
194		*
195		* @param int $ownerId The id of the owner
196		* @param int $ownerType The type of the owner
197		* @return bool
198		*/
199	11	public function checkAccess($ownerId, $ownerType)
200		{
201		return
202	11	$this->checkAccessToModel($ownerId, $ownerType) \|\|
203	11	$this->checkAccessToFile($ownerType);
204		}
205
206		/**
207		* Check access to model
208		*
209		* @param int $ownerId The id of the owner
210		* @param int $ownerType The type of the owner
211		* @return bool
212		*/
213	11	public function checkAccessToModel($ownerId, $ownerType)
214		{
215	11	$equalOwnerType = $this->owner_type === $ownerType;
216	11	$equalOwnerId = $this->owner_id === $ownerId;
217
218	11	return !$this->tmp && $equalOwnerType && $equalOwnerId;
219		}
220
221		/**
222		* Check access to file
223		*
224		* @param int $ownerId The id of the owner
		0 ignored issues – show Bug introduced 2016-10-18 04:23 UTC by Report Bug Copy Issue Report There is no parameter named `$ownerId`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
225		* @param int $ownerType The type of the owner
226		* @return bool
227		*/
228	11	public function checkAccessToFile($ownerType)
229		{
230	11	$equalOwnerType = $this->owner_type === $ownerType;
231	11	$user = $this->user_id === Yii::$app->user->id \|\| $this->user_id === 0;
232
233	11	return $this->tmp && $equalOwnerType && $user;
234		}
235
236		/**
237		* Find all by owner
238		*
239		* @param int $ownerId The id of the owner
240		* @param int $ownerType The type of the owner
241		* @return array
242		*/
243	13	public static function findAllByOwner($ownerId, $ownerType)
244		{
245	13	return static::find()
246	13	->where(['owner_id' => $ownerId, 'owner_type' => $ownerType])
247	13	->orderBy('position ASC')
248	13	->all();
249		}
250
251		/**
252		* Find one by owner
253		*
254		* @param int $ownerId The id of the owner
255		* @param int $ownerType The type of the owner
256		* @return File\|null
257		*/
258	8	public static function findOneByOwner($ownerId, $ownerType)
259		{
260	8	return static::find()
261	8	->where(['owner_id' => $ownerId, 'owner_type' => $ownerType])
262	8	->one();
263		}
264		}
265

rkit / filemanager-yii2

Push — master ( 6d9f7a...3b1f1a )

File::checkAccessToFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like