Added XML file import for create project requests

Eric Neuhaus · Eric Neuhaus · commit 44617e410b88 · 2019-04-08T11:45:21.000-05:00
diff --git a/QuickProjects.js b/QuickProjects.js
@@ -1,3 +1,34 @@
+$(document).ready(function () {
+    $('#user').autocomplete({
+        source: app_path_webroot + "UserRights/search_user.php",
+        minLength: 2,
+        delay: 150,
+        html: true,
+        select: function (event, ui) {
+            $(this).val(ui.item.value);
+            return false;
+        }
+    });
+
+    $[ "ui" ][ "autocomplete" ].prototype["_renderItem"] = function( ul, item) {
+        return $( "<li></li>" )
+            .data( "item.autocomplete", item )
+            .append( $( "<a></a>" ).html( item.label ) )
+            .appendTo( ul );
+    };
+
+    $('#storedXml').change(function () {
+        var projectToken = $('#templateProjectToken');
+
+        if (this.checked) {
+            projectToken.hide();
+        }
+        else {
+            projectToken.show();
+        }
+    });
+});
+
 var UIOWA_QuickProjects = {};
 
 UIOWA_QuickProjects.addService = function() {
@@ -33,6 +64,8 @@ UIOWA_QuickProjects.updateUrlText = function() {
     var paramStr = '';
     var paramList = [
         'token',
+        'projectToken',
+        'storedXml',
         'flag',
         'title',
         'irb',
@@ -52,14 +85,6 @@ UIOWA_QuickProjects.updateUrlText = function() {
     var projectSetup = document.querySelector('input[name = "setupMethod"]:checked').value;
     paramStr += '&method=' + projectSetup;
 
-    if (projectSetup == 'create') {
-        document.querySelector('#projectLink').checked = true;
-        document.querySelector('#publicSurveyLink').disabled = true;
-    }
-    else {
-        document.querySelector('#publicSurveyLink').disabled = false;
-    }
-
     var returnValue = document.querySelector('input[name = "returnValue"]:checked').value;
     paramStr += '&return=' + returnValue;
 
@@ -89,9 +114,7 @@ UIOWA_QuickProjects.updateUrlText = function() {
 
                     var notifyValue = projectInfo[j].children[1].children['surveyNotification'].children[0].checked;
 
-                    if (projectSetup == 'modify') {
-                        paramStr += '&surveyNotification[]=' + notifyValue;
-                    }
+                    paramStr += '&surveyNotification[]=' + notifyValue;
                 }
             }
             else if (paramList[i] == 'purpose_other') {
@@ -114,7 +137,7 @@ UIOWA_QuickProjects.updateUrlText = function() {
                     }
                 }
             }
-            else if (paramList[i] == 'surveys' || paramList[i] == 'longitudinal' || paramList[i] == 'autonumber') {
+            else if (paramList[i] == 'surveys' || paramList[i] == 'longitudinal' || paramList[i] == 'autonumber' || paramList[i] == 'storedXml') {
                 if (projectInfo[j].checked && projectSetup == 'create') {
                     paramStr += '&' + paramList[i] + '=' + '1';
                 }
@@ -155,31 +178,41 @@ UIOWA_QuickProjects.updateFields = function(reqToken) {
     var projectSetup = document.querySelector('input[name = "setupMethod"]:checked').value;
     var projectTitle = document.getElementById('app_title');
     var projectPurpose = document.getElementById('purpose');
-    var superToken = document.getElementById('superToken');
+    var superToken = $('#superToken');
     var reservedFlag = document.getElementById('reservedFlag');
-    var surveyNotifications = $('input[name = "surveyNotification"]');
     var newProjectSettings = $('#newProjectSettings > input');
+    var templateProjectToken = $('#templateProjectToken');
+    var templateXml = $('#templateXml');
 
     if (projectSetup == 'create') {
         projectTitle.required = true;
         projectPurpose.required = true;
-        superToken.style = "";
+
+        if (!templateXml.hasClass('always-hide')) {
+            superToken.show();
+        }
 
         newProjectSettings.attr("disabled", false);
-        surveyNotifications.attr("disabled", true);
         reservedFlag.style.display = "none";
+        templateProjectToken.show();
+
+        if (!templateXml.hasClass('always-hide')) {
+            templateXml.show();
+        }
     }
     else if (projectSetup == 'modify') {
         projectTitle.required = false;
         projectPurpose.required = false;
         reservedFlag.style = "";
 
         newProjectSettings.attr("disabled", true);
-        surveyNotifications.attr("disabled", false);
 
-        if (!reqToken[0]) {
-            superToken.style.display = "none";
+        if (!reqToken[0] || !superToken.hasClass('show-on-modify')) {
+            superToken.hide();
         }
+
+        templateProjectToken.hide();
+        templateXml.hide();
     }
 };
 
diff --git a/QuickProjects.php b/QuickProjects.php
@@ -53,14 +53,20 @@ public function getPermissionsPresets() {
     }
 
     public function generateProject() {
+        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+
         session_start();
 
+        error_log('test');
+
         global $conn;
         if (!isset($conn))
         {
             db_connect(false);
         }
 
+        error_log($_REQUEST['token']);
+
         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
             self::returnResultMessage(["ERROR: The requested method is not implemented."], null);
         }
@@ -91,7 +97,7 @@ public function generateProject() {
             $apiRequired = false;
         }
 
-        if (db_num_rows($result) == 0 && $apiRequired) {
+        if (db_num_rows($result) == 0 && $apiRequired && !$this->getSystemSetting('no-token-required')) {
             self::returnResultMessage(["ERROR: Invalid API Super Token"], null);
         }
 
@@ -123,7 +129,12 @@ public function generateProject() {
             self::returnResultMessage(["ERROR: Project Title is missing. This parameter is required for project copies."], null);
         }
 
-        $supertoken = $_REQUEST['token'];
+        if ($this->getSystemSetting('no-token-required')) {
+            $supertoken = $this->getSystemSetting('super-api-token');
+        }
+        else {
+            $supertoken = $_REQUEST['token'];
+        }
 
         $projectTitle = urldecode($_REQUEST['title']);
         $projectNote = urldecode($_REQUEST['note']);
@@ -175,9 +186,24 @@ public function generateProject() {
             'data' => ''
         );
 
+        $exportProjectXml = array(
+            'token' => '',
+            'content' => 'project_xml'
+        );
+
         if ($_REQUEST['method'] == 'create') {
-            if ($_REQUEST['return'] == 'publicSurveyLink') {
-                self::returnResultMessage(["ERROR: New projects cannot return public survey links. Project was not created."], null);
+            if (isset($_REQUEST['projectToken'])) {
+                $exportProjectXml['token'] = $_REQUEST['projectToken'];
+                $projectXml = $this->redcapApiCall($exportProjectXml, false);
+
+                $createProject['odm'] = $projectXml;
+            }
+
+            if ($_REQUEST['storedXml'] == 1) {
+                $docId = self::getSystemSetting('template-xml-file');
+                $filename = db_query('select stored_name from redcap_edocs_metadata where doc_id = ' . $docId);
+
+                $createProject['odm'] = file_get_contents(EDOC_PATH . db_fetch_assoc($filename)['stored_name']);
             }
 
             $token = $this->redcapApiCall($createProject, false);
@@ -261,6 +287,22 @@ public function generateProject() {
 
         $this->redcapApiCall($importUsers, false);
 
+        if ($reservedPID == null) {
+            $result = db_query('select project_id from redcap_user_rights where api_token = "' . $token . '"');
+            $reservedPID = db_fetch_assoc($result)['project_id'];
+        }
+
+        if ($_REQUEST['method'] == 'create' && $_REQUEST['return'] == 'publicSurveyLink') {
+            $result = db_query('select event_id from redcap_events_metadata
+left join redcap_events_arms on redcap_events_metadata.arm_id = redcap_events_arms.arm_id
+where project_id = ' . $reservedPID);
+            $eventId = db_fetch_assoc($result)['event_id'];
+            $result = db_query('select survey_id from redcap_surveys where project_id = ' . $reservedPID);
+            $surveyId = db_fetch_assoc($result)['survey_id'];
+
+            \Survey::setHash($surveyId, null, $eventId, null, true);
+        }
+
         if (isset($_REQUEST['surveyNotification'])) {
             $notifications = $_REQUEST['surveyNotification'];
 
@@ -290,7 +332,7 @@ public function generateProject() {
         }
 
         if ($_REQUEST['return'] == 'publicSurveyLink') {
-                $sql = "
+            $sql = "
             SELECT s.project_id,s.form_name,s.title as survey_title
             ,pr.app_title, p.hash
             FROM redcap_surveys s
@@ -320,7 +362,7 @@ public function generateProject() {
                 self::returnResultMessage($successMsg, $urlString);
             }
             else {
-                self::returnResultMessage(['No public survey link found. Is the template project configured properly? NOTE: The reserved project (PID: ' . $reservedPID . ') was still updated.'], null);
+                self::returnResultMessage(['No public survey link found.'], null);
             }
 
         }
@@ -332,7 +374,8 @@ public function generateProject() {
             $exportedProjectInfo = json_decode($exportedProjectInfo, true);
 
             $urlString =
-                sprintf("https://%s%sProjectSetup/index.php?pid=%d",  // Project Setup page
+                sprintf("%s%s%sProjectSetup/index.php?pid=%d",  // Project Setup page
+                    $protocol,
                     SERVER_NAME,
                     APP_PATH_WEBROOT,
                     $exportedProjectInfo['project_id']);
@@ -402,14 +445,36 @@ public function displayRequestBuilderPage() {
                         <label for="publicSurveyLink"> Public Survey Link</label>
                     </td>
                 </tr>
-                <tr valign="top" id="superToken">
+                <tr valign="top" id="superToken" style="display:none" class="<?= $this->getSystemSetting('require-super-token') ? 'show-on-modify ' : '' ?><?= $this->getSystemSetting('no-token-required') ? 'always-hide ' : '' ?>">
                     <td style="padding-right:20px;width:150px;">
                         <b>Super API token: </b>
                     </td>
                     <td>
                         <input id="token" type="text" name="token" style="width:70%;max-width:450px;" required value="<?= $superApiToken ?>">
                     </td>
                 </tr>
+                <tr>
+                    <td><br/></td>
+                </tr>
+                <tr valign="top" id="templateXml" style="padding-right:20px;width:150px;<?= !$this->getSystemSetting('template-xml-file') ? 'display:none;" class="always-hide' : '' ?>">
+                    <td style="padding-right:20px;width:150px;">
+                        <b>Use stored project XML template: </b>
+                    </td>
+                    <td>
+                        <input type="checkbox" name="storedXml" id="storedXml" onclick="UIOWA_QuickProjects.updateUrlText()">
+                    </td>
+                </tr>
+                <tr>
+                    <td><br/></td>
+                </tr>
+                <tr valign="top" id="templateProjectToken">
+                    <td style="padding-right:20px;width:150px;">
+                        <b>Source project API token (optional): </b>
+                    </td>
+                    <td>
+                        <input id="projectToken" type="text" name="projectToken" style="width:70%;max-width:450px;">
+                    </td>
+                </tr>
                 <tr valign="top" id="reservedFlag" style="display: none;">
                     <td style="padding-right:20px;width:150px;">
                         <b>Reserved flag: </b>
diff --git a/README.md b/README.md
@@ -1,22 +1,33 @@
 ## Quick Projects
 
 ### Description
-The Quick Projects module allows for the quick creation or modification of REDCap projects (including the process of adding users and assigning rights) via a simple user interface or POST request. Project creations are achieved through a series of REDCap API calls, while project modifications are performed against a pool of pre-configured "reserve" projects, allowing for more complicated project setups to be duplicated quickly. After the project is created/modified, a link to the project/public survey will be returned.
+The Quick Projects module allows for the quick creation or modification of REDCap projects (including the process of adding users and assigning rights) via a single POST request. Project creations are achieved through a series of REDCap API calls, while project modifications are performed against a pool of pre-configured "reserve" projects. After the project is created/modified, a link to the project/public survey will be returned.
 
 ### Basic Usage
-After downloading and enabling this module on your REDCap instance, a link to Quick Projects will appear at the bottom of the Control Center sidebar. This interface will allow you to configure your create/modify request via a graphical interface and execute immediately or copy the URL as a template for automation in another system.
+After downloading and enabling this module on your REDCap instance, a link to Quick Projects will appear at the bottom of the Control Center sidebar. This page will allow you to configure your create/modify request via a graphical interface and execute immediately or copy the URL as a template for automation in another system.
 
 If the Quick Permissions module is also installed, any custom user rights presets configured will be available for use in Quick Projects as well.
 
+### Create Project Method
+A Super API token is required to create projects.
+
+Another project can be used as a template by either specifying a "Source project API token" or using a "stored project XML template". If an API token is specified, the source project's design will automatically be imported into the newly created project. If the XML template is used, the module will import the stored XML file (uploaded via module config) into the newly created project.
+
+NOTE: REDCap v8.10.0 allows a number of additional project components (such as survey settings and reports) to be optionally included when downloading a project's metadata in XML format. However, none of these additional components will be included when using the "Source project API token" method. Please keep this in mind when deciding which of these features to use.
+
 ### Modify Project Method
 No additional configuration is required to create projects with this module, but performing a modify operation requires a bit of setup before use.
 
 To use the modify project feature, you must have a "reserve" of template projects. These projects are designated by a specific project note (defined in module configuration) and every time a project is modified via Quick Projects, the project note will be erased (or replaced), removing it from the reserve. Additionally, the user requesting the modification must have an API token attached to the reserved project.
 
+NOTE: This feature was originally implemented as a workaround for the lack of a "deep copy" method in REDCap. With the new functionality added in REDCap v8.10.0 (see note under "Create Project Method" section), this feature may no longer be necessary.
+
 ### Configuration Options
 * **Prepopulate Super API Token based on currently logged in user:** Check this option to automatically populate the Super API Token field if the current user has one.
 * **Prepopulate Super API Token with specified value:** If this field is not blank, the value entered will automatically populate the Super API Token field (regardless of the above option)
+* **Automatically use above token if not specified in request parameter:** If no super API token is passed with a request, the module will assume the token in the field above is to be used. WARNING: Enable at your own risk, as this allows anyone to create projects without authentication by submitting a request. It is recommended that the IP whitelisting feature is used in conjunction with this option for additional security.
 * **Only allow requests from whitelisted IP addresses:** If this option is enabled, Quick Projects will immediately return an error message to requests from IP addresses that are not explicitly whitelisted.
+* **Stored project metadata file:** An XML file containing project metadata (in CDISC ODM format) can be uploaded and optionally imported into projects created with this module.
 
 #### Modify Project Settings
 
diff --git a/config.json b/config.json
@@ -1,6 +1,6 @@
 {
   "name": "Quick Projects",
-  "description": "Create/modify projects via single POST request",
+  "description": "Create/modify projects via a single POST request",
 
   "namespace": "UIOWA\\QuickProjects",
 
@@ -29,16 +29,27 @@
   "system-settings": [
     {
       "key": "prepopulate-token",
-      "name": "Prepopulate Super API Token based on currently logged in user",
+      "name": "Prepopulate Super API Token based on currently logged in user (Request Builder)",
       "type": "checkbox",
       "required": false
     },
     {
       "key": "super-api-token",
-      "name": "Prepopulate Super API Token with specified value (overrides above option)",
+      "name": "Prepopulate Super API Token with specified value (Request Builder)",
       "type": "text",
       "required": false
     },
+    {
+      "key": "no-token-required",
+      "name": "Automatically use above token if not specified in request parameter",
+      "type": "checkbox",
+      "required": false,
+      "branchingLogic": {
+        "field": "super-api-token",
+        "op": "<>",
+        "value": ""
+      }
+    },
     {
       "key": "restrict-ip",
       "name": "Only allow requests from whitelisted IP addresses",
@@ -56,6 +67,13 @@
         "value": "true"
       }
     },
+    {
+      "key": "template-xml-file",
+      "name": "Stored project metadata file (XML in CDISC ODM format)",
+      "type": "file",
+      "required": false,
+      "repeatable": false
+    },
     {
       "key": "modify-project-settings",
       "name": "Modify Project Settings",
