/** * Testing function course_get_tagged_course_modules - search tagged course modules */ public function test_course_get_tagged_course_modules() { global $DB; $this->resetAfterTest(); $course3 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); $course1 = $this->getDataGenerator()->create_course(); $cm11 = $this->getDataGenerator()->create_module('assign', array('course' => $course1->id, 'tags' => 'Cat, Dog')); $cm12 = $this->getDataGenerator()->create_module('page', array('course' => $course1->id, 'tags' => 'Cat, Mouse', 'visible' => 0)); $cm13 = $this->getDataGenerator()->create_module('page', array('course' => $course1->id, 'tags' => 'Cat, Mouse, Dog')); $cm21 = $this->getDataGenerator()->create_module('forum', array('course' => $course2->id, 'tags' => 'Cat, Mouse')); $cm31 = $this->getDataGenerator()->create_module('forum', array('course' => $course3->id, 'tags' => 'Cat, Mouse')); // Admin is able to view everything. $this->setAdminUser(); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, 0, 0, 1, 0); $this->assertRegExp('/' . $cm11->name . '/', $res->content); $this->assertRegExp('/' . $cm12->name . '/', $res->content); $this->assertRegExp('/' . $cm13->name . '/', $res->content); $this->assertRegExp('/' . $cm21->name . '/', $res->content); $this->assertRegExp('/' . $cm31->name . '/', $res->content); // Results from course1 are returned before results from course2. $this->assertTrue(strpos($res->content, $cm11->name) < strpos($res->content, $cm21->name)); // Ordinary user is not able to see anything. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, 0, 0, 1, 0); $this->assertNull($res); // Enrol user as student in course1 and course2. $roleids = $DB->get_records_menu('role', null, '', 'shortname, id'); $this->getDataGenerator()->enrol_user($user->id, $course1->id, $roleids['student']); $this->getDataGenerator()->enrol_user($user->id, $course2->id, $roleids['student']); core_tag_index_builder::reset_caches(); // Searching in the course context returns visible modules in this course. $context = context_course::instance($course1->id); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, 0, $context->id, 1, 0); $this->assertRegExp('/' . $cm11->name . '/', $res->content); $this->assertNotRegExp('/' . $cm12->name . '/', $res->content); $this->assertRegExp('/' . $cm13->name . '/', $res->content); $this->assertNotRegExp('/' . $cm21->name . '/', $res->content); $this->assertNotRegExp('/' . $cm31->name . '/', $res->content); // Searching FROM the course context returns visible modules in all courses. $context = context_course::instance($course2->id); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, $context->id, 0, 1, 0); $this->assertRegExp('/' . $cm11->name . '/', $res->content); $this->assertNotRegExp('/' . $cm12->name . '/', $res->content); $this->assertRegExp('/' . $cm13->name . '/', $res->content); $this->assertRegExp('/' . $cm21->name . '/', $res->content); $this->assertNotRegExp('/' . $cm31->name . '/', $res->content); // No access to course3. // Results from course2 are returned before results from course1. $this->assertTrue(strpos($res->content, $cm21->name) < strpos($res->content, $cm11->name)); // Enrol user in course1 as a teacher - now he should be able to see hidden module. $this->getDataGenerator()->enrol_user($user->id, $course1->id, $roleids['editingteacher']); get_fast_modinfo(0, 0, true); $context = context_course::instance($course1->id); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, $context->id, 0, 1, 0); $this->assertRegExp('/' . $cm12->name . '/', $res->content); // Create more modules and try pagination. $cm14 = $this->getDataGenerator()->create_module('assign', array('course' => $course1->id, 'tags' => 'Cat, Dog')); $cm15 = $this->getDataGenerator()->create_module('page', array('course' => $course1->id, 'tags' => 'Cat, Mouse', 'visible' => 0)); $cm16 = $this->getDataGenerator()->create_module('page', array('course' => $course1->id, 'tags' => 'Cat, Mouse, Dog')); $context = context_course::instance($course1->id); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, 0, $context->id, 1, 0); $this->assertRegExp('/' . $cm11->name . '/', $res->content); $this->assertRegExp('/' . $cm12->name . '/', $res->content); $this->assertRegExp('/' . $cm13->name . '/', $res->content); $this->assertNotRegExp('/' . $cm21->name . '/', $res->content); $this->assertRegExp('/' . $cm14->name . '/', $res->content); $this->assertRegExp('/' . $cm15->name . '/', $res->content); $this->assertNotRegExp('/' . $cm16->name . '/', $res->content); $this->assertNotRegExp('/' . $cm31->name . '/', $res->content); // No access to course3. $this->assertEmpty($res->prevpageurl); $this->assertNotEmpty($res->nextpageurl); $res = course_get_tagged_course_modules(core_tag_tag::get_by_name(0, 'Cat'), false, 0, $context->id, 1, 1); $this->assertNotRegExp('/' . $cm11->name . '/', $res->content); $this->assertNotRegExp('/' . $cm12->name . '/', $res->content); $this->assertNotRegExp('/' . $cm13->name . '/', $res->content); $this->assertNotRegExp('/' . $cm21->name . '/', $res->content); $this->assertNotRegExp('/' . $cm14->name . '/', $res->content); $this->assertNotRegExp('/' . $cm15->name . '/', $res->content); $this->assertRegExp('/' . $cm16->name . '/', $res->content); $this->assertNotRegExp('/' . $cm31->name . '/', $res->content); // No access to course3. $this->assertNotEmpty($res->prevpageurl); $this->assertEmpty($res->nextpageurl); }
/** * Returns wiki pages tagged with a specified tag. * * This is a callback used by the tag area mod_wiki/wiki_pages to search for wiki pages * tagged with a specific tag. * * @param core_tag_tag $tag * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag * are displayed on the page and the per-page limit may be bigger * @param int $fromctx context id where the link was displayed, may be used by callbacks * to display items in the same context first * @param int $ctx context id where to search for records * @param bool $rec search in subcontexts as well * @param int $page 0-based number of page being displayed * @return \core_tag\output\tagindex */ function mod_wiki_get_tagged_pages($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) { global $OUTPUT; $perpage = $exclusivemode ? 20 : 5; // Build the SQL query. $ctxselect = context_helper::get_preload_record_columns_sql('ctx'); $query = "SELECT wp.id, wp.title, ws.userid, ws.wikiid, ws.id AS subwikiid, ws.groupid, w.wikimode,\n cm.id AS cmid, c.id AS courseid, c.shortname, c.fullname, {$ctxselect}\n FROM {wiki_pages} wp\n JOIN {wiki_subwikis} ws ON wp.subwikiid = ws.id\n JOIN {wiki} w ON w.id = ws.wikiid\n JOIN {modules} m ON m.name='wiki'\n JOIN {course_modules} cm ON cm.module = m.id AND cm.instance = w.id\n JOIN {tag_instance} tt ON wp.id = tt.itemid\n JOIN {course} c ON cm.course = c.id\n JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel\n WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component\n AND wp.id %ITEMFILTER% AND c.id %COURSEFILTER%"; $params = array('itemtype' => 'wiki_pages', 'tagid' => $tag->id, 'component' => 'mod_wiki', 'coursemodulecontextlevel' => CONTEXT_MODULE); if ($ctx) { $context = $ctx ? context::instance_by_id($ctx) : context_system::instance(); $query .= $rec ? ' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid'; $params['contextid'] = $context->id; $params['path'] = $context->path . '/%'; } $query .= " ORDER BY "; if ($fromctx) { // In order-clause specify that modules from inside "fromctx" context should be returned first. $fromcontext = context::instance_by_id($fromctx); $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),'; $params['fromcontextid'] = $fromcontext->id; $params['frompath'] = $fromcontext->path . '/%'; } $query .= ' c.sortorder, cm.id, wp.id'; $totalpages = $page + 1; // Use core_tag_index_builder to build and filter the list of items. $builder = new core_tag_index_builder('mod_wiki', 'wiki_pages', $query, $params, $page * $perpage, $perpage + 1); while ($item = $builder->has_item_that_needs_access_check()) { context_helper::preload_from_record($item); $courseid = $item->courseid; if (!$builder->can_access_course($courseid)) { $builder->set_accessible($item, false); continue; } $modinfo = get_fast_modinfo($builder->get_course($courseid)); // Set accessibility of this item and all other items in the same course. $builder->walk(function ($taggeditem) use($courseid, $modinfo, $builder) { if ($taggeditem->courseid == $courseid) { $accessible = false; if (($cm = $modinfo->get_cm($taggeditem->cmid)) && $cm->uservisible) { $subwiki = (object) array('id' => $taggeditem->subwikiid, 'groupid' => $taggeditem->groupid, 'userid' => $taggeditem->userid, 'wikiid' => $taggeditem->wikiid); $wiki = (object) array('id' => $taggeditem->wikiid, 'wikimode' => $taggeditem->wikimode, 'course' => $cm->course); $accessible = wiki_user_can_view($subwiki, $wiki); } $builder->set_accessible($taggeditem, $accessible); } }); } $items = $builder->get_items(); if (count($items) > $perpage) { $totalpages = $page + 2; // We don't need exact page count, just indicate that the next page exists. array_pop($items); } // Build the display contents. if ($items) { $tagfeed = new core_tag\output\tagfeed(); foreach ($items as $item) { context_helper::preload_from_record($item); $modinfo = get_fast_modinfo($item->courseid); $cm = $modinfo->get_cm($item->cmid); $pageurl = new moodle_url('/mod/wiki/view.php', array('pageid' => $item->id)); $pagename = format_string($item->title, true, array('context' => context_module::instance($item->cmid))); $pagename = html_writer::link($pageurl, $pagename); $courseurl = course_get_url($item->courseid, $cm->sectionnum); $cmname = html_writer::link($cm->url, $cm->get_formatted_name()); $coursename = format_string($item->fullname, true, array('context' => context_course::instance($item->courseid))); $coursename = html_writer::link($courseurl, $coursename); $icon = html_writer::link($pageurl, html_writer::empty_tag('img', array('src' => $cm->get_icon_url()))); $tagfeed->add($icon, $pagename, $cmname . '<br>' . $coursename); } $content = $OUTPUT->render_from_template('core_tag/tagfeed', $tagfeed->export_for_template($OUTPUT)); return new core_tag\output\tagindex($tag, 'mod_wiki', 'wiki_pages', $content, $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages); } }
/** * Returns course modules tagged with a specified tag ready for output on tag/index.php page * * This is a callback used by the tag area core/course_modules to search for course modules * tagged with a specific tag. * * @param core_tag_tag $tag * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag * are displayed on the page and the per-page limit may be bigger * @param int $fromcontextid context id where the link was displayed, may be used by callbacks * to display items in the same context first * @param int $contextid context id where to search for records * @param bool $recursivecontext search in subcontexts as well * @param int $page 0-based number of page being displayed * @return \core_tag\output\tagindex */ function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0, $recursivecontext = 1, $page = 0) { global $OUTPUT; $perpage = $exclusivemode ? 20 : 5; // Build select query. $ctxselect = context_helper::get_preload_record_columns_sql('ctx'); $query = "SELECT cm.id AS cmid, c.id AS courseid, {$ctxselect}\n FROM {course_modules} cm\n JOIN {tag_instance} tt ON cm.id = tt.itemid\n JOIN {course} c ON cm.course = c.id\n JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel\n WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component\n AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%"; $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id, 'component' => 'core', 'coursemodulecontextlevel' => CONTEXT_MODULE); if ($contextid) { $context = context::instance_by_id($contextid); $query .= $recursivecontext ? ' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid'; $params['contextid'] = $context->id; $params['path'] = $context->path . '/%'; } $query .= ' ORDER BY'; if ($fromcontextid) { // In order-clause specify that modules from inside "fromctx" context should be returned first. $fromcontext = context::instance_by_id($fromcontextid); $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),'; $params['fromcontextid'] = $fromcontext->id; $params['frompath'] = $fromcontext->path . '/%'; } $query .= ' c.sortorder, cm.id'; $totalpages = $page + 1; // Use core_tag_index_builder to build and filter the list of items. // Request one item more than we need so we know if next page exists. $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage + 1); while ($item = $builder->has_item_that_needs_access_check()) { context_helper::preload_from_record($item); $courseid = $item->courseid; if (!$builder->can_access_course($courseid)) { $builder->set_accessible($item, false); continue; } $modinfo = get_fast_modinfo($builder->get_course($courseid)); // Set accessibility of this item and all other items in the same course. $builder->walk(function ($taggeditem) use($courseid, $modinfo, $builder) { if ($taggeditem->courseid == $courseid) { $cm = $modinfo->get_cm($taggeditem->cmid); $builder->set_accessible($taggeditem, $cm->uservisible); } }); } $items = $builder->get_items(); if (count($items) > $perpage) { $totalpages = $page + 2; // We don't need exact page count, just indicate that the next page exists. array_pop($items); } // Build the display contents. if ($items) { $tagfeed = new core_tag\output\tagfeed(); foreach ($items as $item) { context_helper::preload_from_record($item); $course = $builder->get_course($item->courseid); $modinfo = get_fast_modinfo($course); $cm = $modinfo->get_cm($item->cmid); $courseurl = course_get_url($item->courseid, $cm->sectionnum); $cmname = $cm->get_formatted_name(); if (!$exclusivemode) { $cmname = shorten_text($cmname, 100); } $cmname = html_writer::link($cm->url ?: $courseurl, $cmname); $coursename = format_string($course->fullname, true, array('context' => context_course::instance($item->courseid))); $coursename = html_writer::link($courseurl, $coursename); $icon = html_writer::empty_tag('img', array('src' => $cm->get_icon_url())); $tagfeed->add($icon, $cmname, $coursename); } $content = $OUTPUT->render_from_template('core_tag/tagfeed', $tagfeed->export_for_template($OUTPUT)); return new core_tag\output\tagindex($tag, 'core', 'course_modules', $content, $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages); } }
public function test_mod_wiki_get_tagged_pages() { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Setup test data. $wikigenerator = $this->getDataGenerator()->get_plugin_generator('mod_wiki'); $course3 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); $course1 = $this->getDataGenerator()->create_course(); $wiki1 = $this->getDataGenerator()->create_module('wiki', array('course' => $course1->id)); $wiki2 = $this->getDataGenerator()->create_module('wiki', array('course' => $course2->id)); $wiki3 = $this->getDataGenerator()->create_module('wiki', array('course' => $course3->id)); $page11 = $wikigenerator->create_content($wiki1, array('tags' => array('Cats', 'Dogs'))); $page12 = $wikigenerator->create_content($wiki1, array('tags' => array('Cats', 'mice'))); $page13 = $wikigenerator->create_content($wiki1, array('tags' => array('Cats'))); $page14 = $wikigenerator->create_content($wiki1); $page15 = $wikigenerator->create_content($wiki1, array('tags' => array('Cats'))); $page21 = $wikigenerator->create_content($wiki2, array('tags' => array('Cats'))); $page22 = $wikigenerator->create_content($wiki2, array('tags' => array('Cats', 'Dogs'))); $page23 = $wikigenerator->create_content($wiki2, array('tags' => array('mice', 'Cats'))); $page31 = $wikigenerator->create_content($wiki3, array('tags' => array('mice', 'Cats'))); $tag = core_tag_tag::get_by_name(0, 'Cats'); // Admin can see everything. $res = mod_wiki_get_tagged_pages($tag, false, 0, 0, 1, 0); $this->assertRegExp('/' . $page11->title . '/', $res->content); $this->assertRegExp('/' . $page12->title . '/', $res->content); $this->assertRegExp('/' . $page13->title . '/', $res->content); $this->assertNotRegExp('/' . $page14->title . '/', $res->content); $this->assertRegExp('/' . $page15->title . '/', $res->content); $this->assertRegExp('/' . $page21->title . '/', $res->content); $this->assertNotRegExp('/' . $page22->title . '/', $res->content); $this->assertNotRegExp('/' . $page23->title . '/', $res->content); $this->assertNotRegExp('/' . $page31->title . '/', $res->content); $this->assertEmpty($res->prevpageurl); $this->assertNotEmpty($res->nextpageurl); $res = mod_wiki_get_tagged_pages($tag, false, 0, 0, 1, 1); $this->assertNotRegExp('/' . $page11->title . '/', $res->content); $this->assertNotRegExp('/' . $page12->title . '/', $res->content); $this->assertNotRegExp('/' . $page13->title . '/', $res->content); $this->assertNotRegExp('/' . $page14->title . '/', $res->content); $this->assertNotRegExp('/' . $page15->title . '/', $res->content); $this->assertNotRegExp('/' . $page21->title . '/', $res->content); $this->assertRegExp('/' . $page22->title . '/', $res->content); $this->assertRegExp('/' . $page23->title . '/', $res->content); $this->assertRegExp('/' . $page31->title . '/', $res->content); $this->assertNotEmpty($res->prevpageurl); $this->assertEmpty($res->nextpageurl); // Create and enrol a user. $student = self::getDataGenerator()->create_user(); $studentrole = $DB->get_record('role', array('shortname' => 'student')); $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id, 'manual'); $this->getDataGenerator()->enrol_user($student->id, $course2->id, $studentrole->id, 'manual'); $this->setUser($student); core_tag_index_builder::reset_caches(); // User can not see pages in course 3 because he is not enrolled. $res = mod_wiki_get_tagged_pages($tag, false, 0, 0, 1, 1); $this->assertRegExp('/' . $page22->title . '/', $res->content); $this->assertRegExp('/' . $page23->title . '/', $res->content); $this->assertNotRegExp('/' . $page31->title . '/', $res->content); // User can search wiki pages inside a course. $coursecontext = context_course::instance($course1->id); $res = mod_wiki_get_tagged_pages($tag, false, 0, $coursecontext->id, 1, 0); $this->assertRegExp('/' . $page11->title . '/', $res->content); $this->assertRegExp('/' . $page12->title . '/', $res->content); $this->assertRegExp('/' . $page13->title . '/', $res->content); $this->assertNotRegExp('/' . $page14->title . '/', $res->content); $this->assertRegExp('/' . $page15->title . '/', $res->content); $this->assertNotRegExp('/' . $page21->title . '/', $res->content); $this->assertNotRegExp('/' . $page22->title . '/', $res->content); $this->assertNotRegExp('/' . $page23->title . '/', $res->content); $this->assertEmpty($res->nextpageurl); }