MDL-87177 question: Update page types returns for 5.2

As part of the qbank work the page types were incorrect. This has
been updated.
Additionally we now check the context that the quesion is in and
load the appropriate module page types as well.

Author: SimonThornett

public/lib/questionlib.php

@@ -1840,27 +1840,39 @@ function core_question_question_preview_pluginfile($previewcontext, $questionid,
 }
 
 /**
- * Return a list of page types
+ * Return a list of page types for questions and the page types for the current module/context.
+ *
+ * This list is used when displaying blocks on a question page, to provide the list of possible page type patterns for the block.
+ *
  * @param string $pagetype current page type
  * @param stdClass $parentcontext Block's parent context
  * @param stdClass $currentcontext Current context of block
  * @return array
  */
 function question_page_type_list($pagetype, $parentcontext, $currentcontext): array {
-    global $CFG;
     $types = [
         'question-*' => get_string('page-question-x', 'question'),
         'question-edit' => get_string('page-question-edit', 'question'),
-        'question-category' => get_string('page-question-category', 'question'),
-        'question-export' => get_string('page-question-export', 'question'),
-        'question-import' => get_string('page-question-import', 'question')
+        'question-bank-managecategories-category' => get_string('page-question-category', 'question'),
+        'question-bank-exportquestions-export' => get_string('page-question-export', 'question'),
+        'question-bank-importquestions-import' => get_string('page-question-import', 'question'),
     ];
-    if ($currentcontext && $currentcontext->contextlevel == CONTEXT_COURSE) {
-        require_once($CFG->dirroot . '/course/lib.php');
-        return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);
-    } else {
-        return $types;
+    // If current page is in a module context, include the list of page types for that module, if it provides one.
+    if ($currentcontext && $currentcontext->contextlevel == CONTEXT_MODULE) {
+        [, $cm] = get_course_and_cm_from_cmid($currentcontext->instanceid);
+        $directory = core_component::get_plugin_directory('mod', $cm->modname);
+        if (!empty($directory)) {
+            $libfile = $directory . '/lib.php';
+            if (file_exists($libfile)) {
+                require_once($libfile);
+                $function = $cm->modname . '_page_type_list';
+                if (function_exists($function)) {
+                    return array_merge($function($pagetype, $parentcontext, $currentcontext), $types);
+                }
+            }
+        }
     }
+    return $types;
 }
 
 /**

public/lib/tests/questionlib_test.php

@@ -16,8 +16,11 @@
 
 namespace core;
 
+use core\context\course;
+use core\context\module;
 use core_question\local\bank\question_bank_helper;
 use mod_quiz\quiz_settings;
+use PHPUnit\Framework\Attributes\DataProvider;
 use question_bank;
 
 defined('MOODLE_INTERNAL') || die();
@@ -53,9 +56,9 @@ public function setUp(): void {
 
     /**
      * Generate a course and question bank module instance for use in test cases, and return the bank context.
-     * @return \core\context\module
+     * @return module
      */
-    protected function create_course_and_question_bank(): \core\context\module {
+    protected function create_course_and_question_bank(): module {
         $course = self::getDataGenerator()->create_course();
         $qbank = self::getDataGenerator()->create_module('qbank', ['course' => $course->id]);
         return \context_module::instance($qbank->cmid);
@@ -1777,4 +1780,76 @@ public function test_move_question_set_references_category(): void {
         $this->assertEquals($randomquestion->contextid, $context2->id);
         $this->assertEquals($randomquestion->filtercondition['filter']['category']['values'][0], $topcategory2->id);
     }
+
+    /**
+     * Provide examples of different modules and the page types returned by their _page_type_list function.
+     *
+     * @return array[] Module name, and a list of page types.
+     */
+    public static function module_page_types(): array {
+        return [
+            'quiz' => [
+                'module' => 'quiz',
+                'pagetypes' => [
+                    'mod-quiz-*',
+                    'mod-quiz-view',
+                    'mod-quiz-attempt',
+                    'mod-quiz-summary',
+                    'mod-quiz-review',
+                    'mod-quiz-edit',
+                    'mod-quiz-report',
+                ],
+            ],
+            'forum' => [
+                'module' => 'forum',
+                'pagetypes' => [
+                    'mod-forum-*',
+                    'mod-forum-view',
+                    'mod-forum-discuss',
+                ],
+            ],
+            'scorm' => [
+                'module' => 'scorm',
+                'pagetypes' => [
+                    'mod-scorm-*',
+                ],
+            ],
+            'lti' => [ // LTI has no additional page types.
+                'module' => 'lti',
+                'pagetypes' => [],
+            ],
+        ];
+    }
+
+    /**
+     * Calling question_page_type_list should return the question page types, plus the page types for the module context.
+     *
+     * @covers ::question_page_type_list
+     * @param string $module The module name.
+     * @param string[] $pagetypes A list of the page type patterns this module should add.
+     */
+    #[DataProvider('module_page_types')]
+    public function test_question_page_type_list(string $module, array $pagetypes): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        $course = $this->getDataGenerator()->create_course();
+        $coursecontext = course::instance($course->id);
+
+        $modulerecord = $this->getDataGenerator()->create_module($module, ['course' => $course->id]);
+        $modulecontext = module::instance($modulerecord->cmid);
+
+        $questionpagetypes = [
+            'question-*',
+            'question-edit',
+            'question-bank-managecategories-category',
+            'question-bank-exportquestions-export',
+            'question-bank-importquestions-import',
+        ];
+
+        $expectedpagetypes = array_merge($pagetypes, $questionpagetypes);
+        $actualpagetypes = question_page_type_list('question-edit', $coursecontext, $modulecontext);
+        // Check that the expected page type patterns match those returned for this module.
+        $this->assertEquals($expectedpagetypes, array_keys($actualpagetypes));
+    }
 }