User_Model::restore_api_key() - Code Metrics - Inspection of "Options page now has a link to restore your old AP..." - DakuTree/manga-tracker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 89a822...3faa1c )

by Angus

created 2018-01-05 08:02 UTC

User_Model::restore_api_key() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	3
nop	0
dl	0
loc	18
ccs	0
cts	12
cp	0
crap	12
rs	9.4285
c	0
b	0
f	0

<?php declare(strict_types=1); defined('BASEPATH') OR exit('No direct script access allowed');

class User_Model extends CI_Model {
	public $id;
	public $username;
	public $email;

	public function __construct() {
		parent::__construct();

		//This needs to be set here as needs to be set before `logged_in` is called.
		if($remember = $this->input->cookie('remember_time')) {
			$this->set_user_expire_time($remember);
		}

		//CHECK: Should this be placed elsewhere?
		if($this->logged_in()) {
			if(!$this->session->userdata('username')) {
				$this->session->set_userdata('username', $this->ion_auth->user()->row()->username);
			}
			if(!$this->session->userdata('email')) {
				//CHECK: This seems like a bad idea?
				$this->session->set_userdata('email', $this->ion_auth->user()->row()->email);
			}
		}

		$this->id       = (int) $this->ion_auth->get_user_id();
		$this->username = $this->session->userdata('username');
		$this->email    = $this->session->userdata('email');
	}

	public function logged_in() : bool {
		return $this->ion_auth->logged_in();
	}

	public function login_redirect() {
		if(!strpos(current_url(), '/import_list') && !strpos(current_url(), '/export_list')) {
			$this->session->set_flashdata('referred_from', current_url());
		}
		//FIXME: We should handle the redirect here too, but it causes issues with tests
		//redirect('user/login');
	}

	public function username_exists(string $username) : bool {
		$this->load->database();

		$query = $this->db->select('*')
		                  ->from('auth_users')
		                  ->where('username', $username)
		                  ->get();

		return (bool) $query->num_rows();
	}

	/**
	 * @param $identity
	 *
	 * @return mixed
	 */
	public function find_email_from_identity(string $identity) {
		//login allows using email or username, but ion_auth doesn't support this
		//check if identity is email, and if not, try and find it
		//returns: email or FALSE
		//CHECK: How should we handle invalid emails being passed to this?
		$email = $identity;

		if(!strpos($identity, '@')) {
			//identity does not contain @, assume username
			$this->load->database();

			$query = $this->db->select('email')
			                  ->from('auth_users')
			                  ->where('username', $identity)
			                  ->get();

			if($query->num_rows() > 0) {
				//username exists, grab email
				$email = $query->row('email');
			}else{
				//username doesn't exist, return FALSE
				$email = FALSE;
			}
		}

		return $email;
	}

	public function get_user_by_username(string $username) {
		$user = NULL;

		$query = $this->db->select('*')
		                  ->from('auth_users')
		                  ->where('username', $username)
		                  ->get();

		if($query->num_rows() > 0) {
			$user = $query->row();
		}
		return $user;
	}

	public function get_gravatar_url($email = NULL, $size = NULL) : string {
		$email = $email ?? $this->email;
		//TODO: FIXME ON PROFILE PAGES
		return $this->gravatar->get($email, $size);
	}

	public function get_new_api_key() : string {
		$api_key = NULL;
		if($this->logged_in()) {
			$api_key = substr("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", mt_rand(0, 51), 1) . substr(md5((string) time()), 1);

			$this->db->where('id', $this->id);
			$this->db->update('auth_users', ['api_key' => $api_key]);
		}

		return $api_key;
	}
	public function restore_api_key() : ?string {
		$api_key = NULL;
		if($this->logged_in()) {
			$this->db->select('api_key')
			         ->where('id', $this->User->id)
			         ->get('auth_users');

			$query = $this->db->select('api_key')
			                  ->where('id', $this->User->id)
			                  ->get('auth_users');

			if($query->num_rows() > 0) {
				$api_key = $query->row('api_key');
			}
		}

		return $api_key;
	}
	
	public function get_id_from_api_key(string $api_key) {
		$query = $this->db->select('id')
		                  ->from('auth_users')
		                  ->where('api_key', $api_key)
		                  ->get();

		if($query->num_rows() > 0) {
			$userID = $query->row('id');
		}

		return $userID ?? FALSE;
	}

	public function set_user_expire_time($remember) : int {
		$expire_time = 0;
		switch($remember) {
			case '1day':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				$expire_time = 86400;
				break;
			case '3day':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				//This is default so do nothing.
				break;
			case '1week':
				$expire_time = 604800;
				break;
			case '1month':
				$expire_time = 2419200;
				break;
			case '3month':
				$expire_time = 7257600;
				break;
			default:
				//Somehow remember_time isn't set?
				break;
		}
		if($expire_time > 0) {
			$this->config->set_item_by_index('user_expire', $expire_time, 'ion_auth');
		}
		return $expire_time;
	}

	/** NOTICES **/

	public function getLatestNotice() {
		$query = $this->db
			->select('tn.notice, tn.created_at')
			->from('tracker_notices AS tn')
			->where("id > IFNULL((SELECT hidden_notice_id FROM tracker_user_notices WHERE user_id = {$this->User->id}), '0')", NULL, FALSE)
			->order_by('tn.id DESC')
			->limit(1)
			->get();

		$noticeData = [];
		if($query->num_rows() > 0) {
			$row = $query->row();

			$noticeData = [
				'date' => str_replace('-', '/', substr($row->created_at, 0, 10)),
				'text' => str_replace('|', '<br/>', htmlspecialchars($row->notice))
			];
		}

		return $noticeData;
	}
	public function hideLatestNotice() {
		$idQuery = $this->db->select('1')
		                    ->where('user_id', $this->User->id)
		                    ->get('tracker_user_notices');
		if($idQuery->num_rows() > 0) {
			$success = (bool) $this->db->set('hidden_notice_id', '(SELECT id FROM tracker_notices ORDER BY id DESC LIMIT 1)', FALSE)
			                           ->where('user_id', $this->User->id)
			                           ->update('tracker_user_notices');
		} else {
			$success = (bool) $this->db->insert('tracker_user_notices', [
				'user_id'           => $this->User->id,
				'hidden_notice_id'  => '(SELECT id FROM tracker_notices ORDER BY id DESC LIMIT 1)'
			], FALSE);
		}

		return $success;
	}
}


1		<?php declare(strict_types=1); defined('BASEPATH') OR exit('No direct script access allowed');
2
3		class User_Model extends CI_Model {
4		public $id;
5		public $username;
6		public $email;
7
8	127	public function __construct() {
9	127	parent::__construct();
10
11		//This needs to be set here as needs to be set before `logged_in` is called.
12	127	if($remember = $this->input->cookie('remember_time')) {
13		$this->set_user_expire_time($remember);
14		}
15
16		//CHECK: Should this be placed elsewhere?
17	127	if($this->logged_in()) {
18	3	if(!$this->session->userdata('username')) {
19	3	$this->session->set_userdata('username', $this->ion_auth->user()->row()->username);
20		}
21	3	if(!$this->session->userdata('email')) {
22		//CHECK: This seems like a bad idea?
23	3	$this->session->set_userdata('email', $this->ion_auth->user()->row()->email);
24		}
25		}
26
27	127	$this->id = (int) $this->ion_auth->get_user_id();
28	127	$this->username = $this->session->userdata('username');
29	127	$this->email = $this->session->userdata('email');
30	127	}
31
32	127	public function logged_in() : bool {
33	127	return $this->ion_auth->logged_in();
34		}
35
36	8	public function login_redirect() {
37	8	if(!strpos(current_url(), '/import_list') && !strpos(current_url(), '/export_list')) {
38	7	$this->session->set_flashdata('referred_from', current_url());
39		}
40		//FIXME: We should handle the redirect here too, but it causes issues with tests
41		//redirect('user/login');
42	8	}
43
44	2	public function username_exists(string $username) : bool {
45	2	$this->load->database();
46
47	2	$query = $this->db->select('*')
48	2	->from('auth_users')
49	2	->where('username', $username)
50	2	->get();
51
52	2	return (bool) $query->num_rows();
53		}
54
55		/**
56		* @param $identity
57		*
58		* @return mixed
59		*/
60	4	public function find_email_from_identity(string $identity) {
61		//login allows using email or username, but ion_auth doesn't support this
62		//check if identity is email, and if not, try and find it
63		//returns: email or FALSE
64		//CHECK: How should we handle invalid emails being passed to this?
65	4	$email = $identity;
66
67	4	if(!strpos($identity, '@')) {
68		//identity does not contain @, assume username
69	2	$this->load->database();
70
71	2	$query = $this->db->select('email')
72	2	->from('auth_users')
73	2	->where('username', $identity)
74	2	->get();
75
76	2	if($query->num_rows() > 0) {
77		//username exists, grab email
78	1	$email = $query->row('email');
79		}else{
80		//username doesn't exist, return FALSE
81	1	$email = FALSE;
82		}
83		}
84
85	4	return $email;
86		}
87
88	5	public function get_user_by_username(string $username) {
89	5	$user = NULL;
90
91	5	$query = $this->db->select('*')
92	5	->from('auth_users')
93	5	->where('username', $username)
94	5	->get();
95
96	5	if($query->num_rows() > 0) {
97	1	$user = $query->row();
98		}
99	5	return $user;
100		}
101
102	1	public function get_gravatar_url($email = NULL, $size = NULL) : string {
103	1	$email = $email ?? $this->email;
104		//TODO: FIXME ON PROFILE PAGES
105	1	return $this->gravatar->get($email, $size);
106		}
107
108		public function get_new_api_key() : string {
109		$api_key = NULL;
110		if($this->logged_in()) {
111		$api_key = substr("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", mt_rand(0, 51), 1) . substr(md5((string) time()), 1);
112
113		$this->db->where('id', $this->id);
114		$this->db->update('auth_users', ['api_key' => $api_key]);
115		}
116
117		return $api_key;
118		}
119		public function restore_api_key() : ?string {
120		$api_key = NULL;
121		if($this->logged_in()) {
122		$this->db->select('api_key')
123		->where('id', $this->User->id)
124		->get('auth_users');
125
126		$query = $this->db->select('api_key')
127		->where('id', $this->User->id)
128		->get('auth_users');
129
130		if($query->num_rows() > 0) {
131		$api_key = $query->row('api_key');
132		}
133		}
134
135		return $api_key;
136		}
137
138		public function get_id_from_api_key(string $api_key) {
139		$query = $this->db->select('id')
140		->from('auth_users')
141		->where('api_key', $api_key)
142		->get();
143
144		if($query->num_rows() > 0) {
145		$userID = $query->row('id');
146		}
147
148		return $userID ?? FALSE;
149		}
150
151		public function set_user_expire_time($remember) : int {
152		$expire_time = 0;
153		switch($remember) {
154		case '1day':
		0 ignored issues – show Coding Style introduced 2017-08-29 16:59 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
155		$expire_time = 86400;
156		break;
157		case '3day':
		0 ignored issues – show Coding Style introduced 2017-08-29 16:59 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
158		//This is default so do nothing.
159		break;
160		case '1week':
161		$expire_time = 604800;
162		break;
163		case '1month':
164		$expire_time = 2419200;
165		break;
166		case '3month':
167		$expire_time = 7257600;
168		break;
169		default:
170		//Somehow remember_time isn't set?
171		break;
172		}
173		if($expire_time > 0) {
174		$this->config->set_item_by_index('user_expire', $expire_time, 'ion_auth');
175		}
176		return $expire_time;
177		}
178
179		/ NOTICES /
180
181		public function getLatestNotice() {
182		$query = $this->db
183		->select('tn.notice, tn.created_at')
184		->from('tracker_notices AS tn')
185		->where("id > IFNULL((SELECT hidden_notice_id FROM tracker_user_notices WHERE user_id = {$this->User->id}), '0')", NULL, FALSE)
186		->order_by('tn.id DESC')
187		->limit(1)
188		->get();
189
190		$noticeData = [];
191		if($query->num_rows() > 0) {
192		$row = $query->row();
193
194		$noticeData = [
195		'date' => str_replace('-', '/', substr($row->created_at, 0, 10)),
196		'text' => str_replace('\|', '<br/>', htmlspecialchars($row->notice))
197		];
198		}
199
200		return $noticeData;
201		}
202		public function hideLatestNotice() {
203		$idQuery = $this->db->select('1')
204		->where('user_id', $this->User->id)
205		->get('tracker_user_notices');
206		if($idQuery->num_rows() > 0) {
207		$success = (bool) $this->db->set('hidden_notice_id', '(SELECT id FROM tracker_notices ORDER BY id DESC LIMIT 1)', FALSE)
208		->where('user_id', $this->User->id)
209		->update('tracker_user_notices');
210		} else {
211		$success = (bool) $this->db->insert('tracker_user_notices', [
212		'user_id' => $this->User->id,
213		'hidden_notice_id' => '(SELECT id FROM tracker_notices ORDER BY id DESC LIMIT 1)'
214		], FALSE);
215		}
216
217		return $success;
218		}
219		}
220

DakuTree / manga-tracker

Push — master ( 89a822...3faa1c )

User_Model::restore_api_key() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like