GMA_API.class.php

<?php
class GMA_API {
	private $gmaUrl;
	private $casUrl = 'https://thekey.me/cas/';
	private $casUser;
	private $casPassword;

	private $_curlOpts = null;

	private $gmaCookie;
	private $csrfToken = null;

	private $language = null;

	public function __construct($gmaUrl) {
		$this->gmaUrl = $gmaUrl;
	}

	private function _getCurlHandle() {
		$ch = curl_init();

		// set default options
		curl_setopt_array($ch, array(
			CURLOPT_RETURNTRANSFER => true,
		));
		if(is_array($this->_curlOpts)) {
			curl_setopt_array($ch, $this->_curlOpts);
		}

		return $ch;
	}

	public function setCasUrl($casUrl) {
		$this->gmaCookie = null;
		$this->casUrl = $casUrl;
		return $this;
	}

	public function setCasUsername($username) {
		$this->gmaCookie = null;
		$this->casUser = $username;
		return $this;
	}

	public function setCasPassword($password) {
		$this->gmaCookie = null;
		$this->casPassword = $password;
		return $this;
	}

	public function setCurlOpts(array $opts = null) {
		$this->_curlOpts = $opts;
		return $this;
	}

	public function getGmaCookie() {
		return $this->gmaCookie;
	}

	public function setGmaCookie($gmaCookie = null) {
		$this->gmaCookie = $gmaCookie;
		return $this;
	}

	public function getCsrfToken() {
		return $this->csrfToken;
	}

	public function setCsrfToken($token = null) {
		$this->csrfToken = $token;
		return $this;
	}

	public function setLanguage($language = null) {
		$this->language = $language;
		return $this;
	}

	private function _establishSession() {
		// clear previous gma cookie
		$this->gmaCookie = null;

		// determine GMA service to pass to CAS
		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_URL    => $this->gmaUrl,
			CURLOPT_HEADER => true,
		));
		$data = curl_exec($ch);
		curl_close($ch);

		// determine the initial service url
		preg_match('/Location:(.*?)\n/', $data, $matches);
		$url = parse_url(trim(array_pop($matches)));
		preg_match('/(?:^|&)service=(.*?)(?:&|$)/', $url['query'], $matches);
		$service = urldecode(array_pop($matches));

		// parse Set-Cookie header (TODO: this is brittle)
		preg_match('/Set-Cookie2?:(.*?)\n/', $data, $matches);
		$parts = explode(';', array_pop($matches));
		$tmpCookie = trim($parts[0]);

		// short-circuit if no service or initial cookie was found
		if(empty($service) || empty($tmpCookie)) {
			return false;
		}


		// login to CAS
		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_URL        => $this->casUrl . "v1/tickets",
			CURLOPT_POSTFIELDS => "username=" . urlencode($this->casUser) . "&password=" . urlencode($this->casPassword),
			CURLOPT_HEADER     => true,
		));
		$data = curl_exec($ch);
		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
		curl_close($ch);

		// parse TGT
		preg_match('/Location:(.*?)\n/', $data, $matches);
		$tgtUrl = trim(array_pop($matches));

		// short-circuit if login was unsuccessful
		if($code != 201 || empty($tgtUrl)) {
			return false;
		}


		// get ST
		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_URL        => $tgtUrl,
			CURLOPT_POSTFIELDS =>  "service=" . urlencode($service),
		));
		$data = curl_exec($ch);
		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
		curl_close($ch);

		$ticket = $data;

		// short-circuit if no ticket was received
		if($code != 200 || empty($ticket)) {
			return false;
		}


		// use ST w/ GMA (follow redirects & capture cookie)
		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_URL    => $service . '&ticket=' . $ticket,
			CURLOPT_COOKIE => $tmpCookie,
			CURLOPT_HEADER => true,
		));
		$data = curl_exec($ch);
		curl_close($ch);


		// GMA performs a redirect which sets a new cookie, this is the actual cookie we need
		preg_match('/Location:(.*?)\n/', $data, $matches);
		$newUri = trim(array_pop($matches));

		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_URL    => $newUri,
			CURLOPT_COOKIE => $tmpCookie,
			CURLOPT_HEADER => true,
		));
		$data = curl_exec($ch);
		curl_close($ch);

		// extract the correct Set-Cookie header
		preg_match_all('/Set-Cookie2?:(.*?)\n/', $data, $matches, PREG_PATTERN_ORDER);
		$parts = explode(';', array_pop($matches[1]));
		$this->gmaCookie = $parts[0];

		// fetch a CSRF token
		$this->_fetchCsrfToken();

		// return session established successfully
		return true;
	}

	private function _fetchCsrfToken() {
		// only fetch a CSRF token when we have a GMA cookie
		if(!empty($this->gmaCookie)) {
			// generate request
			$ch = $this->_getCurlHandle();
			curl_setopt_array($ch, array(
				CURLOPT_URL           => $this->gmaUrl . '?q=services/session/token',
				CURLOPT_COOKIE        => $this->gmaCookie,
			));
			$data = curl_exec($ch);
			$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
			curl_close($ch);

			// only accept CSRF tokens from 200 OK responses
			if($code == 200) {
				$this->csrfToken = $data;
			}
		}
	}

	public function apiRequest($endpoint, $method = 'GET', $postdata = null, $retryCount = 3) {
		if(empty($this->gmaCookie)) {
			$this->_establishSession();
		}

		if(!is_null($this->language)) {
			$endpoint .= '&languageId=' . $this->language;
		}

		// parse postdata into json
		if(is_null($postdata)) {
			$json = null;
		} else if(is_string($postdata)) {
			// raw json data
			$json = $postdata;
		} else {
			$json = json_encode($postdata);
		}

		// build request
		$ch = $this->_getCurlHandle();
		curl_setopt_array($ch, array(
			CURLOPT_CUSTOMREQUEST => $method,
			CURLOPT_URL           => $this->gmaUrl . $endpoint,
			CURLOPT_COOKIE        => $this->gmaCookie,
		));
		$headers = array();
		if(!is_null($this->csrfToken)) {
			$headers[] = 'X-CSRF-Token: ' . $this->csrfToken;
		}
		if($json !== null) {
			$headers[] = 'Content-Type: application/json';
			curl_setopt_array($ch, array(
				CURLOPT_POST       => true,
				CURLOPT_POSTFIELDS => $json,
			));
		}
		if(count($headers) > 0) {
			curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
		}

		$data = curl_exec($ch);
		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
		curl_close($ch);

		// valid response
		if($code == 200) {
			return json_decode($data, true);
		} elseif($code == 404) {
			return null;
		}

		// retry the request because of an invalid response
		// reset the gmaCookie & CSRF token
		$this->gmaCookie = null;
		$this->csrfToken = null;

		// infinite loop sanity check
		if($retryCount <= 0) {
			die("API error!!!!\n");
		}

		// reissue API request
		return $this->apiRequest($endpoint, $method, $postdata, $retryCount - 1);
	}

	// API wrapper functions
	public function getLanguages() {
		return $this->apiRequest('?q=gmaservices/gma_language');
	}

	public function getNodes() {
		return $this->apiRequest('?q=gmaservices/gma_node');
	}

	public function getNode($id) {
		return $this->apiRequest('?q=gmaservices/gma_node/' . $id);
	}

	public function getNodeMeasurements($id) {
		return $this->apiRequest('?q=gmaservices/gma_node/' . $id . '/measurements');
	}

	public function getNodeParent($id) {
		return $this->apiRequest('?q=gmaservices/gma_node/' . $id . '/parent');
	}

	public function getUsers($type = 'active') {
		return $this->apiRequest('?q=gmaservices/gma_user&type=' . $type);
	}

	public function getStaffReportMeasurements($id) {
		return $this->apiRequest('?q=gmaservices/gma_staffReport/' . $id);
	}

	public function getStaffReports($all = false, $nodeIds = null, $renId = null, DateTime $date = null, $submitted = null) {
		$data = array(
			'maxResult' => 0,
		);
		if(!is_null($nodeIds)) {
			if(!is_array($nodeIds)) {
				$nodeIds = array($nodeIds);
			}

			$data['nodeId'] = $nodeIds;
		}
		if(!is_null($date)) {
			$data['dateWithin'] = $date->format('Ymd');
		}
		if(!is_null($submitted)) {
			$data['submitted'] = $submitted;
		}
		if($all && !is_null($renId)) {
			$data['renId'] = $renId;
		}

		return $this->apiRequest('?q=gmaservices/gma_staffReport/search' . ($all ? 'All' : 'Own'), 'POST', $data);
	}

	public function setStaffReportMeasurements($id, array $measurements = array()) {
		$data = array();
		foreach($measurements as $key => $value) {
			$data[] = array(
				'measurementId' => $key,
				'type'          => is_numeric($value) ? 'numeric' : 'text',
				'value'         => $value,
			);
		}

		return $this->apiRequest('?q=gmaservices/gma_staffReport/' . $id, 'PUT', $data);
	}
}