User_Options_Model

Complexity

Total Complexity

28

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

17.39%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	get()	0	5	2
B	set()	0	19	7
B	get_by_userid()	0	22	6
A	get_db()	0	22	2
A	parse_value()	0	20	5
A	generate_radio_array()	0	25	4
A	getValidOptions()	0	3	1

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

class User_Options_Model extends CI_Model {
	public $options = array(
		/** GENERAL OPTIONS **/
		'category_custom_1' => array(
			'default' => 'disabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'enabled'
			)
		),
		'category_custom_2' => array(
			'default' => 'disabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'enabled'
			)
		),
		'category_custom_3' => array(
			'default' => 'disabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'enabled'
			)
		),
		'category_custom_1_text' => array(
			'default' => 'Custom 1',
			'type' => 'string'
		),
		'category_custom_2_text' => array(
			'default' => 'Custom 2',
			'type' => 'string'
		),
		'category_custom_3_text' => array(
			'default' => 'Custom 3',
			'type' => 'string'
		),

		'enable_live_countdown_timer' => array(
			'default' => 'enabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'enabled'
			)
		),

		'default_series_category' => array(
			'default' => 'reading',
			'type' => 'int',
			'valid_options' => array(
				0 => 'reading',
				1 => 'on-hold',
				2 => 'plan-to-read',

				//FIXME: (MAJOR) This should only be enabled if the custom categories are enabled
				// Problem is we can't easily check for this since the userscript uses it's own UserID, and not $this->User->id
				3 => 'custom1',
				4 => 'custom2',
				5 => 'custom3'
			)
		),

		'list_sort_type' => array(
			'default' => 'unread',
			'type' => 'int',
			'valid_options' => array(
				0 => 'unread',
				1 => 'alphabetical',
				2 => 'my_status',
				3 => 'latest',
				4 => 'unread_latest'
			)
		),

		'list_sort_order' => array(
			'default' => 'asc',
			'type' => 'int',
			'valid_options' => array(
				0 => 'asc',
				1 => 'desc'
			)
		),

		'theme' => array(
			'default' => 'light',
			'type' => 'int',
			'valid_options' => array(
				0 => 'light',
				1 => 'dark'
			)
		),

		'enable_public_list' => array(
			'default' => 'disabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'enabled'
			)
		),

		'mal_sync' => array(
			'default' => 'disabled',
			'type' => 'int',
			'valid_options' => array(
				0 => 'disabled',
				1 => 'csrf',
				2 => 'api'
			)
		),
	);

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

		$this->load->helper('security');
	}

	/**
	 * Get user option, or default option if it does not exist.
	 *
	 * @param string   $option
	 * @param int|null $userID
	 *
	 * @return mixed Returns option value as STRING, or FALSE if option does not exist.
	 */
	public function get(string $option, ?int $userID = NULL) {
		$userID = (is_null($userID) ? (int) $this->User->id : $userID);

		return $this->get_by_userid($option, $userID);
	}

	/**
	 * @param string     $option
	 * @param string|int $value
	 *
	 * @return bool
	 */
	public function set(string $option, $value) : bool {
		$success = FALSE;
		//Check if option is valid and user is logged in.
		if(array_key_exists($option, $this->options) && $this->ion_auth->logged_in()) {
			if($this->options[$option]['type'] === 'int') {
				$parsedValue = array_search($value, $this->options[$option]['valid_options'], TRUE);
			} else {
				$parsedValue = (string) $value;
			}
			if(!is_null($parsedValue)) {
				//CI doesn't have any nice way of using the query builder with JSON columns.
				$sql = 'UPDATE `auth_users` SET `options` = JSON_SET(COALESCE(`options`, \'{}\'), ?, ?) WHERE `id` = ?';
				if($success = $this->db->query($sql, ["$.{$option}", $parsedValue, $this->User->id])) {
					if($success) $this->session->unset_tempdata("option_{$option}");
				}
			}
		}
		return $success;
	}

	private function get_by_userid(string $option, int $userID) {
		//Check if option is valid
		if(array_key_exists($option, $this->options)) {
			//Check if userID is > 0
			if($userID) {
				//Check if user has option set.
				if($rowValue = $this->get_db($option, $userID)) {
					//User has option set, get proper value.
					if($userValue = $this->parse_value($option, $rowValue)) {
						//Value is valid. Everything is good.
						$value = $userValue;
					}
				}
			}

			//Overall fallback method.
			if(!isset($value)) $value = $this->options[$option]['default'];
		} else {
			$value = FALSE;
		}
		return $value;
	}

	private function get_db(string $option, int $userID) {
		//This function assumes we've already done some basic validation.

		//FIXME: Query duplication.
		if($this->User->id !== $userID) {
			$query = $this->db->select("options->\"$.{$option}\" AS value", FALSE)
			                  ->from('auth_users')
			                  ->where('id', $userID)
			                  ->limit(1);
			$data = $query->get()->row_object();
		} else {
			//if(!($data = $this->session->tempdata("option_{$option}"))) {
				$query = $this->db->select("options->\"$.{$option}\" AS value", FALSE)
				                  ->from('auth_users')
				                  ->where('id', $userID)
				                  ->limit(1);
				$data = $query->get()->row_object();
				$this->session->set_tempdata("option_{$option}", $data, 3600);
			//}
		}
		return $data->value;
	}

	private function parse_value(string $option, $value) {
		$type = $this->options[$option]['type'];
		switch($type) {
			case 'int':
				//TODO: How exactly should we handle INT? Just DB side?
				if(in_array($value, array_keys($this->options[$option]['valid_options']))) {
					$value = $this->options[$option]['valid_options'][$value];
				}
				break;
			case 'string':
				//TODO: We should have some basically XSS checking here?
				$value = htmlentities(trim(/*xss_clean(*/(string) $value/*)*/, '"'));
				break;
			default:
				//This should never happen.
				break;
		}
		if(!isset($value)) $value = FALSE; //FIXME: This won't play nice with BOOL type false?
		return $value;
	}

	//Used to quickly generate an array used with form_radio.
	public function generate_radio_array(string $option, string $selected_option) {
		if(array_key_exists($option, $this->options)) {
			$base_attributes = array(
				'name' => $option,
				'id'   => $option
			);
			//FIXME: Get a better solution than str_replace for removing special characters
			$elements = array();
			foreach (array_values($this->options[$option]['valid_options']) as $valid_option) {
				$elements[$option.'_'.str_replace(',', '_', $valid_option)] = array_merge($base_attributes, array(
					'value' => $valid_option
				));
			}
			if(isset($elements[$option.'_'.str_replace(',', '_', $selected_option)])) {
				$elements[$option.'_'.str_replace(',', '_', $selected_option)]['checked'] = TRUE;
			} else {
				//This should never occur, but fallbacks are always a good idea..
				$elements[$option.'_'.$this->options[$option]['default']]['checked'] = TRUE;
			}
			//CHECK: Should we attach this to body_data here?
			return $elements;
		} else {
			return FALSE;
		}
	}

	public function getValidOptions(string $option) : array {
		return $this->options[$option]['valid_options'];
	}
}