EpnTapMgr.php 4.81 KB
<?php
/**  @class EpnTapMgr
*	@brief Manager to communicates with EPN-TAP services.
*/

class EpnTapMgr {
	private $logEpnTap;

	private function dateToJD($gregorian_date) {
		list($day, $month, $year, $hours, $minutes, $seconds) = preg_split('/[\s\/:]+/', $gregorian_date);
		return GregorianToJD($month, $day, $year) + $hours/24 + $minutes/(24*60) + $seconds/(24*60*60);
	}

	public function JDTodate($jd) {
		if(!is_numeric($jd)) {
			return '';
		}
		list($month, $day, $year) = preg_split('/[\s\/:]+/', JDToGregorian(intval($jd)));
		$date = sprintf('%02d', $day) . '/' . sprintf('%02d', $month) . '/' . sprintf('%04d', $year);
		return ($date == '00/00/0000') ? '' : $date;
	}

	public function createFilter($dataproduct_type, $target_name, $time_min, $time_max) {
		$filter = array();
		if($dataproduct_type)
			array_push($filter, "dataproduct_type = '$dataproduct_type'");
		if($target_name)
			array_push($filter, "target_name = '$target_name'");
		if($time_min)
			array_push($filter, "time_min >= " . $this->dateToJD($time_min));
		if($time_max)
			array_push($filter, "time_max <= " . $this->dateToJD($time_max));
		return (count($filter) > 0 ? ' WHERE ' . join(' AND ', $filter) : '');
	}

	public function request($access_url, $query) {
		$votMgr = new VOTableMgr;
		$params = 'FORMAT=votable&LANG=ADQL&REQUEST=doQuery';
		$url = $access_url . '/sync?' . $params . '&QUERY=' . urlencode(preg_replace('/\s+/', ' ', $query)); // remove also multiple whitespaces

		$votMgr->load($url);

		$result = $votMgr->parseStream();
		return $votMgr->getVotableError() ? array('error' => $votMgr->getVotableError()) : $result;
	}

	/* filter order: product type, target name, time min, time max */
	public function getGranules($table_name, $access_url, $filter, $limit, $offset) {

		$query = "SELECT TOP {$limit} * FROM {$table_name} " . $this->createFilter($filter[0], $filter[1], $filter[2], $filter[3]) . " OFFSET {$offset}";
		$result = $this->request($access_url, $query);

		$result_path = EpnTapDataPath . "test_result.json";
		$servicesJsonFile = fopen($result_path, "w");

		if(array_key_exists("error", $result)) {
			return $result;
		}

		$non_empty_values = Array();
		for ($i = 0 ; $i < count($result) ; $i++) {
			$result[$i]['num'] = $i + $offset + 1;
			$result[$i]['time_min'] = $this->JDTodate($result[$i]['time_min']);
			$result[$i]['time_max'] = $this->JDTodate($result[$i]['time_max']);

			foreach($result[$i] as $key => $value) {
				$non_empty_values[$key] = (array_key_exists($key, $non_empty_values) ? $non_empty_values[$key] : False) || $value === '' || $value === 'NAN';
			}
		}

		$non_null_cols = array_keys(array_filter($non_empty_values));
		for ($i = 0 ; $i < count($result) ; $i++) {
			$result[$i] = array_diff_key($result[$i], array_flip($non_null_cols));
		}
		// error_log('Query result: ' . json_encode($result));
		return $result;
	}

	/* Return the list of available services by querying some usual registries. */
	public function getServices() {
		$registriesURL = ["http://registry.euro-vo.org/regtap/tap", "http://dc.zah.uni-heidelberg.de/tap", "http://gavo.aip.de/tap", "http://reg.g-vo.org/tap"];
		$columns = ['short_name', 'res_title', 'ivoid', 'access_url', 'table_name', 'content_type', 'creator_seq', 'content_level', 'reference_url', 'created', 'updated'];
		$getServicesQuery = "SELECT DISTINCT " . implode(', ', $columns) . " FROM rr.resource
		                     NATURAL JOIN rr.res_schema NATURAL JOIN rr.res_table NATURAL JOIN rr.interface NATURAL JOIN rr.res_detail NATURAL JOIN rr.capability
		                     WHERE standard_id='ivo://ivoa.net/std/tap' AND intf_type='vs:paramhttp' AND detail_xpath='/capability/dataModel/@ivo-id'
		                     AND 1=ivo_nocasematch(detail_value, 'ivo://vopdc.obspm/std/EpnCore%') AND table_name LIKE '%.epn_core' ORDER BY short_name, table_name";

		for($i=0; $i<count($registriesURL); $i++) {
			$services = $this->request($registriesURL[$i], $getServicesQuery);
			if(! array_key_exists("error", $services)) {
				for($j=0; $j<count($services); $j++) {
					$services[$j]['id'] = $this->generateServiceId($services[$j]);
				}
				return $services;
			} else if($i === count($registriesURL)-1) {
				error_log("Can not access any of these services : " . implode(', ', $registriesURL) . ".");
				return;
			}
		}
	}

	/* Generate a unique service identifier from the service ivoid and the table name. */
	public function generateServiceId($service) {
		return str_replace(['ivo://', '.epn_core'], '', $service['ivoid'] . '/' . $service['table_name']);
	}

	/* filter order: product type, target name, time min, time max */
	public function getNbRows($table_name, $access_url, $filter) {
		$query = "SELECT COUNT(*) AS nb_rows FROM {$table_name} " . $this->createFilter($filter[0], $filter[1], $filter[2], $filter[3]);
		$result = $this->request($access_url, $query)[0]['nb_rows'];
		return $result;
	}

}
?>