Issues in OAuthIdentity.php - New Issues - Inspection of "fix database migration" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — newinternal ( b66232...216d62 )

by Simon

created 2020-05-09 21:44 UTC

includes/DataObjects/OAuthIdentity.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
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\DataObjects;

use DateTimeImmutable;
use Exception;
use stdClass;
use Waca\DataObject;
use Waca\Exceptions\OptimisticLockFailedException;

class OAuthIdentity extends DataObject
{
    #region Fields
    /** @var int */
    private $user;
    /** @var string */
    private $iss;
    /** @var int */
    private $sub;
    /** @var string */
    private $aud;
    /** @var int */
    private $exp;
    /** @var int */
    private $iat;
    /** @var string */
    private $username;
    /** @var int */
    private $editcount;
    /** @var int */
    private $confirmed_email;
    /** @var int */
    private $blocked;
    /** @var string */
    private $registered;
    /** @var int */
    private $checkuser;
    /** @var int */
    private $grantbasic;
    /** @var int */
    private $grantcreateaccount;
    /** @var int */
    private $granthighvolume;
    /** @var int */
    private $grantcreateeditmovepage;
    #endregion

    /**
     * Saves a data object to the database, either updating or inserting a record.
     * @return void
     * @throws Exception
     * @throws OptimisticLockFailedException
     */
    public function save()
    {
        if ($this->isNew()) {
            $statement = $this->dbObject->prepare(<<<SQL
                INSERT INTO oauthidentity (
                    user, iss, sub, aud, exp, iat, username, editcount, confirmed_email, blocked, registered, checkuser, 
                    grantbasic, grantcreateaccount, granthighvolume, grantcreateeditmovepage
                ) VALUES (
                    :user, :iss, :sub, :aud, :exp, :iat, :username, :editcount, :confirmed_email, :blocked, :registered,
                    :checkuser, :grantbasic, :grantcreateaccount, :granthighvolume, :grantcreateeditmovepage
                )
SQL
            );

            $statement->bindValue(':user', $this->user);
            $statement->bindValue(':iss', $this->iss);
            $statement->bindValue(':sub', $this->sub);
            $statement->bindValue(':aud', $this->aud);
            $statement->bindValue(':exp', $this->exp);
            $statement->bindValue(':iat', $this->iat);
            $statement->bindValue(':username', $this->username);
            $statement->bindValue(':editcount', $this->editcount);
            $statement->bindValue(':confirmed_email', $this->confirmed_email);
            $statement->bindValue(':blocked', $this->blocked);
            $statement->bindValue(':registered', $this->registered);
            $statement->bindValue(':checkuser', $this->checkuser);
            $statement->bindValue(':grantbasic', $this->grantbasic);
            $statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
            $statement->bindValue(':granthighvolume', $this->granthighvolume);
            $statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);

            if ($statement->execute()) {
                $this->id = (int)$this->dbObject->lastInsertId();
            }
            else {
                throw new Exception($statement->errorInfo());
            }
        }
        else {

            $statement = $this->dbObject->prepare(<<<SQL
                UPDATE oauthidentity SET
                      iss                     = :iss
                    , sub                     = :sub
                    , aud                     = :aud
                    , exp                     = :exp
                    , iat                     = :iat
                    , username                = :username
                    , editcount               = :editcount
                    , confirmed_email         = :confirmed_email
                    , blocked                 = :blocked
                    , registered              = :registered
                    , checkuser               = :checkuser
                    , grantbasic              = :grantbasic
                    , grantcreateaccount      = :grantcreateaccount
                    , granthighvolume         = :granthighvolume
                    , grantcreateeditmovepage = :grantcreateeditmovepage
                    , updateversion           = updateversion + 1
                WHERE  id = :id AND updateversion = :updateversion
SQL
            );

            $statement->bindValue(':iss', $this->iss);
            $statement->bindValue(':sub', $this->sub);
            $statement->bindValue(':aud', $this->aud);
            $statement->bindValue(':exp', $this->exp);
            $statement->bindValue(':iat', $this->iat);
            $statement->bindValue(':username', $this->username);
            $statement->bindValue(':editcount', $this->editcount);
            $statement->bindValue(':confirmed_email', $this->confirmed_email);
            $statement->bindValue(':blocked', $this->blocked);
            $statement->bindValue(':registered', $this->registered);
            $statement->bindValue(':checkuser', $this->checkuser);
            $statement->bindValue(':grantbasic', $this->grantbasic);
            $statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
            $statement->bindValue(':granthighvolume', $this->granthighvolume);
            $statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);

            $statement->bindValue(':id', $this->id);
            $statement->bindValue(':updateversion', $this->updateversion);

            if (!$statement->execute()) {
                throw new Exception($statement->errorInfo());
            }

            if ($statement->rowCount() !== 1) {
                throw new OptimisticLockFailedException();
            }

            $this->updateversion++;
        }
    }

    #region Properties

    /**
     * @return int
     */
    public function getUserId()
    {
        return $this->user;
    }

    /**
     * @param int $user
     */
    public function setUserId($user)
    {
        $this->user = $user;
    }

    /**
     * @return string
     */
    public function getIssuer()
    {
        return $this->iss;
    }

    /**
     * @return int
     */
    public function getSubject()
    {
        return $this->sub;
    }

    /**
     * @return string
     */
    public function getAudience()
    {
        return $this->aud;
    }

    /**
     * @return int
     */
    public function getExpirationTime()
    {
        return $this->exp;
    }

    /**
     * @return int
     */
    public function getIssuedAtTime()
    {
        return $this->iat;
    }

    /**
     * @return string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * @return int
     */
    public function getEditCount()
    {
        return $this->editcount;
    }

    /**
     * @return bool
     */
    public function getConfirmedEmail()
    {
        return $this->confirmed_email == 1;
    }

    /**
     * @return bool
     */
    public function getBlocked()
    {
        return $this->blocked == 1;
    }

    /**
     * @return string
     */
    public function getRegistered()
    {
        return $this->registered;
    }

    public function getRegistrationDate()

    {
        return DateTimeImmutable::createFromFormat('YmdHis', $this->registered)->format('r');
    }

    public function getAccountAge()

    {
        $regDate = DateTimeImmutable::createFromFormat('YmdHis', $this->registered);
        $interval = $regDate->diff(new DateTimeImmutable(), true);

        return $interval->days;
    }

    /**
     * @return bool
     */
    public function getCheckuser()
    {
        return $this->checkuser == 1;
    }

    /**
     * @return bool
     */
    public function getGrantBasic()
    {
        return $this->grantbasic == 1;
    }

    /**
     * @return bool
     */
    public function getGrantCreateAccount()
    {
        return $this->grantcreateaccount == 1;
    }

    /**
     * @return bool
     */
    public function getGrantHighVolume()
    {
        return $this->granthighvolume == 1;
    }

    /**
     * @return bool
     */
    public function getGrantCreateEditMovePage()
    {
        return $this->grantcreateeditmovepage == 1;
    }

    #endregion Properties

    /**
     * Populates the fields of this instance from a provided JSON Web Token
     *
     * @param stdClass $jwt
     */
    public function populate($jwt)
    {
        $this->iss = $jwt->iss;
        $this->sub = $jwt->sub;
        $this->aud = $jwt->aud;
        $this->exp = $jwt->exp;
        $this->iat = $jwt->iat;
        $this->username = $jwt->username;
        $this->editcount = $jwt->editcount;
        $this->confirmed_email = $jwt->confirmed_email ? 1 : 0;
        $this->blocked = $jwt->blocked ? 1 : 0;
        $this->registered = $jwt->registered;

        /*
         * Rights we need:
         *  Account creation
         *      createaccount      => createaccount
         *  Flagged users:
         *      tboverride-account => createaccount
         *      override-antispoof => N/A
         *  Welcome bot:
         *      createtalk         => createeditmovepage
         *      edit               => editpage/editprotected/editmycssjs/editinterface/createmoveeditpage/delete/protect
         *  Would be nice:
         *      apihighlimits      => highvolume
         *      noratelimit        => highvolume
         *
         * Hence, we're requesting these grants:
         *      useoauth (required)
         *      createaccount
         *      createeditmovepage
         *
         * Any antispoof conflicts will still have to be resolved manually using the normal creation form.
         */

        $this->grantbasic = in_array('basic', $jwt->grants) ? 1 : 0;
        $this->grantcreateaccount = in_array('createaccount', $jwt->grants) ? 1 : 0;
        $this->grantcreateeditmovepage = in_array('createeditmovepage', $jwt->grants) ? 1 : 0;

        // we don't request these yet.
        $this->granthighvolume = 0;

        $this->checkuser = in_array('checkuser', $jwt->rights) ? 1 : 0;
    }
}

1		<?php
2		/******************************************************************************
3		* Wikipedia Account Creation Assistance tool *
4		* *
5		* All code in this file is released into the public domain by the ACC *
6		* Development Team. Please see team.json for a list of contributors. *
7		******************************************************************************/
8
9		namespace Waca\DataObjects;
10
11		use DateTimeImmutable;
12		use Exception;
13		use stdClass;
14		use Waca\DataObject;
15		use Waca\Exceptions\OptimisticLockFailedException;
16
17		class OAuthIdentity extends DataObject
18		{
19		#region Fields
20		/** @var int */
21		private $user;
22		/** @var string */
23		private $iss;
24		/** @var int */
25		private $sub;
26		/** @var string */
27		private $aud;
28		/** @var int */
29		private $exp;
30		/** @var int */
31		private $iat;
32		/** @var string */
33		private $username;
34		/** @var int */
35		private $editcount;
36		/** @var int */
37		private $confirmed_email;
38		/** @var int */
39		private $blocked;
40		/** @var string */
41		private $registered;
42		/** @var int */
43		private $checkuser;
44		/** @var int */
45		private $grantbasic;
46		/** @var int */
47		private $grantcreateaccount;
48		/** @var int */
49		private $granthighvolume;
50		/** @var int */
51		private $grantcreateeditmovepage;
52		#endregion
53
54		/**
55		* Saves a data object to the database, either updating or inserting a record.
56		* @return void
57		* @throws Exception
58		* @throws OptimisticLockFailedException
59		*/
60		public function save()
61		{
62		if ($this->isNew()) {
63		$statement = $this->dbObject->prepare(<<<SQL
64		INSERT INTO oauthidentity (
65		user, iss, sub, aud, exp, iat, username, editcount, confirmed_email, blocked, registered, checkuser,
66		grantbasic, grantcreateaccount, granthighvolume, grantcreateeditmovepage
67		) VALUES (
68		:user, :iss, :sub, :aud, :exp, :iat, :username, :editcount, :confirmed_email, :blocked, :registered,
69		:checkuser, :grantbasic, :grantcreateaccount, :granthighvolume, :grantcreateeditmovepage
70		)
71		SQL
72		);
73
74		$statement->bindValue(':user', $this->user);
75		$statement->bindValue(':iss', $this->iss);
76		$statement->bindValue(':sub', $this->sub);
77		$statement->bindValue(':aud', $this->aud);
78		$statement->bindValue(':exp', $this->exp);
79		$statement->bindValue(':iat', $this->iat);
80		$statement->bindValue(':username', $this->username);
81		$statement->bindValue(':editcount', $this->editcount);
82		$statement->bindValue(':confirmed_email', $this->confirmed_email);
83		$statement->bindValue(':blocked', $this->blocked);
84		$statement->bindValue(':registered', $this->registered);
85		$statement->bindValue(':checkuser', $this->checkuser);
86		$statement->bindValue(':grantbasic', $this->grantbasic);
87		$statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
88		$statement->bindValue(':granthighvolume', $this->granthighvolume);
89		$statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
90
91		if ($statement->execute()) {
92		$this->id = (int)$this->dbObject->lastInsertId();
93		}
94		else {
95		throw new Exception($statement->errorInfo());
96		}
97		}
98	View Code Duplication	else {
		0 ignored issues – show Duplication introduced 2020-04-26 14:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		$statement = $this->dbObject->prepare(<<<SQL
100		UPDATE oauthidentity SET
101		iss = :iss
102		, sub = :sub
103		, aud = :aud
104		, exp = :exp
105		, iat = :iat
106		, username = :username
107		, editcount = :editcount
108		, confirmed_email = :confirmed_email
109		, blocked = :blocked
110		, registered = :registered
111		, checkuser = :checkuser
112		, grantbasic = :grantbasic
113		, grantcreateaccount = :grantcreateaccount
114		, granthighvolume = :granthighvolume
115		, grantcreateeditmovepage = :grantcreateeditmovepage
116		, updateversion = updateversion + 1
117		WHERE id = :id AND updateversion = :updateversion
118		SQL
119		);
120
121		$statement->bindValue(':iss', $this->iss);
122		$statement->bindValue(':sub', $this->sub);
123		$statement->bindValue(':aud', $this->aud);
124		$statement->bindValue(':exp', $this->exp);
125		$statement->bindValue(':iat', $this->iat);
126		$statement->bindValue(':username', $this->username);
127		$statement->bindValue(':editcount', $this->editcount);
128		$statement->bindValue(':confirmed_email', $this->confirmed_email);
129		$statement->bindValue(':blocked', $this->blocked);
130		$statement->bindValue(':registered', $this->registered);
131		$statement->bindValue(':checkuser', $this->checkuser);
132		$statement->bindValue(':grantbasic', $this->grantbasic);
133		$statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
134		$statement->bindValue(':granthighvolume', $this->granthighvolume);
135		$statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
136
137		$statement->bindValue(':id', $this->id);
138		$statement->bindValue(':updateversion', $this->updateversion);
139
140		if (!$statement->execute()) {
141		throw new Exception($statement->errorInfo());
142		}
143
144		if ($statement->rowCount() !== 1) {
145		throw new OptimisticLockFailedException();
146		}
147
148		$this->updateversion++;
149		}
150		}
151
152		#region Properties
153
154		/**
155		* @return int
156		*/
157		public function getUserId()
158		{
159		return $this->user;
160		}
161
162		/**
163		* @param int $user
164		*/
165		public function setUserId($user)
166		{
167		$this->user = $user;
168		}
169
170		/**
171		* @return string
172		*/
173		public function getIssuer()
174		{
175		return $this->iss;
176		}
177
178		/**
179		* @return int
180		*/
181		public function getSubject()
182		{
183		return $this->sub;
184		}
185
186		/**
187		* @return string
188		*/
189		public function getAudience()
190		{
191		return $this->aud;
192		}
193
194		/**
195		* @return int
196		*/
197		public function getExpirationTime()
198		{
199		return $this->exp;
200		}
201
202		/**
203		* @return int
204		*/
205		public function getIssuedAtTime()
206		{
207		return $this->iat;
208		}
209
210		/**
211		* @return string
212		*/
213		public function getUsername()
214		{
215		return $this->username;
216		}
217
218		/**
219		* @return int
220		*/
221		public function getEditCount()
222		{
223		return $this->editcount;
224		}
225
226		/**
227		* @return bool
228		*/
229		public function getConfirmedEmail()
230		{
231		return $this->confirmed_email == 1;
232		}
233
234		/**
235		* @return bool
236		*/
237		public function getBlocked()
238		{
239		return $this->blocked == 1;
240		}
241
242		/**
243		* @return string
244		*/
245		public function getRegistered()
246		{
247		return $this->registered;
248		}
249
250		public function getRegistrationDate()
		0 ignored issues – show Documentation introduced 2020-04-26 14:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
251		{
252		return DateTimeImmutable::createFromFormat('YmdHis', $this->registered)->format('r');
253		}
254
255		public function getAccountAge()
		0 ignored issues – show Documentation introduced 2020-04-26 14:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
256		{
257		$regDate = DateTimeImmutable::createFromFormat('YmdHis', $this->registered);
258		$interval = $regDate->diff(new DateTimeImmutable(), true);
259
260		return $interval->days;
261		}
262
263		/**
264		* @return bool
265		*/
266		public function getCheckuser()
267		{
268		return $this->checkuser == 1;
269		}
270
271		/**
272		* @return bool
273		*/
274		public function getGrantBasic()
275		{
276		return $this->grantbasic == 1;
277		}
278
279		/**
280		* @return bool
281		*/
282		public function getGrantCreateAccount()
283		{
284		return $this->grantcreateaccount == 1;
285		}
286
287		/**
288		* @return bool
289		*/
290		public function getGrantHighVolume()
291		{
292		return $this->granthighvolume == 1;
293		}
294
295		/**
296		* @return bool
297		*/
298		public function getGrantCreateEditMovePage()
299		{
300		return $this->grantcreateeditmovepage == 1;
301		}
302
303		#endregion Properties
304
305		/**
306		* Populates the fields of this instance from a provided JSON Web Token
307		*
308		* @param stdClass $jwt
309		*/
310		public function populate($jwt)
311		{
312		$this->iss = $jwt->iss;
313		$this->sub = $jwt->sub;
314		$this->aud = $jwt->aud;
315		$this->exp = $jwt->exp;
316		$this->iat = $jwt->iat;
317		$this->username = $jwt->username;
318		$this->editcount = $jwt->editcount;
319		$this->confirmed_email = $jwt->confirmed_email ? 1 : 0;
320		$this->blocked = $jwt->blocked ? 1 : 0;
321		$this->registered = $jwt->registered;
322
323		/*
324		* Rights we need:
325		* Account creation
326		* createaccount => createaccount
327		* Flagged users:
328		* tboverride-account => createaccount
329		* override-antispoof => N/A
330		* Welcome bot:
331		* createtalk => createeditmovepage
332		* edit => editpage/editprotected/editmycssjs/editinterface/createmoveeditpage/delete/protect
333		* Would be nice:
334		* apihighlimits => highvolume
335		* noratelimit => highvolume
336		*
337		* Hence, we're requesting these grants:
338		* useoauth (required)
339		* createaccount
340		* createeditmovepage
341		*
342		* Any antispoof conflicts will still have to be resolved manually using the normal creation form.
343		*/
344
345		$this->grantbasic = in_array('basic', $jwt->grants) ? 1 : 0;
346		$this->grantcreateaccount = in_array('createaccount', $jwt->grants) ? 1 : 0;
347		$this->grantcreateeditmovepage = in_array('createeditmovepage', $jwt->grants) ? 1 : 0;
348
349		// we don't request these yet.
350		$this->granthighvolume = 0;
351
352		$this->checkuser = in_array('checkuser', $jwt->rights) ? 1 : 0;
353		}
354		}

enwikipedia-acc / waca

Push — newinternal ( b66232...216d62 )

includes/DataObjects/OAuthIdentity.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like