From 1171ad564bfaa8bd444671982c48dbc79696951f Mon Sep 17 00:00:00 2001 From: Marina Glancy Date: Sun, 28 Jul 2013 18:47:57 +1000 Subject: [PATCH] MDL-40897 avoid extra DB queries in groups_get_activity_groupmode() --- lib/grouplib.php | 15 ++++---- lib/tests/grouplib_test.php | 68 +++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+), 9 deletions(-) diff --git a/lib/grouplib.php b/lib/grouplib.php index 528bf5819af..0c71af17791 100644 --- a/lib/grouplib.php +++ b/lib/grouplib.php @@ -464,22 +464,19 @@ function groups_get_course_groupmode($course) { * overrides activity setting if groupmodeforce enabled. * * @category group - * @param cm_info $cm the course module object. Only the ->course and ->groupmode need to be set. + * @param cm_info|stdClass $cm the course module object. Only the ->course and ->groupmode need to be set. * @param stdClass $course object optional course object to improve perf * @return int group mode */ function groups_get_activity_groupmode($cm, $course=null) { - global $COURSE, $DB; - - // get course object (reuse COURSE if possible) if (isset($course->id) and $course->id == $cm->course) { //ok - } else if ($cm->course == $COURSE->id) { - $course = $COURSE; + } else if (isset($cm->coursegroupmode) && isset($cm->coursegroupmodeforce)) { + // This is an instance of cm_info (or clone) and already has the necessary course fields in it. + return empty($cm->coursegroupmodeforce) ? $cm->groupmode : $cm->coursegroupmode; } else { - if (!$course = $DB->get_record('course', array('id'=>$cm->course))) { - print_error('invalidcourseid'); - } + // Get course object (reuse $COURSE if possible). + $course = get_course($cm->course, false); } return empty($course->groupmodeforce) ? $cm->groupmode : $course->groupmode; diff --git a/lib/tests/grouplib_test.php b/lib/tests/grouplib_test.php index 82b2bcb9260..4a131a0bf7c 100644 --- a/lib/tests/grouplib_test.php +++ b/lib/tests/grouplib_test.php @@ -592,4 +592,72 @@ class grouplib_testcase extends advanced_testcase { $result = groups_group_visible($group1->id, $course, $cm, $user1->id); $this->assertTrue($result); // Cm with visible groups. } + + function test_groups_get_groupmode() { + global $DB; + $generator = $this->getDataGenerator(); + $this->resetAfterTest(); + $this->setAdminUser(); + + // Create a course with no groups forcing. + $course1 = $generator->create_course(); + + // Create cm1 with no groups, cm1 with visible groups, cm2 with separate groups and cm3 with visible groups. + $assign1 = $generator->create_module("assign", array('course' => $course1->id)); + $assign2 = $generator->create_module("assign", array('course' => $course1->id), + array('groupmode' => SEPARATEGROUPS)); + $assign3 = $generator->create_module("assign", array('course' => $course1->id), + array('groupmode' => VISIBLEGROUPS)); + + // Request data for tests. + $cm1 = get_coursemodule_from_instance("assign", $assign1->id); + $cm2 = get_coursemodule_from_instance("assign", $assign2->id); + $cm3 = get_coursemodule_from_instance("assign", $assign3->id); + $modinfo = get_fast_modinfo($course1->id); + + // Assert that any method of getting activity groupmode returns the correct result. + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($cm1)); + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($cm1, $course1)); + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm1->id])); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2, $course1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm2->id])); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($cm3)); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($cm3, $course1)); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm3->id])); + + // Update the course set the groupmode SEPARATEGROUPS but not forced. + update_course((object)array('id' => $course1->id, 'groupmode' => SEPARATEGROUPS)); + // Re-request the data from DB. + $course1 = $DB->get_record('course', array('id' => $course1->id)); + $modinfo = get_fast_modinfo($course1->id); + + // Existing activities are not changed. + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($cm1)); + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($cm1, $course1)); + $this->assertEquals(NOGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm1->id])); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2, $course1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm2->id])); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($cm3)); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($cm3, $course1)); + $this->assertEquals(VISIBLEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm3->id])); + + // Update the course set the groupmode SEPARATEGROUPS and forced. + update_course((object)array('id' => $course1->id, 'groupmode' => SEPARATEGROUPS, 'groupmodeforce' => true)); + // Re-request the data from DB. + $course1 = $DB->get_record('course', array('id' => $course1->id)); + $modinfo = get_fast_modinfo($course1->id); + + // Make sure all activities have separate groups mode now. + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm1, $course1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm1->id])); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm2, $course1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm2->id])); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm3)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($cm3, $course1)); + $this->assertEquals(SEPARATEGROUPS, groups_get_activity_groupmode($modinfo->cms[$cm3->id])); + } } -- 2.17.1