restructuring the review attempts page and logic (#11)

sei-npacheco · web-flow · commit c282bc9c0fec · 2025-05-27T10:45:25.000-04:00
* restructuring the review attempts page and logic

* only display tasks after lab is launched

* moving return button to the button

* adding description field and ability to show it on course page

* adding popup for start and end lab buttons

* removing run task button from viewattempt page

* removing duplicates

* last minute fixes

* improving task filter function and redirecting user after ending lab
diff --git a/classes/crucible.php b/classes/crucible.php
@@ -285,6 +285,52 @@ public function getall_attempts($state = 'all', $review = false, $userid = 0) {
         return $attempts;
     }
 
+    public function get_attempts_by_user($userid, $state = 'all', $review = false) {
+        global $DB;
+    
+        $sqlparams = [];
+        $where = [];
+    
+        $where[] = '{crucible_attempts}.crucibleid = ?';
+        $sqlparams[] = $this->crucible->id;
+    
+        switch ($state) {
+            case 'open':
+                $where[] = '{crucible_attempts}.state = ?';
+                $sqlparams[] = crucible_attempt::INPROGRESS;
+                break;
+            case 'closed':
+                $where[] = '{crucible_attempts}.state = ?';
+                $sqlparams[] = crucible_attempt::FINISHED;
+                break;
+            default:
+                // No additional state filtering
+        }
+    
+        // Always filter by user
+        $where[] = '({crucible_attempts}.userid = ? OR {crucible_attempt_users}.userid = ?)';
+        $sqlparams[] = $userid;
+        $sqlparams[] = $userid;
+    
+        $wherestring = implode(' AND ', $where);
+    
+        $sql = "SELECT {crucible_attempts}.* 
+                FROM {crucible_attempts}
+                LEFT JOIN {crucible_attempt_users}
+                ON {crucible_attempts}.id = {crucible_attempt_users}.attemptid
+                WHERE $wherestring
+                ORDER BY timemodified DESC";
+    
+        $dbattempts = $DB->get_records_sql($sql, $sqlparams);
+    
+        $attempts = [];
+        foreach ($dbattempts as $dbattempt) {
+            $attempts[] = new crucible_attempt($dbattempt);
+        }
+    
+        return $attempts;
+    }
+    
     public function init_attempt() {
         global $DB, $USER;
 
@@ -357,24 +403,47 @@ public function init_attempt() {
     }
 
     // filter for tasks the user can see and sort by name
-    function filter_scenario_tasks($tasks, $visible = 0, $gradable = 0) {
-
+    function filter_scenario_tasks($tasks, $isVisible = false, $isExecutable = false) {
         global $DB;
+    
         if (is_null($tasks)) {
-            return;
+            return [];
         }
-        $filtered = array();
+    
+        $filtered = [];
+    
         foreach ($tasks as $task) {
-            if ($task->userExecutable) {
+            $include = true;
+    
+            // Filter by visibility from DB
+            if ($isVisible) {
+                $sql = 'SELECT visible FROM {crucible_tasks} WHERE ' .
+                $DB->sql_compare_text('name') . ' = ' . $DB->sql_compare_text(':name');
+
+                $rec = $DB->get_record_sql($sql, ['name' => $task->name]);
+    
+                if (!$rec || empty($rec->visible)) {
+                    $include = false;
+                }
+            }
+    
+            // Filter by executable flag from task object
+            if ($isExecutable && empty($task->userExecutable)) {
+                $include = false;
+            }
+    
+            // Include task if it passes all checks
+            if ($include) {
+                if (!empty($task->userExecutable)) {
+                    $task->points = $task->totalScore ?? 0;
+                }
                 $filtered[] = $task;
-                $task->points = $task->totalScore;
             }
         }
-
+    
         usort($filtered, "tasksort");
         return $filtered;
-
-    }
+    }           
 
     public function get_all_attempts_for_form() {
         global $DB, $USER;
diff --git a/lang/en/crucible.php b/lang/en/crucible.php
@@ -118,8 +118,8 @@
 $string['taskname'] = 'Task Name';
 $string['taskresult'] = 'Latest Task Result';
 $string['taskaction'] = 'Action';
-$string['taskexecute'] = 'Run Task';
-$string['tasknoexecute'] = 'No Action';
+$string['taskexecute'] = 'Execute Task';
+$string['tasknoexecute'] = 'Not Executable';
 
 // view
 $string['eventwithoutattempt'] = 'Event exists but attempt does not exist in moodle db.';
@@ -157,4 +157,7 @@
 
 $string['notasksavailable'] = 'There are no tasks available for this activity.';
 $string['backtocruclanding'] = 'Back to Activity View';
+$string['start_attempt_confirm'] = 'Are you sure you want to launch the lab?';
+$string['stop_attempt_confirm'] = 'Are you sure you want to end the lab?';
+
 
diff --git a/lib.php b/lib.php
@@ -216,6 +216,18 @@ function crucible_delete_instance($id) {
  * @return cached_cm_info info
  */
 function crucible_get_coursemodule_info($coursemodule) {
+    global $DB;
+
+    $crucible = $DB->get_record('crucible', array('id' => $coursemodule->instance), '*', MUST_EXIST);
+
+    $info = new cached_cm_info();
+    $info->name = $crucible->name;
+
+    if ($coursemodule->showdescription) {
+        $info->content = format_module_intro('crucible', $crucible, $coursemodule->id, false);
+    }
+
+    return $info;
 }
 
 /*
@@ -404,13 +416,11 @@ function crucible_extend_settings_navigation($settingsnav, $context) {
         $beforekey = $keys[$i + 1];
     }
 
-    if (has_capability('mod/crucible:manage', $PAGE->cm->context)) {
-        $url = new moodle_url('/mod/crucible/review.php', array('id' => $PAGE->cm->id));
-        $node = navigation_node::create(get_string('reviewtext', 'mod_crucible'),
-                new moodle_url($url),
-                navigation_node::TYPE_SETTING, null, 'mod_crucible_review', new pix_icon('i/grades', 'grades'));
-        $context->add_node($node, $beforekey);
-    }
+    $url = new moodle_url('/mod/crucible/review.php', array('id' => $PAGE->cm->id));
+    $node = navigation_node::create(get_string('reviewtext', 'mod_crucible'),
+            new moodle_url($url),
+            navigation_node::TYPE_SETTING, null, 'mod_crucible_review', new pix_icon('i/grades', 'grades'));
+    $context->add_node($node, $beforekey);
 
     if (has_capability('mod/crucible:manage', $PAGE->cm->context)) {
         $url = new moodle_url('/mod/crucible/manage.php', array('c' => $PAGE->cm->course));
diff --git a/mod_form.php b/mod_form.php
@@ -53,7 +53,7 @@ function definition() {
         $config = get_config('crucible');
 
         // Adding the standard "intro" and "introformat" fields.
-        //$this->standard_intro_elements();
+        $this->standard_intro_elements();
         //TODO remove ability to edit the description and just show the select and dropdown
         //$mform->removeElement('introeditor');
         //TODO figure out why the description doesnt appear
@@ -192,8 +192,9 @@ function data_postprocessing($data) {
         }
         $index = array_search($data->eventtemplateid, array_column($this->eventtemplates, 'id'), true);
         $data->name = $this->eventtemplates[$index]->name;
-        $data->intro = $this->eventtemplates[$index]->description;
-        $data->introeditor['format'] = FORMAT_PLAIN;
+        $rawdescription = $this->eventtemplates[$index]->description;
+        $data->intro = strip_tags($rawdescription); // Removes all HTML tags
+        $data->introformat = FORMAT_PLAIN;
 
         // TODO if grade method changed, update all grades
     }
diff --git a/renderer.php b/renderer.php
@@ -39,7 +39,7 @@ class mod_crucible_renderer extends plugin_renderer_base {
     function display_detail ($crucible, $duration) {
         $data = new stdClass();
         $data->name = $crucible->name;
-        $data->intro = $crucible->intro;
+        $data->intro = strip_tags($crucible->intro);
         $data->durationtext = get_string('durationtext', 'mod_crucible');
         $data->duration = $duration;
         echo $this->render_from_template('mod_crucible/detail', $data);
@@ -192,7 +192,7 @@ function display_attempts($attempts, $showgrade, $showuser = false, $showdetail
         global $DB;
         $data = new stdClass();
         $data->tableheaders = new stdClass();
-        $data->tabledata[] = array();
+        $data->tabledata = [];
 
         if ($showuser) {
             $data->tableheaders->username = get_string('username', 'mod_crucible');
@@ -262,8 +262,12 @@ function display_tasks($tasks) {
             $rowdata = array();
             //$rowdata[] = $task->id;
             $rowdata[] = $task->name;
-            $rowdata[] = $task->description;
-            $rowdata[] = $task->points;
+            if ($task->description) {
+                $rowdata[] = $task->description;
+            } else {
+                $rowdata[] = "No description available";
+            }
+            $rowdata[] = $task->score;
             $data->tabledata[] = $rowdata;
         }
 
@@ -353,15 +357,20 @@ function display_results($tasks, $review = false) {
                 if (isset($task->totalStatus)) {
                     $rowdata->result = $task->totalStatus;
                 }
-                // check whether we can execute the task
-                // if ((isset($task->triggerCondition)) && ($task->triggerCondition === "Manual")) {
-                if ($task->executable) {
-                    $rowdata->action = get_string('taskexecute', 'mod_crucible');
+
+                if (!$review) {
+                    if ($task->userExecutable) {
+                        $rowdata->action = get_string('taskexecute', 'mod_crucible');
+                    }
+                    else {
+                        $rowdata->noaction = get_string('tasknoexecute', 'mod_crucible');
+                    }
                 } else {
-                    $rowdata->action = get_string('tasknoexecute', 'mod_crucible');
-                }
+                    $rowdata->noaction = get_string('tasknoexecute', 'mod_crucible');
+                }            
+
                 if ($review) {
-                    if ($task->comment) {
+                    if (isset($task->comment)) {
                         $rowdata->comment = $task->comment;
                     } else {
                         $rowdata->comment = "-";
diff --git a/review.php b/review.php
@@ -91,29 +91,31 @@
     $scenariotemplateid = "";
 }
 
-if (!$object->is_instructor()) {
-    redirect($returnurl);
-}
-
 $renderer = $PAGE->get_renderer('mod_crucible');
 echo $renderer->header();
 $renderer->display_detail($crucible, $object->eventtemplate->durationHours);
-$renderer->display_return_form($returnurl, $id);
 
 if ($scenariotemplateid) {
     $tasks = get_scenariotemplatetasks($object->systemauth, $scenariotemplateid);
 
     if ($tasks) {
         // run as system account
-        $filtered = $object->filter_scenario_tasks($tasks, $visible = 1);
+        $filtered = $object->filter_scenario_tasks($tasks, true, false);
+        if ($filtered) {
+            $renderer->display_tasks($filtered);
+        }
     }
+}
 
-    if (!is_null($tasks)) {
-        $renderer->display_tasks($filtered);
-    }
+if ($object->is_instructor()) {
+    $attempts = $object->getall_attempts('closed', $review = true);
+    echo $renderer->display_attempts($attempts, $showgrade = true, $showuser = true);
+} else {
+    $userid = $USER->id;
+    $attempts = $object->get_attempts_by_user($userid, 'closed');
+    echo $renderer->display_attempts($attempts, $showgrade = true, $showuser = false);
 }
 
-$attempts = $object->getall_attempts('all', $review = true);
-echo $renderer->display_attempts($attempts, $showgrade = true, $showuser = true);
+$renderer->display_return_form($returnurl, $id);
 
 echo $renderer->footer();
diff --git a/templates/form.mustache b/templates/form.mustache
@@ -37,23 +37,54 @@ DM20-0196
 }}
 
 <span>
-  <form action="{{url}}" method="post" style="display:inline">
-      <input id="event" type="hidden" name="event" value=""/>
+  <form id="lab_form" action="{{url}}" method="post" style="display:inline">
+      <input id="event" type="hidden" name="event" value="" />
       <input id="eventtemplateid" type="hidden" name="eventtemplateid" value="{{eventtemplateid}}" />
-      <input id="end_button" style="display:none" class="btn btn-primary" type="submit" name="stop" value="End Lab"
-      {{#joinedAttempt}}
-      disabled="disabled"
-      {{/joinedAttempt}}
-      />
+      <input id="start_confirmed" type="hidden" name="start_confirmed" value="" />
+      <input id="stop_confirmed" type="hidden" name="stop_confirmed" value="" />
+
       <input id="launch_button" style="display:none" class="btn btn-primary" type="submit" name="start" value="Launch Lab" />
+      <input id="end_button" style="display:none" class="btn btn-danger" type="submit" name="stop" value="End Lab"
+          {{#joinedAttempt}}disabled="disabled"{{/joinedAttempt}} />
   </form>
 
-  <button id="wait" style="display:none; width:300px" class="btn btn-primary" type="button" name="start">
+  <button id="wait" style="display:none; width:300px" class="btn btn-primary" type="button" name="wait">
     <span class="spinner-border spinner-border-sm" role="status"></span>
-    &nbsp;&nbsp
-    Please wait, system processing
+    &nbsp;&nbsp;Please wait, system processing
   </button>
-  <input id="failed" style="display:none; width:300px" class="btn btn-primary" type="" name="failed" value="Your operation has failed." />
+
+  <input id="failed" style="display:none; width:300px" class="btn btn-secondary" type="button" name="failed" value="Your operation has failed." />
 
   <p id="enable-fullscreen" style="display: none;" class="btn btn-primary">{{fullscreen}}</p>
 </span>
+
+<script type="text/javascript">
+  document.addEventListener('DOMContentLoaded', function () {
+      const launchBtn = document.getElementById('launch_button');
+      const endBtn = document.getElementById('end_button');
+      const startConfirm = document.getElementById('start_confirmed');
+      const stopConfirm = document.getElementById('stop_confirmed');
+
+      if (launchBtn) {
+          launchBtn.addEventListener('click', function (e) {
+              const confirmed = confirm("{{#str}} start_attempt_confirm, mod_crucible {{/str}}");
+              if (!confirmed) {
+                  e.preventDefault();
+              } else {
+                  startConfirm.value = "yes";
+              }
+          });
+      }
+
+      if (endBtn) {
+          endBtn.addEventListener('click', function (e) {
+              const confirmed = confirm("{{#str}} stop_attempt_confirm, mod_crucible {{/str}}");
+              if (!confirmed) {
+                  e.preventDefault();
+              } else {
+                  stopConfirm.value = "yes";
+              }
+          });
+      }
+  });
+</script>
diff --git a/templates/results.mustache b/templates/results.mustache
@@ -52,7 +52,8 @@ DM20-0196
                 <tr>
                     <td>{{name}}</td>
                     <td>{{desc}}</td>
-                    <td><button id="{{id}}" class="btn btn-primary exec-task">{{action}}</button></td>
+                    {{#action}}<td><button id="{{id}}" class="btn btn-primary exec-task">{{action}}</button></td>{{/action}}
+                    {{#noaction}}<td><button id="{{id}}" class="btn btn-secondary" disabled>{{noaction}}</button></td>{{/noaction}}
                     {{#comment}}
                         <td>{{comment}}</td>
                     {{/comment}}
diff --git a/version.php b/version.php
@@ -37,7 +37,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 // This is the version of the plugin.
-$plugin->version = 2025052101;
+$plugin->version = 2025052200;
 
 // This is the version of Moodle this plugin requires.
 $plugin->requires = 2022112801;
diff --git a/view.php b/view.php
diff --git a/viewattempt.php b/viewattempt.php
