Add the possibility to have template parameters definition in getObsDataTree API

Benjamin Renard
1 parent 91eef29d
Showing 3 changed files with 63 additions and 6 deletions Show diff stats
php/WebServices/WebServer.php
php/classes/AmdaAction.php
php/rest/getObsDataTree.php
@@ -50,7 +50,11 @@ class WebServer
 			$this->userPWD = $vars['password'];
 		else 
 			$this->userPWD = WSConfigClass::getAnonymousUserPwd();
-		
+
+		if (isset($vars['referenceTime']))
+			$this->referenceTime = $vars['referenceTime'];
+		else
+			$this->referenceTime = NULL;
 		return array('success' => true, 'vars' => $vars);
 	}
  
@@ -114,6 +118,12 @@ class WebServer
  
 		return $dataSetDom;
 	}
+
+	private function getUserInfo($data) 
+	{
+		$res = $this->init($data);
+		$this->initUserMgr(); 
+	}
  
 /*
 *  get user TimeTables list; Shared for anonymous user ('impex')
@@ -327,6 +337,42 @@ class WebServer
 		if (!$locParamSrcDom->save(WSConfigClass::getWsResultDir().$locParamDst))
 			$this->throwError('workspaceError', 'Cannot save Amda Local DataBase Parameters description file'.$this->userID);   
 	}
+
+    private function injectTemplateInfo($locParamFile) {
+        $paramTemplateListFile = WSConfigClass::getParamTemplateListFilePath();
+
+        $paramTemplateListFileDom = new DomDocument("1.0");
+        if (!@$paramTemplateListFileDom->load($paramTemplateListFile))
+			$this->throwError("getObsDataTree", "Cannot load  Amda Templated Parameters description file".$this->userID);
+
+        $paramTemplateNodes = $paramTemplateListFileDom->getElementsByTagName('paramTemplate');
+
+        $locParamFileDom = new DomDocument("1.0");
+		$locParamFileDom->preserveWhiteSpace = FALSE; /// Important !!! otherwise removeChild() leaves empty text nodes
+		
+		if (!@$locParamFileDom->load(WSConfigClass::getWsResultDir().$locParamFile))
+			$this->throwError("getObsDataTree", "Cannot load  Amda Local DataBase Parameters description file ".$this->userID);
+ 
+		$xp =  new domxpath($locParamFileDom);
+
+        foreach ($paramTemplateNodes as $paramTemplateNode) {
+            $paramTemplateId = $paramTemplateNode->getAttribute('paramId');
+            $paramFileName = $paramTemplateNode->getAttribute('fileName');
+            $parameterNodes = $xp->query("//parameter[@template='$paramFileName']");
+            $argumentsNodes = $paramTemplateNode->getElementsByTagName("arguments");
+            if ($argumentsNodes->length < 1)
+                continue;
+            $argumentsNode = $argumentsNodes->item(0);
+            foreach ($parameterNodes as $parameterNode) {
+                $node = $locParamFileDom->importNode($argumentsNode, TRUE);
+                $parameterNode->appendChild($node);
+            }
+        }
+
+ 
+		if (!$locParamFileDom->save(WSConfigClass::getWsResultDir().$locParamFile))
+			$this->throwError('workspaceError', 'Cannot save Amda Local DataBase Parameters description file'.$this->userID); 
+    }
  
 	private function checkInputTime($startTime, $stopTime) 
 	{
@@ -349,19 +395,26 @@ class WebServer
 /*
 *   public data only : anonymous user (impex)
 */
-	public function getObsDataTree() 
+	public function getObsDataTree($data) 
 	{         
-		$res = $this->init();	
+		$res = $this->init($data);	
 		$this->initUserMgr();
+
+        $injectTemplateInfo = array_key_exists('templateInfo', $data) && (!empty($data["templateInfo"]));
  
 		$locParamSrc = USERWSDIR.'LocalParams.xml'; 
  
-		$locParamDst = substr(strtolower(__FUNCTION__),3).'_'.$this->userID.'_'.$this->requestTime.'_AmdaLocalDataBaseParameters.xml';
+		$locParamDst = substr(strtolower(__FUNCTION__),3).'_'.$this->userID.'_'.($injectTemplateInfo ? 'withtemplate_' : '').$this->requestTime.'_AmdaLocalDataBaseParameters.xml';
  
 // 		if (!copy($locParamSrc,WSConfigClass::getWsResultDir().$locParamDst))
 // 			$this->throwError('workspaceError', 'No Amda Local DataBase Parameters description file');   
  
 		$this->excludePrivateNodes($locParamSrc,$locParamDst);
+
+        if ($injectTemplateInfo) {
+            $this->injectTemplateInfo($locParamDst);
+        }
+
 		return  array('success' => true,'WorkSpace' => array("LocalDataBaseParameters" => WSConfigClass::getUrl().$locParamDst));
 	}
  
@@ -299,10 +299,10 @@ class AmdaAction
  
 							if ($child->tagName == 'parameter') {
 								$isParameter = true;
-                                if ($child->hasAttribute('TemplatedParameter'))
+                                if ($child->hasAttribute('template'))
                                     $needsArgs = true;
  
-								if ($child->hasAttribute('PredefinedTemplatedParameter'))
+								if ($child->hasAttribute('predefined'))
 									$predefinedArgs = true;
  
 								if ($child->parentNode->hasAttribute('dataStart')) {
@@ -5,6 +5,10 @@
  * @apiDescription Provides the hierarchy of public access data in AMDA.
  * @apiName getObsDataTree
  * @apiGroup webservices
+ * 
+ * @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 {Boolean} [templateInfo] `1` to include info about templated parameters - Default `0`.
  *
  * @apiSuccess {String} success true.
  * @apiSuccess {String} workspace URL of the XML file containing the list of "public" parameters in AMDA.