Addition of management.php script for top-level view of available support scripts. Various other tweaks.

Author: trampgeek

changehistory.md

@@ -1,5 +1,12 @@
 # CHANGE HISTORY
 
+### 4 November 2025, 5.8.1
+
+ * New scripts for question bank clean up (deletion of old unused versions) and integrity checking.
+ * Addition of a top-level management.php script that links to other CodeRunner management scripts.
+ * Fix bug in CodeRunner upgrade lib that resulted in the built-in prototypes being invisibly orphaned
+   rather than properly deleted prior to installing the latest versions.
+
 ### 28 October 2025, 5.8.0
 
  * New question browser script moodlehome/question/type/coderunner/questionbrowserindex.php allows easy browsing

db/upgradelib.php

@@ -120,17 +120,17 @@ function update_question_types_internal() {
  */
 function update_question_types_with_qbank() {
     global $DB;
-    mtrace("CodeRunner prototypes set up using qbank");
+    mtrace("CodeRunner prototypes set up using qbank.");
     $topcategory = moodle5_top_category();
     $topcategorycontextid = $topcategory->contextid;
     $oldprototypecategory = get_old_prototype_category();
     if ($oldprototypecategory) {
-        mtrace("CodeRunner is moving old CR_PROTOTYPES category to new qbank category");
+        mtrace("CodeRunner is moving old CR_PROTOTYPES category to new qbank category.");
         $sourcecategoryid = $oldprototypecategory->id;
         question_move_category_to_context($sourcecategoryid, $sourcecategoryid, $topcategorycontextid);
         $DB->set_field('question_categories', 'parent', $topcategory->id, ['parent' => $sourcecategoryid]);
     }
-    mtrace("CodeRunner: replacing existing prototypes with new ones");
+    mtrace("CodeRunner: replacing existing prototypes with new ones.");
     delete_existing_prototypes($topcategorycontextid);
     $prototypescategory = find_or_make_prototype_category($topcategorycontextid, $topcategory->id);
     load_new_prototypes($topcategorycontextid, $prototypescategory);
@@ -142,10 +142,10 @@ function update_question_types_with_qbank() {
  * @return bool true if successful
  */
 function update_question_types_legacy() {
-    mtrace("CodeRunner prototypes set up in system context");
+    mtrace("CodeRunner prototypes set up in system context.");
     $systemcontext = context_system::instance();
     $systemcontextid = $systemcontext->id;
-    mtrace("CodeRunner: replacing existing prototypes with new ones");
+    mtrace("CodeRunner: replacing existing prototypes with new ones.");
     delete_existing_prototypes($systemcontextid);
     if (function_exists('question_get_top_category')) { // Moodle version >= 3.5.
         $parentid = get_top_id($systemcontextid);
@@ -185,6 +185,55 @@ function get_old_prototype_category() {
     }
 }
 
+/**
+ * Get the existing system question bank instance for Moodle 4.6+.
+ * This is a helper function to avoid duplicating the qbank lookup logic.
+ *
+ * @return object|null The question bank module instance, or null if not found/applicable
+ */
+function get_system_question_bank() {
+    if (!qtype_coderunner_util::using_mod_qbank()) {
+        return null;
+    }
+    try {
+        $course = get_site();
+        return question_bank_helper::get_default_open_instance_system_type($course);
+    } catch (Exception $e) {
+        return null;
+    }
+}
+
+/**
+ * Get the context ID where CodeRunner prototypes are stored.
+ * For Moodle 4.6+: Returns the front-page question bank context ID (if it exists)
+ * For Moodle <4.6: Returns the system context ID (if CR_PROTOTYPES category exists)
+ *
+ * @return int|null The context ID, or null if prototypes context doesn't exist yet
+ */
+function get_prototype_contextid() {
+    global $DB;
+
+    if (qtype_coderunner_util::using_mod_qbank()) {
+        // Moodle 4.6+ - prototypes are in front-page question bank.
+        $qbank = get_system_question_bank();
+        if ($qbank && $qbank->context) {
+            return $qbank->context->id;
+        }
+    } else {
+        // Moodle <4.6 - prototypes are in system context.
+        $systemcontext = context_system::instance();
+        // Verify CR_PROTOTYPES category exists in system context.
+        $prototypecat = $DB->get_record('question_categories', [
+            'contextid' => $systemcontext->id,
+            'name' => 'CR_PROTOTYPES',
+        ]);
+        if ($prototypecat) {
+            return $systemcontext->id;
+        }
+    }
+    return null;
+}
+
 /**
  * If we're on Moodle 4.6 or later we can't use the
  * old system of storing prototypes in a category in the system context. Instead
@@ -198,9 +247,9 @@ function moodle5_top_category() {
     $course = get_site();
     $bankname = get_string('systembank', 'question');
     try {
-        $newmod = question_bank_helper::get_default_open_instance_system_type($course);
+        $newmod = get_system_question_bank();
         if (!$newmod) {
-            mtrace('CodeRunner: creating new system question bank');
+            mtrace('CodeRunner: creating new system question bank.');
             $newmod = question_bank_helper::create_default_open_instance($course, $bankname, question_bank_helper::TYPE_SYSTEM);
         }
     } catch (Exception $e) {
@@ -233,8 +282,10 @@ function delete_existing_prototypes($contextid) {
     }
 
     // Clean up any orphaned version records from previous upgrades that used
-    // the old direct deletion method. Only clean up records that were originally
-    // BUILTIN_PROTOTYPE questions by checking the naming pattern.
+    // the old direct deletion method. These orphaned versions are guaranteed to be
+    // from BUILTIN prototypes because the old buggy code only deleted questions with
+    // names matching 'BUILTIN_PROTOTYPE_%', so user-defined prototypes were never
+    // deleted and thus have no orphaned version records.
     $orphanedversions = $DB->get_records_sql(
         "SELECT DISTINCT qv.id
            FROM {question_versions} qv
@@ -243,18 +294,12 @@ function delete_existing_prototypes($contextid) {
       LEFT JOIN {question} q ON q.id = qv.questionid
           WHERE qc.contextid = ?
             AND qc.name = 'CR_PROTOTYPES'
-            AND q.id IS NULL
-            AND EXISTS (
-                SELECT 1 FROM {question_versions} qv2
-                JOIN {question} q2 ON q2.id = qv2.questionid
-                WHERE qv2.questionbankentryid = qbe.id
-                AND q2.name LIKE 'BUILT%IN_PROTOTYPE_%'
-            )",
+            AND q.id IS NULL",
         [$contextid]
     );
 
     if (!empty($orphanedversions)) {
-        mtrace("  Cleaning up " . count($orphanedversions) . " orphaned prototype version records");
+        mtrace("  Cleaning up " . count($orphanedversions) . " orphaned prototype version records.");
         foreach ($orphanedversions as $versionrecord) {
             $DB->delete_records('question_versions', ['id' => $versionrecord->id]);
         }
@@ -274,7 +319,7 @@ function delete_existing_prototypes($contextid) {
     );
 
     if (!empty($orphanedentries)) {
-        mtrace("  Cleaning up " . count($orphanedentries) . " orphaned prototype bank entries");
+        mtrace("  Cleaning up " . count($orphanedentries) . " orphaned prototype bank entries.");
         foreach ($orphanedentries as $entryrecord) {
             $DB->delete_records('question_bank_entries', ['id' => $entryrecord->id]);
         }

deleteoldquestionversionsindex.php

@@ -33,6 +33,7 @@
 require_once(__DIR__ . '/../../../config.php');
 require_once($CFG->libdir . '/questionlib.php');
 require_once(__DIR__ . '/classes/bulk_tester.php');
+require_once(__DIR__ . '/db/upgradelib.php');
 
 // We are Moodle 4 or less if don't have mod_qbank.
 $oldskool = !(qtype_coderunner_util::using_mod_qbank());
@@ -168,7 +169,6 @@ function display_context_with_buttons($contextid, $name, $numcoderunnerquestions
 // Display.
 echo $OUTPUT->header();
 
-echo html_writer::tag('h3', 'Delete Old Question Versions');
 echo html_writer::tag(
     'p',
     'This tool deletes all old versions of questions, keeping only the most recent version of each question. ' .
@@ -187,26 +187,37 @@ function display_context_with_buttons($contextid, $name, $numcoderunnerquestions
 echo 'Use the integrity checker links below (next to each context) to find and fix any issues.';
 echo html_writer::end_tag('div');
 
-echo html_writer::start_tag('div', ['class' => 'alert alert-warning']);
-echo html_writer::tag('strong', '⚠ Important: ');
-$verifyurl = new moodle_url('/question/type/coderunner/verifyprototypes.php');
-echo 'Before using the integrity checker, ';
-echo html_writer::link($verifyurl, 'verify your CodeRunner prototypes', ['style' => 'font-weight: bold;']);
-echo ' to ensure they were not affected by any interrupted operations.';
-echo html_writer::end_tag('div');
-
 echo html_writer::tag(
     'p',
     'Select a context below. Use <strong>Dry Run</strong> to preview what would be deleted, ' .
     'or <strong>Delete Old Versions</strong> to perform the actual deletion.'
 );
 
+// Check if system prototypes context exists and user has permission.
+$prototypecontextid = get_prototype_contextid();
+$showprototypes = false;
+if ($prototypecontextid && has_capability('moodle/question:editall', \context::instance_by_id($prototypecontextid))) {
+    $showprototypes = true;
+}
+
+// Display system prototypes context first if it exists.
+if ($showprototypes) {
+    echo html_writer::tag('h4', 'System Prototypes');
+    echo html_writer::start_tag('ul');
+    $prototypelabel = $oldskool
+        ? 'System Context - CR_PROTOTYPES (Built-in CodeRunner Prototypes)'
+        : 'Front Page Question Bank - CR_PROTOTYPES (Built-in CodeRunner Prototypes)';
+    display_context_with_buttons($prototypecontextid, $prototypelabel, 0);
+    echo html_writer::end_tag('ul');
+    echo html_writer::tag('br', '');
+}
+
 // Find questions from contexts which the user can edit questions in.
 $availablequestionsbycontext = bulk_tester::get_num_available_coderunner_questions_by_context();
 
-if (count($availablequestionsbycontext) == 0) {
+if (count($availablequestionsbycontext) == 0 && !$showprototypes) {
     echo html_writer::tag('p', 'You do not have permission to edit questions in any contexts.');
-} else {
+} else if (count($availablequestionsbycontext) > 0) {
     if ($oldskool) {
         // Moodle 4 style.
         echo html_writer::tag('h4', 'Available Contexts (' . count($availablequestionsbycontext) . ')');
@@ -216,6 +227,7 @@ function display_context_with_buttons($contextid, $name, $numcoderunnerquestions
         );
     } else {
         // Deal with funky question bank madness in Moodle 5.0.
+        echo html_writer::tag('h4', 'Course Contexts');
         echo html_writer::tag('p', "Moodle >= 5.0 detected. Listing by course then question bank.");
         qtype_coderunner_util::display_course_grouped_contexts(
             $availablequestionsbycontext,
@@ -238,6 +250,10 @@ function display_context_with_buttons($contextid, $name, $numcoderunnerquestions
     border-left-color: #004085;
     background-color: #cce5ff;
 }
+.deleteversions.context.normal {
+    border-left-color: #856404;
+    background-color: #fff3cd;
+}
 .deleteversions.context:hover {
     background-color: #ffeaa7;
 }

downloadquizattemptsanon.php

@@ -19,11 +19,15 @@
  * differs only in that the user name and email are replaced by a single
  * hashed_email field.
  *
+ * This is a wrapper script that sets the ANONYMISE flag and then includes
+ * downloadquizattempts.php, which handles all Moodle initialization and login checks.
+ *
  * @package   qtype_coderunner
  * @copyright 2017 Richard Lobb, The University of Canterbury
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-defined('MOODLE_INTERNAL') || die();
 
+// @codingStandardsIgnoreStart
 define('ANONYMISE', 1);
 require(__DIR__ . '/downloadquizattempts.php');
+// @codingStandardsIgnoreEnd