Userscript

Complexity

Total Complexity

17

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	37	7
A	update()	0	31	4
A	favourite()	0	25	5
A	site_fallback()	0	5	1

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

class Userscript extends AJAX_Controller {
	private $userID;

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

		$this->load->library('Limiter');
		$this->load->library('form_validation');

		//500 requests per hour to either AJAX request.
		if($this->limiter->limit('tracker_userscript', 1000)) {
			$this->output->set_status_header('429', 'Rate limit reached'); //rate limited reached
		}

		//API Key is required for all AJAX requests
		//We're not using set_rules here since we can't run form_validation twice.
		if($this->form_validation->required($this->input->post('api-key')) && ctype_alnum($this->input->post('api-key'))) {
			$this->userID = $this->User->get_id_from_api_key($this->input->post('api-key'));
			if(!$this->userID) {
				$this->output->set_status_header('400', 'Invalid API Key');
			}
		} else {
			$this->output->set_status_header('400', 'Missing/invalid parameters.');
		}

		$updateAvailable = TRUE;
		// TODO: We should record this for analytics purposes.
		if($userUserscriptVersion = $this->input->get_request_header('X-Userscript-Version')) {
			if(version_compare($userUserscriptVersion, '1.11.3', '<=')) {
				// 1.11.3 and below uses an old namespace and having the user update through our notification will install a duplicate version of the script
				// so instead we return this is FALSE
				$updateAvailable = FALSE;
			} else {
				$updateAvailable = version_compare($userUserscriptVersion, USERSCRIPT_VERSION, '<');
			}
		} else {

		}
		$this->output->set_header('X-Userscript-Update-Available: '.((int) $updateAvailable));
	}

	/**
	 * This is the main update URL for the userscript.
	 *
	 * REQ_PARAMS: api-key, manga[site], manga[title], manga[chapter]
	 * METHOD:     POST
	 * URL:        /ajax/userscript/update
	 */
	public function update() : void {
		if($this->output->is_custom_header_set()) { $this->output->reset_status_header(); return; }

		$this->form_validation->set_rules('manga[site]', 'Manga [Site]', 'required');
		$this->form_validation->set_rules('manga[title]', 'Manga [Title]', 'required');
		$this->form_validation->set_rules('manga[chapter]', 'Manga [Chapter]', 'required');

		if($this->form_validation->run() === TRUE) {
			$manga = $this->input->post('manga');

			$titleData = $this->Tracker->list->update($this->userID, $manga['site'], $manga['title'], $manga['chapter'], TRUE, TRUE);
			if($titleData) {
				$malID = $this->Tracker->list->getMalID($this->userID, $titleData['id']);
				$json = [
					'mal_sync' => $this->User_Options->get('mal_sync', $this->userID),
					'mal_id'   => $malID['id'] ?? NULL,
					'chapter'  => $titleData['chapter']
				];

				$this->output
				     ->set_status_header('200')
				     ->set_content_type('application/json', 'utf-8')
				     ->set_output(json_encode($json));
			} else {
				//TODO: We should probably try and have more verbose errors here. Return via JSON or something.
				$this->output->set_status_header('400', 'Unable to update?');
			}
		} else {
			$this->output->set_status_header('400', 'Missing/invalid parameters.');
		}
	}

	/**
	 * Favourite a chapter via the userscript.
	 *
	 * REQ_PARAMS: api-key, manga[site], manga[title], manga[chapter]
	 * METHOD:     POST
	 * URL:        /ajax/userscript/favourite
	 */
	public function favourite() : void {
		if($this->output->is_custom_header_set()) { $this->output->reset_status_header(); return; }

		if($this->limiter->limit('tracker_userscript_favourite', 250)) {
			$this->output->set_status_header('429', 'Rate limit reached'); //rate limited reached
		} else {
			$this->form_validation->set_rules('manga[site]', 'Manga [Site]', 'required');
			$this->form_validation->set_rules('manga[title]', 'Manga [Title]', 'required');
			$this->form_validation->set_rules('manga[chapter]', 'Manga [Chapter]', 'required');
			$this->form_validation->set_rules('manga[page]', 'Manga [Page]', '');

			if($this->form_validation->run() === TRUE) {
				$manga = $this->input->post('manga');

				$success = $this->Tracker->favourites->set($this->userID, $manga['site'], $manga['title'], $manga['chapter'], $manga['page'] ?? NULL);
				if($success['bool']) {
					$this->output->set_status_header('200', $success['status']); //Success!
				} else {
					$this->output->set_status_header('400', $success['status']);
				}
			} else {
				$this->output->set_status_header('400', 'Missing/invalid parameters.');
			}
		}
	}

	public function site_fallback() : void {
		$this->output
			->set_content_type('js') // You could also use ".jpeg" which will have the full stop removed before looking in config/mimes.php
			->set_output('console.log('.json_encode('@require site missing? - '.current_url()).');');
	}
}