Merge branch 'ws_get_catalog' into amdadev

Benjamin Renard
2 parents 777c3ca9 26dbe95d
Showing 4 changed files with 145 additions and 16 deletions Show diff stats
php/WebServices/WebServer.php
php/rest/getCatalog.php
php/rest/getCatalogsList.php
php/rest/getTimeTable.php
@@ -616,43 +616,91 @@ class WebServer
  
 		return  array('success' => true, 'status' => $res['status'],  $resultTag => WSConfigClass::getUrl().$res['result']);
 	}
-	
+
 /*
 *    TODO Can be done by TTCONVERT function of AMDA_Kernel - more hard !!!
 *    TODO Think about this if merge/union will be also done by AMDA_Kernel
 *
 *    get Time Table : shared for anonymous user (impex) ; user' for user
 */
-	public function getTimeTable($data) 
+        public function getTimeTable($data)       
+        {
+		$res = $this->init($data);
+
+		if (!$res['success']){
+			$this->throwError("requestError", "Cannot parse request");
+		}
+
+		$ttID = $res['vars']['ttID'];
+		$format = !empty($res['vars']['outputFormat']) ? $res['vars']['outputFormat'] : 'VOTable';
+
+		return $this->getTimeTableCatalog('timeTable', $ttID, $format);
+	}
+
+/*
+*    TODO Can be done by TTCONVERT function of AMDA_Kernel - more hard !!!
+*    TODO Think about this if merge/union will be also done by AMDA_Kernel
+*
+*    get Time Table : shared for anonymous user (impex) ; user' for user
+*/
+	public function getCatalog($data)       
 	{
 		$res = $this->init($data);
-		
+
 		if (!$res['success']){
-			$this->throwError("requestError", "Cannot parse request"); 
+			$this->throwError("requestError", "Cannot parse request");
 		}
-		
+
+		$catID = $res['vars']['catID'];
+		$format = !empty($res['vars']['outputFormat']) ? $res['vars']['outputFormat'] : 'VOTable';
+
+		return $this->getTimeTableCatalog('catalog', $catID, $format);
+	}
+	
+/*
+*    TODO Can be done by TTCONVERT function of AMDA_Kernel - more hard !!!
+*    TODO Think about this if merge/union will be also done by AMDA_Kernel
+*
+*    get Time Table : shared for anonymous user (impex) ; user' for user
+*/
+	private function getTimeTableCatalog($type, $id, $format) 
+	{
 		$this->initUserMgr();
  
-		$ttID = $res['vars']['ttID'];
-
 		if ($this->userID == WSConfigClass::getAnonymousUserName()) {
 			$sharedObjMgr = new SharedObjectsMgr();
-			$ttSrc = $sharedObjMgr->getDataFilePath('timeTable', $ttID);
+			$objSrc = $sharedObjMgr->getDataFilePath($type, $id);
 		}
 		else
-			$ttSrc = USERTTDIR.$ttID.'.xml';
+			$objSrc = USERTTDIR.$id.'.xml';
  
-		if (!file_exists($ttSrc)) {
-			$this->throwError("workspaceError", "No such table ".$ttID." for user ".$this->userID);
+		if (!file_exists($objSrc)) {
+			$this->throwError("workspaceError", "No such object ".$id." for user ".$this->userID);
 		}
  
-		$ttDst = substr(strtolower(__FUNCTION__), 3)."_".$this->userID."_".$this->requestTime."_$ttID.xml"; 
+		$prefix = ($type == 'catalog') ? 'catalog' : 'timetable';
+
+		$extension = (strtolower($format) == 'votable') ? "xml" : "txt";
+
+		$objDst = $prefix."_".$this->userID."_".$this->requestTime."_$id.$extension"; 
+
+		if (!isset($this->requestManager))
+			$this->requestManager = new RequestManagerClass();
+
+                try {
+			$obj = array(
+				'inputFile' => $objSrc,
+				'outputFormat' => $format,
+				'outputFileName' => $objDst, 
+			);
+                        $res = $this->requestManager->runWSRequest($this->userID, $this->IPclient, FunctionTypeEnumClass::TTCONVERT, $this->service, $obj);
+                } catch (Exception $e) {
+                        return array('success' => false, 'message' => 'Exception detected : '.$e->getMessage());
+                }
  
-		//TODO can be done by
-		// $res = $this->requestManager->runWSRequest($this->userID, $this->IPclient,FunctionTypeEnumClass::TTCONVERT, null, $ttID);
-		$this->xsl2vot($ttSrc,$ttDst);
+		$resKey = ($type == 'catalog') ? 'catFileURL' : 'ttFileURL';
  
-		return array('success' => true, 'ttFileURL' => WSConfigClass::getUrl().$ttDst);
+		return array('success' => true, $resKey => WSConfigClass::getUrl().$objDst);
 	}
  
 /*
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * @api {get} getCatalog.php getCatalog
+ * @apiDescription Provides the contents of a Time Table (TT).
+ * @apiName getCatalog
+ * @apiGroup webservices
+ *
+ * @apiParam {String} catID Identifier of the Catalog, as defined in the file returned by the « getCatalogsList » service.
+ * @apiParam {String} [userID] Identifier of the user in AMDA (*mandatory for user owned data*)
+ * @apiParam {String} [password] Password of the user in AMDA (*mandatory for user owned data*)
+ * @apiParam {String} [outputFormat] Format of the returned file (VOTable by default). Available options: `VOTable`, `ASCII` and `HPEvent`.
+ *
+ * @apiSuccess {String} success `true`
+ * @apiSuccess {String} catFileURL URL of the XML file containing the Catalog (VOTable format)
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     [success] => 1
+ *     [ttFileURL] => http://amda.irap.omp.eu/AMDA/data/WSRESULT/catalog_userID_20180919_cat_0.xml
+ *
+ * @apiErrorExample Error-Response:
+ * {"error":"No such table sharedcatalog_100 for user impex"}
+ */
+
+require_once '../config.php';
+
+  $amda_ws = new WebServer();
+
+  $result = $amda_ws->getCatalog($_GET);
+
+ if ($result['success']){
+	echo $result['catFileURL'];
+   }
+    else {
+     echo $result['message'];  
+    }
+?>
+
+
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * @api {get} getCatalogsList.php getCatalogsList
+ * @apiDescription Provides the private list of Catalogs owned by a user. When called without
+ * userID, this web-service returns the list of shared Catalogs.
+ *
+ * @apiName getCatalogsList
+ * @apiGroup webservices
+ *
+ * @apiParam {String} [userID] Identifier of the user in AMDA.
+ * @apiParam {String} [password] Password of the user in AMDA.
+ *
+ * @apiSuccess {String} success `true`
+ * @apiSuccess {String} CatalogsList URL of the XML file, which contains the list of Catalogs.
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     [success] => 1
+ *     [CatalogsList] =>  http://amda.irap.omp.eu/data/WSRESULT/catalogs_impex_20180905.xml
+ *
+ * @apiErrorExample Error-Response:
+ *     {"error": "Workspace Error : Cannot load Catalogs list for userID"}
+ */
+
+	require_once '../config.php';
+
+	$amda_ws = new WebServer();
+
+	$result = $amda_ws->getCatalogsList($_GET);
+
+	if ($result['success'])
+	{
+		echo $result['CatalogsList'];
+	}
+	else 
+	{
+		echo $result['message'];  
+	}
+?>
@@ -9,6 +9,7 @@
  * @apiParam {String} ttID Identifier of the Time Table, as defined in the file returned by the « getTimeTableList » service.
  * @apiParam {String} [userID] Identifier of the user in AMDA (*mandatory for user owned data*)
  * @apiParam {String} [password] Password of the user in AMDA (*mandatory for user owned data*)
+ * @apiParam {String} [outputFormat] Format of the returned file (VOTable by default). Available options: `VOTable`, `ASCII` and `HPEvent`.
  *
  * @apiSuccess {String} success `true`
  * @apiSuccess {String} ttFileURL URL of the XML file containing the Time Table (VOTable format)