817841554

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/tattersoftware/codeigniter4-permits/commit/<a class=hub.com/tattersoftware/codeigniter4-permits/commit/defee4a450e44b79ccddfad31b3ef733b32a33ab">defee4a45<a href="https://github.com/tattersoftware/codeigniter4-permits/commit/defee4a450e44b79ccddfad31b3ef733b32a33ab">">Merge </a><a class="double-link" href="https://github.com/tattersoftware/codeigniter4-permits/commit/<a class="double-link" href="https://github.com/tattersoftware/codeigniter4-permits/commit/1f8e0ba82d6630f5b50df630cec5bd25500df555">1f8e0ba82</a>">1f8e0ba82</a><a href="https://github.com/tattersoftware/codeigniter4-permits/commit/defee4a450e44b79ccddfad31b3ef733b32a33ab"> into c04d7c7db">c04d7c7db</a>

Pull Request Pull Request #8: Cache bug, Toolkit

Run Details

1 of 2 new or added lines in 1 file covered. (50.0%)

100 of 247 relevant lines covered (40.49%)

0.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

44.44

/src/Permits.php

<?php namespace Tatter\Permits;

use Config\Services;
use Tatter\Permits\Config\Permits as PermitsConfig;
use Tatter\Permits\Interfaces\PermitsUserModelInterface;
use Tatter\Permits\Models\PermitModel;
use Tatter\Permits\Models\UserModel;

class Permits
{
        /**
         * Our configuration instance.
         *
         * @var PermitsConfig
         */
        protected $config;

        /**
         * The permit model used to fetch permits.
         *
         * @var PermitModel
         */
        protected $permitModel;

        /**
         * External model to handle users
         *
         * @var PermitsUserModelInterface
         */
        protected $userModel = null;

        /**
         * Initializes the library.
         *
         * @param PermitsConfig                  $config
         * @param PermitsUserModelInterface|null $userModel
         */
        public function __construct(PermitsConfig $config, PermitsUserModelInterface $userModel = null)
        {
                $this->config = $config;

                // Load the models
                $this->userModel   = $userModel ?? model(UserModel::class);
                $this->permitModel = model(PermitModel::class);

                // Load the helper for mode conversions
                helper('chmod');
        }

        /**
         * Checks for a logged in user based on the configured key.
         *
         * @return integer  The user ID, 0 for "not logged in", -1 for CLI
         */
        public function sessionUserId(): int
        {
                if (ENVIRONMENT !== 'testing' && is_cli())
                {
                        return -1;
                }

                return session($this->config->sessionUserId) ?? 0;
        }

        // try to cache a permit and pass it back
        protected function cache($key, $permit)
        {
                if ($duration = $this->config->cacheDuration)
                {
                        cache()->save($key, $permit, $duration);
                }
                return $permit;
        }

        // series fo checks to ensure input is a valid object and model has permissions setup
        public function isPermissible($object, $objectModel): bool
        {
                if (! is_octal($objectModel->mode))
                {
                        return false;
                }
                if (empty($object))
                {
                        return false;
                }
                return true;
        }

        // checks if user is a member of the supplied group
        public function userHasGroup(int $userId, int $groupId): ?bool
        {
                if (! $this->config->useGroups)
                {
                        return null;
                }

                foreach ($this->userModel->groups($userId) as $group)
                {
                        if ($groupId === $group->id)
                        {
                                return true;
                        }
                }

                return false;
        }

        // checks if user is one of an object's owners
        public function userHasOwnership(int $userId, $object, $objectModel): bool
        {
                // make sure the model has the necessary info
                if (empty($objectModel->userKey))
                {
                        return false;
                }

                // if input is an array, convert it
                if (gettype($object) === 'array')
                {
                        $object = (object) $object;
                }

                // check if the object itself has $userKey set
                if ($object->{$objectModel->userKey})
                {
                        return ($userId === $object->{$objectModel->userKey});

                        // otherwise, check for a valid pivot table
                }
                elseif (! empty($objectModel->usersPivot))
                {
                        // @phpstan-ignore-next-line
                        return (bool) $objectModel->db->table($objectModel->usersPivot)->where($objectModel->userKey, $userId)->where($objectModel->pivotKey, $object->{$objectModel->primaryKey})
                                ->get()->getResult();
                }

                return false;
        }

        // checks if user is a member of an object's groups
        public function userHasGroupOwnership(int $userId, $object, $objectModel): ?bool
        {
                if (! $this->config->useGroups)
                {
                        return null;
                }

                // if input is an array, convert it
                if (gettype($object) === 'array')
                {
                        $object = (object) $object;
                }

                // make sure the model has the necessary info
                if (empty($objectModel->groupKey))
                {
                        return false;
                }

                // check if the object itself has $groupKey set
                if ($groupId = $object->{$objectModel->groupKey})
                {
                        // check if this is a group the user is a part of
                        return $this->userHasGroup($userId, $groupId);

                        // otherwise, check for a valid pivot table
                }
                elseif (! empty($objectModel->groupsPivot))
                {
                        // @phpstan-ignore-next-line
                        return (bool) $objectModel->db->table($objectModel->groupsPivot)->where($objectModel->groupKey, $userId)->where($objectModel->pivotKey, $object->{$objectModel->primaryKey}) // @phpstan-ignore-line
                                ->get()->getResult();
                }

                return false;
        }

        // check if user has direct permit or inherited group permit
        public function hasPermit(?int $userId, string $name): bool
        {
                if (empty($userId))
                {
                        return false;
                }

                // check for cached version
                $cacheKey = "permits-{$name}-{$userId}";
                $permit   = cache($cacheKey);
                if ($permit !== null)
                {
                        return ! empty($this->cache($cacheKey, $permit));
                }

                // check database for user permit
                if ($permit = $this->hasUserPermit($userId, $name))
                {
                        return ! empty($this->cache($cacheKey, $permit));
                }

                if (! $this->config->useGroups)
                {
                        return false;
                }

                // check database for each of user's groups
                foreach ($this->userModel->groups($userId) as $group)
                {
                        if ($permit = $this->hasGroupPermit($group->id, $name))
                        {
                                return $this->cache($cacheKey, $permit);
                        }
                }

                return false;
        }

        // checks for global permit for one user, ignoring groups
        public function hasUserPermit(int $userId, string $name): ?bool
        {
                if (empty($userId))
                {
                        return null;
                }

                // @phpstan-ignore-next-line
                return (bool) $this->permitModel
                        ->where('user_id', $userId)
                        ->where('name', $name)
                        ->first();
        }

        // checks for global permit for one group
        public function hasGroupPermit(int $groupId, string $name): ?bool
        {
                if (! $this->config->useGroups)
                {
                        return null;
                }
                if (empty($groupId))
                {
                        return null;
                }

                // @phpstan-ignore-next-line
                return ! empty($this->permitModel
                        ->where('group_id', $groupId)
                        ->where('name', $name)
                        ->first()
                );
        }
}

1	<?php namespace Tatter\Permits;
2
3	use Config\Services;
4	use Tatter\Permits\Config\Permits as PermitsConfig;
5	use Tatter\Permits\Interfaces\PermitsUserModelInterface;
6	use Tatter\Permits\Models\PermitModel;
7	use Tatter\Permits\Models\UserModel;
8
9	class Permits
10	{
11	/**
12	* Our configuration instance.
13	*
14	* @var PermitsConfig
15	*/
16	protected $config;
17
18	/**
19	* The permit model used to fetch permits.
20	*
21	* @var PermitModel
22	*/
23	protected $permitModel;
24
25	/**
26	* External model to handle users
27	*
28	* @var PermitsUserModelInterface
29	*/
30	protected $userModel = null;
31
32	/**
33	* Initializes the library.
34	*
35	* @param PermitsConfig $config
36	* @param PermitsUserModelInterface\|null $userModel
37	*/
38	public function __construct(PermitsConfig $config, PermitsUserModelInterface $userModel = null)
39	{
40	$this->config = $config;	1✔
41
42	// Load the models
43	$this->userModel = $userModel ?? model(UserModel::class);	1✔
44	$this->permitModel = model(PermitModel::class);	1✔
45
46	// Load the helper for mode conversions
47	helper('chmod');	1✔
48	}	1✔
49
50	/**
51	* Checks for a logged in user based on the configured key.
52	*
53	* @return integer The user ID, 0 for "not logged in", -1 for CLI
54	*/
55	public function sessionUserId(): int
56	{
57	if (ENVIRONMENT !== 'testing' && is_cli())	2✔
58	{
59	return -1;	×
60	}
61
62	return session($this->config->sessionUserId) ?? 0;	2✔
63	}
64
65	// try to cache a permit and pass it back
66	protected function cache($key, $permit)
67	{
68	if ($duration = $this->config->cacheDuration)	×
69	{
70	cache()->save($key, $permit, $duration);	×
71	}
72	return $permit;	×
73	}
74
75	// series fo checks to ensure input is a valid object and model has permissions setup
76	public function isPermissible($object, $objectModel): bool
77	{
78	if (! is_octal($objectModel->mode))	4✔
79	{
80	return false;	2✔
81	}
82	if (empty($object))	2✔
83	{
84	return false;	1✔
85	}
86	return true;	1✔
87	}
88
89	// checks if user is a member of the supplied group
90	public function userHasGroup(int $userId, int $groupId): ?bool
91	{
92	if (! $this->config->useGroups)	×
93	{
94	return null;	×
95	}
96
97	foreach ($this->userModel->groups($userId) as $group)	×
98	{
99	if ($groupId === $group->id)	×
100	{
101	return true;	×
102	}
103	}
104
105	return false;	×
106	}
107
108	// checks if user is one of an object's owners
109	public function userHasOwnership(int $userId, $object, $objectModel): bool
110	{
111	// make sure the model has the necessary info
112	if (empty($objectModel->userKey))	×
113	{
114	return false;	×
115	}
116
117	// if input is an array, convert it
118	if (gettype($object) === 'array')	×
119	{
120	$object = (object) $object;	×
121	}
122
123	// check if the object itself has $userKey set
124	if ($object->{$objectModel->userKey})	×
125	{
126	return ($userId === $object->{$objectModel->userKey});	×
127
128	// otherwise, check for a valid pivot table
129	}
130	elseif (! empty($objectModel->usersPivot))	×
131	{
132	// @phpstan-ignore-next-line
NEW 133	return (bool) $objectModel->db->table($objectModel->usersPivot)->where($objectModel->userKey, $userId)->where($objectModel->pivotKey, $object->{$objectModel->primaryKey})	×
134	->get()->getResult();	×
135	}
136
137	return false;	×
138	}
139
140	// checks if user is a member of an object's groups
141	public function userHasGroupOwnership(int $userId, $object, $objectModel): ?bool
142	{
143	if (! $this->config->useGroups)	×
144	{
145	return null;	×
146	}
147
148	// if input is an array, convert it
149	if (gettype($object) === 'array')	×
150	{
151	$object = (object) $object;	×
152	}
153
154	// make sure the model has the necessary info
155	if (empty($objectModel->groupKey))	×
156	{
157	return false;	×
158	}
159
160	// check if the object itself has $groupKey set
161	if ($groupId = $object->{$objectModel->groupKey})	×
162	{
163	// check if this is a group the user is a part of
164	return $this->userHasGroup($userId, $groupId);	×
165
166	// otherwise, check for a valid pivot table
167	}
168	elseif (! empty($objectModel->groupsPivot))	×
169	{
170	// @phpstan-ignore-next-line
171	return (bool) $objectModel->db->table($objectModel->groupsPivot)->where($objectModel->groupKey, $userId)->where($objectModel->pivotKey, $object->{$objectModel->primaryKey}) // @phpstan-ignore-line	×
172	->get()->getResult();	×
173	}
174
175	return false;	×
176	}
177
178	// check if user has direct permit or inherited group permit
179	public function hasPermit(?int $userId, string $name): bool
180	{
181	if (empty($userId))	2✔
182	{
183	return false;	×
184	}
185
186	// check for cached version
187	$cacheKey = "permits-{$name}-{$userId}";	2✔
188	$permit = cache($cacheKey);	2✔
189	if ($permit !== null)	2✔
190	{
191	return ! empty($this->cache($cacheKey, $permit));	×
192	}
193
194	// check database for user permit
195	if ($permit = $this->hasUserPermit($userId, $name))	2✔
196	{
197	return ! empty($this->cache($cacheKey, $permit));	×
198	}
199
200	if (! $this->config->useGroups)	2✔
201	{
202	return false;	×
203	}
204
205	// check database for each of user's groups
206	foreach ($this->userModel->groups($userId) as $group)	2✔
207	{
208	if ($permit = $this->hasGroupPermit($group->id, $name))	2✔
209	{
210	return $this->cache($cacheKey, $permit);	×
211	}
212	}
213
214	return false;	2✔
215	}
216
217	// checks for global permit for one user, ignoring groups
218	public function hasUserPermit(int $userId, string $name): ?bool
219	{
220	if (empty($userId))	2✔
221	{
222	return null;	×
223	}
224
225	// @phpstan-ignore-next-line
226	return (bool) $this->permitModel	2✔
227	->where('user_id', $userId)	2✔
228	->where('name', $name)	2✔
229	->first();	2✔
230	}
231
232	// checks for global permit for one group
233	public function hasGroupPermit(int $groupId, string $name): ?bool
234	{
235	if (! $this->config->useGroups)	2✔
236	{
237	return null;	×
238	}
239	if (empty($groupId))	2✔
240	{
241	return null;	×
242	}
243
244	// @phpstan-ignore-next-line
245	return ! empty($this->permitModel	2✔
246	->where('group_id', $groupId)	2✔
247	->where('name', $name)	2✔
248	->first()	2✔
249	);
250	}
251	}

tattersoftware / codeigniter4-permits / 817841554

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous