Add readConfiguration and readAllocations actions

Author: gadeynebram

Randapi.php

@@ -14,6 +14,8 @@
 class Randapi extends AbstractExternalModule
 {
 
+    private $contentType = "json";
+
     public function __construct(){
         parent::__construct();
     }
@@ -649,6 +651,10 @@ public function handleRequest(stdClass $jsonObject, string $jsonText):void{
                         $newAid = $this->handleChangeTarget($jsonObject);
                         echo json_encode($newAid);
                         break;
+                    case "readConfiguration": $this->readConfiguration($jsonObject);
+                        break;
+                    case "readAllocations": $this->readAllocations($jsonObject);
+                        break;
                     default:
                         throw new RandapiException("Invalid Action was specified");
                 }
@@ -663,6 +669,30 @@ public function handleRequest(stdClass $jsonObject, string $jsonText):void{
         }
     }
 
+    public function handleGetRequest(){
+        $params = new stdClass();
+        $params->token = $_GET["token"];
+        if($this->checkToken($params)){
+            if(isset($_GET["action"]) && isset($_GET["pid"])){
+                switch($_GET["action"]){
+                    case "readConfiguration": $this->readConfiguration();
+                        break;
+                    case "readAllocations": $this->readAllocations();
+                        break;
+                    default:
+                        throw new RandapiException("Invalid Action was specified");
+                }
+            }else{
+                http_response_code(500);
+                $exception = new RandapiException("No action or pid was set");
+                echo json_encode($exception);
+            }
+        }else{
+            error_log("incorrect token");
+            throw new RandapiException("You don't have sufficient privileges to access this api.",500);
+        }
+    }
+
     /**
      * @param stdClass $jsonObject
      * @return bool
@@ -908,4 +938,81 @@ private function handleChangeTarget(stdClass $jsonObject){
             $eventName);
     }
 
+    /**
+     *
+     */
+    private function readConfiguration(){
+        $configQuery = $this->query("select r.*
+            from redcap_randomization r
+            where r.project_id = ".$this->getProjectId().";");
+        $ret = array();
+        while($row = $configQuery->fetch_assoc()){
+            foreach($row as $key=>$value){
+                if(!key_exists($key,$ret)){
+                    $ret[$key]=array();
+                }
+                array_push($ret[$key],$value);
+            }
+        }
+        $this->printCsv($ret);
+    }
+
+    /**
+     * @throws RandapiException
+     */
+    private function readAllocations(){
+        if(!isset($_GET["status"])){
+            error_log("parameter status not found.");
+            throw new RandapiException("parameter status not found.");
+        }
+
+        $allocationsQuery = $this->query("select a.*
+            from redcap_randomization r
+            join redcap_randomization_allocation a on
+                a.rid = r.rid and
+                a.project_status = ".$_GET["status"]."
+            where r.project_id = ".$this->getProjectId().";");
+        $ret = array();
+        while($row = $allocationsQuery->fetch_assoc()){
+            foreach($row as $key=>$value){
+                if(!key_exists($key,$ret)){
+                    $ret[$key]=array();
+                }
+                array_push($ret[$key],$value);
+            }
+        }
+        $this->printCsv($ret);
+    }
+
+    /**
+     * @param array $ret a map with key, the column name and value an array with values for each line.
+     */
+    private function printCsv(array $ret){
+        $this->setHeaderCSV();
+        // assume each array has an equal nr of rows
+        $nrOfRow = sizeof($ret[array_keys($ret)[0]]);
+        $keys = array_keys($ret);
+        echo implode(";",$keys)."\r\n";
+        for($i = 0; $i<$nrOfRow;$i++){
+            $line = array();
+            foreach($keys as $key){
+                array_push($line, $ret[$key][$i]);
+            }
+            echo implode(";",$line)."\r\n";
+        }
+    }
+
+    private function setHeaderCSV(){
+        $this->contentType = "csv";
+    }
+
+    public function setHeaders(){
+        if($this->contentType == "json"){
+            header("Content-Type: application/json");
+        }else if($this->contentType == "csv"){
+            header("Content-Type: application/csv");
+            header("Content-Disposition: attachment;filename=export.csv");
+        }
+    }
+
 }

api.php

@@ -9,8 +9,6 @@
 
     if ($_SERVER['REQUEST_METHOD'] == 'POST'){
 
-        header('Content-Type: application/json');
-
         $jsonText = file_get_contents("php://input");
         error_log("received text: $jsonText");
         $jsonObject = json_decode($jsonText, false);
@@ -19,6 +17,10 @@
          * @var $module \redcapuzgent\Randapi\Randapi
          */
         $module->handleRequest($jsonObject,$jsonText);
+        $module->setHeaders();
+    }else if($_SERVER['REQUEST_METHOD'] == 'GET' && isset($_GET["action"])){
+        $module->handleGetRequest();
+        $module->setHeaders();
     }else{
         include('help.php');
     }

config.json

@@ -14,7 +14,8 @@
 		{"0.0.6": "Add unrandomize method"},
 		{"0.0.7": "Bugfix release. Remove fixed database schema name"},
 		{"0.0.8": "Add changeSources method"},
-		{"0.0.9": "Add changeTarget method"}
+		{"0.0.9": "Add changeTarget method"},
+		{"0.0.10": "Add readAllocations en readConfiguration"}
 	],
 
 	"authors": [

help.php

@@ -203,6 +203,18 @@
                     }
                 </code>
             </pre>
+
+            <h2>readConfiguration</h2>
+            <p>This method must be executed in a GET request and extracts the randomization configuration settings from REDCap for the given project</p>
+            <p>The API exports this configuration in a CSV format.</p>
+            <p>Example URL: https://localhost/api/?type=module&prefix=randapi&page=api&pid=19&NOAUTH&token=F33F6876ADC5EC63CE79EBFF88FF0092&action=readConfiguration</p>
+
+            <h2>readAllocations</h2>
+            <p>This method must be executed in a GET request and extracts the allocation table for the given project (and status) from REDCap.</p>
+            <p>The status parameter is required. The value 0 van be passed for projects in development status and 1 for projects with a production status.</p>
+            <p>The API exports this allocations in a CSV format.</p>
+            <p>Example URL: https://localhost/api/?type=module&prefix=randapi&page=api&pid=19&NOAUTH&token=F33F6876ADC5EC63CE79EBFF88FF0092&action=readAllocations&status=0</p>
+
         </div>
     </body>
 </html>