SpriteSheet.api.php

<?php
/**
 * SpriteSheet
 * SpriteSheet API
 *
 * @author		Alexia E. Smith
 * @license		LGPL v3.0
 * @package		SpriteSheet
 * @link		https://github.com/CurseStaff/SpriteSheet
 *
 **/

class SpriteSheetAPI extends ApiBase {
	/**
	 * API Initialized
	 *
	 * @var		boolean
	 */
	private $initialized = false;

	/**
	 * Initiates some needed classes.
	 *
	 * @access	public
	 * @return	void
	 */
	private function init() {
		if (!$this->initialized) {
			global $wgUser, $wgRequest;

			$this->wgUser		= $wgUser;
			$this->wgRequest	= $wgRequest;

			$this->initialized = true;
		}
	}

	/**
	 * Main Executor
	 *
	 * @access	public
	 * @return	void	[Outputs to screen]
	 */
	public function execute() {
		$this->init();

		$this->params = $this->extractRequestParams();

		parse_str($this->params['form'], $this->form);

		$this->title = Title::newFromText($this->form['page_title'], NS_FILE);
		if ($this->title !== null) {
			$this->spriteSheet = SpriteSheet::newFromTitle($this->title);
		}

		if (!$this->title || ($this->form['spritesheet_id'] > 0 && $this->spriteSheet !== false && $this->spriteSheet->getId() != $this->form['spritesheet_id'])) {
			$response = [
				'success' => false,
				'message' => wfMessage('ss_api_bad_title')->text()
			];
		} else {
			//These do not require permission checks.
			switch ($this->params['do']) {
				case 'getSpriteSheet':
					$response = $this->getSpriteSheet();
					break;
				case 'getAllSpriteNames':
					$response = $this->getAllSpriteNames();
					break;
			}

			if (!$response) {
				//The following do require permission checks.
				if (!$this->canEditSprites()) {
					$response = [
						'success' => false,
						'message' => wfMessage('ss_api_no_permission')->text()
					];
				} else {
					switch ($this->params['do']) {
						case 'saveSpriteSheet':
							$response = $this->saveSpriteSheet();
							break;
						case 'saveSpriteName':
							$response = $this->saveSpriteName();
							break;
						case 'updateSpriteName':
							$response = $this->updateSpriteName();
							break;
						case 'deleteSpriteName':
							$response = $this->deleteSpriteName();
							break;
						default:
							$this->dieUsageMsg(['invaliddo', $this->params['do']]);
							break;
					}
				}
			}
		}

		foreach ($response as $key => $value) {
			$this->getResult()->addValue(null, $key, $value);
		}
	}

	/**
	 * Can this user edit sprites?
	 *
	 * @access	private
	 * @return	boolean	Can Edit Sprites
	 */
	private function canEditSprites() {
		return $this->wgUser->isAllowed('edit_sprites') && $this->spriteSheet->getTitle()->userCan('edit');
	}

	/**
	 * Requirements for API call parameters.
	 *
	 * @access	public
	 * @return	array	Merged array of parameter requirements.
	 */
	public function getAllowedParams() {
		return [
			'do' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => true
			],
			'form' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'type' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'values' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'spritesheet_id' => [
				ApiBase::PARAM_TYPE		=> 'integer',
				ApiBase::PARAM_REQUIRED => false
			],
			'spritename_id' => [
				ApiBase::PARAM_TYPE		=> 'integer',
				ApiBase::PARAM_REQUIRED => false
			],
			'old_sprite_name' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'new_sprite_name' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'sprite_name' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			],
			'title' => [
				ApiBase::PARAM_TYPE		=> 'string',
				ApiBase::PARAM_REQUIRED => false
			]
		];
	}

	/**
	 * Descriptions for API call parameters.
	 *
	 * @access	public
	 * @return	array	Merged array of parameter descriptions.
	 */
	public function getParamDescription() {
		return [
			'do'				=> 'Action to take.',
			'form'				=> 'Form data from a sprite sheet editor form.',
			'type'				=> 'Sprite or Slice',
			'values'			=> 'Values for the sprite or slice being saved.',
			'spritesheet_id'	=> 'SpriteSheet ID of the the SpriteSheet to load.',
			'spritename_id'		=> 'SpriteName ID of the the SpriteName to load.',
			'old_sprite_name'	=> 'Old Sprite Name for the designated SpriteName object.',
			'new_sprite_name'	=> 'New Sprite Name for the designated SpriteName object.',
			'sprite_name'		=> 'Sprite Name for the designated SpriteName object.',
			'title'				=> 'Page Title'
		];
	}

	/**
	 * Get Sprite Sheet information.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function getSpriteSheet() {
		$success = false;
		$message = 'ss_api_unknown_error';

		if ($this->spriteSheet !== false) {
			$data = [
				'title'		=> $this->spriteSheet->getTitle()->getDBkey(),
				'columns'	=> $this->spriteSheet->getColumns(),
				'rows'		=> $this->spriteSheet->getRows(),
				'inset'		=> $this->spriteSheet->getInset()
			];

			$success = true;
			$message = 'ss_api_okay';
		} else {
			$message = 'ss_api_fatal_error_sprite_sheet_not_found';
		}

		$return = [
			'success' => $success,
			'message' => wfMessage($message)->text()
		];

		if (is_array($data)) {
			$return['data'] = $data;
		}

		return $return;
	}

	/**
	 * Save Sprite Sheet information.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function saveSpriteSheet() {
		$success = false;
		$message = 'ss_api_unknown_error';

		if ($this->wgRequest->wasPosted()) {
			if ($this->spriteSheet !== false) {
				$this->spriteSheet->setColumns($this->form['sprite_columns']);
				$this->spriteSheet->setRows($this->form['sprite_rows']);
				$this->spriteSheet->setInset($this->form['sprite_inset']);

				$success = $this->spriteSheet->save();

				if ($success) {
					$message = 'ss_api_okay';
				} else {
					$message = 'ss_api_fatal_error_saving';
				}
			} else {
				$message = 'ss_api_fatal_error_sprite_sheet_not_found';
			}
		} else {
			$message = 'ss_api_must_be_posted';
		}

		$return = [
			'success' => $success,
			'message' => wfMessage($message)->text()
		];

		if ($success) {
			$return['spriteSheetId'] = $this->spriteSheet->getId();
		}

		return $return;
	}

	/**
	 * Save a named sprite/slice.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function saveSpriteName() {
		$success = false;
		$message = 'ss_api_unknown_error';

		if ($this->wgRequest->wasPosted()) {
			$values = @json_decode($this->params['values'], true);

			if ($this->spriteSheet !== false) {
				if (!$this->spriteSheet->exists()) {
					//Save the sheet first otherwise calls to SpriteName will fail.
					$this->spriteSheet->save();
				}
				$spriteName = $this->spriteSheet->getSpriteName($this->form['sprite_name']);
				$validName = true;

				if (!$spriteName->isNameValid()) {
					$message = 'ss_api_invalid_sprite_name';
					$validName = false;
				}

				if ($validName) {
					$spriteName->setDeleted(false);

					switch ($this->params['type']) {
						case 'sprite':
							if ($this->spriteSheet->validateSpriteCoordindates($values['xPos'], $values['yPos'])) {
								$spriteName->setValues($values);
								$spriteName->setType('sprite');

								$success = $spriteName->save();

								if ($success) {
									$message = 'ss_api_okay';
								} else {
									$message = 'ss_api_fatal_error_saving';
								}
							} else {
								$message = 'ss_api_invalid_coordinates';
							}
							break;
						case 'slice':
							if ($this->spriteSheet->validateSlicePercentages($values['xPercent'], $values['yPercent'], $values['widthPercent'], $values['heightPercent'])) {
								$spriteName->setValues($values);
								$spriteName->setType('slice');

								$success = $spriteName->save();

								if ($success) {
									$message = 'ss_api_okay';
								} else {
									$message = 'ss_api_fatal_error_saving';
								}
							} else {
								$message = 'ss_api_invalid_precentages';
							}
							break;
						default:
							break;
					}
				}
			} else {
				$message = 'ss_api_fatal_error_sprite_sheet_not_found';
			}
		} else {
			$message = 'ss_api_must_be_posted';
		}

		$return = [
			'success' => $success,
			'message' => wfMessage($message)->text()
		];

		if ($success) {
			$return['data'] = [
				'id'				=> $spriteName->getId(),
				'name'				=> $spriteName->getName(),
				'type'				=> $spriteName->getType(),
				'values'			=> $spriteName->getValues(),
				'tag'				=> $spriteName->getParserTag(),
				'spritesheet_id'	=> $this->spriteSheet->getId()
			];
		}

		return $return;
	}

	/**
	 * Update a named sprite/slice's name.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function updateSpriteName() {
		$success = false;
		$message = 'ss_api_unknown_error';

		if ($this->wgRequest->wasPosted()) {
			$spriteNameId = intval($this->params['spritename_id']);

			if ($this->spriteSheet !== false) {
				$spriteName = $this->spriteSheet->getSpriteName($this->params['old_sprite_name']);
				$newSpriteName = $this->spriteSheet->getSpriteName($this->params['new_sprite_name']);
				$validName = true;

				if ($newSpriteName->exists() || $spriteName->getId() != $spriteNameId) {
					$message = 'ss_api_sprite_name_in_use';
					$validName = false;
				}

				$spriteName->setName($this->params['new_sprite_name']);

				if (!$spriteName->isNameValid()) {
					$message = 'ss_api_invalid_sprite_name';
					$validName = false;
				}

				if ($validName) {
					$success = $spriteName->save();

					if ($success) {
						$message = 'ss_api_okay';
					} else {
						$message = 'ss_api_fatal_error_saving';
					}
				}
			} else {
				$message = 'ss_api_fatal_error_sprite_sheet_not_found';
			}
		} else {
			$message = 'ss_api_must_be_posted';
		}

		$return = [
			'success' => $success,
			'message' => wfMessage($message)->text()
		];

		if ($success) {
			$return['data'] = [
				'id'				=> $spriteName->getId(),
				'name'				=> $spriteName->getName(),
				'type'				=> $spriteName->getType(),
				'values'			=> $spriteName->getValues(),
				'tag'				=> $spriteName->getParserTag(),
				'spritesheet_id'	=> $this->spriteSheet->getId()
			];
		}

		return $return;
	}

	/**
	 * Delete a named sprite/slice.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function deleteSpriteName() {
		$success = false;
		$message = 'ss_api_unknown_error';

		if ($this->wgRequest->wasPosted()) {
			$spriteNameId = intval($this->params['spritename_id']);

			if ($this->spriteSheet !== false) {
				$spriteName = $this->spriteSheet->getSpriteName($this->params['sprite_name']);

				if (!$spriteName->exists() || $spriteName->getId() != $spriteNameId) {
					$message = 'ss_api_fatal_error_deleting_name';
				} else {
					$spriteName->setDeleted();
					$success = $spriteName->save();
				}

				if ($success) {
					$message = 'ss_api_okay';
				}
			} else {
				$message = 'ss_api_fatal_error_sprite_sheet_not_found';
			}
		} else {
			$message = 'ss_api_must_be_posted';
		}

		$return = [
			'success' => $success,
			'message' => wfMessage($message)->text()
		];

		return $return;
	}

	/**
	 * Return all sprite names for the specified sprite sheet.
	 *
	 * @access	private
	 * @return	array	API Response
	 */
	private function getAllSpriteNames() {
		$success = false;
		$message = 'ss_api_unknown_error';

		$data = [];
		if ($this->spriteSheet !== false && $this->spriteSheet->exists()) {
			$spriteNames = $this->spriteSheet->getAllSpriteNames();

			asort($spriteNames);

			foreach ($spriteNames as $name => $spriteName) {
				$data[$spriteName->getName()] = [
					'id'				=> $spriteName->getId(),
					'name'				=> $spriteName->getName(),
					'type'				=> $spriteName->getType(),
					'values'			=> $spriteName->getValues(),
					'tag'				=> $spriteName->getParserTag(),
					'spritesheet_id'	=> $this->spriteSheet->getId(),
					'deleted'			=> $spriteName->isDeleted()
				];
			}

			$message = 'ss_api_okay';
			$success = true;
		} else {
			$message = 'ss_api_fatal_error_sprite_sheet_not_found';
		}

		$return = [
			'success'	=> $success,
			'message'	=> wfMessage($message)->text()
		];

		if ($success) {
			$return['data'] = $data;
		}

		return $return;
	}

	/**
	 * Get version of this API Extension.
	 *
	 * @access	public
	 * @return	string	API Extension Version
	 */
	public function getVersion() {
		return '1.0';
	}

	/**
	 * Return a ApiFormatJson format object.
	 *
	 * @access	public
	 * @return	object	ApiFormatJson
	 */
	public function getCustomPrinter() {
		return $this->getMain()->createPrinterByName('json');
	}
}