[Survey module] Make public module

modules/survey_module/ajax/survey_api.php

@@ -0,0 +1,364 @@
+<?php
+/**
+ * This is used by the Loris survey module to retrieve the email
+ * template for the current instrument. It is used in the survey_accounts
+ * page via AJAX to update the email template with the current page
+ *
+ * PHP Version 7
+ *
+ * @category Survey
+ * @package  Loris
+ * @author   Jordan Stirling <jstirling91@gmail.com>
+ * @license  Loris license
+ * @link     https://www.github.com/aces/Loris/
+ */
+
+/**
+ * Class to handle request types
+ *
+ * PHP Version 7
+ *
+ * @category Survey
+ * @package  Loris
+ * @author   Jordan Stirling <jstirling91@gmail.com>
+ * @license  Loris license
+ * @link     https://www.github.com/aces/Loris/
+ */
+class DirectDataEntryMainPage
+{
+    var $tpl_data = array();
+
+    /**
+     * Initialize all of the class variables and things required from the
+     * REQUEST.
+     *
+     * @return null
+     */
+    function initialize()
+    {
+        ob_start('ob_gzhandler');
+        $client = new NDB_Client();
+        $client->makeCommandLine();
+        $client->initialize();
+
+        $factory  = NDB_Factory::singleton();
+        $config   = $factory->config();
+        $settings = $factory->settings();
+
+        $this->tpl_data['baseurl'] = $settings->getBaseURL();
+        $this->key = $_REQUEST['key'];
+
+        $DB = Database::singleton();
+        $this->SurveyInfo = $DB->pselect(
+            "SELECT Status, Test_name, CommentID FROM participant_accounts
+            WHERE OneTimePassword=:key",
+            array('key' => $this->key)
+        );
+
+        if (empty($this->SurveyInfo)) {
+            throw new Exception("The given survey doesn't exist", 404);
+        } else if (count($this->SurveyInfo) > 1) {
+            throw new Exception("Well looks like we made a mistake :(", 500);
+        } else if ($this->SurveyInfo[0]['Status'] === 'Complete') {
+            throw new Exception("Data has already been submitted.", 403);
+        }
+
+        $this->SurveyInfo = $this->SurveyInfo[0];
+
+    }
+
+    /**
+     * Handles a request by delegating to the appropriate
+     * handle method
+     *
+     * @return null
+     */
+    function handleRequest()
+    {
+        switch($_SERVER['REQUEST_METHOD']) {
+        case 'GET':
+            $this->handleGET();
+            break;
+        case 'PUT':
+            $this->handlePUT();
+            break;
+        case 'PATCH':
+            $this->handlePATCH();
+            break;
+        case 'POST':
+            $this->handlePOST();
+            break;
+        default:
+            $this->header("HTTP/1.1 501 Not Implemented");
+            break;
+        }
+    }
+
+    /**
+     * Handle a GET request. This will render and display the page.
+     *
+     * @return null
+     */
+    function handleGET()
+    {
+
+        try {
+            $this->Instrument = \NDB_BVL_Instrument::factory(
+                $this->SurveyInfo['Test_name'],
+                $this->SurveyInfo['CommentID'],
+                null,
+                true
+            );
+        } catch(\Exception $e) {
+            throw new Exception("Instrument not found", 405);
+        }
+
+        $this->tpl_data['InstrumentJSON'] = $this->Instrument->toDirectJSON();
+
+        $Values = \NDB_BVL_Instrument::loadInstanceData($this->Instrument);
+
+        unset($Values['CommentID']);
+        unset($Values['UserID']);
+        // unset($Values['Testdate']);
+        unset($Values['Data_entry_completion_status']);
+
+        // Unset score values
+        $json_instrument = json_decode($this->tpl_data['InstrumentJSON']);
+        $this->unsetScores($Values, $json_instrument->Elements);
+
+        $this->tpl_data['Values'] = json_encode($Values);
+
+        echo json_encode($this->tpl_data);
+
+        // $this->display();
+    }
+
+    /**
+     * Unsets Score values so that they are not transferred to the frontend
+     *
+     * @param pointer $values   pointer to the values array
+     * @param array   $elements the elements to check if
+     *                          score fields are present
+     *
+     * @return null
+     */
+    function unsetScores(&$values, $elements)
+    {
+        foreach ($elements as $element) {
+            if ($element->Type === 'ElementGroup') {
+                $this->unsetScores($values, $element->Elements);
+            } else if ($element->Type === 'label'
+                && array_key_exists($element->Name, $values)
+            ) {
+                unset($values[$element->Name]);
+            }
+        }
+    }
+
+    /**
+     * Handle a PATCH request. This will update a single field
+     *
+     * @return null
+     */
+    function handlePATCH()
+    {
+
+        try {
+            $this->Instrument = \NDB_BVL_Instrument::factory(
+                $this->SurveyInfo['Test_name'],
+                $this->SurveyInfo['CommentID'],
+                null,
+                true
+            );
+        } catch(\Exception $e) {
+            throw new Exception("Instrument not found", 405);
+        }
+
+        $fp   = fopen("php://input", "r");
+        $data = '';
+        while (!feof($fp)) {
+            $data .= fread($fp, 1024);
+        }
+        fclose($fp);
+
+        $data            = json_decode($data);
+        $instrument_name = $this->Instrument->testName;
+
+        if (count($data) !== 1) {
+            // The survey module will only PATCH one variable at a time.
+            header("HTTP/1.0 400 Bad Request");
+        }
+
+        if ($this->Instrument->validate($data)) {
+            try {
+                $this->Instrument->_save($data);
+
+            } catch (Exception $e) {
+                header("HTTP/1.0 400 Bad Request");
+            }
+        } else {
+            $this->Header("HTTP/1.1 403 Forbidden");
+            if (!$this->Instrument->determineDataEntryAllowed()) {
+                $msg = "Can not update instruments that"
+                       . " are flagged as complete";
+                // $this->JSON = array('error' => $msg);
+            } else {
+                // $this->JSON = array("error" => "Could not update.");
+            }
+        }
+    }
+
+    /**
+     * Handle a PATCH request. This will update a single field
+     *
+     * @return null
+     */
+    function handlePUT()
+    {
+
+        $fp   = fopen("php://input", "r");
+        $data = '';
+        while (!feof($fp)) {
+            $data .= fread($fp, 1024);
+        }
+        fclose($fp);
+
+        $data    = json_decode($data, true);
+        $subtest = null;
+
+        if ($data['page'] !== 0) {
+            $subtest = $data['page'];
+        }
+
+        try {
+            $this->Instrument = \NDB_BVL_Instrument::factory(
+                $this->SurveyInfo['Test_name'],
+                $this->SurveyInfo['CommentID'],
+                $subtest,
+                true
+            );
+        } catch(\Exception $e) {
+            throw new Exception("Instrument not found", 405);
+        }
+
+        $this->Instrument->form->directEntry  = true;
+        $this->Instrument->form->directValues = $data['data'];
+
+        if ($this->Instrument->form->validate()) {
+            if ($data['FinalPage']) {
+                echo $this->Instrument->getReactReview();
+            } else {
+                echo $this->Instrument->toDirectJSON();
+            }
+        } else {
+            header("HTTP/1.0 400 Bad Request");
+            echo json_encode($this->Instrument->form->errors);
+        }
+
+    }
+
+    /**
+     * Handle a PATCH request. This will update a single field
+     *
+     * @return null
+     */
+    function handlePOST()
+    {
+
+        $fp   = fopen("php://input", "r");
+        $data = '';
+        while (!feof($fp)) {
+            $data .= fread($fp, 1024);
+        }
+        fclose($fp);
+
+        $data = json_decode($data, true);
+
+        try {
+            $this->Instrument = \NDB_BVL_Instrument::factory(
+                $this->SurveyInfo['Test_name'],
+                $this->SurveyInfo['CommentID'],
+                null,
+                true
+            );
+        } catch(\Exception $e) {
+            throw new Exception("Instrument not found", 405);
+        }
+
+        $valid = $this->Instrument->directEntryValidation();
+
+        if ($valid === true) {
+            header("HTTP/1.0 200 OK");
+            $DB = Database::singleton();
+            $DB->update(
+                "participant_accounts",
+                array('Status' => "Complete"),
+                array('OneTimePassword' => $this->key)
+            );
+        } else {
+            header("HTTP/1.0 400 Bad Request");
+            echo json_encode($valid);
+        }
+
+    }
+
+    /**
+     * Run the current page, consists of initializing and then displaying the page
+     *
+     * @return null
+     */
+    function run()
+    {
+        try {
+            $this->initialize();
+            $this->handleRequest();
+        } catch(Exception $e) {
+            $this->displayError($e);
+        }
+    }
+
+    /**
+     * Loads the correct page and renders it to the user
+     *
+     * @return null
+     */
+    function display()
+    {
+        $smarty = new Smarty_neurodb;
+        $smarty->assign($this->tpl_data);
+        $smarty->display('directentryreact.tpl');
+    }
+
+     /**
+     * Display an error page in the event of an exception.
+     *
+     * @param Exception $e The exception which was thrown by the code
+     *
+     * @return null, but as a side-effect changes the HTTP return code
+     */
+    function displayError($e)
+    {
+        switch($e->getCode())
+        {
+        case 404:
+            header("HTTP/1.1 404 Not Found");
+            break;
+        case 403:
+            header("HTTP/1.1 403 Forbidden");
+            break;
+        }
+
+        $this->tpl_data['workspace'] = $e->getMessage();
+        $this->tpl_data['complete']  = false;
+        $smarty = new Smarty_neurodb;
+        $smarty->assign($this->tpl_data);
+        $smarty->display('directentry.tpl');
+
+    }
+}
+
+if (!class_exists('UnitTestCase')) {
+    $Runner = new DirectDataEntryMainPage();
+    $Runner->run();
+}
+?>

modules/survey_module/js/CheckInput.js

@@ -0,0 +1,8 @@
+/**
+ *  Check if the input is supported by the Browser
+ */
+function checkInput(type) {
+    var input = document.createElement("input");
+    input.setAttribute("type", type);
+    return input.type == type;
+}