Merge branch 'wip-MDL-44952-master' of https://github.com/marinaglancy/moodle
authorDan Poltawski <dan@moodle.com>
Tue, 1 Mar 2016 04:30:56 +0000 (12:30 +0800)
committerDan Poltawski <dan@moodle.com>
Tue, 1 Mar 2016 04:30:56 +0000 (12:30 +0800)
14 files changed:
lib/db/services.php
lib/form/tests/behat/modgrade_validation.feature
mod/folder/classes/event/all_files_downloaded.php [new file with mode: 0644]
mod/folder/download_folder.php
mod/folder/lang/en/folder.php
mod/folder/lib.php
mod/folder/tests/events_test.php
mod/wiki/classes/external.php
mod/wiki/db/services.php
mod/wiki/locallib.php
mod/wiki/tests/externallib_test.php
mod/wiki/tests/lib_test.php
mod/wiki/version.php
version.php

index afeeebe..64e7b38 100644 (file)
@@ -1314,6 +1314,7 @@ $services = array(
             'mod_wiki_get_wikis_by_courses',
             'mod_wiki_view_wiki',
             'mod_wiki_view_page',
+            'mod_wiki_get_subwikis',
             'mod_glossary_view_glossary',
             'mod_glossary_view_entry',
             'mod_glossary_get_entries_by_letter',
index 73ecb0a..d680313 100644 (file)
@@ -141,7 +141,6 @@ Feature: Using the activity grade form element
       | Subject  | Discussion subject |
       | Message | Discussion message |
     And I press "Post to forum"
-    And I follow "Continue"
     And I log out
     And I log in as "teacher1"
     And I follow "Course 1"
diff --git a/mod/folder/classes/event/all_files_downloaded.php b/mod/folder/classes/event/all_files_downloaded.php
new file mode 100644 (file)
index 0000000..27e9d21
--- /dev/null
@@ -0,0 +1,95 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * The mod_folder course module downloaded event.
+ *
+ * @package   mod_folder
+ * @copyright 2015 Andrew Hancox <andrewdchancox@googlemail.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_folder\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The mod_folder course module viewed event class.
+ *
+ * @package    mod_folder
+ * @since      Moodle 3.1
+ * @copyright  2015 Andrew Hancox <andrewdchancox@googlemail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class all_files_downloaded extends \core\event\base {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+        $this->data['objecttable'] = 'folder';
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' downloaded a zip archive containing all the files from the folder activity with " .
+        "course module id '$this->contextinstanceid'.";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventallfilesdownloaded', 'folder');
+    }
+
+    /**
+     * Get URL related to the action.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url("/mod/folder/view.php", array('id' => $this->contextinstanceid));
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        parent::validate_data();
+        // Make sure this class is never used without proper object details.
+        if (empty($this->objectid) || empty($this->objecttable)) {
+            throw new \coding_exception('The course_module_viewed event must define objectid and object table.');
+        }
+        // Make sure the context level is set to module.
+        if ($this->contextlevel != CONTEXT_MODULE) {
+            throw new \coding_exception('Context level must be CONTEXT_MODULE.');
+        }
+    }
+}
index a1a8631..ef6d101 100644 (file)
@@ -40,9 +40,7 @@ if (!$downloadable) {
     print_error('cannotdownloaddir', 'repository');
 }
 
-// Completion.
-$completion = new completion_info($course);
-$completion->set_module_viewed($cm);
+folder_downloaded($folder, $course, $cm, $context);
 
 $fs = get_file_storage();
 $file = $fs->get_file($context->id, 'mod_folder', 'content', 0, '/', '.');
index 9559ac9..abca28b 100644 (file)
@@ -26,6 +26,7 @@
 $string['contentheader'] = 'Content';
 $string['dnduploadmakefolder'] = 'Unzip files and create folder';
 $string['downloadfolder'] = 'Download folder';
+$string['eventallfilesdownloaded'] = 'Zip archive of folder downloaded';
 $string['eventfolderupdated'] = 'Folder updated';
 $string['folder:addinstance'] = 'Add a new folder';
 $string['folder:managefiles'] = 'Manage files in folder module';
index dd7c30c..bd6a47f 100644 (file)
@@ -530,4 +530,29 @@ function folder_get_directory_size($directory) {
     }
 
     return $size;
-}
\ No newline at end of file
+}
+
+/**
+ * Mark the activity completed (if required) and trigger the all_files_downloaded event.
+ *
+ * @param  stdClass $folder     folder object
+ * @param  stdClass $course     course object
+ * @param  stdClass $cm         course module object
+ * @param  stdClass $context    context object
+ * @since Moodle 3.1
+ */
+function folder_downloaded($folder, $course, $cm, $context) {
+    $params = array(
+        'context' => $context,
+        'objectid' => $folder->id
+    );
+    $event = \mod_folder\event\all_files_downloaded::create($params);
+    $event->add_record_snapshot('course_modules', $cm);
+    $event->add_record_snapshot('course', $course);
+    $event->add_record_snapshot('folder', $folder);
+    $event->trigger();
+
+    // Completion.
+    $completion = new completion_info($course);
+    $completion->set_module_viewed($cm);
+}
index a7b54a4..71723dc 100644 (file)
@@ -68,4 +68,31 @@ class mod_folder_events_testcase extends advanced_testcase {
         $this->assertEventLegacyLogData($expected, $event);
         $this->assertEventContextNotUsed($event);
     }
+
+    /**
+     * Test the folder updated event.
+     *
+     * There is no external API for updating a folder, so the unit test will simply create
+     * and trigger the event and ensure the legacy log data is returned as expected.
+     */
+    public function test_all_files_downloaded() {
+        $this->setAdminUser();
+        $course = $this->getDataGenerator()->create_course();
+        $folder = $this->getDataGenerator()->create_module('folder', array('course' => $course->id));
+        $context = context_module::instance($folder->cmid);
+        $cm = get_coursemodule_from_id('folder', $folder->cmid, $course->id, true, MUST_EXIST);
+
+        $sink = $this->redirectEvents();
+        folder_downloaded($folder, $course, $cm, $context);
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Checking that the event contains the expected values.
+        $this->assertInstanceOf('\mod_folder\event\all_files_downloaded', $event);
+        $this->assertEquals(context_module::instance($folder->cmid), $event->get_context());
+        $this->assertEquals($folder->id, $event->objectid);
+        $expected = array($course->id, 'folder', 'edit', 'edit.php?id=' . $folder->cmid, $folder->id, $folder->cmid);
+        $this->assertEventContextNotUsed($event);
+    }
 }
index 0ce1096..1aa157e 100644 (file)
@@ -320,4 +320,79 @@ class mod_wiki_external extends external_api {
         );
     }
 
+    /**
+     * Describes the parameters for get_subwikis.
+     *
+     * @return external_function_parameters
+     * @since Moodle 3.1
+     */
+    public static function get_subwikis_parameters() {
+        return new external_function_parameters (
+            array(
+                'wikiid' => new external_value(PARAM_INT, 'Wiki instance ID.')
+            )
+        );
+    }
+
+    /**
+     * Returns the list of subwikis the user can see in a specific wiki.
+     *
+     * @param int $wikiid The wiki instance ID.
+     * @return array Containing a list of warnings and a list of subwikis.
+     * @since Moodle 3.1
+     */
+    public static function get_subwikis($wikiid) {
+        global $USER;
+
+        $warnings = array();
+
+        $params = self::validate_parameters(self::get_subwikis_parameters(), array('wikiid' => $wikiid));
+
+        // Get wiki instance.
+        if (!$wiki = wiki_get_wiki($params['wikiid'])) {
+            throw new moodle_exception('incorrectwikiid', 'wiki');
+        }
+
+        // Validate context and capabilities.
+        list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
+        $context = context_module::instance($cm->id);
+        self::validate_context($context);
+        require_capability('mod/wiki:viewpage', $context);
+
+        $returnedsubwikis = wiki_get_visible_subwikis($wiki, $cm, $context);
+        foreach ($returnedsubwikis as $subwiki) {
+            $subwiki->canedit = wiki_user_can_edit($subwiki);
+        }
+
+        $result = array();
+        $result['subwikis'] = $returnedsubwikis;
+        $result['warnings'] = $warnings;
+        return $result;
+    }
+
+    /**
+     * Describes the get_subwikis return value.
+     *
+     * @return external_single_structure
+     * @since Moodle 3.1
+     */
+    public static function get_subwikis_returns() {
+        return new external_single_structure(
+            array(
+                'subwikis' => new external_multiple_structure(
+                    new external_single_structure(
+                        array(
+                            'id' => new external_value(PARAM_INT, 'Subwiki ID.'),
+                            'wikiid' => new external_value(PARAM_INT, 'Wiki ID.'),
+                            'groupid' => new external_value(PARAM_RAW, 'Group ID.'),
+                            'userid' => new external_value(PARAM_INT, 'User ID.'),
+                            'canedit' => new external_value(PARAM_BOOL, 'True if user can edit the subwiki.'),
+                        ), 'Subwikis'
+                    )
+                ),
+                'warnings' => new external_warnings(),
+            )
+        );
+    }
+
 }
index 46cf320..e0ff470 100644 (file)
@@ -49,5 +49,13 @@ $functions = array(
         'description'   => 'Trigger the page viewed event and update the module completion status.',
         'type'          => 'write',
         'capabilities'  => 'mod/wiki:viewpage'
+    ),
+
+    'mod_wiki_get_subwikis' => array(
+        'classname'     => 'mod_wiki_external',
+        'methodname'    => 'get_subwikis',
+        'description'   => 'Returns the list of subwikis the user can see in a specific wiki.',
+        'type'          => 'read',
+        'capabilities'  => 'mod/wiki:viewpage'
     )
 );
index 2ddbb83..474246d 100644 (file)
@@ -1562,3 +1562,127 @@ function wiki_get_updated_pages_by_subwiki($swid) {
 function wiki_can_create_pages($context, $user = null) {
     return has_capability('mod/wiki:createpage', $context, $user);
 }
+
+/**
+ * Get a sub wiki instance by wiki id, group id and user id.
+ * If the wiki doesn't exist in DB it will return an isntance with id -1.
+ *
+ * @param int $wikiid  Wiki ID.
+ * @param int $groupid Group ID.
+ * @param int $userid  User ID.
+ * @return object      Subwiki instance.
+ * @since Moodle 3.1
+ */
+function wiki_get_possible_subwiki_by_group($wikiid, $groupid, $userid = 0) {
+    if (!$subwiki = wiki_get_subwiki_by_group($wikiid, $groupid, $userid)) {
+        $subwiki = new stdClass();
+        $subwiki->id = -1;
+        $subwiki->wikiid = $wikiid;
+        $subwiki->groupid = $groupid;
+        $subwiki->userid = $userid;
+    }
+    return $subwiki;
+}
+
+/**
+ * Get all the possible subwikis visible to the user in a wiki.
+ * It will return all the subwikis that can be created in a wiki, even if they don't exist in DB yet.
+ *
+ * @param  stdClass $wiki          Wiki to get the subwikis from.
+ * @param  cm_info|stdClass $cm    Optional. The course module object.
+ * @param  context_module $context Optional. Context of wiki module.
+ * @return array                   List of subwikis.
+ * @since Moodle 3.1
+ */
+function wiki_get_visible_subwikis($wiki, $cm = null, $context = null) {
+    global $USER;
+
+    $subwikis = array();
+
+    if (empty($wiki) or !is_object($wiki)) {
+        // Wiki not valid.
+        return $subwikis;
+    }
+
+    if (empty($cm)) {
+        $cm = get_coursemodule_from_instance('wiki', $wiki->id);
+    }
+    if (empty($context)) {
+        $context = context_module::instance($cm->id);
+    }
+
+    if (!has_capability('mod/wiki:viewpage', $context)) {
+        return $subwikis;
+    }
+
+    $manage = has_capability('mod/wiki:managewiki', $context);
+
+    if (!$groupmode = groups_get_activity_groupmode($cm)) {
+        // No groups.
+        if ($wiki->wikimode == 'collaborative') {
+            // Only 1 subwiki.
+            $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, 0);
+        } else if ($wiki->wikimode == 'individual') {
+            // There's 1 subwiki per user.
+            if ($manage) {
+                // User can view all subwikis.
+                $users = get_enrolled_users($context);
+                foreach ($users as $user) {
+                    $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $user->id);
+                }
+            } else {
+                // User can only see his subwiki.
+                $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $USER->id);
+            }
+        }
+    } else {
+        if ($wiki->wikimode == 'collaborative') {
+            // 1 subwiki per group.
+            $aag = has_capability('moodle/site:accessallgroups', $context);
+            if ($aag || $groupmode == VISIBLEGROUPS) {
+                // User can see all groups.
+                $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
+                $allparticipants = new stdClass();
+                $allparticipants->id = 0;
+                array_unshift($allowedgroups, $allparticipants); // Add all participants.
+            } else {
+                // User can only see the groups he belongs to.
+                $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
+            }
+
+            foreach ($allowedgroups as $group) {
+                $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, 0);
+            }
+        } else if ($wiki->wikimode == 'individual') {
+            // 1 subwiki per user and group.
+
+            if ($manage || $groupmode == VISIBLEGROUPS) {
+                // User can view all subwikis.
+                $users = get_enrolled_users($context);
+                foreach ($users as $user) {
+                    // Get all the groups this user belongs to.
+                    $groups = groups_get_all_groups($cm->course, $user->id);
+                    if (!empty($groups)) {
+                        foreach ($groups as $group) {
+                            $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, $user->id);
+                        }
+                    } else {
+                        // User doesn't belong to any group, add it to group 0.
+                        $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $user->id);
+                    }
+                }
+            } else {
+                // The user can only see the subwikis of the groups he belongs.
+                $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
+                foreach ($allowedgroups as $group) {
+                    $users = groups_get_members($group->id);
+                    foreach ($users as $user) {
+                        $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, $user->id);
+                    }
+                }
+            }
+        }
+    }
+
+    return $subwikis;
+}
index 978a841..06c3ace 100644 (file)
@@ -315,4 +315,61 @@ class mod_wiki_external_testcase extends externallib_advanced_testcase {
 
     }
 
+    /**
+     * Test get_subwikis.
+     */
+    public function test_get_subwikis() {
+
+        // Test invalid wiki id.
+        try {
+            mod_wiki_external::get_subwikis(0);
+            $this->fail('Exception expected due to invalid get_subwikis wiki id.');
+        } catch (moodle_exception $e) {
+            $this->assertEquals('incorrectwikiid', $e->errorcode);
+        }
+
+        // Test not-enrolled user.
+        $usernotenrolled = self::getDataGenerator()->create_user();
+        $this->setUser($usernotenrolled);
+        try {
+            mod_wiki_external::get_subwikis($this->wiki->id);
+            $this->fail('Exception expected due to not enrolled user.');
+        } catch (moodle_exception $e) {
+            $this->assertEquals('requireloginerror', $e->errorcode);
+        }
+
+        // Test user with full capabilities.
+        $this->setUser($this->student);
+
+        // Create what we expect to be returned. We only test a basic case because deep testing is already done
+        // in the tests for wiki_get_visible_subwikis.
+        $expectedsubwikis = array();
+        $expectedsubwiki = array(
+                'id' => $this->firstpage->subwikiid,
+                'wikiid' => $this->wiki->id,
+                'groupid' => 0,
+                'userid' => 0,
+                'canedit' => true
+            );
+        $expectedsubwikis[] = $expectedsubwiki;
+
+        $result = mod_wiki_external::get_subwikis($this->wiki->id);
+        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwikis_returns(), $result);
+        $this->assertEquals($expectedsubwikis, $result['subwikis']);
+        $this->assertCount(0, $result['warnings']);
+
+        // Test user with no capabilities.
+        // We need a explicit prohibit since this capability is allowed for students by default.
+        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
+        accesslib_clear_all_caches_for_unit_testing();
+
+        try {
+            mod_wiki_external::get_subwikis($this->wiki->id);
+            $this->fail('Exception expected due to missing capability.');
+        } catch (moodle_exception $e) {
+            $this->assertEquals('nopermissions', $e->errorcode);
+        }
+
+    }
+
 }
index 7fc076c..8f01047 100644 (file)
@@ -28,6 +28,7 @@ defined('MOODLE_INTERNAL') || die();
 
 global $CFG;
 require_once($CFG->dirroot . '/mod/wiki/lib.php');
+require_once($CFG->dirroot . '/mod/wiki/locallib.php');
 require_once($CFG->libdir . '/completionlib.php');
 
 /**
@@ -35,7 +36,7 @@ require_once($CFG->libdir . '/completionlib.php');
  *
  * @package    mod_wiki
  * @category   external
- * @copyright  2015 Dani Palou <juan@moodle.com>
+ * @copyright  2015 Dani Palou <dani@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since      Moodle 3.1
  */
@@ -391,4 +392,266 @@ class mod_wiki_lib_testcase extends advanced_testcase {
         $this->assertTrue(wiki_user_can_edit($swvisindg2s2));
         $this->assertTrue(wiki_user_can_edit($swvisindteacher));
     }
+
+    /**
+     * Test wiki_get_visible_subwikis without groups.
+     *
+     * @return void
+     */
+    public function test_wiki_get_visible_subwikis_without_groups() {
+        global $DB;
+
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        // Setup test data.
+        $course = $this->getDataGenerator()->create_course();
+        $indwiki = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id, 'wikimode' => 'individual'));
+        $colwiki = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id, 'wikimode' => 'collaborative'));
+
+        // Create users.
+        $student = self::getDataGenerator()->create_user();
+        $teacher = self::getDataGenerator()->create_user();
+
+        // Users enrolments.
+        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
+        $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual');
+
+        $this->setUser($student);
+
+        // Check that not passing a wiki returns empty array.
+        $result = wiki_get_visible_subwikis(null);
+        $this->assertEquals(array(), $result);
+
+        // Check that the student can get the only subwiki from the collaborative wiki.
+        $expectedsubwikis = array();
+        $expectedsubwiki = new stdClass();
+        $expectedsubwiki->id = -1; // We haven't created any page so the subwiki hasn't been created.
+        $expectedsubwiki->wikiid = $colwiki->id;
+        $expectedsubwiki->groupid = 0;
+        $expectedsubwiki->userid = 0;
+        $expectedsubwikis[] = $expectedsubwiki;
+
+        $result = wiki_get_visible_subwikis($colwiki);
+        $this->assertEquals($expectedsubwikis, $result);
+
+        // Create a page now so the subwiki is created.
+        $colfirstpage = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_first_page($colwiki);
+
+        // Call the function again, now we expect to have a subwiki ID.
+        $expectedsubwikis[0]->id = $colfirstpage->subwikiid;
+        $result = wiki_get_visible_subwikis($colwiki);
+        $this->assertEquals($expectedsubwikis, $result);
+
+        // Check that the teacher can see it too.
+        $this->setUser($teacher);
+        $result = wiki_get_visible_subwikis($colwiki);
+        $this->assertEquals($expectedsubwikis, $result);
+
+        // Check that the student can only see his subwiki in the individual wiki.
+        $this->setUser($student);
+        $expectedsubwikis[0]->id = -1;
+        $expectedsubwikis[0]->wikiid = $indwiki->id;
+        $expectedsubwikis[0]->userid = $student->id;
+        $result = wiki_get_visible_subwikis($indwiki);
+        $this->assertEquals($expectedsubwikis, $result);
+
+        // Check that the teacher can see his subwiki and the student subwiki in the individual wiki.
+        $this->setUser($teacher);
+        $teachersubwiki = new stdClass();
+        $teachersubwiki->id = -1;
+        $teachersubwiki->wikiid = $indwiki->id;
+        $teachersubwiki->groupid = 0;
+        $teachersubwiki->userid = $teacher->id;
+        $expectedsubwikis[] = $teachersubwiki;
+
+        $result = wiki_get_visible_subwikis($indwiki);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true); // Compare without order.
+    }
+
+    /**
+     * Test wiki_get_visible_subwikis using collaborative wikis with groups.
+     *
+     * @return void
+     */
+    public function test_wiki_get_visible_subwikis_with_groups_collaborative() {
+        global $DB;
+
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        // Setup test data.
+        $course = $this->getDataGenerator()->create_course();
+        $wikisepcol = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id,
+                                                        'groupmode' => SEPARATEGROUPS, 'wikimode' => 'collaborative'));
+        $wikiviscol = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id,
+                                                        'groupmode' => VISIBLEGROUPS, 'wikimode' => 'collaborative'));
+
+        // Create users.
+        $student = self::getDataGenerator()->create_user();
+        $student2 = self::getDataGenerator()->create_user();
+        $student3 = self::getDataGenerator()->create_user();
+        $teacher = self::getDataGenerator()->create_user();
+
+        // Users enrolments.
+        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
+        $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($student3->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual');
+
+        // Create groups.
+        $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student->id, 'groupid' => $group1->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student2->id, 'groupid' => $group1->id));
+        $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student2->id, 'groupid' => $group2->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student3->id, 'groupid' => $group2->id));
+
+        $this->setUser($student);
+
+        // Create all the possible subwikis. We haven't created any page so ids will be -1.
+        // Subwikis in collaborative wikis: 1 subwiki per group + 1 subwiki for all participants.
+        $swsepcolg1 = new stdClass();
+        $swsepcolg1->id = -1;
+        $swsepcolg1->wikiid = $wikisepcol->id;
+        $swsepcolg1->groupid = $group1->id;
+        $swsepcolg1->userid = 0;
+
+        $swsepcolg2 = clone($swsepcolg1);
+        $swsepcolg2->groupid = $group2->id;
+
+        $swsepcolallparts = clone($swsepcolg1); // All participants.
+        $swsepcolallparts->groupid = 0;
+
+        $swviscolg1 = clone($swsepcolg1);
+        $swviscolg1->wikiid = $wikiviscol->id;
+
+        $swviscolg2 = clone($swviscolg1);
+        $swviscolg2->groupid = $group2->id;
+
+        $swviscolallparts = clone($swviscolg1); // All participants.
+        $swviscolallparts->groupid = 0;
+
+        // Check that the student can get only the subwiki from his group in collaborative wiki with separate groups.
+        $expectedsubwikis = array($swsepcolg1);
+        $result = wiki_get_visible_subwikis($wikisepcol);
+        $this->assertEquals($expectedsubwikis, $result);
+
+        // Check that he can get subwikis from both groups in collaborative wiki with visible groups, and also all participants.
+        $expectedsubwikis = array($swviscolallparts, $swviscolg1, $swviscolg2);
+        $result = wiki_get_visible_subwikis($wikiviscol);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true);
+
+        // Now test it as a teacher. No need to check visible groups wikis because the result is the same as student.
+        $this->setUser($teacher);
+
+        // Check that he can get the subwikis from all the groups in collaborative wiki with separate groups.
+        $expectedsubwikis = array($swsepcolg1, $swsepcolg2, $swsepcolallparts);
+        $result = wiki_get_visible_subwikis($wikisepcol);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true);
+    }
+
+    /**
+     * Test wiki_get_visible_subwikis using individual wikis with groups.
+     *
+     * @return void
+     */
+    public function test_wiki_get_visible_subwikis_with_groups_individual() {
+        global $DB;
+
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        // Setup test data.
+        $course = $this->getDataGenerator()->create_course();
+        $wikisepind = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id,
+                                                        'groupmode' => SEPARATEGROUPS, 'wikimode' => 'individual'));
+        $wikivisind = $this->getDataGenerator()->create_module('wiki', array('course' => $course->id,
+                                                        'groupmode' => VISIBLEGROUPS, 'wikimode' => 'individual'));
+
+        // Create users.
+        $student = self::getDataGenerator()->create_user();
+        $student2 = self::getDataGenerator()->create_user();
+        $student3 = self::getDataGenerator()->create_user();
+        $teacher = self::getDataGenerator()->create_user();
+
+        // Users enrolments.
+        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
+        $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($student3->id, $course->id, $studentrole->id, 'manual');
+        $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual');
+
+        // Create groups.
+        $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student->id, 'groupid' => $group1->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student2->id, 'groupid' => $group1->id));
+        $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student2->id, 'groupid' => $group2->id));
+        $this->getDataGenerator()->create_group_member(array('userid' => $student3->id, 'groupid' => $group2->id));
+
+        $this->setUser($student);
+
+        // Create all the possible subwikis to be returned. We haven't created any page so ids will be -1.
+        // Subwikis in individual wikis: 1 subwiki per user and group. If user doesn't belong to any group then groupid is 0.
+        $swsepindg1s1 = new stdClass();
+        $swsepindg1s1->id = -1;
+        $swsepindg1s1->wikiid = $wikisepind->id;
+        $swsepindg1s1->groupid = $group1->id;
+        $swsepindg1s1->userid = $student->id;
+
+        $swsepindg1s2 = clone($swsepindg1s1);
+        $swsepindg1s2->userid = $student2->id;
+
+        $swsepindg2s2 = clone($swsepindg1s2);
+        $swsepindg2s2->groupid = $group2->id;
+
+        $swsepindg2s3 = clone($swsepindg1s1);
+        $swsepindg2s3->userid = $student3->id;
+        $swsepindg2s3->groupid = $group2->id;
+
+        $swsepindteacher = clone($swsepindg1s1);
+        $swsepindteacher->userid = $teacher->id;
+        $swsepindteacher->groupid = 0;
+
+        $swvisindg1s1 = clone($swsepindg1s1);
+        $swvisindg1s1->wikiid = $wikivisind->id;
+
+        $swvisindg1s2 = clone($swvisindg1s1);
+        $swvisindg1s2->userid = $student2->id;
+
+        $swvisindg2s2 = clone($swvisindg1s2);
+        $swvisindg2s2->groupid = $group2->id;
+
+        $swvisindg2s3 = clone($swvisindg1s1);
+        $swvisindg2s3->userid = $student3->id;
+        $swvisindg2s3->groupid = $group2->id;
+
+        $swvisindteacher = clone($swvisindg1s1);
+        $swvisindteacher->userid = $teacher->id;
+        $swvisindteacher->groupid = 0;
+
+        // Check that student can get the subwikis from his group in individual wiki with separate groups.
+        $expectedsubwikis = array($swsepindg1s1, $swsepindg1s2);
+        $result = wiki_get_visible_subwikis($wikisepind);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true);
+
+        // Check that he can get subwikis from all users and groups in individual wiki with visible groups.
+        $expectedsubwikis = array($swvisindg1s1, $swvisindg1s2, $swvisindg2s2, $swvisindg2s3, $swvisindteacher);
+        $result = wiki_get_visible_subwikis($wikivisind);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true);
+
+        // Now test it as a teacher. No need to check visible groups wikis because the result is the same as student.
+        $this->setUser($teacher);
+
+        // Check that teacher can get the subwikis from all the groups in individual wiki with separate groups.
+        $expectedsubwikis = array($swsepindg1s1, $swsepindg1s2, $swsepindg2s2, $swsepindg2s3, $swsepindteacher);
+        $result = wiki_get_visible_subwikis($wikisepind);
+        $this->assertEquals($expectedsubwikis, $result, '', 0, 10, true);
+    }
 }
index d82e96b..dc729d4 100644 (file)
@@ -33,7 +33,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2016011100;       // The current module version (Date: YYYYMMDDXX)
+$plugin->version   = 2016011101;       // The current module version (Date: YYYYMMDDXX)
 $plugin->requires  = 2015111000;    // Requires this Moodle version
 $plugin->component = 'mod_wiki';       // Full name of the plugin (used for diagnostics)
 $plugin->cron      = 0;
index 8454fe1..4adc2d6 100644 (file)
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2016030101.00;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2016030102.00;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.